ai 3.3.17 → 3.3.19

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { Schema, DeepPartial, Attachment, JSONValue as JSONValue$1, CreateMessage, FunctionCall as FunctionCall$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
+import { Schema, DeepPartial, ToolInvocation, Attachment, JSONValue as JSONValue$1, CreateMessage, FunctionCall as FunctionCall$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
 export { AssistantMessage, AssistantStatus, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DeepPartial, Function, FunctionCall, FunctionCallHandler, IdGenerator, JSONValue, Message, RequestOptions, Schema, StreamPart, Tool, ToolCall, ToolCallHandler, ToolChoice, ToolInvocation, UseAssistantOptions, formatStreamPart, jsonSchema, parseComplexResponse, parseStreamPart, readDataStream } from '@ai-sdk/ui-utils';
 import { AttributeValue } from '@opentelemetry/api';
-import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONValue, AISDKError } from '@ai-sdk/provider';
-export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LoadAPIKeyError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
+import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONValue, NoSuchModelError, AISDKError } from '@ai-sdk/provider';
+export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
 import { z } from 'zod';
 import { ServerResponse } from 'http';
 import { ServerResponse as ServerResponse$1 } from 'node:http';
@@ -115,6 +115,34 @@ type CoreToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | '
     toolName: keyof TOOLS;
 };
 
+/**
+ * Provider for language and text embedding models.
+ */
+type Provider = {
+    /**
+    Returns the language model with the given id.
+    The model id is then passed to the provider function to get the model.
+  
+    @param {string} id - The id of the model to return.
+  
+    @returns {LanguageModel} The language model associated with the id
+  
+    @throws {NoSuchModelError} If no such model exists.
+       */
+    languageModel(modelId: string): LanguageModel;
+    /**
+    Returns the text embedding model with the given id.
+    The model id is then passed to the provider function to get the model.
+  
+    @param {string} id - The id of the model to return.
+  
+    @returns {LanguageModel} The language model associated with the id
+  
+    @throws {NoSuchModelError} If no such model exists.
+       */
+    textEmbeddingModel(modelId: string): EmbeddingModel<string>;
+};
+
 /**
 Additional provider-specific metadata. They are passed through
 to the provider from the AI SDK and enable provider-specific
@@ -1025,6 +1053,18 @@ declare function tool<PARAMETERS extends Parameters, RESULT>(tool: CoreTool<PARA
  */
 type ExperimentalTool = CoreTool;
 
+type ConvertibleMessage = {
+    role: 'system' | 'user' | 'assistant' | 'function' | 'data' | 'tool';
+    content: string;
+    toolInvocations?: ToolInvocation[];
+    experimental_attachments?: Attachment[];
+};
+/**
+Converts an array of messages from useChat into an array of CoreMessages that can be used
+with the AI core functions (e.g. `streamText`).
+ */
+declare function convertToCoreMessages(messages: Array<ConvertibleMessage>): CoreMessage[];
+
 /**
 Create a union of the given object's values, and optionally specify which keys to get the values from.
 
@@ -1067,28 +1107,16 @@ onlyBar('bar');
 */
 type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
 
-/**
-Typed tool result that is returned by generateText and streamText.
-It contains the tool call ID, the tool name, the tool arguments, and the tool result.
- */
-interface ToolResult<NAME extends string, ARGS, RESULT> {
-    /**
-  ID of the tool call. This ID is used to match the tool call with the tool result.
-   */
-    toolCallId: string;
-    /**
-  Name of the tool that was called.
-   */
-    toolName: NAME;
-    /**
-  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
-     */
-    args: ARGS;
-    /**
-  Result of the tool call. This is the result of the tool's execution.
-     */
-    result: RESULT;
-}
+type ToToolCall<TOOLS extends Record<string, CoreTool>> = ValueOf<{
+    [NAME in keyof TOOLS]: {
+        type: 'tool-call';
+        toolCallId: string;
+        toolName: NAME & string;
+        args: inferParameters<TOOLS[NAME]['parameters']>;
+    };
+}>;
+type ToToolCallArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolCall<TOOLS>>;
+
 type ToToolsWithExecute<TOOLS extends Record<string, CoreTool>> = {
     [K in keyof TOOLS as TOOLS[K] extends {
         execute: any;
@@ -1109,27 +1137,6 @@ type ToToolResultObject<TOOLS extends Record<string, CoreTool>> = ValueOf<{
 type ToToolResult<TOOLS extends Record<string, CoreTool>> = ToToolResultObject<ToToolsWithDefinedExecute<ToToolsWithExecute<TOOLS>>>;
 type ToToolResultArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolResult<TOOLS>>;
 
-/**
-Converts an array of messages from useChat into an array of CoreMessages that can be used
-with the AI core functions (e.g. `streamText`).
- */
-declare function convertToCoreMessages(messages: Array<{
-    role: 'user' | 'assistant' | 'system';
-    content: string;
-    toolInvocations?: Array<ToolResult<string, unknown, unknown>>;
-    experimental_attachments?: Attachment[];
-}>): CoreMessage[];
-
-type ToToolCall<TOOLS extends Record<string, CoreTool>> = ValueOf<{
-    [NAME in keyof TOOLS]: {
-        type: 'tool-call';
-        toolCallId: string;
-        toolName: NAME & string;
-        args: inferParameters<TOOLS[NAME]['parameters']>;
-    };
-}>;
-type ToToolCallArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolCall<TOOLS>>;
-
 /**
 The result of a `generateText` call.
 It contains the generated text, the tool calls that were made during the generation, and the results of the tool calls.
@@ -1616,64 +1623,31 @@ Callback that is called when the LLM response and all request tool executions
  */
 declare const experimental_streamText: typeof streamText;
 
-declare const symbol$a: unique symbol;
-declare class InvalidModelIdError extends AISDKError {
-    private readonly [symbol$a];
-    readonly id: string;
-    constructor({ id, message, }: {
-        id: string;
-        message?: string;
-    });
-    static isInstance(error: unknown): error is InvalidModelIdError;
-    /**
-     * @deprecated use `isInstance` instead
-     */
-    static isInvalidModelIdError(error: unknown): error is InvalidModelIdError;
-    /**
-     * @deprecated Do not use this method. It will be removed in the next major version.
-     */
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        id: string;
-    };
-}
+/**
+ * Creates a custom provider with specified language models, text embedding models, and an optional fallback provider.
+ *
+ * @param {Object} options - The options for creating the custom provider.
+ * @param {Record<string, LanguageModelV1>} [options.languageModels] - A record of language models, where keys are model IDs and values are LanguageModelV1 instances.
+ * @param {Record<string, EmbeddingModelV1<string>>} [options.textEmbeddingModels] - A record of text embedding models, where keys are model IDs and values are EmbeddingModelV1<string> instances.
+ * @param {Provider} [options.fallbackProvider] - An optional fallback provider to use when a requested model is not found in the custom provider.
+ * @returns {Provider} A Provider object with languageModel and textEmbeddingModel methods.
+ *
+ * @throws {NoSuchModelError} Throws when a requested model is not found and no fallback provider is available.
+ */
+declare function experimental_customProvider({ languageModels, textEmbeddingModels, fallbackProvider, }: {
+    languageModels?: Record<string, LanguageModelV1>;
+    textEmbeddingModels?: Record<string, EmbeddingModelV1<string>>;
+    fallbackProvider?: Provider;
+}): Provider;
 
 declare const symbol$9: unique symbol;
-type ModelType = 'languageModel' | 'textEmbeddingModel';
-declare class NoSuchModelError extends AISDKError {
+declare class NoSuchProviderError extends NoSuchModelError {
     private readonly [symbol$9];
-    readonly modelId: string;
-    readonly modelType: ModelType;
-    constructor({ modelId, modelType, message, }: {
-        modelId: string;
-        modelType: ModelType;
-        message?: string;
-    });
-    static isInstance(error: unknown): error is NoSuchModelError;
-    /**
-     * @deprecated use `isInstance` instead
-     */
-    static isNoSuchModelError(error: unknown): error is NoSuchModelError;
-    /**
-     * @deprecated Do not use this method. It will be removed in the next major version.
-     */
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        modelId: string;
-        modelType: ModelType;
-    };
-}
-
-declare const symbol$8: unique symbol;
-declare class NoSuchProviderError extends AISDKError {
-    private readonly [symbol$8];
     readonly providerId: string;
     readonly availableProviders: string[];
-    constructor({ providerId, availableProviders, message, }: {
+    constructor({ modelId, modelType, providerId, availableProviders, message, }: {
+        modelId: string;
+        modelType: 'languageModel' | 'textEmbeddingModel';
         providerId: string;
         availableProviders: string[];
         message?: string;
@@ -1690,6 +1664,8 @@ declare class NoSuchProviderError extends AISDKError {
         name: string;
         message: string;
         stack: string | undefined;
+        modelId: string;
+        modelType: "languageModel" | "textEmbeddingModel";
         providerId: string;
         availableProviders: string[];
     };
@@ -1697,6 +1673,8 @@ declare class NoSuchProviderError extends AISDKError {
 
 /**
  * Provides for language and text embedding models.
+ *
+ * @deprecated Use `ProviderV1` instead.
  */
 interface experimental_Provider {
     /**
@@ -1741,33 +1719,10 @@ interface experimental_Provider {
 
 /**
 Registry for managing models. It enables getting a model with a string id.
+
+@deprecated Use `experimental_Provider` instead.
  */
-type experimental_ProviderRegistry = {
-    /**
-  Returns the language model with the given id in the format `providerId:modelId`.
-  The model id is then passed to the provider function to get the model.
-  
-  @param {string} id - The id of the model to return.
-  
-  @throws {NoSuchModelError} If no model with the given id exists.
-  @throws {NoSuchProviderError} If no provider with the given id exists.
-  
-  @returns {LanguageModel} The language model associated with the id.
-     */
-    languageModel(id: string): LanguageModel;
-    /**
-  Returns the text embedding model with the given id in the format `providerId:modelId`.
-  The model id is then passed to the provider function to get the model.
-  
-  @param {string} id - The id of the model to return.
-  
-  @throws {NoSuchModelError} If no model with the given id exists.
-  @throws {NoSuchProviderError} If no provider with the given id exists.
-  
-  @returns {LanguageModel} The language model associated with the id.
-     */
-    textEmbeddingModel(id: string): EmbeddingModel<string>;
-};
+type experimental_ProviderRegistry = Provider;
 /**
  * @deprecated Use `experimental_ProviderRegistry` instead.
  */
@@ -1775,7 +1730,7 @@ type experimental_ModelRegistry = experimental_ProviderRegistry;
 /**
  * Creates a registry for the given providers.
  */
-declare function experimental_createProviderRegistry(providers: Record<string, experimental_Provider>): experimental_ProviderRegistry;
+declare function experimental_createProviderRegistry(providers: Record<string, experimental_Provider | Provider>): Provider;
 /**
  * @deprecated Use `experimental_createProviderRegistry` instead.
  */
@@ -1793,9 +1748,9 @@ declare const experimental_createModelRegistry: typeof experimental_createProvid
  */
 declare function cosineSimilarity(vector1: number[], vector2: number[]): number;
 
-declare const symbol$7: unique symbol;
+declare const symbol$8: unique symbol;
 declare class InvalidArgumentError extends AISDKError {
-    private readonly [symbol$7];
+    private readonly [symbol$8];
     readonly parameter: string;
     readonly value: unknown;
     constructor({ parameter, value, message, }: {
@@ -1817,9 +1772,9 @@ declare class InvalidArgumentError extends AISDKError {
     };
 }
 
-declare const symbol$6: unique symbol;
+declare const symbol$7: unique symbol;
 declare class InvalidToolArgumentsError extends AISDKError {
-    private readonly [symbol$6];
+    private readonly [symbol$7];
     readonly toolName: string;
     readonly toolArgs: string;
     constructor({ toolArgs, toolName, cause, message, }: {
@@ -1846,9 +1801,9 @@ declare class InvalidToolArgumentsError extends AISDKError {
     };
 }
 
-declare const symbol$5: unique symbol;
+declare const symbol$6: unique symbol;
 declare class NoSuchToolError extends AISDKError {
-    private readonly [symbol$5];
+    private readonly [symbol$6];
     readonly toolName: string;
     readonly availableTools: string[] | undefined;
     constructor({ toolName, availableTools, message, }: {
@@ -1873,12 +1828,12 @@ declare class NoSuchToolError extends AISDKError {
     };
 }
 
-declare const symbol$4: unique symbol;
+declare const symbol$5: unique symbol;
 /**
 Thrown when the AI provider fails to generate a parsable object.
  */
 declare class NoObjectGeneratedError extends AISDKError {
-    private readonly [symbol$4];
+    private readonly [symbol$5];
     constructor({ message }?: {
         message?: string;
     });
@@ -1898,9 +1853,9 @@ declare class NoObjectGeneratedError extends AISDKError {
     };
 }
 
-declare const symbol$3: unique symbol;
+declare const symbol$4: unique symbol;
 declare class InvalidDataContentError extends AISDKError {
-    private readonly [symbol$3];
+    private readonly [symbol$4];
     readonly content: unknown;
     constructor({ content, cause, message, }: {
         content: unknown;
@@ -1924,9 +1879,9 @@ declare class InvalidDataContentError extends AISDKError {
     };
 }
 
-declare const symbol$2: unique symbol;
+declare const symbol$3: unique symbol;
 declare class InvalidMessageRoleError extends AISDKError {
-    private readonly [symbol$2];
+    private readonly [symbol$3];
     readonly role: string;
     constructor({ role, message, }: {
         role: string;
@@ -1948,6 +1903,17 @@ declare class InvalidMessageRoleError extends AISDKError {
     };
 }
 
+declare const symbol$2: unique symbol;
+declare class MessageConversionError extends AISDKError {
+    private readonly [symbol$2];
+    readonly originalMessage: ConvertibleMessage;
+    constructor({ originalMessage, message, }: {
+        originalMessage: ConvertibleMessage;
+        message: string;
+    });
+    static isInstance(error: unknown): error is MessageConversionError;
+}
+
 declare const symbol$1: unique symbol;
 declare class DownloadError extends AISDKError {
     private readonly [symbol$1];
@@ -2769,4 +2735,4 @@ declare const generateId: (size?: number) => string;
  */
 declare const nanoid: (size?: number) => string;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantResponse, CallWarning, CohereStream, CompletionTokenUsage, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolChoice, CoreToolMessage, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingTokenUsage, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidModelIdError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, MistralStream, ModelType, NoObjectGeneratedError, NoSuchModelError, NoSuchProviderError, NoSuchToolError, ObjectStreamInputPart, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, ProviderMetadata, ReplicateStream, RetryError, StreamData, StreamObjectResult, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolCallPayload, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createCallbacksTransformer, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantResponse, CallWarning, CohereStream, CompletionTokenUsage, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolChoice, CoreToolMessage, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingTokenUsage, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, MessageConversionError, MistralStream, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamInputPart, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, Provider, ProviderMetadata, ReplicateStream, RetryError, StreamData, StreamObjectResult, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolCallPayload, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createCallbacksTransformer, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_customProvider, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };