@ai-sdk/provider 2.1.0-beta.1 → 2.1.0-beta.3

package/dist/index.d.mts

@@ -485,6 +485,158 @@ declare function isJSONValue(value: unknown): value is JSONValue;
 declare function isJSONArray(value: unknown): value is JSONArray;
 declare function isJSONObject(value: unknown): value is JSONObject;
 
+type ImageModelV3CallOptions = {
+    /**
+  Prompt for the image generation.
+       */
+    prompt: string;
+    /**
+  Number of images to generate.
+   */
+    n: number;
+    /**
+  Size of the images to generate.
+  Must have the format `{width}x{height}`.
+  `undefined` will use the provider's default size.
+   */
+    size: `${number}x${number}` | undefined;
+    /**
+  Aspect ratio of the images to generate.
+  Must have the format `{width}:{height}`.
+  `undefined` will use the provider's default aspect ratio.
+   */
+    aspectRatio: `${number}:${number}` | undefined;
+    /**
+  Seed for the image generation.
+  `undefined` will use the provider's default seed.
+   */
+    seed: number | undefined;
+    /**
+  Additional provider-specific options that are passed through to the provider
+  as body parameters.
+  
+  The outer record is keyed by the provider name, and the inner
+  record is keyed by the provider-specific metadata key.
+  ```ts
+  {
+    "openai": {
+      "style": "vivid"
+    }
+  }
+  ```
+   */
+    providerOptions: SharedV2ProviderOptions;
+    /**
+  Abort signal for cancelling the operation.
+   */
+    abortSignal?: AbortSignal;
+    /**
+  Additional HTTP headers to be sent with the request.
+  Only applicable for HTTP-based providers.
+   */
+    headers?: Record<string, string | undefined>;
+};
+
+/**
+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 ImageModelV3CallWarning = {
+    type: 'unsupported-setting';
+    setting: keyof ImageModelV3CallOptions;
+    details?: string;
+} | {
+    type: 'other';
+    message: string;
+};
+
+type ImageModelV3ProviderMetadata = Record<string, {
+    images: JSONArray;
+} & JSONValue>;
+type GetMaxImagesPerCallFunction$1 = (options: {
+    modelId: string;
+}) => PromiseLike<number | undefined> | number | undefined;
+/**
+Image generation model specification version 3.
+ */
+type ImageModelV3 = {
+    /**
+  The image model must specify which image model interface
+  version it implements. This will allow us to evolve the image
+  model interface and retain backwards compatibility. The different
+  implementation versions can be handled as a discriminated union
+  on our side.
+     */
+    readonly specificationVersion: 'v3';
+    /**
+  Name of the provider for logging purposes.
+     */
+    readonly provider: string;
+    /**
+  Provider-specific model ID for logging purposes.
+     */
+    readonly modelId: string;
+    /**
+  Limit of how many images can be generated in a single API call.
+  Can be set to a number for a fixed limit, to undefined to use
+  the global limit, or a function that returns a number or undefined,
+  optionally as a promise.
+     */
+    readonly maxImagesPerCall: number | undefined | GetMaxImagesPerCallFunction$1;
+    /**
+  Generates an array of images.
+     */
+    doGenerate(options: ImageModelV3CallOptions): PromiseLike<{
+        /**
+    Generated images as base64 encoded strings or binary data.
+    The images should be returned without any unnecessary conversion.
+    If the API returns base64 encoded strings, the images should be returned
+    as base64 encoded strings. If the API returns binary data, the images should
+    be returned as binary data.
+         */
+        images: Array<string> | Array<Uint8Array>;
+        /**
+    Warnings for the call, e.g. unsupported settings.
+         */
+        warnings: Array<ImageModelV3CallWarning>;
+        /**
+    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.
+    
+    The outer record is keyed by the provider name, and the inner
+    record is provider-specific metadata. It always includes an
+    `images` key with image-specific metadata
+    
+    ```ts
+    {
+      "openai": {
+        "images": ["revisedPrompt": "Revised prompt here."]
+      }
+    }
+    ```
+          */
+        providerMetadata?: ImageModelV3ProviderMetadata;
+        /**
+    Response information for telemetry and debugging purposes.
+         */
+        response: {
+            /**
+      Timestamp for the start of the generated response.
+            */
+            timestamp: Date;
+            /**
+      The ID of the response model that was used to generate the response.
+            */
+            modelId: string;
+            /**
+      Response headers.
+            */
+            headers: Record<string, string> | undefined;
+        };
+    }>;
+};
+
 type ImageModelV2CallOptions = {
     /**
   Prompt for the image generation.
@@ -546,28 +698,753 @@ type ImageModelV2CallWarning = {
     setting: keyof ImageModelV2CallOptions;
     details?: string;
 } | {
-    type: 'other';
-    message: string;
+    type: 'other';
+    message: string;
+};
+
+type ImageModelV2ProviderMetadata = Record<string, {
+    images: JSONArray;
+} & JSONValue>;
+type GetMaxImagesPerCallFunction = (options: {
+    modelId: string;
+}) => PromiseLike<number | undefined> | number | undefined;
+/**
+Image generation model specification version 2.
+ */
+type ImageModelV2 = {
+    /**
+  The image model must specify which image model interface
+  version it implements. This will allow us to evolve the image
+  model interface and retain backwards compatibility. The different
+  implementation versions can be handled as a discriminated union
+  on our side.
+     */
+    readonly specificationVersion: 'v2';
+    /**
+  Name of the provider for logging purposes.
+     */
+    readonly provider: string;
+    /**
+  Provider-specific model ID for logging purposes.
+     */
+    readonly modelId: string;
+    /**
+  Limit of how many images can be generated in a single API call.
+  Can be set to a number for a fixed limit, to undefined to use
+  the global limit, or a function that returns a number or undefined,
+  optionally as a promise.
+     */
+    readonly maxImagesPerCall: number | undefined | GetMaxImagesPerCallFunction;
+    /**
+  Generates an array of images.
+     */
+    doGenerate(options: ImageModelV2CallOptions): PromiseLike<{
+        /**
+    Generated images as base64 encoded strings or binary data.
+    The images should be returned without any unnecessary conversion.
+    If the API returns base64 encoded strings, the images should be returned
+    as base64 encoded strings. If the API returns binary data, the images should
+    be returned as binary data.
+         */
+        images: Array<string> | Array<Uint8Array>;
+        /**
+    Warnings for the call, e.g. unsupported settings.
+         */
+        warnings: Array<ImageModelV2CallWarning>;
+        /**
+    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.
+    
+    The outer record is keyed by the provider name, and the inner
+    record is provider-specific metadata. It always includes an
+    `images` key with image-specific metadata
+    
+    ```ts
+    {
+      "openai": {
+        "images": ["revisedPrompt": "Revised prompt here."]
+      }
+    }
+    ```
+          */
+        providerMetadata?: ImageModelV2ProviderMetadata;
+        /**
+    Response information for telemetry and debugging purposes.
+         */
+        response: {
+            /**
+      Timestamp for the start of the generated response.
+            */
+            timestamp: Date;
+            /**
+      The ID of the response model that was used to generate the response.
+            */
+            modelId: string;
+            /**
+      Response headers.
+            */
+            headers: Record<string, string> | undefined;
+        };
+    }>;
+};
+
+/**
+A tool has a name, a description, and a set of parameters.
+
+Note: this is **not** the user-facing tool definition. The AI SDK methods will
+map the user-facing tool definitions to this format.
+ */
+type LanguageModelV3FunctionTool = {
+    /**
+  The type of the tool (always 'function').
+     */
+    type: 'function';
+    /**
+  The name of the tool. Unique within this model call.
+     */
+    name: string;
+    /**
+  A description of the tool. The language model uses this to understand the
+  tool's purpose and to provide better completion suggestions.
+     */
+    description?: string;
+    /**
+  The parameters that the tool expects. The language model uses this to
+  understand the tool's input requirements and to provide matching suggestions.
+     */
+    inputSchema: JSONSchema7;
+    /**
+  The provider-specific options for the tool.
+     */
+    providerOptions?: SharedV2ProviderOptions;
+};
+
+/**
+Data content. Can be a Uint8Array, base64 encoded data as a string or a URL.
+*/
+type LanguageModelV3DataContent = Uint8Array | string | URL;
+
+/**
+A prompt is a list of messages.
+
+Note: Not all models and prompt formats support multi-modal inputs and
+tool calls. The validation happens at runtime.
+
+Note: This is not a user-facing prompt. The AI SDK methods will map the
+user-facing prompt types such as chat or instruction prompts to this format.
+ */
+type LanguageModelV3Prompt = Array<LanguageModelV3Message>;
+type LanguageModelV3Message = ({
+    role: 'system';
+    content: string;
+} | {
+    role: 'user';
+    content: Array<LanguageModelV3TextPart | LanguageModelV3FilePart>;
+} | {
+    role: 'assistant';
+    content: Array<LanguageModelV3TextPart | LanguageModelV3FilePart | LanguageModelV3ReasoningPart | LanguageModelV3ToolCallPart | LanguageModelV3ToolResultPart>;
+} | {
+    role: 'tool';
+    content: Array<LanguageModelV3ToolResultPart>;
+}) & {
+    /**
+     * 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?: SharedV2ProviderOptions;
+};
+/**
+Text content part of a prompt. It contains a string of text.
+ */
+interface LanguageModelV3TextPart {
+    type: 'text';
+    /**
+  The text content.
+     */
+    text: 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?: SharedV2ProviderOptions;
+}
+/**
+Reasoning content part of a prompt. It contains a string of reasoning text.
+ */
+interface LanguageModelV3ReasoningPart {
+    type: 'reasoning';
+    /**
+  The reasoning text.
+     */
+    text: 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?: SharedV2ProviderOptions;
+}
+/**
+File content part of a prompt. It contains a file.
+ */
+interface LanguageModelV3FilePart {
+    type: 'file';
+    /**
+     * Optional filename of the file.
+     */
+    filename?: string;
+    /**
+  File data. Can be a Uint8Array, base64 encoded data as a string or a URL.
+  */
+    data: LanguageModelV3DataContent;
+    /**
+  IANA media type of the file.
+  
+  Can support wildcards, e.g. `image/*` (in which case the provider needs to take appropriate action).
+  
+  @see https://www.iana.org/assignments/media-types/media-types.xhtml
+     */
+    mediaType: 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?: SharedV2ProviderOptions;
+}
+/**
+Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
+ */
+interface LanguageModelV3ToolCallPart {
+    type: 'tool-call';
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that is being called.
+   */
+    toolName: string;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    input: unknown;
+    /**
+     * Whether the tool call will be executed by the provider.
+     * If this flag is not set or is false, the tool call will be executed by the client.
+     */
+    providerExecuted?: boolean;
+    /**
+     * 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?: SharedV2ProviderOptions;
+}
+/**
+Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
+ */
+interface LanguageModelV3ToolResultPart {
+    type: 'tool-result';
+    /**
+  ID of the tool call that this result is associated with.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that generated this result.
+    */
+    toolName: string;
+    /**
+  Result of the tool call.
+     */
+    output: LanguageModelV3ToolResultOutput;
+    /**
+     * 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?: SharedV2ProviderOptions;
+}
+type LanguageModelV3ToolResultOutput = {
+    type: 'text';
+    value: string;
+} | {
+    type: 'json';
+    value: JSONValue;
+} | {
+    type: 'error-text';
+    value: string;
+} | {
+    type: 'error-json';
+    value: JSONValue;
+} | {
+    type: 'content';
+    value: Array<{
+        type: 'text';
+        /**
+Text content.
+*/
+        text: string;
+    } | {
+        type: 'media';
+        /**
+Base-64 encoded media data.
+*/
+        data: string;
+        /**
+IANA media type.
+@see https://www.iana.org/assignments/media-types/media-types.xhtml
+*/
+        mediaType: string;
+    }>;
+};
+
+/**
+The configuration of a tool that is defined by the provider.
+ */
+type LanguageModelV3ProviderDefinedTool = {
+    /**
+  The type of the tool (always 'provider-defined').
+     */
+    type: 'provider-defined';
+    /**
+  The ID of the tool. Should follow the format `<provider-name>.<unique-tool-name>`.
+     */
+    id: `${string}.${string}`;
+    /**
+  The name of the tool that the user must use in the tool set.
+     */
+    name: string;
+    /**
+  The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
+    */
+    args: Record<string, unknown>;
+};
+
+type LanguageModelV3ToolChoice = {
+    type: 'auto';
+} | {
+    type: 'none';
+} | {
+    type: 'required';
+} | {
+    type: 'tool';
+    toolName: string;
+};
+
+type LanguageModelV3CallOptions = {
+    /**
+  A language mode prompt is a standardized prompt type.
+  
+  Note: This is **not** the user-facing prompt. The AI SDK methods will map the
+  user-facing prompt types such as chat or instruction prompts to this format.
+  That approach allows us to evolve the user  facing prompts without breaking
+  the language model interface.
+     */
+    prompt: LanguageModelV3Prompt;
+    /**
+  Maximum number of tokens to generate.
+     */
+    maxOutputTokens?: number;
+    /**
+  Temperature setting. The range depends on the provider and model.
+   */
+    temperature?: number;
+    /**
+  Stop sequences.
+  If set, the model will stop generating text when one of the stop sequences is generated.
+  Providers may have limits on the number of stop sequences.
+   */
+    stopSequences?: string[];
+    /**
+  Nucleus sampling.
+   */
+    topP?: number;
+    /**
+  Only sample from the top K options for each subsequent token.
+  
+  Used to remove "long tail" low probability responses.
+  Recommended for advanced use cases only. You usually only need to use temperature.
+   */
+    topK?: number;
+    /**
+  Presence penalty setting. It affects the likelihood of the model to
+  repeat information that is already in the prompt.
+   */
+    presencePenalty?: number;
+    /**
+  Frequency penalty setting. It affects the likelihood of the model
+  to repeatedly use the same words or phrases.
+   */
+    frequencyPenalty?: number;
+    /**
+  Response format. The output can either be text or JSON. Default is text.
+  
+  If JSON is selected, a schema can optionally be provided to guide the LLM.
+   */
+    responseFormat?: {
+        type: 'text';
+    } | {
+        type: 'json';
+        /**
+         * JSON schema that the generated output should conform to.
+         */
+        schema?: JSONSchema7;
+        /**
+         * Name of output that should be generated. Used by some providers for additional LLM guidance.
+         */
+        name?: string;
+        /**
+         * Description of the output that should be generated. Used by some providers for additional LLM guidance.
+         */
+        description?: string;
+    };
+    /**
+  The seed (integer) to use for random sampling. If set and supported
+  by the model, calls will generate deterministic results.
+   */
+    seed?: number;
+    /**
+  The tools that are available for the model.
+    */
+    tools?: Array<LanguageModelV3FunctionTool | LanguageModelV3ProviderDefinedTool>;
+    /**
+  Specifies how the tool should be selected. Defaults to 'auto'.
+  */
+    toolChoice?: LanguageModelV3ToolChoice;
+    /**
+  Include raw chunks in the stream. Only applicable for streaming calls.
+   */
+    includeRawChunks?: boolean;
+    /**
+  Abort signal for cancelling the operation.
+   */
+    abortSignal?: AbortSignal;
+    /**
+  Additional HTTP headers to be sent with the request.
+  Only applicable for HTTP-based providers.
+   */
+    headers?: Record<string, string | undefined>;
+    /**
+     * 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?: SharedV2ProviderOptions;
+};
+
+/**
+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 LanguageModelV3CallWarning = {
+    type: 'unsupported-setting';
+    setting: Omit<keyof LanguageModelV3CallOptions, 'prompt'>;
+    details?: string;
+} | {
+    type: 'unsupported-tool';
+    tool: LanguageModelV3FunctionTool | LanguageModelV3ProviderDefinedTool;
+    details?: string;
+} | {
+    type: 'other';
+    message: string;
+};
+
+/**
+A file that has been generated by the model.
+Generated files as base64 encoded strings or binary data.
+The files should be returned without any unnecessary conversion.
+ */
+type LanguageModelV3File = {
+    type: 'file';
+    /**
+  The IANA media type of the file, e.g. `image/png` or `audio/mp3`.
+  
+  @see https://www.iana.org/assignments/media-types/media-types.xhtml
+         */
+    mediaType: string;
+    /**
+  Generated file data as base64 encoded strings or binary data.
+  
+  The file data should be returned without any unnecessary conversion.
+  If the API returns base64 encoded strings, the file data should be returned
+  as base64 encoded strings. If the API returns binary data, the file data should
+  be returned as binary data.
+   */
+    data: string | Uint8Array;
+};
+
+/**
+Reasoning that the model has generated.
+ */
+type LanguageModelV3Reasoning = {
+    type: 'reasoning';
+    text: string;
+    /**
+     * Optional provider-specific metadata for the reasoning part.
+     */
+    providerMetadata?: SharedV2ProviderMetadata;
+};
+
+/**
+A source that has been used as input to generate the response.
+ */
+type LanguageModelV3Source = {
+    type: 'source';
+    /**
+     * The type of source - URL sources reference web content.
+     */
+    sourceType: 'url';
+    /**
+     * The ID of the source.
+     */
+    id: string;
+    /**
+     * The URL of the source.
+     */
+    url: string;
+    /**
+     * The title of the source.
+     */
+    title?: string;
+    /**
+     * Additional provider metadata for the source.
+     */
+    providerMetadata?: SharedV2ProviderMetadata;
+} | {
+    type: 'source';
+    /**
+     * The type of source - document sources reference files/documents.
+     */
+    sourceType: 'document';
+    /**
+     * The ID of the source.
+     */
+    id: string;
+    /**
+     * IANA media type of the document (e.g., 'application/pdf').
+     */
+    mediaType: string;
+    /**
+     * The title of the document.
+     */
+    title: string;
+    /**
+     * Optional filename of the document.
+     */
+    filename?: string;
+    /**
+     * Additional provider metadata for the source.
+     */
+    providerMetadata?: SharedV2ProviderMetadata;
+};
+
+/**
+Text that the model has generated.
+ */
+type LanguageModelV3Text = {
+    type: 'text';
+    /**
+  The text content.
+     */
+    text: string;
+    providerMetadata?: SharedV2ProviderMetadata;
+};
+
+/**
+ * Tool calls that the model has generated.
+ */
+type LanguageModelV3ToolCall = {
+    type: 'tool-call';
+    /**
+     * The identifier of the tool call. It must be unique across all tool calls.
+     */
+    toolCallId: string;
+    /**
+     * The name of the tool that should be called.
+     */
+    toolName: string;
+    /**
+     * Stringified JSON object with the tool call arguments. Must match the
+     * parameters schema of the tool.
+     */
+    input: string;
+    /**
+     * Whether the tool call will be executed by the provider.
+     * If this flag is not set or is false, the tool call will be executed by the client.
+     */
+    providerExecuted?: boolean;
+    /**
+     * Additional provider-specific metadata for the tool call.
+     */
+    providerMetadata?: SharedV2ProviderMetadata;
+};
+
+/**
+Result of a tool call that has been executed by the provider.
+ */
+type LanguageModelV3ToolResult = {
+    type: 'tool-result';
+    /**
+     * The ID of the tool call that this result is associated with.
+     */
+    toolCallId: string;
+    /**
+     * Name of the tool that generated this result.
+     */
+    toolName: string;
+    /**
+     * Result of the tool call. This is a JSON-serializable object.
+     */
+    result: unknown;
+    /**
+     * Optional flag if the result is an error or an error message.
+     */
+    isError?: boolean;
+    /**
+     * Whether the tool result was generated by the provider.
+     * If this flag is set to true, the tool result was generated by the provider.
+     * If this flag is not set or is false, the tool result was generated by the client.
+     */
+    providerExecuted?: boolean;
+    /**
+     * Additional provider-specific metadata for the tool result.
+     */
+    providerMetadata?: SharedV2ProviderMetadata;
+};
+
+type LanguageModelV3Content = LanguageModelV3Text | LanguageModelV3Reasoning | LanguageModelV3File | LanguageModelV3Source | LanguageModelV3ToolCall | LanguageModelV3ToolResult;
+
+/**
+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
+- `unknown`: the model has not transmitted a finish reason
+ */
+type LanguageModelV3FinishReason = 'stop' | 'length' | 'content-filter' | 'tool-calls' | 'error' | 'other' | 'unknown';
+
+interface LanguageModelV3ResponseMetadata {
+    /**
+  ID for the generated response, if the provider sends one.
+       */
+    id?: string;
+    /**
+  Timestamp for the start of the generated response, if the provider sends one.
+  */
+    timestamp?: Date;
+    /**
+  The ID of the response model that was used to generate the response, if the provider sends one.
+  */
+    modelId?: string;
+}
+
+/**
+Usage information for a language model call.
+
+If your API return additional usage information, you can add it to the
+provider metadata under your provider's key.
+ */
+type LanguageModelV3Usage = {
+    /**
+  The number of input (prompt) tokens used.
+     */
+    inputTokens: number | undefined;
+    /**
+  The number of output (completion) tokens used.
+     */
+    outputTokens: number | undefined;
+    /**
+  The total number of tokens as reported by the provider.
+  This number might be different from the sum of `inputTokens` and `outputTokens`
+  and e.g. include reasoning tokens or other overhead.
+     */
+    totalTokens: number | undefined;
+    /**
+  The number of reasoning tokens used.
+     */
+    reasoningTokens?: number | undefined;
+    /**
+  The number of cached input tokens.
+     */
+    cachedInputTokens?: number | undefined;
+};
+
+type LanguageModelV3StreamPart = {
+    type: 'text-start';
+    providerMetadata?: SharedV2ProviderMetadata;
+    id: string;
+} | {
+    type: 'text-delta';
+    id: string;
+    providerMetadata?: SharedV2ProviderMetadata;
+    delta: string;
+} | {
+    type: 'text-end';
+    providerMetadata?: SharedV2ProviderMetadata;
+    id: string;
+} | {
+    type: 'reasoning-start';
+    providerMetadata?: SharedV2ProviderMetadata;
+    id: string;
+} | {
+    type: 'reasoning-delta';
+    id: string;
+    providerMetadata?: SharedV2ProviderMetadata;
+    delta: string;
+} | {
+    type: 'reasoning-end';
+    id: string;
+    providerMetadata?: SharedV2ProviderMetadata;
+} | {
+    type: 'tool-input-start';
+    id: string;
+    toolName: string;
+    providerMetadata?: SharedV2ProviderMetadata;
+    providerExecuted?: boolean;
+} | {
+    type: 'tool-input-delta';
+    id: string;
+    delta: string;
+    providerMetadata?: SharedV2ProviderMetadata;
+} | {
+    type: 'tool-input-end';
+    id: string;
+    providerMetadata?: SharedV2ProviderMetadata;
+} | LanguageModelV3ToolCall | LanguageModelV3ToolResult | LanguageModelV3File | LanguageModelV3Source | {
+    type: 'stream-start';
+    warnings: Array<LanguageModelV3CallWarning>;
+} | ({
+    type: 'response-metadata';
+} & LanguageModelV3ResponseMetadata) | {
+    type: 'finish';
+    usage: LanguageModelV3Usage;
+    finishReason: LanguageModelV3FinishReason;
+    providerMetadata?: SharedV2ProviderMetadata;
+} | {
+    type: 'raw';
+    rawValue: unknown;
+} | {
+    type: 'error';
+    error: unknown;
 };
 
-type ImageModelV2ProviderMetadata = Record<string, {
-    images: JSONArray;
-} & JSONValue>;
-type GetMaxImagesPerCallFunction = (options: {
-    modelId: string;
-}) => PromiseLike<number | undefined> | number | undefined;
 /**
-Image generation model specification version 2.
+Specification for a language model that implements the language model interface version 3.
  */
-type ImageModelV2 = {
+type LanguageModelV3 = {
     /**
-  The image model must specify which image model interface
-  version it implements. This will allow us to evolve the image
-  model interface and retain backwards compatibility. The different
-  implementation versions can be handled as a discriminated union
-  on our side.
+  The language model must specify which language model interface version it implements.
      */
-    readonly specificationVersion: 'v2';
+    readonly specificationVersion: 'v3';
     /**
   Name of the provider for logging purposes.
      */
@@ -577,66 +1454,179 @@ type ImageModelV2 = {
      */
     readonly modelId: string;
     /**
-  Limit of how many images can be generated in a single API call.
-  Can be set to a number for a fixed limit, to undefined to use
-  the global limit, or a function that returns a number or undefined,
-  optionally as a promise.
+  Supported URL patterns by media type for the provider.
+  
+  The keys are media type patterns or full media types (e.g. `*\/*` for everything, `audio/*`, `video/*`, or `application/pdf`).
+  and the values are arrays of regular expressions that match the URL paths.
+  
+  The matching should be against lower-case URLs.
+  
+  Matched URLs are supported natively by the model and are not downloaded.
+  
+  @returns A map of supported URL patterns by media type (as a promise or a plain object).
      */
-    readonly maxImagesPerCall: number | undefined | GetMaxImagesPerCallFunction;
+    supportedUrls: PromiseLike<Record<string, RegExp[]>> | Record<string, RegExp[]>;
     /**
-  Generates an array of images.
+  Generates a language model output (non-streaming).
+  
+  Naming: "do" prefix to prevent accidental direct usage of the method
+  by the user.
      */
-    doGenerate(options: ImageModelV2CallOptions): PromiseLike<{
+    doGenerate(options: LanguageModelV3CallOptions): PromiseLike<{
         /**
-    Generated images as base64 encoded strings or binary data.
-    The images should be returned without any unnecessary conversion.
-    If the API returns base64 encoded strings, the images should be returned
-    as base64 encoded strings. If the API returns binary data, the images should
-    be returned as binary data.
+    Ordered content that the model has generated.
          */
-        images: Array<string> | Array<Uint8Array>;
+        content: Array<LanguageModelV3Content>;
         /**
-    Warnings for the call, e.g. unsupported settings.
+    Finish reason.
          */
-        warnings: Array<ImageModelV2CallWarning>;
+        finishReason: LanguageModelV3FinishReason;
+        /**
+      Usage information.
+         */
+        usage: LanguageModelV3Usage;
         /**
     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.
-    
-    The outer record is keyed by the provider name, and the inner
-    record is provider-specific metadata. It always includes an
-    `images` key with image-specific metadata
-    
-    ```ts
-    {
-      "openai": {
-        "images": ["revisedPrompt": "Revised prompt here."]
-      }
-    }
-    ```
-          */
-        providerMetadata?: ImageModelV2ProviderMetadata;
+         */
+        providerMetadata?: SharedV2ProviderMetadata;
         /**
-    Response information for telemetry and debugging purposes.
+    Optional request information for telemetry and debugging purposes.
          */
-        response: {
+        request?: {
             /**
-      Timestamp for the start of the generated response.
-            */
-            timestamp: Date;
+      Request HTTP body that was sent to the provider API.
+             */
+            body?: unknown;
+        };
+        /**
+    Optional response information for telemetry and debugging purposes.
+         */
+        response?: LanguageModelV3ResponseMetadata & {
             /**
-      The ID of the response model that was used to generate the response.
+      Response headers.
             */
-            modelId: string;
+            headers?: SharedV2Headers;
+            /**
+      Response HTTP body.
+      */
+            body?: unknown;
+        };
+        /**
+    Warnings for the call, e.g. unsupported settings.
+         */
+        warnings: Array<LanguageModelV3CallWarning>;
+    }>;
+    /**
+  Generates a language model output (streaming).
+  
+  Naming: "do" prefix to prevent accidental direct usage of the method
+  by the user.
+     *
+  @return A stream of higher-level language model output parts.
+     */
+    doStream(options: LanguageModelV3CallOptions): PromiseLike<{
+        stream: ReadableStream<LanguageModelV3StreamPart>;
+        /**
+    Optional request information for telemetry and debugging purposes.
+         */
+        request?: {
+            /**
+      Request HTTP body that was sent to the provider API.
+         */
+            body?: unknown;
+        };
+        /**
+    Optional response data.
+         */
+        response?: {
             /**
       Response headers.
-            */
-            headers: Record<string, string> | undefined;
+             */
+            headers?: SharedV2Headers;
         };
     }>;
 };
 
+/**
+ * Experimental middleware for LanguageModelV3.
+ * This type defines the structure for middleware that can be used to modify
+ * the behavior of LanguageModelV3 operations.
+ */
+type LanguageModelV3Middleware = {
+    /**
+     * Middleware specification version. Use `v3` for the current version.
+     */
+    middlewareVersion?: 'v3' | undefined;
+    /**
+     * Override the provider name if desired.
+     * @param options.model - The language model instance.
+     */
+    overrideProvider?: (options: {
+        model: LanguageModelV3;
+    }) => string;
+    /**
+     * Override the model ID if desired.
+     * @param options.model - The language model instance.
+     */
+    overrideModelId?: (options: {
+        model: LanguageModelV3;
+    }) => string;
+    /**
+     * Override the supported URLs if desired.
+     * @param options.model - The language model instance.
+     */
+    overrideSupportedUrls?: (options: {
+        model: LanguageModelV3;
+    }) => PromiseLike<Record<string, RegExp[]>> | Record<string, RegExp[]>;
+    /**
+     * Transforms the parameters before they are passed to the language model.
+     * @param options - Object containing the type of operation and the parameters.
+     * @param options.type - The type of operation ('generate' or 'stream').
+     * @param options.params - The original parameters for the language model call.
+     * @returns A promise that resolves to the transformed parameters.
+     */
+    transformParams?: (options: {
+        type: 'generate' | 'stream';
+        params: LanguageModelV3CallOptions;
+        model: LanguageModelV3;
+    }) => PromiseLike<LanguageModelV3CallOptions>;
+    /**
+     * Wraps the generate operation of the language model.
+     * @param options - Object containing the generate function, parameters, and model.
+     * @param options.doGenerate - The original generate function.
+     * @param options.doStream - The original stream function.
+     * @param options.params - The parameters for the generate call. If the
+     * `transformParams` middleware is used, this will be the transformed parameters.
+     * @param options.model - The language model instance.
+     * @returns A promise that resolves to the result of the generate operation.
+     */
+    wrapGenerate?: (options: {
+        doGenerate: () => ReturnType<LanguageModelV3['doGenerate']>;
+        doStream: () => ReturnType<LanguageModelV3['doStream']>;
+        params: LanguageModelV3CallOptions;
+        model: LanguageModelV3;
+    }) => Promise<Awaited<ReturnType<LanguageModelV3['doGenerate']>>>;
+    /**
+     * Wraps the stream operation of the language model.
+     *
+     * @param options - Object containing the stream function, parameters, and model.
+     * @param options.doGenerate - The original generate function.
+     * @param options.doStream - The original stream function.
+     * @param options.params - The parameters for the stream call. If the
+     * `transformParams` middleware is used, this will be the transformed parameters.
+     * @param options.model - The language model instance.
+     * @returns A promise that resolves to the result of the stream operation.
+     */
+    wrapStream?: (options: {
+        doGenerate: () => ReturnType<LanguageModelV3['doGenerate']>;
+        doStream: () => ReturnType<LanguageModelV3['doStream']>;
+        params: LanguageModelV3CallOptions;
+        model: LanguageModelV3;
+    }) => PromiseLike<Awaited<ReturnType<LanguageModelV3['doStream']>>>;
+};
+
 /**
 A tool has a name, a description, and a set of parameters.
 
@@ -1767,6 +2757,61 @@ type TranscriptionModelV2 = {
     }>;
 };
 
+/**
+ * Provider for language, text embedding, and image generation models.
+ */
+interface ProviderV3 {
+    /**
+  Returns the language model with the given id.
+  The model id is then passed to the provider function to get the model.
+  
+  @param {string} modelId - The id of the model to return.
+  
+  @returns {LanguageModel} The language model associated with the id
+  
+  @throws {NoSuchModelError} If no such model exists.
+     */
+    languageModel(modelId: string): LanguageModelV3;
+    /**
+  Returns the text embedding model with the given id.
+  The model id is then passed to the provider function to get the model.
+  
+  @param {string} modelId - The id of the model to return.
+  
+  @returns {LanguageModel} The language model associated with the id
+  
+  @throws {NoSuchModelError} If no such model exists.
+     */
+    textEmbeddingModel(modelId: string): EmbeddingModelV3<string>;
+    /**
+  Returns the image model with the given id.
+  The model id is then passed to the provider function to get the model.
+  
+  @param {string} modelId - The id of the model to return.
+  
+  @returns {ImageModel} The image model associated with the id
+  */
+    imageModel(modelId: string): ImageModelV3;
+    /**
+  Returns the transcription model with the given id.
+  The model id is then passed to the provider function to get the model.
+  
+  @param {string} modelId - The id of the model to return.
+  
+  @returns {TranscriptionModel} The transcription model associated with the id
+    */
+    transcriptionModel?(modelId: string): TranscriptionModelV2;
+    /**
+  Returns the speech model with the given id.
+  The model id is then passed to the provider function to get the model.
+  
+  @param {string} modelId - The id of the model to return.
+  
+  @returns {SpeechModel} The speech model associated with the id
+    */
+    speechModel?(modelId: string): SpeechModelV2;
+}
+
 /**
  * Provider for language, text embedding, and image generation models.
  */
@@ -1792,7 +2837,7 @@ interface ProviderV2 {
   
   @throws {NoSuchModelError} If no such model exists.
      */
-    textEmbeddingModel(modelId: string): EmbeddingModelV3<string>;
+    textEmbeddingModel(modelId: string): EmbeddingModelV2<string>;
     /**
   Returns the image model with the given id.
   The model id is then passed to the provider function to get the model.
@@ -1822,4 +2867,4 @@ interface ProviderV2 {
     speechModel?(modelId: string): SpeechModelV2;
 }
 
-export { AISDKError, APICallError, type EmbeddingModelV2, type EmbeddingModelV2Embedding, type EmbeddingModelV3, type EmbeddingModelV3Embedding, EmptyResponseBodyError, type ImageModelV2, type ImageModelV2CallOptions, type ImageModelV2CallWarning, type ImageModelV2ProviderMetadata, InvalidArgumentError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV2, type LanguageModelV2CallOptions, type LanguageModelV2CallWarning, type LanguageModelV2Content, type LanguageModelV2DataContent, type LanguageModelV2File, type LanguageModelV2FilePart, type LanguageModelV2FinishReason, type LanguageModelV2FunctionTool, type LanguageModelV2Message, type LanguageModelV2Middleware, type LanguageModelV2Prompt, type LanguageModelV2ProviderDefinedTool, type LanguageModelV2Reasoning, type LanguageModelV2ReasoningPart, type LanguageModelV2ResponseMetadata, type LanguageModelV2Source, type LanguageModelV2StreamPart, type LanguageModelV2Text, type LanguageModelV2TextPart, type LanguageModelV2ToolCall, type LanguageModelV2ToolCallPart, type LanguageModelV2ToolChoice, type LanguageModelV2ToolResultOutput, type LanguageModelV2ToolResultPart, type LanguageModelV2Usage, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV2, type SharedV2Headers, type SharedV2ProviderMetadata, type SharedV2ProviderOptions, type SpeechModelV2, type SpeechModelV2CallOptions, type SpeechModelV2CallWarning, TooManyEmbeddingValuesForCallError, type TranscriptionModelV2, type TranscriptionModelV2CallOptions, type TranscriptionModelV2CallWarning, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };
+export { AISDKError, APICallError, type EmbeddingModelV2, type EmbeddingModelV2Embedding, type EmbeddingModelV3, type EmbeddingModelV3Embedding, EmptyResponseBodyError, type ImageModelV2, type ImageModelV2CallOptions, type ImageModelV2CallWarning, type ImageModelV2ProviderMetadata, type ImageModelV3, type ImageModelV3CallOptions, type ImageModelV3CallWarning, type ImageModelV3ProviderMetadata, InvalidArgumentError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV2, type LanguageModelV2CallOptions, type LanguageModelV2CallWarning, type LanguageModelV2Content, type LanguageModelV2DataContent, type LanguageModelV2File, type LanguageModelV2FilePart, type LanguageModelV2FinishReason, type LanguageModelV2FunctionTool, type LanguageModelV2Message, type LanguageModelV2Middleware, type LanguageModelV2Prompt, type LanguageModelV2ProviderDefinedTool, type LanguageModelV2Reasoning, type LanguageModelV2ReasoningPart, type LanguageModelV2ResponseMetadata, type LanguageModelV2Source, type LanguageModelV2StreamPart, type LanguageModelV2Text, type LanguageModelV2TextPart, type LanguageModelV2ToolCall, type LanguageModelV2ToolCallPart, type LanguageModelV2ToolChoice, type LanguageModelV2ToolResultOutput, type LanguageModelV2ToolResultPart, type LanguageModelV2Usage, type LanguageModelV3, type LanguageModelV3CallOptions, type LanguageModelV3CallWarning, type LanguageModelV3Content, type LanguageModelV3DataContent, type LanguageModelV3File, type LanguageModelV3FilePart, type LanguageModelV3FinishReason, type LanguageModelV3FunctionTool, type LanguageModelV3Message, type LanguageModelV3Middleware, type LanguageModelV3Prompt, type LanguageModelV3ProviderDefinedTool, type LanguageModelV3Reasoning, type LanguageModelV3ReasoningPart, type LanguageModelV3ResponseMetadata, type LanguageModelV3Source, type LanguageModelV3StreamPart, type LanguageModelV3Text, type LanguageModelV3TextPart, type LanguageModelV3ToolCall, type LanguageModelV3ToolCallPart, type LanguageModelV3ToolChoice, type LanguageModelV3ToolResult, type LanguageModelV3ToolResultOutput, type LanguageModelV3ToolResultPart, type LanguageModelV3Usage, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV2, type ProviderV3, type SharedV2Headers, type SharedV2ProviderMetadata, type SharedV2ProviderOptions, type SpeechModelV2, type SpeechModelV2CallOptions, type SpeechModelV2CallWarning, TooManyEmbeddingValuesForCallError, type TranscriptionModelV2, type TranscriptionModelV2CallOptions, type TranscriptionModelV2CallWarning, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };