ai 4.1.44 → 4.1.46

package/dist/index.d.ts

@@ -2,13 +2,61 @@ import { IDGenerator } from '@ai-sdk/provider-utils';
 export { CoreToolCall, CoreToolResult, IDGenerator, ToolCall, ToolResult, createIdGenerator, generateId } from '@ai-sdk/provider-utils';
 import { DataStreamString, Message, Schema, DeepPartial, JSONValue as JSONValue$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
 export { AssistantMessage, AssistantStatus, Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DataStreamPart, DeepPartial, IdGenerator, JSONValue, Message, RequestOptions, Schema, ToolInvocation, UIMessage, UseAssistantOptions, formatAssistantStreamPart, formatDataStreamPart, jsonSchema, parseAssistantStreamPart, parseDataStreamPart, processDataStream, processTextStream, zodSchema } from '@ai-sdk/ui-utils';
-import { JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1Source, LanguageModelV1ProviderMetadata, JSONParseError, TypeValidationError, LanguageModelV1CallOptions, AISDKError, LanguageModelV1FunctionToolCall, JSONSchema7, ProviderV1, NoSuchModelError } from '@ai-sdk/provider';
+import { LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1Source, JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV1ProviderMetadata, JSONParseError, TypeValidationError, LanguageModelV1CallOptions, AISDKError, LanguageModelV1FunctionToolCall, JSONSchema7, ProviderV1, NoSuchModelError } from '@ai-sdk/provider';
 export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV1, LanguageModelV1CallOptions, LanguageModelV1Prompt, LanguageModelV1StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
 import { ServerResponse } from 'node:http';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
 import { z } from 'zod';
 import { ServerResponse as ServerResponse$1 } from 'http';
 
+/**
+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.
+
+@deprecated Will become a provider extension in the future.
+ */
+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;
+/**
+A source that has been used as input to generate the response.
+*/
+type Source = LanguageModelV1Source;
+/**
+Tool choice for the generation. It supports the following settings:
+
+- `auto` (default): the model can choose whether and which tools to call.
+- `required`: the model must call a tool. It can choose which tool to call.
+- `none`: the model must not call tools
+- `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool
+ */
+type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
+    type: 'tool';
+    toolName: keyof TOOLS;
+};
+/**
+ * @deprecated Use `ToolChoice` instead.
+ */
+type CoreToolChoice<TOOLS extends Record<string, unknown>> = ToolChoice<TOOLS>;
+
 interface DataStreamWriter {
     /**
      * Appends a data part to the stream.
@@ -22,6 +70,10 @@ interface DataStreamWriter {
      * Appends a message annotation to the stream.
      */
     writeMessageAnnotation(value: JSONValue): void;
+    /**
+     * Appends a source part to the stream.
+     */
+    writeSource(source: Source): void;
     /**
      * Merges the contents of another stream to this stream.
      */
@@ -119,54 +171,6 @@ type ImageModelResponseMetadata = {
     headers?: Record<string, string>;
 };
 
-/**
-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.
-
-@deprecated Will become a provider extension in the future.
- */
-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;
-/**
-A source that has been used as input to generate the response.
-*/
-type Source = LanguageModelV1Source;
-/**
-Tool choice for the generation. It supports the following settings:
-
-- `auto` (default): the model can choose whether and which tools to call.
-- `required`: the model must call a tool. It can choose which tool to call.
-- `none`: the model must not call tools
-- `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool
- */
-type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
-    type: 'tool';
-    toolName: keyof TOOLS;
-};
-/**
- * @deprecated Use `ToolChoice` instead.
- */
-type CoreToolChoice<TOOLS extends Record<string, unknown>> = ToolChoice<TOOLS>;
-
 type LanguageModelRequestMetadata = {
     /**
     Raw request HTTP body that was sent to the provider API as a string (JSON should be stringified).
@@ -682,6 +686,50 @@ interface FilePart {
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
+/**
+ * Reasoning content part of a prompt. It contains a reasoning.
+ */
+interface ReasoningPart {
+    type: 'reasoning';
+    /**
+  The reasoning text.
+     */
+    text: string;
+    /**
+  An optional signature for verifying that the reasoning originated from the model.
+     */
+    signature?: string;
+    /**
+  Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
+   */
+    experimental_providerMetadata?: ProviderMetadata;
+}
+/**
+Redacted reasoning content part of a prompt.
+ */
+interface RedactedReasoningPart {
+    type: 'redacted-reasoning';
+    /**
+  Redacted reasoning data.
+     */
+    data: string;
+    /**
+  Additional provider-specific metadata. 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;
+    /**
+  @deprecated Use `providerOptions` instead.
+   */
+    experimental_providerMetadata?: ProviderMetadata;
+}
 /**
 Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
  */
@@ -812,7 +860,7 @@ declare const coreAssistantMessageSchema: z.ZodType<CoreAssistantMessage>;
 /**
 Content of an assistant message. It can be a string or an array of text and tool call parts.
  */
-type AssistantContent = string | Array<TextPart | ToolCallPart>;
+type AssistantContent = string | Array<TextPart | ReasoningPart | RedactedReasoningPart | ToolCallPart>;
 /**
 A tool message. It contains the result of one or more tool calls.
  */
@@ -1525,6 +1573,15 @@ declare function appendClientMessage({ messages, message, }: {
     message: Message;
 }): Message[];
 
+type ReasoningDetail = {
+    type: 'text';
+    text: string;
+    signature?: string;
+} | {
+    type: 'redacted';
+    data: string;
+};
+
 type Parameters = z.ZodTypeAny | Schema<any>;
 type inferParameters<PARAMETERS extends Parameters> = PARAMETERS extends Schema<any> ? PARAMETERS['_type'] : PARAMETERS extends z.ZodTypeAny ? z.infer<PARAMETERS> : never;
 interface ToolExecutionOptions {
@@ -1714,6 +1771,7 @@ type StepResult<TOOLS extends ToolSet> = {
   The reasoning that was generated during the generation.
   */
     readonly reasoning: string | undefined;
+    readonly reasoningDetails: Array<ReasoningDetail>;
     /**
   The sources that were used to generate the text.
   */
@@ -1821,6 +1879,10 @@ interface GenerateTextResult<TOOLS extends ToolSet, OUTPUT> {
      */
     readonly reasoning: string | undefined;
     /**
+  The full reasoning that the model has generated.
+     */
+    readonly reasoningDetails: Array<ReasoningDetail>;
+    /**
   Sources that have been used as input to generate the response.
   For multi-step generation, the sources are accumulated from all steps.
      */
@@ -1929,9 +1991,9 @@ declare namespace output {
   };
 }
 
-declare const symbol$d: unique symbol;
+declare const symbol$e: unique symbol;
 declare class InvalidToolArgumentsError extends AISDKError {
-    private readonly [symbol$d];
+    private readonly [symbol$e];
     readonly toolName: string;
     readonly toolArgs: string;
     constructor({ toolArgs, toolName, cause, message, }: {
@@ -1943,9 +2005,9 @@ declare class InvalidToolArgumentsError extends AISDKError {
     static isInstance(error: unknown): error is InvalidToolArgumentsError;
 }
 
-declare const symbol$c: unique symbol;
+declare const symbol$d: unique symbol;
 declare class NoSuchToolError extends AISDKError {
-    private readonly [symbol$c];
+    private readonly [symbol$d];
     readonly toolName: string;
     readonly availableTools: string[] | undefined;
     constructor({ toolName, availableTools, message, }: {
@@ -2189,6 +2251,12 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
        */
     readonly reasoning: Promise<string | undefined>;
     /**
+  The full reasoning that the model has generated.
+  
+  Resolved when the response is finished.
+     */
+    readonly reasoningDetails: Promise<Array<ReasoningDetail>>;
+    /**
   The tool calls that have been executed in the last step.
   
   Resolved when the response is finished.
@@ -2327,6 +2395,12 @@ type TextStreamPart<TOOLS extends ToolSet> = {
 } | {
     type: 'reasoning';
     textDelta: string;
+} | {
+    type: 'reasoning-signature';
+    signature: string;
+} | {
+    type: 'redacted-reasoning';
+    data: string;
 } | {
     type: 'source';
     source: Source;
@@ -2729,9 +2803,9 @@ declare function customProvider<LANGUAGE_MODELS extends Record<string, LanguageM
 declare const experimental_customProvider: typeof customProvider;
 type ExtractModelId<MODELS extends Record<string, unknown>> = Extract<keyof MODELS, string>;
 
-declare const symbol$b: unique symbol;
+declare const symbol$c: unique symbol;
 declare class NoSuchProviderError extends NoSuchModelError {
-    private readonly [symbol$b];
+    private readonly [symbol$c];
     readonly providerId: string;
     readonly availableProviders: string[];
     constructor({ modelId, modelType, providerId, availableProviders, message, }: {
@@ -2785,9 +2859,9 @@ declare function simulateReadableStream<T>({ chunks, initialDelayInMs, chunkDela
     };
 }): ReadableStream<T>;
 
-declare const symbol$a: unique symbol;
+declare const symbol$b: unique symbol;
 declare class InvalidArgumentError extends AISDKError {
-    private readonly [symbol$a];
+    private readonly [symbol$b];
     readonly parameter: string;
     readonly value: unknown;
     constructor({ parameter, value, message, }: {
@@ -2798,6 +2872,61 @@ declare class InvalidArgumentError extends AISDKError {
     static isInstance(error: unknown): error is InvalidArgumentError;
 }
 
+type SingleRequestTextStreamPart<TOOLS extends ToolSet> = {
+    type: 'text-delta';
+    textDelta: string;
+} | {
+    type: 'reasoning';
+    textDelta: string;
+} | {
+    type: 'reasoning-signature';
+    signature: string;
+} | {
+    type: 'redacted-reasoning';
+    data: string;
+} | {
+    type: 'source';
+    source: Source;
+} | ({
+    type: 'tool-call';
+} & ToolCallUnion<TOOLS>) | {
+    type: 'tool-call-streaming-start';
+    toolCallId: string;
+    toolName: string;
+} | {
+    type: 'tool-call-delta';
+    toolCallId: string;
+    toolName: string;
+    argsTextDelta: string;
+} | ({
+    type: 'tool-result';
+} & ToolResultUnion<TOOLS>) | {
+    type: 'response-metadata';
+    id?: string;
+    timestamp?: Date;
+    modelId?: string;
+} | {
+    type: 'finish';
+    finishReason: FinishReason;
+    logprobs?: LogProbs;
+    usage: LanguageModelUsage;
+    experimental_providerMetadata?: ProviderMetadata;
+} | {
+    type: 'error';
+    error: unknown;
+};
+
+declare const symbol$a: unique symbol;
+declare class InvalidStreamPartError extends AISDKError {
+    private readonly [symbol$a];
+    readonly chunk: SingleRequestTextStreamPart<any>;
+    constructor({ chunk, message, }: {
+        chunk: SingleRequestTextStreamPart<any>;
+        message: string;
+    });
+    static isInstance(error: unknown): error is InvalidStreamPartError;
+}
+
 declare const symbol$9: unique symbol;
 /**
 Thrown when no image could be generated. This can have multiple causes:
@@ -3093,4 +3222,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamOptions, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RepairTextFunction, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, customProvider, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool, wrapLanguageModel };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamOptions, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RepairTextFunction, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, customProvider, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool, wrapLanguageModel };