ai 5.0.0-canary.7 → 5.0.0-canary.8

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { ToolCall, ToolResult, FetchFunction, Validator, IDGenerator } from '@ai-sdk/provider-utils';
 export { CoreToolCall, CoreToolResult, IDGenerator, ToolCall, ToolResult, createIdGenerator, generateId } from '@ai-sdk/provider-utils';
-import { EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2LogProbs, LanguageModelV2CallWarning, LanguageModelV2Source, LanguageModelV2ProviderMetadata, JSONValue as JSONValue$1, JSONObject, LanguageModelV2CallOptions, AISDKError, LanguageModelV2FunctionToolCall, JSONSchema7 as JSONSchema7$1, JSONParseError, TypeValidationError, TranscriptionModelV1CallWarning, TranscriptionModelV1, LanguageModelV2ProviderOptions, LanguageModelV2Middleware, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
-export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Prompt, LanguageModelV2StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
+import { EmbeddingModelV2, EmbeddingModelV2Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2LogProbs, LanguageModelV2CallWarning, LanguageModelV2Source, SharedV2ProviderMetadata, SharedV2ProviderOptions, JSONValue as JSONValue$1, JSONObject, LanguageModelV2CallOptions, AISDKError, LanguageModelV2ToolCall, JSONSchema7 as JSONSchema7$1, JSONParseError, TypeValidationError, TranscriptionModelV1CallWarning, TranscriptionModelV1, LanguageModelV2Middleware, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
+export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
 import { ServerResponse } from 'node:http';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
 import { z } from 'zod';
@@ -11,11 +11,11 @@ import { ServerResponse as ServerResponse$1 } from 'http';
 /**
 Embedding model that is used by the AI SDK Core functions.
 */
-type EmbeddingModel<VALUE> = EmbeddingModelV1<VALUE>;
+type EmbeddingModel<VALUE> = EmbeddingModelV2<VALUE>;
 /**
 Embedding.
  */
-type Embedding = EmbeddingModelV1Embedding;
+type Embedding = EmbeddingModelV2Embedding;
 
 /**
 Image model that is used by the AI SDK Core functions.
@@ -85,10 +85,6 @@ type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'requ
     type: 'tool';
     toolName: Extract<keyof TOOLS, string>;
 };
-/**
- * @deprecated Use `ToolChoice` instead.
- */
-type CoreToolChoice<TOOLS extends Record<string, unknown>> = ToolChoice<TOOLS>;
 
 type LanguageModelRequestMetadata = {
     /**
@@ -159,14 +155,14 @@ Additional provider-specific metadata that is returned from the provider.
 This is needed to enable provider-specific functionality that can be
 fully encapsulated in the provider.
  */
-type ProviderMetadata = LanguageModelV2ProviderMetadata;
+type ProviderMetadata = SharedV2ProviderMetadata;
 /**
 Additional provider-specific options.
 
 They are passed through to the provider from the AI SDK and enable
 provider-specific functionality that can be fully encapsulated in the provider.
  */
-type ProviderOptions = LanguageModelV2ProviderMetadata;
+type ProviderOptions = SharedV2ProviderOptions;
 
 /**
 Represents the number of tokens used in a prompt and completion.
@@ -1010,13 +1006,17 @@ interface EmbedResult<VALUE> {
       */
     readonly usage: EmbeddingModelUsage;
     /**
-    Optional raw response data.
+    Optional response data.
        */
-    readonly rawResponse?: {
+    readonly response?: {
         /**
       Response headers.
            */
         headers?: Record<string, string>;
+        /**
+        The response body.
+        */
+        body?: unknown;
     };
 }
 
@@ -1032,7 +1032,7 @@ Embed a value using an embedding model. The type of the value is defined by the
 
 @returns A result object that contains the embedding, the value, and additional information.
  */
-declare function embed<VALUE>({ model, value, maxRetries: maxRetriesArg, abortSignal, headers, experimental_telemetry: telemetry, }: {
+declare function embed<VALUE>({ model, value, providerOptions, maxRetries: maxRetriesArg, abortSignal, headers, experimental_telemetry: telemetry, }: {
     /**
   The embedding model to use.
        */
@@ -1056,6 +1056,12 @@ declare function embed<VALUE>({ model, value, maxRetries: maxRetriesArg, abortSi
   Only applicable for HTTP-based providers.
    */
     headers?: Record<string, string>;
+    /**
+    Additional provider-specific options. They are passed through
+    to the provider from the AI SDK and enable provider-specific
+    functionality that can be fully encapsulated in the provider.
+    */
+    providerOptions?: ProviderOptions;
     /**
      * Optional telemetry configuration (experimental).
      */
@@ -1079,6 +1085,19 @@ interface EmbedManyResult<VALUE> {
     The embedding token usage.
       */
     readonly usage: EmbeddingModelUsage;
+    /**
+    Optional raw response data.
+       */
+    readonly responses?: Array<{
+        /**
+  Response headers.
+       */
+        headers?: Record<string, string>;
+        /**
+    The response body.
+    */
+        body?: unknown;
+    } | undefined>;
 }
 
 /**
@@ -1097,7 +1116,7 @@ has a limit on how many embeddings can be generated in a single call.
 
 @returns A result object that contains the embeddings, the value, and additional information.
  */
-declare function embedMany<VALUE>({ model, values, maxRetries: maxRetriesArg, abortSignal, headers, experimental_telemetry: telemetry, }: {
+declare function embedMany<VALUE>({ model, values, maxRetries: maxRetriesArg, abortSignal, headers, providerOptions, experimental_telemetry: telemetry, }: {
     /**
   The embedding model to use.
        */
@@ -1125,6 +1144,12 @@ declare function embedMany<VALUE>({ model, values, maxRetries: maxRetriesArg, ab
      * Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
+    /**
+    Additional provider-specific options. They are passed through
+    to the provider from the AI SDK and enable provider-specific
+    functionality that can be fully encapsulated in the provider.
+    */
+    providerOptions?: ProviderOptions;
 }): Promise<EmbedManyResult<VALUE>>;
 
 type CallSettings = {
@@ -1839,26 +1864,22 @@ Optional conversion function that maps the tool result to multi-part tool conten
 }> & ({
     /**
 Function tool.
-   */
+ */
     type?: undefined | 'function';
 } | {
     /**
 Provider-defined tool.
-   */
+ */
     type: 'provider-defined';
     /**
 The ID of the tool. Should follow the format `<provider-name>.<tool-name>`.
-   */
+ */
     id: `${string}.${string}`;
     /**
 The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
-   */
+ */
     args: Record<string, unknown>;
 });
-/**
- * @deprecated Use `Tool` instead.
- */
-type CoreTool<PARAMETERS extends ToolParameters = any, RESULT = any> = Tool<PARAMETERS, RESULT>;
 /**
 Helper function for inferring the execute args of a tool.
  */
@@ -2693,10 +2714,6 @@ type ToolCallUnion<TOOLS extends ToolSet> = ValueOf<{
         args: TOOLS[NAME] extends Tool<infer PARAMETERS> ? PARAMETERS : never;
     };
 }>;
-/**
- * @deprecated Use `ToolCallUnion` instead.
- */
-type CoreToolCallUnion<TOOLS extends ToolSet> = ToolCallUnion<ToolSet>;
 type ToolCallArray<TOOLS extends ToolSet> = Array<ToolCallUnion<TOOLS>>;
 
 type ToToolsWithDefinedExecute<TOOLS extends ToolSet> = {
@@ -2712,10 +2729,6 @@ type ToToolResultObject<TOOLS extends ToolSet> = ValueOf<{
     };
 }>;
 type ToolResultUnion<TOOLS extends ToolSet> = ToToolResultObject<ToToolsWithDefinedExecute<TOOLS>>;
-/**
- * @deprecated Use `ToolResultUnion` instead.
- */
-type CoreToolResultUnion<TOOLS extends ToolSet> = ToolResultUnion<TOOLS>;
 type ToolResultArray<TOOLS extends ToolSet> = Array<ToolResultUnion<TOOLS>>;
 
 /**
@@ -3021,13 +3034,13 @@ declare function convertToCoreMessages<TOOLS extends ToolSet = never>(messages:
 type ToolCallRepairFunction<TOOLS extends ToolSet> = (options: {
     system: string | undefined;
     messages: CoreMessage[];
-    toolCall: LanguageModelV2FunctionToolCall;
+    toolCall: LanguageModelV2ToolCall;
     tools: TOOLS;
     parameterSchema: (options: {
         toolName: string;
     }) => JSONSchema7$1;
     error: NoSuchToolError | InvalidToolArgumentsError;
-}) => Promise<LanguageModelV2FunctionToolCall | null>;
+}) => Promise<LanguageModelV2ToolCall | null>;
 
 /**
 Callback that is set using the `onStepFinish` option.
@@ -3401,23 +3414,26 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
     toTextStreamResponse(init?: ResponseInit): Response;
 }
 type TextStreamPart<TOOLS extends ToolSet> = {
-    type: 'text-delta';
-    textDelta: string;
+    type: 'text';
+    text: string;
 } | {
     type: 'reasoning';
-    textDelta: string;
+    reasoningType: 'text';
+    text: string;
 } | {
-    type: 'reasoning-signature';
+    type: 'reasoning';
+    reasoningType: 'signature';
     signature: string;
 } | {
-    type: 'redacted-reasoning';
+    type: 'reasoning';
+    reasoningType: 'redacted';
     data: string;
-} | {
-    type: 'source';
-    source: Source;
 } | ({
+    type: 'source';
+} & Source) | {
     type: 'file';
-} & GeneratedFile) | ({
+    file: GeneratedFile;
+} | ({
     type: 'tool-call';
 } & ToolCallUnion<TOOLS>) | {
     type: 'tool-call-streaming-start';
@@ -3524,7 +3540,7 @@ Callback that is set using the `onChunk` option.
  */
 type StreamTextOnChunkCallback<TOOLS extends ToolSet> = (event: {
     chunk: Extract<TextStreamPart<TOOLS>, {
-        type: 'text-delta' | 'reasoning' | 'source' | 'tool-call' | 'tool-call-streaming-start' | 'tool-call-delta' | 'tool-result';
+        type: 'text' | 'reasoning' | 'source' | 'tool-call' | 'tool-call-streaming-start' | 'tool-call-delta' | 'tool-result';
     }>;
 }) => Promise<void> | void;
 /**
@@ -4377,7 +4393,7 @@ declare function transcribe({ model, audio, providerOptions, maxRetries: maxRetr
  */
 declare function defaultSettingsMiddleware({ settings, }: {
     settings: Partial<LanguageModelV2CallOptions & {
-        providerOptions?: LanguageModelV2ProviderOptions;
+        providerOptions?: SharedV2ProviderOptions;
     }>;
 }): LanguageModelV2Middleware;
 
@@ -4497,21 +4513,13 @@ declare const experimental_createProviderRegistry: typeof createProviderRegistry
  *
  * @param vector1 - The first vector.
  * @param vector2 - The second vector.
- * @param options - Optional configuration.
- * @param options.throwErrorForEmptyVectors - If true, throws an error for empty vectors. Default: false.
  *
  * @returns The cosine similarity between vector1 and vector2.
  * @returns 0 if either vector is the zero vector.
  *
- * @throws {InvalidArgumentError} If throwErrorForEmptyVectors is true and vectors are empty.
  * @throws {InvalidArgumentError} If the vectors do not have the same length.
  */
-declare function cosineSimilarity(vector1: number[], vector2: number[], options?: {
-    /**
-     * @deprecated will be removed in 5.0
-     */
-    throwErrorForEmptyVectors?: boolean;
-}): number;
+declare function cosineSimilarity(vector1: number[], vector2: number[]): number;
 
 /**
  * Creates a ReadableStream that emits the provided values with an optional delay between each value.
@@ -4545,23 +4553,26 @@ declare class InvalidArgumentError extends AISDKError {
 }
 
 type SingleRequestTextStreamPart<TOOLS extends ToolSet> = {
-    type: 'text-delta';
-    textDelta: string;
+    type: 'text';
+    text: string;
 } | {
     type: 'reasoning';
-    textDelta: string;
+    reasoningType: 'text';
+    text: string;
 } | {
-    type: 'reasoning-signature';
+    type: 'reasoning';
+    reasoningType: 'signature';
     signature: string;
 } | {
-    type: 'redacted-reasoning';
+    type: 'reasoning';
+    reasoningType: 'redacted';
     data: string;
-} | ({
+} | {
     type: 'file';
-} & GeneratedFile) | {
-    type: 'source';
-    source: Source;
+    file: GeneratedFile;
 } | ({
+    type: 'source';
+} & Source) | ({
     type: 'tool-call';
 } & ToolCallUnion<TOOLS>) | {
     type: 'tool-call-streaming-start';
@@ -4878,4 +4889,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, Attachment, CallSettings, CallWarning, ChatRequest, ChatRequestOptions, ChunkDetector, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, CreateMessage, DataContent, DataStreamOptions, DataStreamPart, DataStreamString, DataStreamWriter, DeepPartial, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, TranscriptionResult as Experimental_TranscriptionResult, FilePart, FileUIPart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedFile, IdGenerator, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, JSONValue, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage$1 as LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MCPClientError, MCPTransport, Message, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Prompt, Provider, ProviderMetadata, ProviderOptions, ProviderRegistryProvider, ReasoningUIPart, RepairTextFunction, RequestOptions, RetryError, Schema, SourceUIPart, StepResult, StepStartUIPart, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, TextUIPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolInvocation, ToolInvocationUIPart, ToolResultPart, ToolResultUnion, ToolSet, UIMessage, UseChatOptions, UseCompletionOptions, UserContent, appendClientMessage, appendResponseMessages, asSchema, callChatApi, callCompletionApi, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, createProviderRegistry, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, transcribe as experimental_transcribe, experimental_wrapLanguageModel, extractMaxToolInvocationStep, extractReasoningMiddleware, fillMessageParts, formatDataStreamPart, generateObject, generateText, getMessageParts, getTextFromDataUrl, isAssistantMessageWithCompletedToolCalls, isDeepEqualData, jsonSchema, parseDataStreamPart, parsePartialJson, pipeDataStreamToResponse, prepareAttachmentsForRequest, processDataStream, processTextStream, shouldResubmitMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, tool, updateToolCallResult, wrapLanguageModel, zodSchema };
+export { AssistantContent, Attachment, CallSettings, CallWarning, ChatRequest, ChatRequestOptions, ChunkDetector, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataStreamOptions, DataStreamPart, DataStreamString, DataStreamWriter, DeepPartial, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, TranscriptionResult as Experimental_TranscriptionResult, FilePart, FileUIPart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedFile, IdGenerator, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, JSONValue, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage$1 as LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MCPClientError, MCPTransport, Message, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Prompt, Provider, ProviderMetadata, ProviderOptions, ProviderRegistryProvider, ReasoningUIPart, RepairTextFunction, RequestOptions, RetryError, Schema, SourceUIPart, StepResult, StepStartUIPart, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, TextUIPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolInvocation, ToolInvocationUIPart, ToolResultPart, ToolResultUnion, ToolSet, UIMessage, UseChatOptions, UseCompletionOptions, UserContent, appendClientMessage, appendResponseMessages, asSchema, callChatApi, callCompletionApi, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, createProviderRegistry, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, transcribe as experimental_transcribe, experimental_wrapLanguageModel, extractMaxToolInvocationStep, extractReasoningMiddleware, fillMessageParts, formatDataStreamPart, generateObject, generateText, getMessageParts, getTextFromDataUrl, isAssistantMessageWithCompletedToolCalls, isDeepEqualData, jsonSchema, parseDataStreamPart, parsePartialJson, pipeDataStreamToResponse, prepareAttachmentsForRequest, processDataStream, processTextStream, shouldResubmitMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, tool, updateToolCallResult, wrapLanguageModel, zodSchema };