ai 2.2.30 → 2.2.32

package/dist/index.d.ts

@@ -95,6 +95,10 @@ interface Message$1 {
      * the tool call name and arguments. Otherwise, the field should not be set.
      */
     tool_calls?: string | ToolCall[];
+    /**
+     * Additional message-specific information added on the server via StreamData
+     */
+    annotations?: JSONValue[] | undefined;
 }
 type CreateMessage = Omit<Message$1, 'id'> & {
     id?: Message$1['id'];
@@ -299,7 +303,8 @@ declare const dataMessageStreamPart: StreamPart<'6', 'data_message', DataMessage
 declare const toolCallStreamPart: StreamPart<'7', 'tool_calls', {
     tool_calls: ToolCall[];
 }>;
-type StreamPartType = ReturnType<typeof textStreamPart.parse> | ReturnType<typeof functionCallStreamPart.parse> | ReturnType<typeof dataStreamPart.parse> | ReturnType<typeof errorStreamPart.parse> | ReturnType<typeof assistantMessageStreamPart.parse> | ReturnType<typeof assistantControlDataStreamPart.parse> | ReturnType<typeof dataMessageStreamPart.parse> | ReturnType<typeof toolCallStreamPart.parse>;
+declare const messageAnnotationsStreamPart: StreamPart<'8', 'message_annotations', Array<JSONValue>>;
+type StreamPartType = ReturnType<typeof textStreamPart.parse> | ReturnType<typeof functionCallStreamPart.parse> | ReturnType<typeof dataStreamPart.parse> | ReturnType<typeof errorStreamPart.parse> | ReturnType<typeof assistantMessageStreamPart.parse> | ReturnType<typeof assistantControlDataStreamPart.parse> | ReturnType<typeof dataMessageStreamPart.parse> | ReturnType<typeof toolCallStreamPart.parse> | ReturnType<typeof messageAnnotationsStreamPart.parse>;
 /**
  * The map of prefixes for data in the stream
  *
@@ -331,6 +336,7 @@ declare const StreamStringPrefixes: {
     readonly assistant_control_data: "5";
     readonly data_message: "6";
     readonly tool_calls: "7";
+    readonly message_annotations: "8";
 };
 
 declare const nanoid: (size?: number | undefined) => string;
@@ -339,7 +345,7 @@ declare function createChunkDecoder(complex: false): (chunk: Uint8Array | undefi
 declare function createChunkDecoder(complex: true): (chunk: Uint8Array | undefined) => StreamPartType[];
 declare function createChunkDecoder(complex?: boolean): (chunk: Uint8Array | undefined) => StreamPartType[] | string;
 
-declare const isStreamStringEqualToType: (type: keyof typeof StreamStringPrefixes, value: string) => value is `0:${string}\n` | `1:${string}\n` | `2:${string}\n` | `3:${string}\n` | `4:${string}\n` | `5:${string}\n` | `6:${string}\n` | `7:${string}\n`;
+declare const isStreamStringEqualToType: (type: keyof typeof StreamStringPrefixes, value: string) => value is `0:${string}\n` | `1:${string}\n` | `2:${string}\n` | `3:${string}\n` | `4:${string}\n` | `5:${string}\n` | `6:${string}\n` | `7:${string}\n` | `8:${string}\n`;
 type StreamString = `${(typeof StreamStringPrefixes)[keyof typeof StreamStringPrefixes]}:${string}\n`;
 /**
  * A header sent to the client so it knows how to handle parsing the stream (as a deprecated text response or using the new prefixed protocol)
@@ -568,12 +574,23 @@ interface AIStreamCallbacksAndOptions {
      */
     experimental_streamData?: boolean;
 }
+/**
+ * Options for the AIStreamParser.
+ * @interface
+ * @property {string} event - The event (type) from the server side event stream.
+ */
+interface AIStreamParserOptions {
+    event?: string;
+}
 /**
  * Custom parser for AIStream data.
  * @interface
+ * @param {string} data - The data to be parsed.
+ * @param {AIStreamParserOptions} options - The options for the parser.
+ * @returns {string | void} The parsed data or void.
  */
 interface AIStreamParser {
-    (data: string): string | void;
+    (data: string, options: AIStreamParserOptions): string | void;
 }
 /**
  * Creates a TransformStream that parses events from an EventSource stream using a custom parser.
@@ -844,9 +861,11 @@ declare class experimental_StreamData {
     private isClosedPromiseResolver;
     private isClosed;
     private data;
+    private messageAnnotations;
     constructor();
     close(): Promise<void>;
     append(value: JSONValue): void;
+    appendMessageAnnotation(value: JSONValue): void;
 }
 /**
  * A TransformStream for LLMs that do not have their own transform stream handlers managing encoding (e.g. OpenAIStream has one for function call handling).
@@ -900,4 +919,4 @@ declare function streamToResponse(res: ReadableStream, response: ServerResponse,
     status?: number;
 }): void;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantMessage, COMPLEX_HEADER, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CreateMessage, DataMessage, Function, FunctionCall, FunctionCallHandler, FunctionCallPayload, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, JSONValue, LangChainStream, Message$1 as Message, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamString, StreamingTextResponse, Tool, ToolCall, ToolCallHandler, ToolCallPayload, ToolChoice, UseChatOptions, UseCompletionOptions, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, isStreamStringEqualToType, nanoid, readableFromAsyncIterable, streamToResponse, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantMessage, COMPLEX_HEADER, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CreateMessage, DataMessage, Function, FunctionCall, FunctionCallHandler, FunctionCallPayload, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, JSONValue, LangChainStream, Message$1 as Message, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamString, StreamingTextResponse, Tool, ToolCall, ToolCallHandler, ToolCallPayload, ToolChoice, UseChatOptions, UseCompletionOptions, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, isStreamStringEqualToType, nanoid, readableFromAsyncIterable, streamToResponse, trimStartOfStreamHelper };

package/dist/index.js

@@ -165,6 +165,16 @@ var toolCallStreamPart = {
     };
   }
 };
+var messageAnnotationsStreamPart = {
+  code: "8",
+  name: "message_annotations",
+  parse: (value) => {
+    if (!Array.isArray(value)) {
+      throw new Error('"message_annotations" parts expect an array value.');
+    }
+    return { type: "message_annotations", value };
+  }
+};
 var streamParts = [
   textStreamPart,
   functionCallStreamPart,
@@ -173,7 +183,8 @@ var streamParts = [
   assistantMessageStreamPart,
   assistantControlDataStreamPart,
   dataMessageStreamPart,
-  toolCallStreamPart
+  toolCallStreamPart,
+  messageAnnotationsStreamPart
 ];
 var streamPartsByCode = {
   [textStreamPart.code]: textStreamPart,
@@ -183,7 +194,8 @@ var streamPartsByCode = {
   [assistantMessageStreamPart.code]: assistantMessageStreamPart,
   [assistantControlDataStreamPart.code]: assistantControlDataStreamPart,
   [dataMessageStreamPart.code]: dataMessageStreamPart,
-  [toolCallStreamPart.code]: toolCallStreamPart
+  [toolCallStreamPart.code]: toolCallStreamPart,
+  [messageAnnotationsStreamPart.code]: messageAnnotationsStreamPart
 };
 var StreamStringPrefixes = {
   [textStreamPart.name]: textStreamPart.code,
@@ -193,7 +205,8 @@ var StreamStringPrefixes = {
   [assistantMessageStreamPart.name]: assistantMessageStreamPart.code,
   [assistantControlDataStreamPart.name]: assistantControlDataStreamPart.code,
   [dataMessageStreamPart.name]: dataMessageStreamPart.code,
-  [toolCallStreamPart.name]: toolCallStreamPart.code
+  [toolCallStreamPart.name]: toolCallStreamPart.code,
+  [messageAnnotationsStreamPart.name]: messageAnnotationsStreamPart.code
 };
 var validCodes = streamParts.map((part) => part.code);
 var parseStreamPart = (line) => {
@@ -257,7 +270,9 @@ function createEventStreamTransformer(customParser) {
             return;
           }
           if ("data" in event) {
-            const parsedMessage = customParser ? customParser(event.data) : event.data;
+            const parsedMessage = customParser ? customParser(event.data, {
+              event: event.event
+            }) : event.data;
             if (parsedMessage)
               controller.enqueue(parsedMessage);
           }
@@ -369,6 +384,7 @@ var experimental_StreamData = class {
     this.isClosed = false;
     // array to store appended data
     this.data = [];
+    this.messageAnnotations = [];
     this.isClosedPromise = new Promise((resolve) => {
       this.isClosedPromiseResolver = resolve;
     });
@@ -385,6 +401,12 @@ var experimental_StreamData = class {
           self.data = [];
           controller.enqueue(encodedData);
         }
+        if (self.messageAnnotations.length) {
+          const encodedmessageAnnotations = self.encoder.encode(
+            formatStreamPart("message_annotations", self.messageAnnotations)
+          );
+          controller.enqueue(encodedmessageAnnotations);
+        }
         controller.enqueue(chunk);
       },
       async flush(controller) {
@@ -403,6 +425,12 @@ var experimental_StreamData = class {
           );
           controller.enqueue(encodedData);
         }
+        if (self.messageAnnotations.length) {
+          const encodedData = self.encoder.encode(
+            formatStreamPart("message_annotations", self.messageAnnotations)
+          );
+          controller.enqueue(encodedData);
+        }
       }
     });
   }
@@ -423,6 +451,12 @@ var experimental_StreamData = class {
     }
     this.data.push(value);
   }
+  appendMessageAnnotation(value) {
+    if (this.isClosed) {
+      throw new Error("Data Stream has already been closed.");
+    }
+    this.messageAnnotations.push(value);
+  }
 };
 function createStreamDataTransformer(experimental_streamData) {
   if (!experimental_streamData) {
@@ -1108,6 +1142,22 @@ async function parseComplexResponse({
         };
       }
     }
+    if (type == "message_annotations") {
+      if (prefixMap["text"]) {
+        prefixMap["text"] = {
+          ...prefixMap["text"],
+          annotations: [...prefixMap["text"].annotations || [], ...value]
+        };
+      } else {
+        prefixMap["text"] = {
+          id: generateId(),
+          role: "assistant",
+          content: "",
+          annotations: [...value],
+          createdAt
+        };
+      }
+    }
     let functionCallMessage = null;
     if (type === "function_call") {
       prefixMap["function_call"] = {