ai 6.0.91 → 6.0.93

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # ai
 
+## 6.0.93
+
+### Patch Changes
+
+- d3769ec: feat(ai): add experimental callbacks in generateText
+
+## 6.0.92
+
+### Patch Changes
+
+- Updated dependencies [765b013]
+  - @ai-sdk/gateway@3.0.51
+
 ## 6.0.91
 
 ### Patch Changes

package/dist/index.d.mts

@@ -4,7 +4,7 @@ import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { Tool, InferToolInput, InferToolOutput, FlexibleSchema, InferSchema, SystemModelMessage, ModelMessage, AssistantModelMessage, ToolModelMessage, ReasoningPart, ProviderOptions, UserModelMessage, IdGenerator, ToolCall, MaybePromiseLike, TextPart, FilePart, Resolvable, FetchFunction, DataContent } from '@ai-sdk/provider-utils';
 export { AssistantContent, AssistantModelMessage, DataContent, DownloadError, FilePart, FlexibleSchema, IdGenerator, ImagePart, InferSchema, InferToolInput, InferToolOutput, ModelMessage, Schema, SystemModelMessage, TextPart, Tool, ToolApprovalRequest, ToolApprovalResponse, ToolCallOptions, ToolCallPart, ToolContent, ToolExecuteFunction, ToolExecutionOptions, ToolModelMessage, ToolResultPart, UserContent, UserModelMessage, asSchema, createIdGenerator, dynamicTool, generateId, jsonSchema, parseJsonEventStream, tool, zodSchema } from '@ai-sdk/provider-utils';
 import * as _ai_sdk_provider from '@ai-sdk/provider';
-import { EmbeddingModelV3, EmbeddingModelV2, EmbeddingModelV3Embedding, EmbeddingModelV3Middleware, ImageModelV3, ImageModelV2, ImageModelV3ProviderMetadata, ImageModelV2ProviderMetadata, ImageModelV3Middleware, JSONValue as JSONValue$1, LanguageModelV3, LanguageModelV2, SharedV3Warning, LanguageModelV3Source, LanguageModelV3Middleware, RerankingModelV3, SharedV3ProviderMetadata, SpeechModelV3, SpeechModelV2, TranscriptionModelV3, TranscriptionModelV2, JSONObject, ImageModelV3Usage, AISDKError, LanguageModelV3ToolCall, JSONSchema7, LanguageModelV3CallOptions, JSONParseError, TypeValidationError, Experimental_VideoModelV3, EmbeddingModelV3CallOptions, ProviderV3, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
+import { EmbeddingModelV3, EmbeddingModelV2, EmbeddingModelV3Embedding, EmbeddingModelV3Middleware, ImageModelV3, ImageModelV2, ImageModelV3ProviderMetadata, ImageModelV2ProviderMetadata, ImageModelV3Middleware, JSONValue as JSONValue$1, LanguageModelV3, LanguageModelV2, SharedV3Warning, LanguageModelV3Source, LanguageModelV3Middleware, RerankingModelV3, SharedV3ProviderMetadata, SpeechModelV3, SpeechModelV2, TranscriptionModelV3, TranscriptionModelV2, JSONObject, ImageModelV3Usage, AISDKError, LanguageModelV3ToolCall, JSONSchema7, LanguageModelV3ToolChoice, LanguageModelV3CallOptions, JSONParseError, TypeValidationError, Experimental_VideoModelV3, EmbeddingModelV3CallOptions, ProviderV3, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
 export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, JSONSchema7, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, TooManyEmbeddingValuesForCallError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
 import { ServerResponse } from 'node:http';
@@ -778,6 +778,33 @@ type ResponseMessage = AssistantModelMessage | ToolModelMessage;
  * The result of a single step in the generation process.
  */
 type StepResult<TOOLS extends ToolSet> = {
+    /**
+     * Zero-based index of this step.
+     */
+    readonly stepNumber: number;
+    /**
+     * Information about the model that produced this step.
+     */
+    readonly model: {
+        /** The provider of the model. */
+        readonly provider: string;
+        /** The ID of the model. */
+        readonly modelId: string;
+    };
+    /**
+     * Identifier from telemetry settings for grouping related operations.
+     */
+    readonly functionId: string | undefined;
+    /**
+     * Additional metadata from telemetry settings.
+     */
+    readonly metadata: Record<string, unknown> | undefined;
+    /**
+     * User-defined context object flowing through the generation.
+     *
+     * Experimental (can break in patch releases).
+     */
+    readonly experimental_context: unknown;
     /**
      * The content that was generated in the last step.
      */
@@ -953,6 +980,12 @@ type StopCondition<TOOLS extends ToolSet> = (options: {
 declare function stepCountIs(stepCount: number): StopCondition<any>;
 declare function hasToolCall(toolName: string): StopCondition<any>;
 
+declare const systemModelMessageSchema: z.ZodType<SystemModelMessage>;
+declare const userModelMessageSchema: z.ZodType<UserModelMessage>;
+declare const assistantModelMessageSchema: z.ZodType<AssistantModelMessage>;
+declare const toolModelMessageSchema: z.ZodType<ToolModelMessage>;
+declare const modelMessageSchema: z.ZodType<ModelMessage>;
+
 declare const symbol$j: unique symbol;
 declare class InvalidToolInputError extends AISDKError {
     private readonly [symbol$j];
@@ -980,12 +1013,6 @@ declare class NoSuchToolError extends AISDKError {
     static isInstance(error: unknown): error is NoSuchToolError;
 }
 
-declare const systemModelMessageSchema: z.ZodType<SystemModelMessage>;
-declare const userModelMessageSchema: z.ZodType<UserModelMessage>;
-declare const assistantModelMessageSchema: z.ZodType<AssistantModelMessage>;
-declare const toolModelMessageSchema: z.ZodType<ToolModelMessage>;
-declare const modelMessageSchema: z.ZodType<ModelMessage>;
-
 /**
  * A function that attempts to repair a tool call that failed to parse.
  *
@@ -1010,34 +1037,325 @@ type ToolCallRepairFunction<TOOLS extends ToolSet> = (options: {
     error: NoSuchToolError | InvalidToolInputError;
 }) => Promise<LanguageModelV3ToolCall | null>;
 
+/**
+ * Callback that is set using the `experimental_onStart` option.
+ *
+ * Called when the generateText operation begins, before any LLM calls.
+ * Use this callback for logging, analytics, or initializing state at the
+ * start of a generation.
+ *
+ * @param event - The event object containing generation configuration.
+ */
+type GenerateTextOnStartCallback<TOOLS extends ToolSet = ToolSet, OUTPUT extends Output = Output> = (event: {
+    /** The model being used for generation. */
+    readonly model: {
+        /** The provider identifier (e.g., 'openai', 'anthropic'). */
+        readonly provider: string;
+        /** The specific model identifier (e.g., 'gpt-4o'). */
+        readonly modelId: string;
+    };
+    /** The system message(s) provided to the model. */
+    readonly system: string | SystemModelMessage | Array<SystemModelMessage> | undefined;
+    /** The prompt string or array of messages if using the prompt option. */
+    readonly prompt: string | Array<ModelMessage> | undefined;
+    /** The messages array if using the messages option. */
+    readonly messages: Array<ModelMessage> | undefined;
+    /** The tools available for this generation. */
+    readonly tools: TOOLS | undefined;
+    /** The tool choice strategy for this generation. */
+    readonly toolChoice: ToolChoice<NoInfer<TOOLS>> | undefined;
+    /** Limits which tools are available for the model to call. */
+    readonly activeTools: Array<keyof TOOLS> | undefined;
+    /** Maximum number of tokens to generate. */
+    readonly maxOutputTokens: number | undefined;
+    /** Sampling temperature for generation. */
+    readonly temperature: number | undefined;
+    /** Top-p (nucleus) sampling parameter. */
+    readonly topP: number | undefined;
+    /** Top-k sampling parameter. */
+    readonly topK: number | undefined;
+    /** Presence penalty for generation. */
+    readonly presencePenalty: number | undefined;
+    /** Frequency penalty for generation. */
+    readonly frequencyPenalty: number | undefined;
+    /** Sequences that will stop generation. */
+    readonly stopSequences: string[] | undefined;
+    /** Random seed for reproducible generation. */
+    readonly seed: number | undefined;
+    /** Maximum number of retries for failed requests. */
+    readonly maxRetries: number;
+    /**
+     * Timeout configuration for the generation.
+     * Can be a number (milliseconds) or an object with totalMs, stepMs, chunkMs.
+     */
+    readonly timeout: TimeoutConfiguration | undefined;
+    /** Additional HTTP headers sent with the request. */
+    readonly headers: Record<string, string | undefined> | undefined;
+    /** Additional provider-specific options. */
+    readonly providerOptions: ProviderOptions | undefined;
+    /**
+     * Condition(s) for stopping the generation.
+     * When the condition is an array, any of the conditions can be met to stop.
+     */
+    readonly stopWhen: StopCondition<TOOLS> | Array<StopCondition<TOOLS>> | undefined;
+    /** The output specification for structured outputs, if configured. */
+    readonly output: OUTPUT | undefined;
+    /** Abort signal for cancelling the operation. */
+    readonly abortSignal: AbortSignal | undefined;
+    /**
+     * Settings for controlling what data is included in step results.
+     * `requestBody` and `responseBody` control whether these are retained.
+     */
+    readonly include: {
+        requestBody?: boolean;
+        responseBody?: boolean;
+    } | undefined;
+    /** Identifier from telemetry settings for grouping related operations. */
+    readonly functionId: string | undefined;
+    /** Additional metadata passed to the generation. */
+    readonly metadata: Record<string, unknown> | undefined;
+    /**
+     * User-defined context object that flows through the entire generation lifecycle.
+     * Can be accessed and modified in `prepareStep` and tool `execute` functions.
+     */
+    readonly experimental_context: unknown;
+}) => PromiseLike<void> | void;
+/**
+ * Callback that is set using the `experimental_onStepStart` option.
+ *
+ * Called when a step (LLM call) begins, before the provider is called.
+ * Each step represents a single LLM invocation. Multiple steps occur when
+ * using tool calls (the model may be called multiple times in a loop).
+ *
+ * @param event - The event object containing step configuration.
+ */
+type GenerateTextOnStepStartCallback<TOOLS extends ToolSet = ToolSet, OUTPUT extends Output = Output> = (event: {
+    /** Zero-based index of the current step. */
+    readonly stepNumber: number;
+    /** The model being used for this step. */
+    readonly model: {
+        /** The provider identifier. */
+        readonly provider: string;
+        /** The specific model identifier. */
+        readonly modelId: string;
+    };
+    /**
+     * The system message for this step.
+     */
+    readonly system: string | SystemModelMessage | Array<SystemModelMessage> | undefined;
+    /**
+     * The messages that will be sent to the model for this step.
+     * Uses the user-facing `ModelMessage` format.
+     * May be overridden by prepareStep.
+     */
+    readonly messages: Array<ModelMessage>;
+    /** The tools available for this generation. */
+    readonly tools: TOOLS | undefined;
+    /** The tool choice configuration for this step. */
+    readonly toolChoice: LanguageModelV3ToolChoice | undefined;
+    /** Limits which tools are available for this step. */
+    readonly activeTools: Array<keyof TOOLS> | undefined;
+    /** Array of results from previous steps (empty for first step). */
+    readonly steps: ReadonlyArray<StepResult<TOOLS>>;
+    /** Additional provider-specific options for this step. */
+    readonly providerOptions: ProviderOptions | undefined;
+    /**
+     * Timeout configuration for the generation.
+     * Can be a number (milliseconds) or an object with totalMs, stepMs, chunkMs.
+     */
+    readonly timeout: TimeoutConfiguration | undefined;
+    /** Additional HTTP headers sent with the request. */
+    readonly headers: Record<string, string | undefined> | undefined;
+    /**
+     * Condition(s) for stopping the generation.
+     * When the condition is an array, any of the conditions can be met to stop.
+     */
+    readonly stopWhen: StopCondition<TOOLS> | Array<StopCondition<TOOLS>> | undefined;
+    /** The output specification for structured outputs, if configured. */
+    readonly output: OUTPUT | undefined;
+    /** Abort signal for cancelling the operation. */
+    readonly abortSignal: AbortSignal | undefined;
+    /**
+     * Settings for controlling what data is included in step results.
+     */
+    readonly include: {
+        requestBody?: boolean;
+        responseBody?: boolean;
+    } | undefined;
+    /** Identifier from telemetry settings for grouping related operations. */
+    readonly functionId: string | undefined;
+    /** Additional metadata from telemetry settings. */
+    readonly metadata: Record<string, unknown> | undefined;
+    /**
+     * User-defined context object. May be updated from `prepareStep` between steps.
+     */
+    readonly experimental_context: unknown;
+}) => PromiseLike<void> | void;
+/**
+ * Callback that is set using the `experimental_onToolCallStart` option.
+ *
+ * Called when a tool execution begins, before the tool's `execute` function is invoked.
+ * Use this for logging tool invocations, tracking tool usage, or pre-execution validation.
+ *
+ * @param event - The event object containing tool call information.
+ * @param event.stepNumber - Zero-based index of the current step where this tool call occurs.
+ * @param event.model - Information about the model being used (provider and modelId).
+ * @param event.toolCall - The full tool call object containing toolName, toolCallId, input, and metadata.
+ * @param event.messages - The conversation messages available at tool execution time.
+ * @param event.abortSignal - Signal for cancelling the operation.
+ * @param event.functionId - Identifier from telemetry settings for grouping related operations.
+ * @param event.metadata - Additional metadata from telemetry settings.
+ * @param event.experimental_context - User-defined context object flowing through the generation.
+ */
+type GenerateTextOnToolCallStartCallback<TOOLS extends ToolSet = ToolSet> = (event: {
+    /** Zero-based index of the current step where this tool call occurs. May be undefined in streaming contexts. */
+    readonly stepNumber: number | undefined;
+    /** Information about the model being used. May be undefined in streaming contexts. */
+    readonly model: {
+        /** The provider of the model. */
+        readonly provider: string;
+        /** The ID of the model. */
+        readonly modelId: string;
+    } | undefined;
+    /** The full tool call object. */
+    readonly toolCall: TypedToolCall<TOOLS>;
+    /** The conversation messages available at tool execution time. */
+    readonly messages: Array<ModelMessage>;
+    /** Signal for cancelling the operation. */
+    readonly abortSignal: AbortSignal | undefined;
+    /** Identifier from telemetry settings for grouping related operations. */
+    readonly functionId: string | undefined;
+    /** Additional metadata from telemetry settings. */
+    readonly metadata: Record<string, unknown> | undefined;
+    /** User-defined context object flowing through the generation. */
+    readonly experimental_context: unknown;
+}) => PromiseLike<void> | void;
+/**
+ * Callback that is set using the `experimental_onToolCallFinish` option.
+ *
+ * Called when a tool execution completes, either successfully or with an error.
+ * Use this for logging tool results, tracking execution time, or error handling.
+ *
+ * The event uses a discriminated union on the `success` field:
+ * - When `success: true`: `output` contains the tool result, `error` is never present.
+ * - When `success: false`: `error` contains the error, `output` is never present.
+ *
+ * @param event - The event object containing tool call result information.
+ * @param event.stepNumber - Zero-based index of the current step where this tool call occurred.
+ * @param event.model - Information about the model being used (provider and modelId).
+ * @param event.toolCall - The full tool call object containing toolName, toolCallId, input, and metadata.
+ * @param event.messages - The conversation messages available at tool execution time.
+ * @param event.abortSignal - Signal for cancelling the operation.
+ * @param event.durationMs - Execution time of the tool call in milliseconds.
+ * @param event.functionId - Identifier from telemetry settings for grouping related operations.
+ * @param event.metadata - Additional metadata from telemetry settings.
+ * @param event.experimental_context - User-defined context object flowing through the generation.
+ * @param event.success - Discriminator indicating whether the tool call succeeded.
+ * @param event.output - The tool's return value (only present when `success: true`).
+ * @param event.error - The error that occurred (only present when `success: false`).
+ */
+type GenerateTextOnToolCallFinishCallback<TOOLS extends ToolSet = ToolSet> = (event: {
+    /** Zero-based index of the current step where this tool call occurred. May be undefined in streaming contexts. */
+    readonly stepNumber: number | undefined;
+    /** Information about the model being used. May be undefined in streaming contexts. */
+    readonly model: {
+        /** The provider of the model. */
+        readonly provider: string;
+        /** The ID of the model. */
+        readonly modelId: string;
+    } | undefined;
+    /** The full tool call object. */
+    readonly toolCall: TypedToolCall<TOOLS>;
+    /** The conversation messages available at tool execution time. */
+    readonly messages: Array<ModelMessage>;
+    /** Signal for cancelling the operation. */
+    readonly abortSignal: AbortSignal | undefined;
+    /** Execution time of the tool call in milliseconds. */
+    readonly durationMs: number;
+    /** Identifier from telemetry settings for grouping related operations. */
+    readonly functionId: string | undefined;
+    /** Additional metadata from telemetry settings. */
+    readonly metadata: Record<string, unknown> | undefined;
+    /** User-defined context object flowing through the generation. */
+    readonly experimental_context: unknown;
+} & ({
+    /** Indicates the tool call succeeded. */
+    readonly success: true;
+    /** The tool's return value. */
+    readonly output: unknown;
+    readonly error?: never;
+} | {
+    /** Indicates the tool call failed. */
+    readonly success: false;
+    readonly output?: never;
+    /** The error that occurred during tool execution. */
+    readonly error: unknown;
+})) => PromiseLike<void> | void;
 /**
  * Callback that is set using the `onStepFinish` option.
  *
+ * Called when a step (LLM call) completes. The event includes all step result
+ * properties (text, tool calls, usage, etc.) along with additional metadata.
+ *
  * @param stepResult - The result of the step.
  */
 type GenerateTextOnStepFinishCallback<TOOLS extends ToolSet> = (stepResult: StepResult<TOOLS>) => Promise<void> | void;
 /**
  * Callback that is set using the `onFinish` option.
  *
- * @param event - The event that is passed to the callback.
+ * Called when the entire generation completes (all steps finished).
+ * The event includes the final step's result properties along with
+ * aggregated data from all steps.
+ *
+ * @param event - The final result along with aggregated step data.
+ *
+ * Inherited from StepResult (reflects the final step):
+ * @param event.content - Array of content parts from the final step.
+ * @param event.text - The generated text from the final step.
+ * @param event.reasoning - Array of reasoning parts from the final step.
+ * @param event.reasoningText - Combined reasoning text from the final step.
+ * @param event.files - Array of generated files from the final step.
+ * @param event.sources - Array of sources from the final step.
+ * @param event.toolCalls - Array of tool calls from the final step.
+ * @param event.toolResults - Array of tool results from the final step.
+ * @param event.finishReason - Finish reason from the final step.
+ * @param event.usage - Token usage from the final step only.
+ * @param event.warnings - Warnings from the final step.
+ * @param event.request - Request metadata from the final step.
+ * @param event.response - Response metadata from the final step.
+ * @param event.providerMetadata - Provider metadata from the final step.
+ *
+ * Additional properties:
+ * @param event.steps - Array containing results from all steps in the generation.
+ * @param event.totalUsage - Aggregated token usage across all steps.
+ * @param event.experimental_context - The final state of the user-defined context object.
+ * @param event.functionId - Identifier from telemetry settings for grouping related operations.
+ * @param event.metadata - Additional metadata from telemetry settings.
  */
 type GenerateTextOnFinishCallback<TOOLS extends ToolSet> = (event: StepResult<TOOLS> & {
     /**
-     * Details for all steps.
+     * Array containing results from all steps in the generation.
      */
     readonly steps: StepResult<TOOLS>[];
     /**
-     * Total usage for all steps. This is the sum of the usage of all steps.
+     * Aggregated token usage across all steps.
+     * This is the sum of the usage from each individual step.
      */
     readonly totalUsage: LanguageModelUsage;
     /**
-     * Context that is passed into tool execution.
+     * The final state of the user-defined context object.
+     * This reflects any modifications made during the generation lifecycle
+     * via `prepareStep` or tool execution.
      *
      * Experimental (can break in patch releases).
      *
      * @default undefined
      */
     experimental_context: unknown;
+    /** Identifier from telemetry settings for grouping related operations. */
+    readonly functionId: string | undefined;
+    /** Additional metadata from telemetry settings. */
+    readonly metadata: Record<string, unknown> | undefined;
 }) => PromiseLike<void> | void;
 /**
  * Generate a text and call tools for a given prompt using a language model.
@@ -1079,13 +1397,21 @@ type GenerateTextOnFinishCallback<TOOLS extends ToolSet> = (event: StepResult<TO
  * @param timeout - An optional timeout in milliseconds. The call will be aborted if it takes longer than the specified timeout.
  * @param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
  *
+ * @param experimental_context - User-defined context object that flows through the entire generation lifecycle.
+ * @param experimental_onStart - Callback invoked when generation begins, before any LLM calls.
+ * @param experimental_onStepStart - Callback invoked when each step begins, before the provider is called.
+ * Receives step number, messages (in ModelMessage format), tools, and context.
+ * @param experimental_onToolCallStart - Callback invoked before each tool execution begins.
+ * Receives tool name, call ID, input, and context.
+ * @param experimental_onToolCallFinish - Callback invoked after each tool execution completes.
+ * Uses a discriminated union: check `success` to determine if `output` or `error` is present.
  * @param onStepFinish - Callback that is called when each step (LLM call) is finished, including intermediate steps.
  * @param onFinish - Callback that is called when all steps are finished and the response is complete.
  *
  * @returns
  * A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends ToolSet, OUTPUT extends Output = Output<string, string>>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, timeout, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_download: download, experimental_context, experimental_include: include, _internal: { generateId }, onStepFinish, onFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT extends Output = Output<string, string>>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, timeout, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_download: download, experimental_context, experimental_include: include, _internal: { generateId }, experimental_onStart: onStart, experimental_onStepStart: onStepStart, experimental_onToolCallStart: onToolCallStart, experimental_onToolCallFinish: onToolCallFinish, onStepFinish, onFinish, ...settings }: CallSettings & Prompt & {
     /**
      * The language model to use.
      */
@@ -1152,6 +1478,24 @@ declare function generateText<TOOLS extends ToolSet, OUTPUT extends Output = Out
      * A function that attempts to repair a tool call that failed to parse.
      */
     experimental_repairToolCall?: ToolCallRepairFunction<NoInfer<TOOLS>>;
+    /**
+     * Callback that is called when the generateText operation begins,
+     * before any LLM calls are made.
+     */
+    experimental_onStart?: GenerateTextOnStartCallback<NoInfer<TOOLS>, OUTPUT>;
+    /**
+     * Callback that is called when a step (LLM call) begins,
+     * before the provider is called.
+     */
+    experimental_onStepStart?: GenerateTextOnStepStartCallback<NoInfer<TOOLS>, OUTPUT>;
+    /**
+     * Callback that is called right before a tool's execute function runs.
+     */
+    experimental_onToolCallStart?: GenerateTextOnToolCallStartCallback<NoInfer<TOOLS>>;
+    /**
+     * Callback that is called right after a tool's execute function completes (or errors).
+     */
+    experimental_onToolCallFinish?: GenerateTextOnToolCallFinishCallback<NoInfer<TOOLS>>;
     /**
      * Callback that is called when each step (LLM call) is finished, including intermediate steps.
      */
@@ -6010,4 +6354,4 @@ declare global {
     var AI_SDK_LOG_WARNINGS: LogWarningsFunction | undefined | false;
 }
 
-export { AbstractChat, Agent, AgentCallParameters, AgentStreamParameters, AsyncIterableStream, CallSettings, CallWarning, ChatAddToolApproveResponseFunction, ChatInit, ChatOnDataCallback, ChatOnErrorCallback, ChatOnFinishCallback, ChatOnToolCallCallback, ChatRequestOptions, ChatState, ChatStatus, ChatTransport, ChunkDetector, CompletionRequestOptions, ContentPart, CreateUIMessage, DataUIPart, DeepPartial, DefaultChatTransport, DefaultGeneratedFile, DirectChatTransport, DirectChatTransportOptions, DynamicToolCall, DynamicToolError, DynamicToolResult, DynamicToolUIPart, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelMiddleware, EmbeddingModelUsage, ErrorHandler, ToolLoopAgent as Experimental_Agent, ToolLoopAgentSettings as Experimental_AgentSettings, DownloadFunction as Experimental_DownloadFunction, Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, InferAgentUIMessage as Experimental_InferAgentUIMessage, LogWarningsFunction as Experimental_LogWarningsFunction, SpeechResult as Experimental_SpeechResult, TranscriptionResult as Experimental_TranscriptionResult, FileUIPart, FinishReason, GenerateImageResult, GenerateObjectResult, GenerateTextOnFinishCallback, GenerateTextOnStepFinishCallback, GenerateTextResult, GenerateVideoPrompt, GenerateVideoResult, GeneratedAudioFile, GeneratedFile, HttpChatTransport, HttpChatTransportInitOptions, ImageModel, ImageModelMiddleware, ImageModelProviderMetadata, ImageModelResponseMetadata, ImageModelUsage, InferAgentUIMessage, InferCompleteOutput as InferGenerateOutput, InferPartialOutput as InferStreamOutput, InferUIDataParts, InferUIMessageChunk, InferUITool, InferUITools, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolApprovalError, InvalidToolInputError, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelMiddleware, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LogWarningsFunction, MessageConversionError, MissingToolResultsError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputGeneratedError, NoSpeechGeneratedError, NoSuchProviderError, NoSuchToolError, NoTranscriptGeneratedError, NoVideoGeneratedError, ObjectStreamPart, output as Output, PrepareReconnectToStreamRequest, PrepareSendMessagesRequest, PrepareStepFunction, PrepareStepResult, Prompt, Provider, ProviderMetadata, ProviderRegistryProvider, ReasoningOutput, ReasoningUIPart, RepairTextFunction, RerankResult, RerankingModel, RetryError, SafeValidateUIMessagesResult, SerialJobExecutor, SourceDocumentUIPart, SourceUrlUIPart, SpeechModel, SpeechModelResponseMetadata, StaticToolCall, StaticToolError, StaticToolOutputDenied, StaticToolResult, StepResult, StepStartUIPart, StopCondition, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextStreamChatTransport, TextStreamPart, TextUIPart, TimeoutConfiguration, ToolApprovalRequestOutput, ToolCallNotFoundForApprovalError, ToolCallRepairError, ToolCallRepairFunction, ToolChoice, ToolLoopAgent, ToolLoopAgentOnFinishCallback, ToolLoopAgentOnStepFinishCallback, ToolLoopAgentSettings, ToolSet, ToolUIPart, TranscriptionModel, TranscriptionModelResponseMetadata, TypedToolCall, TypedToolError, TypedToolOutputDenied, TypedToolResult, UIDataPartSchemas, UIDataTypes, UIMessage, UIMessageChunk, UIMessagePart, UIMessageStreamError, UIMessageStreamOnFinishCallback, UIMessageStreamOnStepFinishCallback, UIMessageStreamOptions, UIMessageStreamWriter, UITool, UIToolInvocation, UITools, UI_MESSAGE_STREAM_HEADERS, UnsupportedModelVersionError, UseCompletionOptions, Warning, addToolInputExamplesMiddleware, assistantModelMessageSchema, callCompletionApi, consumeStream, convertFileListToFileUIParts, convertToModelMessages, cosineSimilarity, createAgentUIStream, createAgentUIStreamResponse, createDownload, createProviderRegistry, createTextStreamResponse, createUIMessageStream, createUIMessageStreamResponse, customProvider, defaultEmbeddingSettingsMiddleware, defaultSettingsMiddleware, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, experimental_generateImage, generateSpeech as experimental_generateSpeech, experimental_generateVideo, transcribe as experimental_transcribe, extractJsonMiddleware, extractReasoningMiddleware, generateImage, generateObject, generateText, getStaticToolName, getTextFromDataUrl, getToolName, getToolOrDynamicToolName, hasToolCall, isDataUIPart, isDeepEqualData, isFileUIPart, isReasoningUIPart, isStaticToolUIPart, isTextUIPart, isToolOrDynamicToolUIPart, isToolUIPart, lastAssistantMessageIsCompleteWithApprovalResponses, lastAssistantMessageIsCompleteWithToolCalls, modelMessageSchema, parsePartialJson, pipeAgentUIStreamToResponse, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, pruneMessages, readUIMessageStream, rerank, safeValidateUIMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, stepCountIs, streamObject, streamText, systemModelMessageSchema, toolModelMessageSchema, uiMessageChunkSchema, userModelMessageSchema, validateUIMessages, wrapEmbeddingModel, wrapImageModel, wrapLanguageModel, wrapProvider };
+export { AbstractChat, Agent, AgentCallParameters, AgentStreamParameters, AsyncIterableStream, CallSettings, CallWarning, ChatAddToolApproveResponseFunction, ChatInit, ChatOnDataCallback, ChatOnErrorCallback, ChatOnFinishCallback, ChatOnToolCallCallback, ChatRequestOptions, ChatState, ChatStatus, ChatTransport, ChunkDetector, CompletionRequestOptions, ContentPart, CreateUIMessage, DataUIPart, DeepPartial, DefaultChatTransport, DefaultGeneratedFile, DirectChatTransport, DirectChatTransportOptions, DynamicToolCall, DynamicToolError, DynamicToolResult, DynamicToolUIPart, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelMiddleware, EmbeddingModelUsage, ErrorHandler, ToolLoopAgent as Experimental_Agent, ToolLoopAgentSettings as Experimental_AgentSettings, DownloadFunction as Experimental_DownloadFunction, Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, InferAgentUIMessage as Experimental_InferAgentUIMessage, LogWarningsFunction as Experimental_LogWarningsFunction, SpeechResult as Experimental_SpeechResult, TranscriptionResult as Experimental_TranscriptionResult, FileUIPart, FinishReason, GenerateImageResult, GenerateObjectResult, GenerateTextOnFinishCallback, GenerateTextOnStartCallback, GenerateTextOnStepFinishCallback, GenerateTextOnStepStartCallback, GenerateTextOnToolCallFinishCallback, GenerateTextOnToolCallStartCallback, GenerateTextResult, GenerateVideoPrompt, GenerateVideoResult, GeneratedAudioFile, GeneratedFile, HttpChatTransport, HttpChatTransportInitOptions, ImageModel, ImageModelMiddleware, ImageModelProviderMetadata, ImageModelResponseMetadata, ImageModelUsage, InferAgentUIMessage, InferCompleteOutput as InferGenerateOutput, InferPartialOutput as InferStreamOutput, InferUIDataParts, InferUIMessageChunk, InferUITool, InferUITools, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolApprovalError, InvalidToolInputError, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelMiddleware, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LogWarningsFunction, MessageConversionError, MissingToolResultsError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputGeneratedError, NoSpeechGeneratedError, NoSuchProviderError, NoSuchToolError, NoTranscriptGeneratedError, NoVideoGeneratedError, ObjectStreamPart, output as Output, PrepareReconnectToStreamRequest, PrepareSendMessagesRequest, PrepareStepFunction, PrepareStepResult, Prompt, Provider, ProviderMetadata, ProviderRegistryProvider, ReasoningOutput, ReasoningUIPart, RepairTextFunction, RerankResult, RerankingModel, RetryError, SafeValidateUIMessagesResult, SerialJobExecutor, SourceDocumentUIPart, SourceUrlUIPart, SpeechModel, SpeechModelResponseMetadata, StaticToolCall, StaticToolError, StaticToolOutputDenied, StaticToolResult, StepResult, StepStartUIPart, StopCondition, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextStreamChatTransport, TextStreamPart, TextUIPart, TimeoutConfiguration, ToolApprovalRequestOutput, ToolCallNotFoundForApprovalError, ToolCallRepairError, ToolCallRepairFunction, ToolChoice, ToolLoopAgent, ToolLoopAgentOnFinishCallback, ToolLoopAgentOnStepFinishCallback, ToolLoopAgentSettings, ToolSet, ToolUIPart, TranscriptionModel, TranscriptionModelResponseMetadata, TypedToolCall, TypedToolError, TypedToolOutputDenied, TypedToolResult, UIDataPartSchemas, UIDataTypes, UIMessage, UIMessageChunk, UIMessagePart, UIMessageStreamError, UIMessageStreamOnFinishCallback, UIMessageStreamOnStepFinishCallback, UIMessageStreamOptions, UIMessageStreamWriter, UITool, UIToolInvocation, UITools, UI_MESSAGE_STREAM_HEADERS, UnsupportedModelVersionError, UseCompletionOptions, Warning, addToolInputExamplesMiddleware, assistantModelMessageSchema, callCompletionApi, consumeStream, convertFileListToFileUIParts, convertToModelMessages, cosineSimilarity, createAgentUIStream, createAgentUIStreamResponse, createDownload, createProviderRegistry, createTextStreamResponse, createUIMessageStream, createUIMessageStreamResponse, customProvider, defaultEmbeddingSettingsMiddleware, defaultSettingsMiddleware, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, experimental_generateImage, generateSpeech as experimental_generateSpeech, experimental_generateVideo, transcribe as experimental_transcribe, extractJsonMiddleware, extractReasoningMiddleware, generateImage, generateObject, generateText, getStaticToolName, getTextFromDataUrl, getToolName, getToolOrDynamicToolName, hasToolCall, isDataUIPart, isDeepEqualData, isFileUIPart, isReasoningUIPart, isStaticToolUIPart, isTextUIPart, isToolOrDynamicToolUIPart, isToolUIPart, lastAssistantMessageIsCompleteWithApprovalResponses, lastAssistantMessageIsCompleteWithToolCalls, modelMessageSchema, parsePartialJson, pipeAgentUIStreamToResponse, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, pruneMessages, readUIMessageStream, rerank, safeValidateUIMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, stepCountIs, streamObject, streamText, systemModelMessageSchema, toolModelMessageSchema, uiMessageChunkSchema, userModelMessageSchema, validateUIMessages, wrapEmbeddingModel, wrapImageModel, wrapLanguageModel, wrapProvider };