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

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { JSONSchema7 } from 'json-schema';
 export { JSONSchema7, JSONSchema7Definition } from 'json-schema';
 
-type SharedV2Headers = Record<string, string>;
+type SharedV3Headers = Record<string, string>;
 
 /**
 A JSON value can be a string, number, boolean, object, array, or null.
@@ -13,6 +13,54 @@ type JSONObject = {
 };
 type JSONArray = JSONValue[];
 
+/**
+ * Additional provider-specific metadata.
+ * Metadata are additional outputs from the provider.
+ * They are passed through to the provider from the AI SDK
+ * and enable provider-specific functionality
+ * that can be fully encapsulated in the provider.
+ *
+ * This enables us to quickly ship provider-specific functionality
+ * without affecting the core AI SDK.
+ *
+ * The outer record is keyed by the provider name, and the inner
+ * record is keyed by the provider-specific metadata key.
+ *
+ * ```ts
+ * {
+ *   "anthropic": {
+ *     "cacheControl": { "type": "ephemeral" }
+ *   }
+ * }
+ * ```
+ */
+type SharedV3ProviderMetadata = Record<string, Record<string, JSONValue>>;
+
+/**
+ * Additional provider-specific options.
+ * Options are additional input to the provider.
+ * They are passed through to the provider from the AI SDK
+ * and enable provider-specific functionality
+ * that can be fully encapsulated in the provider.
+ *
+ * This enables us to quickly ship provider-specific functionality
+ * without affecting the core AI SDK.
+ *
+ * The outer record is keyed by the provider name, and the inner
+ * record is keyed by the provider-specific metadata key.
+ *
+ * ```ts
+ * {
+ *   "anthropic": {
+ *     "cacheControl": { "type": "ephemeral" }
+ *   }
+ * }
+ * ```
+ */
+type SharedV3ProviderOptions = Record<string, Record<string, JSONValue>>;
+
+type SharedV2Headers = Record<string, string>;
+
 /**
  * Additional provider-specific metadata.
  * Metadata are additional outputs from the provider.
@@ -120,7 +168,7 @@ type EmbeddingModelV3<VALUE> = {
     to the provider from the AI SDK and enable provider-specific
     functionality that can be fully encapsulated in the provider.
         */
-        providerOptions?: SharedV2ProviderOptions;
+        providerOptions?: SharedV3ProviderOptions;
         /**
       Additional HTTP headers to be sent with the request.
       Only applicable for HTTP-based providers.
@@ -142,7 +190,7 @@ type EmbeddingModelV3<VALUE> = {
     from the provider to the AI SDK and enable provider-specific
     results that can be fully encapsulated in the provider.
          */
-        providerMetadata?: SharedV2ProviderMetadata;
+        providerMetadata?: SharedV3ProviderMetadata;
         /**
     Optional response information for debugging purposes.
          */
@@ -150,7 +198,7 @@ type EmbeddingModelV3<VALUE> = {
             /**
       Response headers.
              */
-            headers?: SharedV2Headers;
+            headers?: SharedV3Headers;
             /**
             The response body.
             */
@@ -525,7 +573,7 @@ type ImageModelV3CallOptions = {
   }
   ```
    */
-    providerOptions: SharedV2ProviderOptions;
+    providerOptions: SharedV3ProviderOptions;
     /**
   Abort signal for cancelling the operation.
    */
@@ -817,7 +865,7 @@ type LanguageModelV3FunctionTool = {
     /**
   The provider-specific options for the tool.
      */
-    providerOptions?: SharedV2ProviderOptions;
+    providerOptions?: SharedV3ProviderOptions;
 };
 
 /**
@@ -853,7 +901,7 @@ type LanguageModelV3Message = ({
      * to the provider from the AI SDK and enable provider-specific
      * functionality that can be fully encapsulated in the provider.
      */
-    providerOptions?: SharedV2ProviderOptions;
+    providerOptions?: SharedV3ProviderOptions;
 };
 /**
 Text content part of a prompt. It contains a string of text.
@@ -869,7 +917,7 @@ interface LanguageModelV3TextPart {
      * to the provider from the AI SDK and enable provider-specific
      * functionality that can be fully encapsulated in the provider.
      */
-    providerOptions?: SharedV2ProviderOptions;
+    providerOptions?: SharedV3ProviderOptions;
 }
 /**
 Reasoning content part of a prompt. It contains a string of reasoning text.
@@ -885,7 +933,7 @@ interface LanguageModelV3ReasoningPart {
      * to the provider from the AI SDK and enable provider-specific
      * functionality that can be fully encapsulated in the provider.
      */
-    providerOptions?: SharedV2ProviderOptions;
+    providerOptions?: SharedV3ProviderOptions;
 }
 /**
 File content part of a prompt. It contains a file.
@@ -913,7 +961,7 @@ interface LanguageModelV3FilePart {
      * to the provider from the AI SDK and enable provider-specific
      * functionality that can be fully encapsulated in the provider.
      */
-    providerOptions?: SharedV2ProviderOptions;
+    providerOptions?: SharedV3ProviderOptions;
 }
 /**
 Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
@@ -942,7 +990,7 @@ interface LanguageModelV3ToolCallPart {
      * to the provider from the AI SDK and enable provider-specific
      * functionality that can be fully encapsulated in the provider.
      */
-    providerOptions?: SharedV2ProviderOptions;
+    providerOptions?: SharedV3ProviderOptions;
 }
 /**
 Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
@@ -966,14 +1014,26 @@ interface LanguageModelV3ToolResultPart {
      * to the provider from the AI SDK and enable provider-specific
      * functionality that can be fully encapsulated in the provider.
      */
-    providerOptions?: SharedV2ProviderOptions;
+    providerOptions?: SharedV3ProviderOptions;
 }
+/**
+ * Result of a tool call.
+ */
 type LanguageModelV3ToolResultOutput = {
     type: 'text';
     value: string;
 } | {
     type: 'json';
     value: JSONValue;
+} | {
+    /**
+     * Type when the user has denied the execution of the tool call.
+     */
+    type: 'execution-denied';
+    /**
+     * Optional reason for the execution denial.
+     */
+    reason?: string;
 } | {
     type: 'error-text';
     value: string;
@@ -1133,7 +1193,7 @@ type LanguageModelV3CallOptions = {
      * to the provider from the AI SDK and enable provider-specific
      * functionality that can be fully encapsulated in the provider.
      */
-    providerOptions?: SharedV2ProviderOptions;
+    providerOptions?: SharedV3ProviderOptions;
 };
 
 /**
@@ -1186,7 +1246,7 @@ type LanguageModelV3Reasoning = {
     /**
      * Optional provider-specific metadata for the reasoning part.
      */
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
 };
 
 /**
@@ -1213,7 +1273,7 @@ type LanguageModelV3Source = {
     /**
      * Additional provider metadata for the source.
      */
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
 } | {
     type: 'source';
     /**
@@ -1239,7 +1299,7 @@ type LanguageModelV3Source = {
     /**
      * Additional provider metadata for the source.
      */
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
 };
 
 /**
@@ -1251,7 +1311,7 @@ type LanguageModelV3Text = {
   The text content.
      */
     text: string;
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
 };
 
 /**
@@ -1280,7 +1340,7 @@ type LanguageModelV3ToolCall = {
     /**
      * Additional provider-specific metadata for the tool call.
      */
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
 };
 
 /**
@@ -1306,14 +1366,25 @@ type LanguageModelV3ToolResult = {
     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;
+    /**
+     * Whether the tool result is preliminary.
+     *
+     * Preliminary tool results replace each other, e.g. image previews.
+     * There always has to be a final, non-preliminary tool result.
+     *
+     * If this flag is set to true, the tool result is preliminary.
+     * If this flag is not set or is false, the tool result is not preliminary.
+     */
+    preliminary?: boolean;
     /**
      * Additional provider-specific metadata for the tool result.
      */
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
 };
 
 type LanguageModelV3Content = LanguageModelV3Text | LanguageModelV3Reasoning | LanguageModelV3File | LanguageModelV3Source | LanguageModelV3ToolCall | LanguageModelV3ToolResult;
@@ -1380,45 +1451,45 @@ type LanguageModelV3Usage = {
 
 type LanguageModelV3StreamPart = {
     type: 'text-start';
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
     id: string;
 } | {
     type: 'text-delta';
     id: string;
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
     delta: string;
 } | {
     type: 'text-end';
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
     id: string;
 } | {
     type: 'reasoning-start';
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
     id: string;
 } | {
     type: 'reasoning-delta';
     id: string;
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
     delta: string;
 } | {
     type: 'reasoning-end';
     id: string;
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
 } | {
     type: 'tool-input-start';
     id: string;
     toolName: string;
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
     providerExecuted?: boolean;
 } | {
     type: 'tool-input-delta';
     id: string;
     delta: string;
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
 } | {
     type: 'tool-input-end';
     id: string;
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
 } | LanguageModelV3ToolCall | LanguageModelV3ToolResult | LanguageModelV3File | LanguageModelV3Source | {
     type: 'stream-start';
     warnings: Array<LanguageModelV3CallWarning>;
@@ -1428,7 +1499,7 @@ type LanguageModelV3StreamPart = {
     type: 'finish';
     usage: LanguageModelV3Usage;
     finishReason: LanguageModelV3FinishReason;
-    providerMetadata?: SharedV2ProviderMetadata;
+    providerMetadata?: SharedV3ProviderMetadata;
 } | {
     type: 'raw';
     rawValue: unknown;
@@ -1490,7 +1561,7 @@ type LanguageModelV3 = {
     from the provider to the AI SDK and enable provider-specific
     results that can be fully encapsulated in the provider.
          */
-        providerMetadata?: SharedV2ProviderMetadata;
+        providerMetadata?: SharedV3ProviderMetadata;
         /**
     Optional request information for telemetry and debugging purposes.
          */
@@ -1507,7 +1578,7 @@ type LanguageModelV3 = {
             /**
       Response headers.
             */
-            headers?: SharedV2Headers;
+            headers?: SharedV3Headers;
             /**
       Response HTTP body.
       */
@@ -1544,7 +1615,7 @@ type LanguageModelV3 = {
             /**
       Response headers.
              */
-            headers?: SharedV2Headers;
+            headers?: SharedV3Headers;
         };
     }>;
 };
@@ -2465,8 +2536,8 @@ type LanguageModelV2Middleware = {
     }) => PromiseLike<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
 };
 
-type SpeechModelV2ProviderOptions = Record<string, Record<string, JSONValue>>;
-type SpeechModelV2CallOptions = {
+type SpeechModelV3ProviderOptions = Record<string, Record<string, JSONValue>>;
+type SpeechModelV3CallOptions = {
     /**
      * Text to convert to speech.
      */
@@ -2505,7 +2576,7 @@ type SpeechModelV2CallOptions = {
      * }
      * ```
      */
-    providerOptions?: SpeechModelV2ProviderOptions;
+    providerOptions?: SpeechModelV3ProviderOptions;
     /**
      * Abort signal for cancelling the operation.
      */
@@ -2521,9 +2592,9 @@ type SpeechModelV2CallOptions = {
  * 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 SpeechModelV2CallWarning = {
+type SpeechModelV3CallWarning = {
     type: 'unsupported-setting';
-    setting: keyof SpeechModelV2CallOptions;
+    setting: keyof SpeechModelV3CallOptions;
     details?: string;
 } | {
     type: 'other';
@@ -2531,9 +2602,9 @@ type SpeechModelV2CallWarning = {
 };
 
 /**
- * Speech model specification version 2.
+ * Speech model specification version 3.
  */
-type SpeechModelV2 = {
+type SpeechModelV3 = {
     /**
      * The speech model must specify which speech model interface
      * version it implements. This will allow us to evolve the speech
@@ -2541,7 +2612,7 @@ type SpeechModelV2 = {
      * implementation versions can be handled as a discriminated union
      * on our side.
      */
-    readonly specificationVersion: 'v2';
+    readonly specificationVersion: 'v3';
     /**
      * Name of the provider for logging purposes.
      */
@@ -2553,7 +2624,7 @@ type SpeechModelV2 = {
     /**
      * Generates speech audio from text.
      */
-    doGenerate(options: SpeechModelV2CallOptions): PromiseLike<{
+    doGenerate(options: SpeechModelV3CallOptions): PromiseLike<{
         /**
          * Generated audio as an ArrayBuffer.
          * The audio should be returned without any unnecessary conversion.
@@ -2565,7 +2636,7 @@ type SpeechModelV2 = {
         /**
          * Warnings for the call, e.g. unsupported settings.
          */
-        warnings: Array<SpeechModelV2CallWarning>;
+        warnings: Array<SpeechModelV3CallWarning>;
         /**
          * Optional request information for telemetry and debugging purposes.
          */
@@ -2605,8 +2676,8 @@ type SpeechModelV2 = {
     }>;
 };
 
-type TranscriptionModelV2ProviderOptions = Record<string, Record<string, JSONValue>>;
-type TranscriptionModelV2CallOptions = {
+type TranscriptionModelV3ProviderOptions = Record<string, Record<string, JSONValue>>;
+type TranscriptionModelV3CallOptions = {
     /**
   Audio data to transcribe.
   Accepts a `Uint8Array` or `string`, where `string` is a base64 encoded audio file.
@@ -2632,7 +2703,7 @@ type TranscriptionModelV2CallOptions = {
   }
   ```
    */
-    providerOptions?: TranscriptionModelV2ProviderOptions;
+    providerOptions?: TranscriptionModelV3ProviderOptions;
     /**
   Abort signal for cancelling the operation.
    */
@@ -2648,9 +2719,9 @@ type TranscriptionModelV2CallOptions = {
 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 TranscriptionModelV2CallWarning = {
+type TranscriptionModelV3CallWarning = {
     type: 'unsupported-setting';
-    setting: keyof TranscriptionModelV2CallOptions;
+    setting: keyof TranscriptionModelV3CallOptions;
     details?: string;
 } | {
     type: 'other';
@@ -2658,9 +2729,9 @@ type TranscriptionModelV2CallWarning = {
 };
 
 /**
-Transcription model specification version 2.
+Transcription model specification version 3.
  */
-type TranscriptionModelV2 = {
+type TranscriptionModelV3 = {
     /**
   The transcription model must specify which transcription model interface
   version it implements. This will allow us to evolve the transcription
@@ -2668,7 +2739,7 @@ type TranscriptionModelV2 = {
   implementation versions can be handled as a discriminated union
   on our side.
      */
-    readonly specificationVersion: 'v2';
+    readonly specificationVersion: 'v3';
     /**
   Name of the provider for logging purposes.
      */
@@ -2680,7 +2751,7 @@ type TranscriptionModelV2 = {
     /**
   Generates a transcript.
      */
-    doGenerate(options: TranscriptionModelV2CallOptions): PromiseLike<{
+    doGenerate(options: TranscriptionModelV3CallOptions): PromiseLike<{
         /**
          * The complete transcribed text from the audio.
          */
@@ -2716,7 +2787,7 @@ type TranscriptionModelV2 = {
         /**
     Warnings for the call, e.g. unsupported settings.
          */
-        warnings: Array<TranscriptionModelV2CallWarning>;
+        warnings: Array<TranscriptionModelV3CallWarning>;
         /**
     Optional request information for telemetry and debugging purposes.
          */
@@ -2742,7 +2813,7 @@ type TranscriptionModelV2 = {
             /**
       Response headers.
             */
-            headers?: SharedV2Headers;
+            headers?: SharedV3Headers;
             /**
       Response body.
             */
@@ -2800,7 +2871,7 @@ interface ProviderV3 {
   
   @returns {TranscriptionModel} The transcription model associated with the id
     */
-    transcriptionModel?(modelId: string): TranscriptionModelV2;
+    transcriptionModel?(modelId: string): TranscriptionModelV3;
     /**
   Returns the speech model with the given id.
   The model id is then passed to the provider function to get the model.
@@ -2809,9 +2880,301 @@ interface ProviderV3 {
   
   @returns {SpeechModel} The speech model associated with the id
     */
-    speechModel?(modelId: string): SpeechModelV2;
+    speechModel?(modelId: string): SpeechModelV3;
 }
 
+type SpeechModelV2ProviderOptions = Record<string, Record<string, JSONValue>>;
+type SpeechModelV2CallOptions = {
+    /**
+     * Text to convert to speech.
+     */
+    text: string;
+    /**
+     * The voice to use for speech synthesis.
+     * This is provider-specific and may be a voice ID, name, or other identifier.
+     */
+    voice?: string;
+    /**
+     * The desired output format for the audio e.g. "mp3", "wav", etc.
+     */
+    outputFormat?: string;
+    /**
+     * Instructions for the speech generation e.g. "Speak in a slow and steady tone".
+     */
+    instructions?: string;
+    /**
+     * The speed of the speech generation.
+     */
+    speed?: number;
+    /**
+     * The language for speech generation. This should be an ISO 639-1 language code (e.g. "en", "es", "fr")
+     * or "auto" for automatic language detection. Provider support varies.
+     */
+    language?: string;
+    /**
+     * 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": {}
+     * }
+     * ```
+     */
+    providerOptions?: SpeechModelV2ProviderOptions;
+    /**
+     * 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 SpeechModelV2CallWarning = {
+    type: 'unsupported-setting';
+    setting: keyof SpeechModelV2CallOptions;
+    details?: string;
+} | {
+    type: 'other';
+    message: string;
+};
+
+/**
+ * Speech model specification version 2.
+ */
+type SpeechModelV2 = {
+    /**
+     * The speech model must specify which speech model interface
+     * version it implements. This will allow us to evolve the speech
+     * 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;
+    /**
+     * Generates speech audio from text.
+     */
+    doGenerate(options: SpeechModelV2CallOptions): PromiseLike<{
+        /**
+         * Generated audio as an ArrayBuffer.
+         * The audio should be returned without any unnecessary conversion.
+         * If the API returns base64 encoded strings, the audio should be returned
+         * as base64 encoded strings. If the API returns binary data, the audio
+         * should be returned as binary data.
+         */
+        audio: string | Uint8Array;
+        /**
+         * Warnings for the call, e.g. unsupported settings.
+         */
+        warnings: Array<SpeechModelV2CallWarning>;
+        /**
+         * Optional request information for telemetry and debugging purposes.
+         */
+        request?: {
+            /**
+             * Response body (available only for providers that use HTTP requests).
+             */
+            body?: unknown;
+        };
+        /**
+         * 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?: SharedV2Headers;
+            /**
+             * Response body.
+             */
+            body?: unknown;
+        };
+        /**
+         * 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.
+         */
+        providerMetadata?: Record<string, Record<string, JSONValue>>;
+    }>;
+};
+
+type TranscriptionModelV2ProviderOptions = Record<string, Record<string, JSONValue>>;
+type TranscriptionModelV2CallOptions = {
+    /**
+  Audio data to transcribe.
+  Accepts a `Uint8Array` or `string`, where `string` is a base64 encoded audio file.
+       */
+    audio: Uint8Array | string;
+    /**
+  The IANA media type of the audio data.
+  
+  @see https://www.iana.org/assignments/media-types/media-types.xhtml
+     */
+    mediaType: string;
+    /**
+  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": {
+  "timestampGranularities": ["word"]
+  }
+  }
+  ```
+   */
+    providerOptions?: TranscriptionModelV2ProviderOptions;
+    /**
+  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 TranscriptionModelV2CallWarning = {
+    type: 'unsupported-setting';
+    setting: keyof TranscriptionModelV2CallOptions;
+    details?: string;
+} | {
+    type: 'other';
+    message: string;
+};
+
+/**
+Transcription model specification version 2.
+ */
+type TranscriptionModelV2 = {
+    /**
+  The transcription model must specify which transcription model interface
+  version it implements. This will allow us to evolve the transcription
+  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;
+    /**
+  Generates a transcript.
+     */
+    doGenerate(options: TranscriptionModelV2CallOptions): PromiseLike<{
+        /**
+         * The complete transcribed text from the audio.
+         */
+        text: string;
+        /**
+         * Array of transcript segments with timing information.
+         * Each segment represents a portion of the transcribed text with start and end times.
+         */
+        segments: Array<{
+            /**
+             * The text content of this segment.
+             */
+            text: string;
+            /**
+             * The start time of this segment in seconds.
+             */
+            startSecond: number;
+            /**
+             * The end time of this segment in seconds.
+             */
+            endSecond: number;
+        }>;
+        /**
+         * The detected language of the audio content, as an ISO-639-1 code (e.g., 'en' for English).
+         * May be undefined if the language couldn't be detected.
+         */
+        language: string | undefined;
+        /**
+         * The total duration of the audio file in seconds.
+         * May be undefined if the duration couldn't be determined.
+         */
+        durationInSeconds: number | undefined;
+        /**
+    Warnings for the call, e.g. unsupported settings.
+         */
+        warnings: Array<TranscriptionModelV2CallWarning>;
+        /**
+    Optional request information for telemetry and debugging purposes.
+         */
+        request?: {
+            /**
+      Raw request HTTP body that was sent to the provider API as a string (JSON should be stringified).
+      Non-HTTP(s) providers should not set this.
+             */
+            body?: string;
+        };
+        /**
+    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?: SharedV2Headers;
+            /**
+      Response body.
+            */
+            body?: unknown;
+        };
+        /**
+    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.
+         */
+        providerMetadata?: Record<string, Record<string, JSONValue>>;
+    }>;
+};
+
 /**
  * Provider for language, text embedding, and image generation models.
  */
@@ -2867,4 +3230,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, 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 };
+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 SharedV3Headers, type SharedV3ProviderMetadata, type SharedV3ProviderOptions, type SpeechModelV2, type SpeechModelV2CallOptions, type SpeechModelV2CallWarning, type SpeechModelV3, type SpeechModelV3CallOptions, type SpeechModelV3CallWarning, TooManyEmbeddingValuesForCallError, type TranscriptionModelV2, type TranscriptionModelV2CallOptions, type TranscriptionModelV2CallWarning, type TranscriptionModelV3, type TranscriptionModelV3CallOptions, type TranscriptionModelV3CallWarning, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };