chore(types): consistent naming for text block types (#373)

anthropics · Apr 4, 2024 · 84a6a58 · 84a6a58
1 parent a04edd8
commit 84a6a58
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 8 deletions.
diff --git a/api.md b/api.md
@@ -17,6 +17,7 @@ Types:
 - <code><a href="./src/resources/messages.ts">MessageStopEvent</a></code>
 - <code><a href="./src/resources/messages.ts">MessageStreamEvent</a></code>
 - <code><a href="./src/resources/messages.ts">TextBlock</a></code>
+- <code><a href="./src/resources/messages.ts">TextBlockParam</a></code>
 - <code><a href="./src/resources/messages.ts">TextDelta</a></code>
 - <code><a href="./src/resources/messages.ts">Usage</a></code>
 

diff --git a/src/index.ts b/src/index.ts
@@ -250,6 +250,7 @@ export namespace Anthropic {
   export import MessageStopEvent = API.MessageStopEvent;
   export import MessageStreamEvent = API.MessageStreamEvent;
   export import TextBlock = API.TextBlock;
+  export import TextBlockParam = API.TextBlockParam;
   export import TextDelta = API.TextDelta;
   export import Usage = API.Usage;
   export import MessageCreateParams = API.MessageCreateParams;

diff --git a/src/resources/index.ts b/src/resources/index.ts
@@ -21,6 +21,7 @@ export {
   MessageStopEvent,
   MessageStreamEvent,
   TextBlock,
+  TextBlockParam,
   TextDelta,
   Usage,
   MessageCreateParams,

diff --git a/src/resources/messages.ts b/src/resources/messages.ts
@@ -47,11 +47,7 @@ export class Messages extends APIResource {
   }
 }
 
-export interface ContentBlock {
-  text: string;
-
-  type: 'text';
-}
+export type ContentBlock = TextBlock;
 
 export interface ContentBlockDeltaEvent {
   delta: TextDelta;
@@ -62,7 +58,7 @@ export interface ContentBlockDeltaEvent {
 }
 
 export interface ContentBlockStartEvent {
-  content_block: ContentBlock;
+  content_block: TextBlock;
 
   index: number;
 
@@ -133,7 +129,7 @@ export interface Message {
    * [{ "type": "text", "text": "B)" }]
    * ```
    */
-  content: Array<ContentBlock>;
+  content: Array<TextBlock>;
 
   /**
    * The model that handled the request.
@@ -234,7 +230,7 @@ export interface MessageDeltaUsage {
 }
 
 export interface MessageParam {
-  content: string | Array<TextBlock | ImageBlockParam>;
+  content: string | Array<TextBlockParam | ImageBlockParam>;
 
   role: 'user' | 'assistant';
 }
@@ -263,6 +259,12 @@ export interface TextBlock {
   type: 'text';
 }
 
+export interface TextBlockParam {
+  text: string;
+
+  type: 'text';
+}
+
 export interface TextDelta {
   text: string;
 
@@ -720,6 +722,7 @@ export namespace Messages {
   export import MessageStopEvent = MessagesAPI.MessageStopEvent;
   export import MessageStreamEvent = MessagesAPI.MessageStreamEvent;
   export import TextBlock = MessagesAPI.TextBlock;
+  export import TextBlockParam = MessagesAPI.TextBlockParam;
   export import TextDelta = MessagesAPI.TextDelta;
   export import Usage = MessagesAPI.Usage;
   export import MessageCreateParams = MessagesAPI.MessageCreateParams;