ai 3.1.8 → 3.1.10

package/dist/index.d.mts

@@ -102,6 +102,60 @@ declare class EmbedResult<VALUE> {
     });
 }
 
+/**
+Embed several values using an embedding model. The type of the value is defined
+by the embedding model.
+
+`embedMany` automatically splits large requests into smaller chunks if the model
+has a limit on how many embeddings can be generated in a single call.
+
+@param model - The embedding model to use.
+@param values - The values that should be embedded.
+
+@param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
+@param abortSignal - An optional abort signal that can be used to cancel the call.
+
+@returns A result object that contains the embeddings, the value, and additional information.
+ */
+declare function embedMany<VALUE>({ model, values, maxRetries, abortSignal, }: {
+    /**
+  The embedding model to use.
+       */
+    model: EmbeddingModel<VALUE>;
+    /**
+  The values that should be embedded.
+     */
+    values: Array<VALUE>;
+    /**
+  Maximum number of retries per embedding model call. Set to 0 to disable retries.
+  
+  @default 2
+     */
+    maxRetries?: number;
+    /**
+  Abort signal.
+   */
+    abortSignal?: AbortSignal;
+}): Promise<EmbedManyResult<VALUE>>;
+/**
+The result of a `embedMany` call.
+It contains the embeddings, the values, and additional information.
+ */
+declare class EmbedManyResult<VALUE> {
+    /**
+  The values that were embedded.
+     */
+    readonly values: Array<VALUE>;
+    /**
+  The embeddings. They are in the same order as the values.
+    */
+    readonly embeddings: Array<Embedding>;
+    constructor(options: {
+        values: Array<VALUE>;
+        embeddings: Array<Embedding>;
+    });
+}
+
 type TokenUsage = {
     promptTokens: number;
     completionTokens: number;
@@ -1023,6 +1077,38 @@ declare function convertToCoreMessages(messages: Array<{
     toolInvocations?: Array<ToolResult<string, unknown, unknown>>;
 }>): CoreMessage[];
 
+type AssistantStatus = 'in_progress' | 'awaiting_message';
+type UseAssistantOptions = {
+    /**
+     * The API endpoint that accepts a `{ threadId: string | null; message: string; }` object and returns an `AssistantResponse` stream.
+     * The threadId refers to an existing thread with messages (or is `null` to create a new thread).
+     * The message is the next message that should be appended to the thread and sent to the assistant.
+     */
+    api: string;
+    /**
+     * An optional string that represents the ID of an existing thread.
+     * If not provided, a new thread will be created.
+     */
+    threadId?: string;
+    /**
+     * An optional literal that sets the mode of credentials to be used on the request.
+     * Defaults to "same-origin".
+     */
+    credentials?: RequestCredentials;
+    /**
+     * An optional object of headers to be passed to the API endpoint.
+     */
+    headers?: Record<string, string> | Headers;
+    /**
+     * An optional, additional body object to be passed to the API endpoint.
+     */
+    body?: object;
+    /**
+     * An optional callback that will be called when the assistant encounters an error.
+     */
+    onError?: (error: Error) => void;
+};
+
 interface FunctionCall$1 {
     /**
      * The arguments to call the function with, as generated by the model in JSON
@@ -2184,4 +2270,4 @@ declare function streamToResponse(res: ReadableStream, response: ServerResponse,
     status?: number;
 }): void;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, EmbedResult, Embedding, EmbeddingModel, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, Message$1 as Message, MistralStream, ObjectStreamPart, ObjectStreamPartInput, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamData, StreamObjectResult, StreamPart, StreamString, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, Tool, ToolCall, ToolCallHandler, ToolCallPart, ToolCallPayload, ToolChoice, ToolContent, ToolInvocation, ToolResultPart, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, convertToCoreMessages, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, embed, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, formatStreamPart, generateId, generateObject, generateText, isStreamStringEqualToType, generateId as nanoid, parseStreamPart, readDataStream, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, AssistantStatus, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, Message$1 as Message, MistralStream, ObjectStreamPart, ObjectStreamPartInput, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamData, StreamObjectResult, StreamPart, StreamString, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, Tool, ToolCall, ToolCallHandler, ToolCallPart, ToolCallPayload, ToolChoice, ToolContent, ToolInvocation, ToolResultPart, UseAssistantOptions, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, convertToCoreMessages, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, formatStreamPart, generateId, generateObject, generateText, isStreamStringEqualToType, generateId as nanoid, parseStreamPart, readDataStream, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };

package/dist/index.d.ts

@@ -102,6 +102,60 @@ declare class EmbedResult<VALUE> {
     });
 }
 
+/**
+Embed several values using an embedding model. The type of the value is defined
+by the embedding model.
+
+`embedMany` automatically splits large requests into smaller chunks if the model
+has a limit on how many embeddings can be generated in a single call.
+
+@param model - The embedding model to use.
+@param values - The values that should be embedded.
+
+@param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
+@param abortSignal - An optional abort signal that can be used to cancel the call.
+
+@returns A result object that contains the embeddings, the value, and additional information.
+ */
+declare function embedMany<VALUE>({ model, values, maxRetries, abortSignal, }: {
+    /**
+  The embedding model to use.
+       */
+    model: EmbeddingModel<VALUE>;
+    /**
+  The values that should be embedded.
+     */
+    values: Array<VALUE>;
+    /**
+  Maximum number of retries per embedding model call. Set to 0 to disable retries.
+  
+  @default 2
+     */
+    maxRetries?: number;
+    /**
+  Abort signal.
+   */
+    abortSignal?: AbortSignal;
+}): Promise<EmbedManyResult<VALUE>>;
+/**
+The result of a `embedMany` call.
+It contains the embeddings, the values, and additional information.
+ */
+declare class EmbedManyResult<VALUE> {
+    /**
+  The values that were embedded.
+     */
+    readonly values: Array<VALUE>;
+    /**
+  The embeddings. They are in the same order as the values.
+    */
+    readonly embeddings: Array<Embedding>;
+    constructor(options: {
+        values: Array<VALUE>;
+        embeddings: Array<Embedding>;
+    });
+}
+
 type TokenUsage = {
     promptTokens: number;
     completionTokens: number;
@@ -1023,6 +1077,38 @@ declare function convertToCoreMessages(messages: Array<{
     toolInvocations?: Array<ToolResult<string, unknown, unknown>>;
 }>): CoreMessage[];
 
+type AssistantStatus = 'in_progress' | 'awaiting_message';
+type UseAssistantOptions = {
+    /**
+     * The API endpoint that accepts a `{ threadId: string | null; message: string; }` object and returns an `AssistantResponse` stream.
+     * The threadId refers to an existing thread with messages (or is `null` to create a new thread).
+     * The message is the next message that should be appended to the thread and sent to the assistant.
+     */
+    api: string;
+    /**
+     * An optional string that represents the ID of an existing thread.
+     * If not provided, a new thread will be created.
+     */
+    threadId?: string;
+    /**
+     * An optional literal that sets the mode of credentials to be used on the request.
+     * Defaults to "same-origin".
+     */
+    credentials?: RequestCredentials;
+    /**
+     * An optional object of headers to be passed to the API endpoint.
+     */
+    headers?: Record<string, string> | Headers;
+    /**
+     * An optional, additional body object to be passed to the API endpoint.
+     */
+    body?: object;
+    /**
+     * An optional callback that will be called when the assistant encounters an error.
+     */
+    onError?: (error: Error) => void;
+};
+
 interface FunctionCall$1 {
     /**
      * The arguments to call the function with, as generated by the model in JSON
@@ -2184,4 +2270,4 @@ declare function streamToResponse(res: ReadableStream, response: ServerResponse,
     status?: number;
 }): void;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, EmbedResult, Embedding, EmbeddingModel, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, Message$1 as Message, MistralStream, ObjectStreamPart, ObjectStreamPartInput, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamData, StreamObjectResult, StreamPart, StreamString, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, Tool, ToolCall, ToolCallHandler, ToolCallPart, ToolCallPayload, ToolChoice, ToolContent, ToolInvocation, ToolResultPart, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, convertToCoreMessages, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, embed, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, formatStreamPart, generateId, generateObject, generateText, isStreamStringEqualToType, generateId as nanoid, parseStreamPart, readDataStream, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, AssistantStatus, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, Message$1 as Message, MistralStream, ObjectStreamPart, ObjectStreamPartInput, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamData, StreamObjectResult, StreamPart, StreamString, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, Tool, ToolCall, ToolCallHandler, ToolCallPart, ToolCallPayload, ToolChoice, ToolContent, ToolInvocation, ToolResultPart, UseAssistantOptions, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, convertToCoreMessages, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, formatStreamPart, generateId, generateObject, generateText, isStreamStringEqualToType, generateId as nanoid, parseStreamPart, readDataStream, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };

package/dist/index.js

@@ -40,6 +40,7 @@ __export(streams_exports, {
   AnthropicStream: () => AnthropicStream,
   AssistantResponse: () => AssistantResponse,
   CohereStream: () => CohereStream,
+  EmbedManyResult: () => EmbedManyResult,
   EmbedResult: () => EmbedResult,
   EmptyResponseBodyError: () => import_provider8.EmptyResponseBodyError,
   GenerateObjectResult: () => GenerateObjectResult,
@@ -78,6 +79,7 @@ __export(streams_exports, {
   createEventStreamTransformer: () => createEventStreamTransformer,
   createStreamDataTransformer: () => createStreamDataTransformer,
   embed: () => embed,
+  embedMany: () => embedMany,
   experimental_AssistantResponse: () => experimental_AssistantResponse,
   experimental_StreamData: () => experimental_StreamData,
   experimental_StreamingReactResponse: () => experimental_StreamingReactResponse,
@@ -192,6 +194,53 @@ var EmbedResult = class {
   }
 };
 
+// core/util/split-array.ts
+function splitArray(array, chunkSize) {
+  if (chunkSize <= 0) {
+    throw new Error("chunkSize must be greater than 0");
+  }
+  const result = [];
+  for (let i = 0; i < array.length; i += chunkSize) {
+    result.push(array.slice(i, i + chunkSize));
+  }
+  return result;
+}
+
+// core/embed/embed-many.ts
+async function embedMany({
+  model,
+  values,
+  maxRetries,
+  abortSignal
+}) {
+  const retry = retryWithExponentialBackoff({ maxRetries });
+  const maxEmbeddingsPerCall = model.maxEmbeddingsPerCall;
+  if (maxEmbeddingsPerCall == null) {
+    const modelResponse = await retry(
+      () => model.doEmbed({ values, abortSignal })
+    );
+    return new EmbedManyResult({
+      values,
+      embeddings: modelResponse.embeddings
+    });
+  }
+  const valueChunks = splitArray(values, maxEmbeddingsPerCall);
+  const embeddings = [];
+  for (const chunk of valueChunks) {
+    const modelResponse = await retry(
+      () => model.doEmbed({ values: chunk, abortSignal })
+    );
+    embeddings.push(...modelResponse.embeddings);
+  }
+  return new EmbedManyResult({ values, embeddings });
+}
+var EmbedManyResult = class {
+  constructor(options) {
+    this.values = options.values;
+    this.embeddings = options.embeddings;
+  }
+};
+
 // core/generate-object/generate-object.ts
 var import_provider5 = require("@ai-sdk/provider");
 var import_provider_utils3 = require("@ai-sdk/provider-utils");
@@ -1685,7 +1734,7 @@ var StreamTextResult = class {
       "Content-Type": "text/plain; charset=utf-8",
       ...init == null ? void 0 : init.headers
     });
-    const reader = this.textStream.pipeThrough(createCallbacksTransformer(void 0)).pipeThrough(createStreamDataTransformer()).getReader();
+    const reader = this.toAIStream().getReader();
     const read = async () => {
       try {
         while (true) {
@@ -1716,15 +1765,14 @@ var StreamTextResult = class {
       "Content-Type": "text/plain; charset=utf-8",
       ...init == null ? void 0 : init.headers
     });
-    const reader = this.textStream.getReader();
+    const reader = this.textStream.pipeThrough(new TextEncoderStream()).getReader();
     const read = async () => {
-      const encoder = new TextEncoder();
       try {
         while (true) {
           const { done, value } = await reader.read();
           if (done)
             break;
-          response.write(encoder.encode(value));
+          response.write(value);
         }
       } catch (error) {
         throw error;
@@ -1754,23 +1802,13 @@ var StreamTextResult = class {
      */
   toTextStreamResponse(init) {
     var _a;
-    const encoder = new TextEncoder();
-    return new Response(
-      this.textStream.pipeThrough(
-        new TransformStream({
-          transform(chunk, controller) {
-            controller.enqueue(encoder.encode(chunk));
-          }
-        })
-      ),
-      {
-        status: (_a = init == null ? void 0 : init.status) != null ? _a : 200,
-        headers: {
-          "Content-Type": "text/plain; charset=utf-8",
-          ...init == null ? void 0 : init.headers
-        }
+    return new Response(this.textStream.pipeThrough(new TextEncoderStream()), {
+      status: (_a = init == null ? void 0 : init.status) != null ? _a : 200,
+      headers: {
+        "Content-Type": "text/plain; charset=utf-8",
+        ...init == null ? void 0 : init.headers
       }
-    );
+    });
   }
 };
 var experimental_streamText = streamText;
@@ -3322,6 +3360,7 @@ function streamToResponse(res, response, init) {
   AnthropicStream,
   AssistantResponse,
   CohereStream,
+  EmbedManyResult,
   EmbedResult,
   EmptyResponseBodyError,
   GenerateObjectResult,
@@ -3360,6 +3399,7 @@ function streamToResponse(res, response, init) {
   createEventStreamTransformer,
   createStreamDataTransformer,
   embed,
+  embedMany,
   experimental_AssistantResponse,
   experimental_StreamData,
   experimental_StreamingReactResponse,