ai 3.1.7 → 3.1.9

package/dist/index.d.mts

@@ -1,10 +1,107 @@
-import { z } from 'zod';
-import { LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning } from '@ai-sdk/provider';
+import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning } from '@ai-sdk/provider';
 export { APICallError, EmptyResponseBodyError, InvalidArgumentError, InvalidDataContentError, InvalidPromptError, InvalidResponseDataError, InvalidToolArgumentsError, JSONParseError, LoadAPIKeyError, NoObjectGeneratedError, NoSuchToolError, RetryError, ToolCallParseError, TypeValidationError, UnsupportedFunctionalityError, UnsupportedJSONSchemaError } from '@ai-sdk/provider';
+import { z } from 'zod';
 import { ServerResponse } from 'node:http';
 import { AssistantStream } from 'openai/lib/AssistantStream';
 import { Run } from 'openai/resources/beta/threads/runs/runs';
 
+/**
+Embedding model that is used by the AI SDK Core functions.
+*/
+type EmbeddingModel<VALUE> = EmbeddingModelV1<VALUE>;
+/**
+Embedding.
+ */
+type Embedding = EmbeddingModelV1Embedding;
+
+/**
+Language model that is used by the AI SDK Core functions.
+*/
+type LanguageModel = LanguageModelV1;
+/**
+Reason why a language model finished generating a response.
+
+Can be one of the following:
+- `stop`: model generated stop sequence
+- `length`: model generated maximum number of tokens
+- `content-filter`: content filter violation stopped the model
+- `tool-calls`: model triggered tool calls
+- `error`: model stopped because of an error
+- `other`: model stopped for other reasons
+*/
+type FinishReason = LanguageModelV1FinishReason;
+/**
+Log probabilities for each token and its top log probabilities.
+ */
+type LogProbs = LanguageModelV1LogProbs;
+/**
+Warning from the model provider for this call. The call will proceed, but e.g.
+some settings might not be supported, which can lead to suboptimal results.
+*/
+type CallWarning = LanguageModelV1CallWarning;
+
+/**
+Embed a value using an embedding model. The type of the value is defined by the embedding model.
+
+@param model - The embedding model to use.
+@param value - The value 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 embedding, the value, and additional information.
+ */
+declare function embed<VALUE>({ model, value, maxRetries, abortSignal, }: {
+    /**
+  The embedding model to use.
+       */
+    model: EmbeddingModel<VALUE>;
+    /**
+  The value that should be embedded.
+     */
+    value: VALUE;
+    /**
+  Maximum number of retries per embedding model call. Set to 0 to disable retries.
+  
+  @default 2
+     */
+    maxRetries?: number;
+    /**
+  Abort signal.
+   */
+    abortSignal?: AbortSignal;
+}): Promise<EmbedResult<VALUE>>;
+/**
+The result of a `embed` call.
+It contains the embedding, the value, and additional information.
+ */
+declare class EmbedResult<VALUE> {
+    /**
+  The value that was embedded.
+     */
+    readonly value: VALUE;
+    /**
+  The embedding of the value.
+    */
+    readonly embedding: Embedding;
+    /**
+  Optional raw response data.
+     */
+    readonly rawResponse?: {
+        /**
+    Response headers.
+         */
+        headers?: Record<string, string>;
+    };
+    constructor(options: {
+        value: VALUE;
+        embedding: Embedding;
+        rawResponse?: {
+            headers?: Record<string, string>;
+        };
+    });
+}
+
 type TokenUsage = {
     promptTokens: number;
     completionTokens: number;
@@ -242,32 +339,6 @@ type Prompt = {
     messages?: Array<CoreMessage>;
 };
 
-/**
-Language model that is used by the AI SDK Core functions.
-*/
-type LanguageModel = LanguageModelV1;
-/**
-Reason why a language model finished generating a response.
-
-Can be one of the following:
-- `stop`: model generated stop sequence
-- `length`: model generated maximum number of tokens
-- `content-filter`: content filter violation stopped the model
-- `tool-calls`: model triggered tool calls
-- `error`: model stopped because of an error
-- `other`: model stopped for other reasons
-*/
-type FinishReason = LanguageModelV1FinishReason;
-/**
-Log probabilities for each token and its top log probabilities.
- */
-type LogProbs = LanguageModelV1LogProbs;
-/**
-Warning from the model provider for this call. The call will proceed, but e.g.
-some settings might not be supported, which can lead to suboptimal results.
-*/
-type CallWarning = LanguageModelV1CallWarning;
-
 /**
 Generate a structured, typed object for a given prompt and schema using a language model.
 
@@ -952,6 +1023,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
@@ -2113,4 +2216,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, 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, 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, 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, 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

@@ -1,10 +1,107 @@
-import { z } from 'zod';
-import { LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning } from '@ai-sdk/provider';
+import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning } from '@ai-sdk/provider';
 export { APICallError, EmptyResponseBodyError, InvalidArgumentError, InvalidDataContentError, InvalidPromptError, InvalidResponseDataError, InvalidToolArgumentsError, JSONParseError, LoadAPIKeyError, NoObjectGeneratedError, NoSuchToolError, RetryError, ToolCallParseError, TypeValidationError, UnsupportedFunctionalityError, UnsupportedJSONSchemaError } from '@ai-sdk/provider';
+import { z } from 'zod';
 import { ServerResponse } from 'node:http';
 import { AssistantStream } from 'openai/lib/AssistantStream';
 import { Run } from 'openai/resources/beta/threads/runs/runs';
 
+/**
+Embedding model that is used by the AI SDK Core functions.
+*/
+type EmbeddingModel<VALUE> = EmbeddingModelV1<VALUE>;
+/**
+Embedding.
+ */
+type Embedding = EmbeddingModelV1Embedding;
+
+/**
+Language model that is used by the AI SDK Core functions.
+*/
+type LanguageModel = LanguageModelV1;
+/**
+Reason why a language model finished generating a response.
+
+Can be one of the following:
+- `stop`: model generated stop sequence
+- `length`: model generated maximum number of tokens
+- `content-filter`: content filter violation stopped the model
+- `tool-calls`: model triggered tool calls
+- `error`: model stopped because of an error
+- `other`: model stopped for other reasons
+*/
+type FinishReason = LanguageModelV1FinishReason;
+/**
+Log probabilities for each token and its top log probabilities.
+ */
+type LogProbs = LanguageModelV1LogProbs;
+/**
+Warning from the model provider for this call. The call will proceed, but e.g.
+some settings might not be supported, which can lead to suboptimal results.
+*/
+type CallWarning = LanguageModelV1CallWarning;
+
+/**
+Embed a value using an embedding model. The type of the value is defined by the embedding model.
+
+@param model - The embedding model to use.
+@param value - The value 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 embedding, the value, and additional information.
+ */
+declare function embed<VALUE>({ model, value, maxRetries, abortSignal, }: {
+    /**
+  The embedding model to use.
+       */
+    model: EmbeddingModel<VALUE>;
+    /**
+  The value that should be embedded.
+     */
+    value: VALUE;
+    /**
+  Maximum number of retries per embedding model call. Set to 0 to disable retries.
+  
+  @default 2
+     */
+    maxRetries?: number;
+    /**
+  Abort signal.
+   */
+    abortSignal?: AbortSignal;
+}): Promise<EmbedResult<VALUE>>;
+/**
+The result of a `embed` call.
+It contains the embedding, the value, and additional information.
+ */
+declare class EmbedResult<VALUE> {
+    /**
+  The value that was embedded.
+     */
+    readonly value: VALUE;
+    /**
+  The embedding of the value.
+    */
+    readonly embedding: Embedding;
+    /**
+  Optional raw response data.
+     */
+    readonly rawResponse?: {
+        /**
+    Response headers.
+         */
+        headers?: Record<string, string>;
+    };
+    constructor(options: {
+        value: VALUE;
+        embedding: Embedding;
+        rawResponse?: {
+            headers?: Record<string, string>;
+        };
+    });
+}
+
 type TokenUsage = {
     promptTokens: number;
     completionTokens: number;
@@ -242,32 +339,6 @@ type Prompt = {
     messages?: Array<CoreMessage>;
 };
 
-/**
-Language model that is used by the AI SDK Core functions.
-*/
-type LanguageModel = LanguageModelV1;
-/**
-Reason why a language model finished generating a response.
-
-Can be one of the following:
-- `stop`: model generated stop sequence
-- `length`: model generated maximum number of tokens
-- `content-filter`: content filter violation stopped the model
-- `tool-calls`: model triggered tool calls
-- `error`: model stopped because of an error
-- `other`: model stopped for other reasons
-*/
-type FinishReason = LanguageModelV1FinishReason;
-/**
-Log probabilities for each token and its top log probabilities.
- */
-type LogProbs = LanguageModelV1LogProbs;
-/**
-Warning from the model provider for this call. The call will proceed, but e.g.
-some settings might not be supported, which can lead to suboptimal results.
-*/
-type CallWarning = LanguageModelV1CallWarning;
-
 /**
 Generate a structured, typed object for a given prompt and schema using a language model.
 
@@ -952,6 +1023,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
@@ -2113,4 +2216,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, 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, 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, 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, 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 };