ai 4.1.9 → 4.1.11

package/dist/index.d.ts

@@ -214,11 +214,19 @@ type Provider = {
 };
 
 /**
-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.
+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 = LanguageModelV1ProviderMetadata;
+/**
+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 = LanguageModelV1ProviderMetadata;
 
 /**
 Represents the number of tokens used in a prompt and completion.
@@ -487,12 +495,6 @@ declare function generateImage({ model, prompt, n, size, aspectRatio, seed, prov
   Only applicable for HTTP-based providers.
    */
     headers?: Record<string, string>;
-    /**
-     * Internal. For test use only. May change without notice.
-     */
-    _internal?: {
-        currentDate?: () => Date;
-    };
 }): Promise<GenerateImageResult>;
 
 type CallSettings = {
@@ -596,6 +598,10 @@ interface TextPart {
   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;
 }
@@ -619,6 +625,10 @@ interface ImagePart {
   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;
 }
@@ -642,6 +652,10 @@ interface FilePart {
   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;
 }
@@ -666,6 +680,10 @@ interface ToolCallPart {
   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;
 }
@@ -698,6 +716,10 @@ interface ToolResultPart {
   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;
 }
@@ -716,6 +738,10 @@ type CoreSystemMessage = {
   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;
 };
@@ -731,6 +757,10 @@ type CoreUserMessage = {
   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;
 };
 declare const coreUserMessageSchema: z.ZodType<CoreUserMessage>;
@@ -749,6 +779,10 @@ type CoreAssistantMessage = {
   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;
 };
 declare const coreAssistantMessageSchema: z.ZodType<CoreAssistantMessage>;
@@ -767,6 +801,10 @@ type CoreToolMessage = {
   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;
 };
 declare const coreToolMessageSchema: z.ZodType<CoreToolMessage>;
@@ -904,9 +942,13 @@ Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
     /**
-Additional provider-specific metadata. They are passed through
+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;
+    /**
+@deprecated Use `providerOptions` instead.
 */
     experimental_providerMetadata?: ProviderMetadata;
     /**
@@ -966,18 +1008,15 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
-Additional provider-specific metadata. They are passed through
+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.
 */
-    experimental_providerMetadata?: ProviderMetadata;
+    providerOptions?: ProviderOptions;
     /**
-     * Internal. For test use only. May change without notice.
-     */
-    _internal?: {
-        generateId?: () => string;
-        currentDate?: () => Date;
-    };
+@deprecated Use `providerOptions` instead.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
 }): Promise<GenerateObjectResult<Array<ELEMENT>>>;
 /**
 Generate a value from an enum (limited list of string values) using a language model.
@@ -1016,9 +1055,13 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
-Additional provider-specific metadata. They are passed through
+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;
+    /**
+@deprecated Use `providerOptions` instead.
 */
     experimental_providerMetadata?: ProviderMetadata;
     /**
@@ -1052,9 +1095,13 @@ Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
     /**
-Additional provider-specific metadata. They are passed through
+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;
+    /**
+@deprecated Use `providerOptions` instead.
 */
     experimental_providerMetadata?: ProviderMetadata;
     /**
@@ -1178,11 +1225,15 @@ type OnFinishCallback<RESULT> = (event: {
   */
     warnings?: CallWarning[];
     /**
-  Additional provider-specific metadata. They are passed through
-  from the provider to the AI SDK and enable provider-specific
-  results that can be fully encapsulated in the provider.
+  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;
+    /**
+  @deprecated Use `providerOptions` instead.
   */
-    experimental_providerMetadata: ProviderMetadata | undefined;
+    experimental_providerMetadata?: ProviderMetadata;
 }) => Promise<void> | void;
 /**
 Generate a structured, typed object for a given prompt and schema using a language model.
@@ -1233,23 +1284,19 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
-Additional provider-specific metadata. They are passed through
+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;
+    /**
+@deprecated Use `providerOptions` instead.
 */
     experimental_providerMetadata?: ProviderMetadata;
     /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: OnFinishCallback<OBJECT>;
-    /**
-     * Internal. For test use only. May change without notice.
-     */
-    _internal?: {
-        generateId?: () => string;
-        currentDate?: () => Date;
-        now?: () => number;
-    };
 }): StreamObjectResult<DeepPartial<OBJECT>, OBJECT, never>;
 /**
 Generate an array with structured, typed elements for a given prompt and element schema using a language model.
@@ -1300,9 +1347,13 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
-Additional provider-specific metadata. They are passed through
+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;
+    /**
+@deprecated Use `providerOptions` instead.
 */
     experimental_providerMetadata?: ProviderMetadata;
     /**
@@ -1341,9 +1392,13 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
-Additional provider-specific metadata. They are passed through
+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;
+    /**
+@deprecated Use `providerOptions` instead.
 */
     experimental_providerMetadata?: ProviderMetadata;
     /**
@@ -1847,7 +1902,7 @@ If set and supported by the model, calls will generate deterministic results.
 @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 = never, OUTPUT_PARTIAL = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata, providerOptions, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1883,10 +1938,14 @@ Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
     /**
-Additional provider-specific metadata. They are passed through
+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;
+    /**
+@deprecated Use `providerOptions` instead.
+     */
     experimental_providerMetadata?: ProviderMetadata;
     /**
 Limits the tools that are available for the model to call without
@@ -1905,13 +1964,6 @@ A function that attempts to repair a tool call that failed to parse.
     Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
     onStepFinish?: (event: StepResult<TOOLS>) => Promise<void> | void;
-    /**
-     * Internal. For test use only. May change without notice.
-     */
-    _internal?: {
-        generateId?: IDGenerator;
-        currentDate?: () => Date;
-    };
 }): Promise<GenerateTextResult<TOOLS, OUTPUT>>;
 
 /**
@@ -2169,12 +2221,6 @@ type TextStreamPart<TOOLS extends ToolSet> = {
 declare function smoothStream<TOOLS extends ToolSet>({ delayInMs, chunking, _internal: { delay }, }?: {
     delayInMs?: number | null;
     chunking?: 'word' | 'line' | RegExp;
-    /**
-     * Internal. For test use only. May change without notice.
-     */
-    _internal?: {
-        delay?: (delayInMs: number | null) => Promise<void>;
-    };
 }): (options: {
     tools: TOOLS;
 }) => TransformStream<TextStreamPart<TOOLS>, TextStreamPart<TOOLS>>;
@@ -2237,7 +2283,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming, toolCallStreaming, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, onChunk, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata, providerOptions, experimental_toolCallStreaming, toolCallStreaming, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, onChunk, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -2273,9 +2319,13 @@ Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
     /**
-Additional provider-specific metadata. They are passed through
+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;
+    /**
+@deprecated Use `providerOptions` instead.
  */
     experimental_providerMetadata?: ProviderMetadata;
     /**
@@ -2329,14 +2379,6 @@ Details for all steps.
 Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
     onStepFinish?: (event: StepResult<TOOLS>) => Promise<void> | void;
-    /**
-Internal. For test use only. May change without notice.
-     */
-    _internal?: {
-        now?: () => number;
-        generateId?: IDGenerator;
-        currentDate?: () => Date;
-    };
 }): StreamTextResult<TOOLS, PARTIAL_OUTPUT>;
 
 /**
@@ -2344,7 +2386,11 @@ Internal. For test use only. May change without notice.
  * This type defines the structure for middleware that can be used to modify
  * the behavior of LanguageModelV1 operations.
  */
-type Experimental_LanguageModelV1Middleware = {
+type LanguageModelV1Middleware = {
+    /**
+     * Middleware specification version. Use `v1` for the current version.
+     */
+    middlewareVersion?: 'v1' | undefined;
     /**
      * Transforms the parameters before they are passed to the language model.
      * @param options - Object containing the type of operation and the parameters.
@@ -2385,6 +2431,22 @@ type Experimental_LanguageModelV1Middleware = {
         model: LanguageModelV1;
     }) => PromiseLike<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
 };
+/**
+ * @deprecated Use `LanguageModelV1Middleware` instead.
+ */
+type Experimental_LanguageModelV1Middleware = LanguageModelV1Middleware;
+
+/**
+ * Extract an XML-tagged reasoning section from the generated text and exposes it
+ * as a `reasoning` property on the result.
+ *
+ * @param tagName - The name of the XML tag to extract reasoning from.
+ * @param separator - The separator to use between reasoning and text sections.
+ */
+declare function extractReasoningMiddleware({ tagName, separator, }: {
+    tagName: string;
+    separator?: string;
+}): LanguageModelV1Middleware;
 
 /**
  * Wraps a LanguageModelV1 instance with middleware functionality.
@@ -2398,24 +2460,21 @@ type Experimental_LanguageModelV1Middleware = {
  * @param options.providerId - Optional custom provider ID to override the original model's provider.
  * @returns A new LanguageModelV1 instance with middleware applied.
  */
-declare const experimental_wrapLanguageModel: ({ model, middleware: { transformParams, wrapGenerate, wrapStream }, modelId, providerId, }: {
+declare const wrapLanguageModel: ({ model, middleware: { transformParams, wrapGenerate, wrapStream }, modelId, providerId, }: {
     model: LanguageModelV1;
-    middleware: Experimental_LanguageModelV1Middleware;
+    middleware: LanguageModelV1Middleware;
     modelId?: string;
     providerId?: string;
 }) => LanguageModelV1;
-
 /**
- * Extract an XML-tagged reasoning section from the generated text and exposes it
- * as a `reasoning` property on the result.
- *
- * @param tagName - The name of the XML tag to extract reasoning from.
- * @param separator - The separator to use between reasoning and text sections.
+ * @deprecated Use `wrapLanguageModel` instead.
  */
-declare function extractReasoningMiddleware({ tagName, separator, }: {
-    tagName: string;
-    separator?: string;
-}): Experimental_LanguageModelV1Middleware;
+declare const experimental_wrapLanguageModel: ({ model, middleware: { transformParams, wrapGenerate, wrapStream }, modelId, providerId, }: {
+    model: LanguageModelV1;
+    middleware: LanguageModelV1Middleware;
+    modelId?: string;
+    providerId?: string;
+}) => LanguageModelV1;
 
 /**
  * Creates a custom provider with specified language models, text embedding models, and an optional fallback provider.
@@ -2485,9 +2544,6 @@ declare function simulateReadableStream<T>({ chunks, initialDelayInMs, chunkDela
     chunks: T[];
     initialDelayInMs?: number | null;
     chunkDelayInMs?: number | null;
-    _internal?: {
-        delay?: (ms: number | null) => Promise<void>;
-    };
 }): ReadableStream<T>;
 
 declare const symbol$a: unique symbol;
@@ -2798,4 +2854,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, 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, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, 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, RetryError, StepResult, StreamData, StreamObjectResult, 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, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, smoothStream, streamObject, streamText, tool, wrapLanguageModel };