@jerome-benoit/sap-ai-provider-v2 4.9.1 → 5.0.1

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-import { EmbeddingModelV2, SharedV2ProviderOptions, SharedV2ProviderMetadata, SharedV2Headers, LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Content, LanguageModelV2FinishReason, LanguageModelV2ResponseMetadata, LanguageModelV2Usage, LanguageModelV2CallWarning, LanguageModelV2StreamPart, ProviderV2, ImageModelV2 } from '@ai-sdk/provider';
 import { DeploymentIdConfig, ResourceGroupConfig } from '@sap-ai-sdk/ai-api/internal.js';
 import { CustomRequestConfig } from '@sap-ai-sdk/core';
 export { CustomRequestConfig } from '@sap-ai-sdk/core';
@@ -7,6 +6,7 @@ export { HttpDestinationOrFetchOptions } from '@sap-cloud-sdk/connectivity';
 import { AzureOpenAiChatCompletionParameters } from '@sap-ai-sdk/foundation-models';
 import { OrchestrationConfigRefOverride, OrchestrationModuleConfig, FilteringModule, GroundingModule, MaskingModule, OrchestrationConfigRefById, OrchestrationConfigRefByName, ChatCompletionTool, TranslationModule, ChatModel } from '@sap-ai-sdk/orchestration';
 export { AssistantChatMessage, ChatCompletionRequest, ChatCompletionTool, ChatMessage, ChatMessageContent, ChatMessages, Citation, DeveloperChatMessage, DocumentTranslationApplyToSelector, FileContent, FilteringModule, FunctionObject, GroundingModule, ImageContentUrl, LlmModelDetails, LlmModelParams, MaskingModule, OrchestrationClient, OrchestrationConfigRef, OrchestrationConfigRefById, OrchestrationConfigRefByName, OrchestrationConfigRefOverride, OrchestrationEmbeddingClient, OrchestrationEmbeddingResponse, OrchestrationError, OrchestrationErrorResponse, OrchestrationModuleConfig, OrchestrationModuleConfigList, OrchestrationResponse, OrchestrationStream, OrchestrationStreamChunkResponse, OrchestrationStreamResponse, PromptTemplatingModule, SystemChatMessage, ToolChatMessage, TranslationApplyToCategory, TranslationInputParameters, TranslationModule, TranslationOutputParameters, TranslationTargetLanguage, UserChatMessage, UserChatMessageContent, UserChatMessageContentItem, buildAzureContentSafetyFilter, buildDocumentGroundingConfig, buildDpiMaskingProvider, buildLlamaGuard38BFilter, buildTranslationConfig } from '@sap-ai-sdk/orchestration';
+import { SharedV3Warning, LanguageModelV3StreamPart, LanguageModelV2 as LanguageModelV2$1, LanguageModelV2CallOptions as LanguageModelV2CallOptions$1, LanguageModelV3CallOptions } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { InferSchema } from '@ai-sdk/provider-utils';
 
@@ -15,7 +15,7 @@ declare const SAP_AI_PROVIDER_NAME: "sap-ai";
 /**
  * Extracts the provider name from a provider identifier (e.g., "sap-ai.chat" → "sap-ai").
  * @param providerIdentifier - The full provider identifier string.
- * @returns The provider name without any suffix.
+ * @returns The prefix before the first dot, or the unchanged identifier when no dot exists.
  */
 declare function getProviderName(providerIdentifier: string): string;
 /** @internal */
@@ -81,7 +81,6 @@ type SAPAIEmbeddingProviderOptions = InferSchema<typeof sapAIEmbeddingProviderOp
 declare function escapeOrchestrationPlaceholders(text: string): string;
 /**
  * Reverses escaping by removing zero-width spaces from template delimiters.
- *
  * Useful for processing model responses that may contain escaped delimiters.
  * @param text - The text to unescape.
  * @returns The unescaped text with zero-width spaces removed.
@@ -89,13 +88,1602 @@ declare function escapeOrchestrationPlaceholders(text: string): string;
  */
 declare function unescapeOrchestrationPlaceholders(text: string): string;
 
+// ==================================================================================================
+// JSON Schema Draft 07
+// ==================================================================================================
+// https://tools.ietf.org/html/draft-handrews-json-schema-validation-01
+// --------------------------------------------------------------------------------------------------
+
+/**
+ * Primitive type
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
+ */
+type JSONSchema7TypeName =
+    | "string" //
+    | "number"
+    | "integer"
+    | "boolean"
+    | "object"
+    | "array"
+    | "null";
+
+/**
+ * Primitive type
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
+ */
+type JSONSchema7Type =
+    | string //
+    | number
+    | boolean
+    | JSONSchema7Object
+    | JSONSchema7Array
+    | null;
+
+// Workaround for infinite type recursion
+interface JSONSchema7Object {
+    [key: string]: JSONSchema7Type;
+}
+
+// Workaround for infinite type recursion
+// https://github.com/Microsoft/TypeScript/issues/3496#issuecomment-128553540
+interface JSONSchema7Array extends Array<JSONSchema7Type> {}
+
+/**
+ * Meta schema
+ *
+ * Recommended values:
+ * - 'http://json-schema.org/schema#'
+ * - 'http://json-schema.org/hyper-schema#'
+ * - 'http://json-schema.org/draft-07/schema#'
+ * - 'http://json-schema.org/draft-07/hyper-schema#'
+ *
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-5
+ */
+type JSONSchema7Version = string;
+
+/**
+ * JSON Schema v7
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01
+ */
+type JSONSchema7Definition = JSONSchema7 | boolean;
+interface JSONSchema7 {
+    $id?: string | undefined;
+    $ref?: string | undefined;
+    $schema?: JSONSchema7Version | undefined;
+    $comment?: string | undefined;
+
+    /**
+     * @see https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-00#section-8.2.4
+     * @see https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#appendix-A
+     */
+    $defs?: {
+        [key: string]: JSONSchema7Definition;
+    } | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1
+     */
+    type?: JSONSchema7TypeName | JSONSchema7TypeName[] | undefined;
+    enum?: JSONSchema7Type[] | undefined;
+    const?: JSONSchema7Type | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.2
+     */
+    multipleOf?: number | undefined;
+    maximum?: number | undefined;
+    exclusiveMaximum?: number | undefined;
+    minimum?: number | undefined;
+    exclusiveMinimum?: number | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.3
+     */
+    maxLength?: number | undefined;
+    minLength?: number | undefined;
+    pattern?: string | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.4
+     */
+    items?: JSONSchema7Definition | JSONSchema7Definition[] | undefined;
+    additionalItems?: JSONSchema7Definition | undefined;
+    maxItems?: number | undefined;
+    minItems?: number | undefined;
+    uniqueItems?: boolean | undefined;
+    contains?: JSONSchema7Definition | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.5
+     */
+    maxProperties?: number | undefined;
+    minProperties?: number | undefined;
+    required?: string[] | undefined;
+    properties?: {
+        [key: string]: JSONSchema7Definition;
+    } | undefined;
+    patternProperties?: {
+        [key: string]: JSONSchema7Definition;
+    } | undefined;
+    additionalProperties?: JSONSchema7Definition | undefined;
+    dependencies?: {
+        [key: string]: JSONSchema7Definition | string[];
+    } | undefined;
+    propertyNames?: JSONSchema7Definition | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.6
+     */
+    if?: JSONSchema7Definition | undefined;
+    then?: JSONSchema7Definition | undefined;
+    else?: JSONSchema7Definition | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.7
+     */
+    allOf?: JSONSchema7Definition[] | undefined;
+    anyOf?: JSONSchema7Definition[] | undefined;
+    oneOf?: JSONSchema7Definition[] | undefined;
+    not?: JSONSchema7Definition | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-7
+     */
+    format?: string | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-8
+     */
+    contentMediaType?: string | undefined;
+    contentEncoding?: string | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-9
+     */
+    definitions?: {
+        [key: string]: JSONSchema7Definition;
+    } | undefined;
+
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-10
+     */
+    title?: string | undefined;
+    description?: string | undefined;
+    default?: JSONSchema7Type | undefined;
+    readOnly?: boolean | undefined;
+    writeOnly?: boolean | undefined;
+    examples?: JSONSchema7Type | undefined;
+}
+
+type SharedV2Headers = Record<string, string>;
+
+/**
+A JSON value can be a string, number, boolean, object, array, or null.
+JSON values can be serialized and deserialized by the JSON.stringify and JSON.parse methods.
+ */
+type JSONValue = null | string | number | boolean | JSONObject | JSONArray;
+type JSONObject = {
+    [key: string]: JSONValue;
+};
+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 SharedV2ProviderMetadata = 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 SharedV2ProviderOptions = Record<string, Record<string, JSONValue>>;
+
+/**
+An embedding is a vector, i.e. an array of numbers.
+It is e.g. used to represent a text as a vector of word embeddings.
+ */
+type EmbeddingModelV2Embedding = Array<number>;
+
+/**
+Specification for an embedding model that implements the embedding model
+interface version 1.
+
+VALUE is the type of the values that the model can embed.
+This will allow us to go beyond text embeddings in the future,
+e.g. to support image embeddings
+ */
+type EmbeddingModelV2<VALUE> = {
+    /**
+  The embedding model must specify which embedding model interface
+  version it implements. This will allow us to evolve the embedding
+  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 embeddings can be generated in a single API call.
+  
+  Use Infinity for models that do not have a limit.
+     */
+    readonly maxEmbeddingsPerCall: PromiseLike<number | undefined> | number | undefined;
+    /**
+  True if the model can handle multiple embedding calls in parallel.
+     */
+    readonly supportsParallelCalls: PromiseLike<boolean> | boolean;
+    /**
+  Generates a list of embeddings for the given input text.
+  
+  Naming: "do" prefix to prevent accidental direct usage of the method
+  by the user.
+     */
+    doEmbed(options: {
+        /**
+    List of values to embed.
+         */
+        values: Array<VALUE>;
+        /**
+    Abort signal for cancelling the operation.
+         */
+        abortSignal?: AbortSignal;
+        /**
+    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;
+        /**
+      Additional HTTP headers to be sent with the request.
+      Only applicable for HTTP-based providers.
+         */
+        headers?: Record<string, string | undefined>;
+    }): PromiseLike<{
+        /**
+    Generated embeddings. They are in the same order as the input values.
+         */
+        embeddings: Array<EmbeddingModelV2Embedding>;
+        /**
+    Token usage. We only have input tokens for embeddings.
+        */
+        usage?: {
+            tokens: number;
+        };
+        /**
+    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?: SharedV2ProviderMetadata;
+        /**
+    Optional response information for debugging purposes.
+         */
+        response?: {
+            /**
+      Response headers.
+             */
+            headers?: SharedV2Headers;
+            /**
+            The response body.
+            */
+            body?: unknown;
+        };
+    }>;
+};
+
+type ImageModelV2CallOptions = {
+    /**
+  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 ImageModelV2CallWarning = {
+    type: 'unsupported-setting';
+    setting: keyof ImageModelV2CallOptions;
+    details?: 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>;
+        /**
+    Whether an unsuccessful result, such as an empty image result, can be
+    retried. When omitted, the result is unclassified.
+         */
+        isRetryable?: boolean;
+        /**
+    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 LanguageModelV2FunctionTool = {
+    /**
+  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 LanguageModelV2DataContent = 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 LanguageModelV2Prompt = Array<LanguageModelV2Message>;
+type LanguageModelV2Message = ({
+    role: 'system';
+    content: string;
+} | {
+    role: 'user';
+    content: Array<LanguageModelV2TextPart | LanguageModelV2FilePart>;
+} | {
+    role: 'assistant';
+    content: Array<LanguageModelV2TextPart | LanguageModelV2FilePart | LanguageModelV2ReasoningPart | LanguageModelV2ToolCallPart | LanguageModelV2ToolResultPart>;
+} | {
+    role: 'tool';
+    content: Array<LanguageModelV2ToolResultPart>;
+}) & {
+    /**
+     * 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 LanguageModelV2TextPart {
+    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 LanguageModelV2ReasoningPart {
+    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 LanguageModelV2FilePart {
+    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: LanguageModelV2DataContent;
+    /**
+  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 LanguageModelV2ToolCallPart {
+    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 LanguageModelV2ToolResultPart {
+    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: LanguageModelV2ToolResultOutput;
+    /**
+     * 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 LanguageModelV2ToolResultOutput = {
+    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 LanguageModelV2ProviderDefinedTool = {
+    /**
+  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 LanguageModelV2ToolChoice = {
+    type: 'auto';
+} | {
+    type: 'none';
+} | {
+    type: 'required';
+} | {
+    type: 'tool';
+    toolName: string;
+};
+
+type LanguageModelV2CallOptions = {
+    /**
+  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: LanguageModelV2Prompt;
+    /**
+  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<LanguageModelV2FunctionTool | LanguageModelV2ProviderDefinedTool>;
+    /**
+  Specifies how the tool should be selected. Defaults to 'auto'.
+  */
+    toolChoice?: LanguageModelV2ToolChoice;
+    /**
+  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 LanguageModelV2CallWarning = {
+    type: 'unsupported-setting';
+    setting: Omit<keyof LanguageModelV2CallOptions, 'prompt'>;
+    details?: string;
+} | {
+    type: 'unsupported-tool';
+    tool: LanguageModelV2FunctionTool | LanguageModelV2ProviderDefinedTool;
+    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 LanguageModelV2File = {
+    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 LanguageModelV2Reasoning = {
+    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 LanguageModelV2Source = {
+    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 LanguageModelV2Text = {
+    type: 'text';
+    /**
+  The text content.
+     */
+    text: string;
+    providerMetadata?: SharedV2ProviderMetadata;
+};
+
+/**
+ * Tool calls that the model has generated.
+ */
+type LanguageModelV2ToolCall = {
+    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 LanguageModelV2ToolResult = {
+    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 LanguageModelV2Content = LanguageModelV2Text | LanguageModelV2Reasoning | LanguageModelV2File | LanguageModelV2Source | LanguageModelV2ToolCall | LanguageModelV2ToolResult;
+
+/**
+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 LanguageModelV2FinishReason = 'stop' | 'length' | 'content-filter' | 'tool-calls' | 'error' | 'other' | 'unknown';
+
+interface LanguageModelV2ResponseMetadata {
+    /**
+  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 LanguageModelV2Usage = {
+    /**
+  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 LanguageModelV2StreamPart = {
+    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;
+} | LanguageModelV2ToolCall | LanguageModelV2ToolResult | LanguageModelV2File | LanguageModelV2Source | {
+    type: 'stream-start';
+    warnings: Array<LanguageModelV2CallWarning>;
+} | ({
+    type: 'response-metadata';
+} & LanguageModelV2ResponseMetadata) | {
+    type: 'finish';
+    usage: LanguageModelV2Usage;
+    finishReason: LanguageModelV2FinishReason;
+    providerMetadata?: SharedV2ProviderMetadata;
+} | {
+    type: 'raw';
+    rawValue: unknown;
+} | {
+    type: 'error';
+    error: unknown;
+};
+
+/**
+Specification for a language model that implements the language model interface version 2.
+ */
+type LanguageModelV2 = {
+    /**
+  The language model must specify which language model interface version it implements.
+     */
+    readonly specificationVersion: 'v2';
+    /**
+  Name of the provider for logging purposes.
+     */
+    readonly provider: string;
+    /**
+  Provider-specific model ID for logging purposes.
+     */
+    readonly modelId: string;
+    /**
+  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).
+     */
+    supportedUrls: PromiseLike<Record<string, RegExp[]>> | Record<string, RegExp[]>;
+    /**
+  Generates a language model output (non-streaming).
+  
+  Naming: "do" prefix to prevent accidental direct usage of the method
+  by the user.
+     */
+    doGenerate(options: LanguageModelV2CallOptions): PromiseLike<{
+        /**
+    Ordered content that the model has generated.
+         */
+        content: Array<LanguageModelV2Content>;
+        /**
+    Finish reason.
+         */
+        finishReason: LanguageModelV2FinishReason;
+        /**
+      Usage information.
+         */
+        usage: LanguageModelV2Usage;
+        /**
+    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?: SharedV2ProviderMetadata;
+        /**
+    Optional request information for telemetry and debugging purposes.
+         */
+        request?: {
+            /**
+      Request HTTP body that was sent to the provider API.
+             */
+            body?: unknown;
+        };
+        /**
+    Optional response information for telemetry and debugging purposes.
+         */
+        response?: LanguageModelV2ResponseMetadata & {
+            /**
+      Response headers.
+            */
+            headers?: SharedV2Headers;
+            /**
+      Response HTTP body.
+      */
+            body?: unknown;
+        };
+        /**
+    Warnings for the call, e.g. unsupported settings.
+         */
+        warnings: Array<LanguageModelV2CallWarning>;
+    }>;
+    /**
+  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: LanguageModelV2CallOptions): PromiseLike<{
+        stream: ReadableStream<LanguageModelV2StreamPart>;
+        /**
+    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?: SharedV2Headers;
+        };
+    }>;
+};
+
+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.
+ */
+interface ProviderV2 {
+    /**
+  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): LanguageModelV2;
+    /**
+  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): EmbeddingModelV2<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): ImageModelV2;
+    /**
+  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;
+}
+
 /** Azure OpenAI chat extension configuration for "On Your Data" RAG scenarios. */
 type AzureOpenAiChatExtensionConfiguration = NonNullable<AzureOpenAiChatCompletionParameters["data_sources"]>[number];
 /**
  * Common model parameters shared between both APIs.
  *
- * These parameters control text generation behavior and are validated by Zod schemas
- * when passed via `providerOptions`.
+ * Known parameters are validated by Zod in constructor settings and per-call
+ * `modelParams` provider options; additional model-specific keys are passed through.
  */
 interface CommonModelParams {
     /**
@@ -110,7 +1698,7 @@ interface CommonModelParams {
     readonly maxTokens?: number;
     /**
      * Number of completions to generate.
-     * Not supported by Amazon/Anthropic models.
+     * Availability depends on the selected SAP API and model; no model-family filtering is applied.
      * Range: Positive integer
      */
     readonly n?: number;
@@ -161,7 +1749,10 @@ interface FoundationModelsModelSettings {
     readonly api: "foundation-models";
     /** Azure OpenAI "On Your Data" configuration for RAG scenarios. */
     readonly dataSources?: AzureOpenAiChatExtensionConfiguration[];
-    /** @default false */
+    /**
+     * Forward assistant reasoning from the input history as text; does not enable reasoning output.
+     * @default false
+     */
     readonly includeReasoning?: boolean;
     readonly modelParams?: FoundationModelsModelParams;
     readonly modelVersion?: string;
@@ -181,7 +1772,7 @@ interface OrchestrationModelSettings {
     readonly escapeTemplatePlaceholders?: boolean;
     /**
      * Additional module configurations for prompt module fallback.
-     * The SDK tries the primary configuration first, then each fallback in order until one succeeds.
+     * These entries follow the primary configuration in the list passed to the SAP SDK.
      * Each entry is a full `OrchestrationModuleConfig` with its own model, prompt, and modules.
      * @example
      * ```ts
@@ -198,7 +1789,10 @@ interface OrchestrationModelSettings {
     readonly fallbackModuleConfigs?: OrchestrationModuleConfig[];
     readonly filtering?: FilteringModule;
     readonly grounding?: GroundingModule;
-    /** @default false */
+    /**
+     * Forward assistant reasoning from the input history as text; does not enable reasoning output.
+     * @default false
+     */
     readonly includeReasoning?: boolean;
     readonly masking?: MaskingModule | {
         providers: MaskingModule["masking_providers"];
@@ -209,7 +1803,8 @@ interface OrchestrationModelSettings {
      * Reference to a complete orchestration configuration stored in SAP AI Core Prompt Registry.
      * When provided, local module settings (filtering, masking, grounding, translation, tools,
      * promptTemplateRef, responseFormat) are ignored as the full configuration is managed
-     * by the referenced config. Only `placeholderValues` and messages are passed through.
+     * by the referenced config. The reference, including its explicit `overrideConfig`,
+     * is passed to the SAP SDK; messages and `placeholderValues` remain request inputs.
      * @example { id: "f47ac10b-58cc-4372-a567-0e02b2c3d479" }
      * @example { scenario: "customer-support", name: "prod-config", version: "1.0.0" }
      */
@@ -218,8 +1813,8 @@ interface OrchestrationModelSettings {
     readonly promptTemplateRef?: PromptTemplateRef;
     readonly responseFormat?: ResponseFormat;
     /**
-     * Options for streaming behavior with post-LLM modules.
-     * Only applies when using `streamText()` with orchestration modules.
+     * Options for streaming behavior with locally configured post-LLM modules.
+     * Includes direct `doStream()` calls; ignored when `orchestrationConfigRef` is used.
      */
     readonly streamOptions?: OrchestrationStreamOptions;
     readonly tools?: ChatCompletionTool[];
@@ -228,6 +1823,8 @@ interface OrchestrationModelSettings {
 /**
  * Stream options for orchestration post-LLM module processing.
  * Controls chunking behavior for translation, filtering, and other modules during streaming.
+ * Ignored with `orchestrationConfigRef`; configure streaming in the stored
+ * configuration or its `overrideConfig` instead.
  */
 interface OrchestrationStreamOptions {
     /**
@@ -237,7 +1834,7 @@ interface OrchestrationStreamOptions {
     readonly chunkSize?: number;
     /**
      * Delimiters for splitting stream into chunks (e.g., sentence boundaries).
-     * Required when translation module is configured.
+     * Recommended for translation; the provider warns when local translation settings lack them.
      * @example ["\n", ".", "?", "!"]
      */
     readonly delimiters?: readonly string[];
@@ -286,7 +1883,10 @@ interface SAPAIEmbeddingSettings {
     readonly modelParams?: FoundationModelsEmbeddingParams | Record<string, unknown>;
     readonly modelVersion?: string;
     readonly [key: string]: unknown;
-    /** @default 'text' */
+    /**
+     * Orchestration embedding input type; ignored by Foundation Models.
+     * @default 'text'
+     */
     readonly type?: "document" | "query" | "text";
 }
 /**
@@ -320,7 +1920,10 @@ interface SAPAISettings {
     readonly filtering?: FilteringModule;
     /** Orchestration API only. */
     readonly grounding?: GroundingModule;
-    /** @default false */
+    /**
+     * Forward assistant reasoning from the input history as text; does not enable reasoning output.
+     * @default false
+     */
     readonly includeReasoning?: boolean;
     /** Orchestration API only. */
     readonly masking?: MaskingModule | {
@@ -335,7 +1938,7 @@ interface SAPAISettings {
     /** Orchestration API only. */
     readonly promptTemplateRef?: PromptTemplateRef;
     readonly responseFormat?: ResponseFormat;
-    /** Orchestration API only. */
+    /** Orchestration API only; ignored when `orchestrationConfigRef` is used. */
     readonly streamOptions?: OrchestrationStreamOptions;
     /** Orchestration API only. */
     readonly tools?: ChatCompletionTool[];
@@ -480,7 +2083,7 @@ declare class ApiSwitchError extends Error {
  * @example
  * ```typescript
  * throw new UnsupportedFeatureError("Content filtering", "foundation-models", "orchestration");
- * // "Content filtering is only available with Orchestration API and will be ignored by Foundation Models API."
+ * // Rejects the request: content filtering requires the Orchestration API.
  * ```
  * @see {@link validateSettings} - Main validation function that throws this error
  * @see {@link ApiSwitchError} - Related error for API switching conflicts
@@ -492,12 +2095,46 @@ declare class UnsupportedFeatureError extends Error {
     /**
      * Creates a new UnsupportedFeatureError.
      * @param feature - The name of the unsupported feature (e.g., "Content filtering").
-     * @param api - The API being used where the feature will be ignored.
+     * @param api - The API being used that does not support the feature.
      * @param suggestedApi - The API that supports this feature.
      */
     constructor(feature: string, api: SAPAIApiType, suggestedApi: SAPAIApiType);
 }
 
+/** Adapters to convert internal (V3) formats to LanguageModelV2 formats for the V2 facade. */
+
+type ConvertedV2StreamPart = Exclude<LanguageModelV2StreamPart, {
+    type: "stream-start";
+}> | {
+    type: "stream-start";
+    warnings: ReturnType<typeof convertWarningsToV2>;
+};
+/**
+ * Converts internal warnings array to V2 warnings array.
+ * @param internalWarnings - Internal warning objects.
+ * @returns V2 warning objects.
+ * @internal
+ */
+declare function convertWarningsToV2(internalWarnings: SharedV3Warning[]): ReturnType<typeof convertWarningToV2>[];
+/**
+ * Converts internal warning to V2 warning format.
+ *
+ * Maps `unsupported`/`compatibility` warnings to V2 `other` type with descriptive message.
+ * @param internalWarning - Internal warning object.
+ * @returns V2 warning object.
+ * @internal
+ */
+declare function convertWarningToV2(internalWarning: SharedV3Warning): Extract<LanguageModelV2CallWarning, {
+    type: "other";
+}>;
+/**
+ * Transforms internal stream to V2 ReadableStream.
+ * @param internalStream - Internal ReadableStream to transform.
+ * @returns V2-formatted ReadableStream.
+ * @internal
+ */
+declare function createV2StreamFromInternal(internalStream: ReadableStream<LanguageModelV3StreamPart>): ReadableStream<ConvertedV2StreamPart>;
+
 /**
  * SAP AI Language Model V2 - Vercel AI SDK LanguageModelV2 implementation for SAP AI Core.
  *
@@ -507,6 +2144,9 @@ declare class UnsupportedFeatureError extends Error {
  * @see {@link https://sdk.vercel.ai/docs/reference/ai-sdk-core/stream-text | Vercel AI SDK streamText()}
  */
 
+type CompatibleV2CallOptions = Omit<LanguageModelV2CallOptions$1, "tools"> & {
+    tools?: LanguageModelV2CallOptions$1["tools"] | LanguageModelV3CallOptions["tools"];
+};
 /** @internal */
 interface SAPAILanguageModelV2Config {
     readonly deploymentConfig: DeploymentIdConfig | ResourceGroupConfig;
@@ -551,7 +2191,7 @@ interface SAPAILanguageModelV2Config {
  * @see {@link https://sdk.vercel.ai/docs/ai-sdk-core/generating-text | Vercel AI SDK Text Generation}
  * @see {@link createSAPAIProvider} - Factory function to create provider instances
  */
-declare class SAPAILanguageModelV2 implements LanguageModelV2 {
+declare class SAPAILanguageModelV2 implements LanguageModelV2$1 {
     readonly modelId: SAPAIModelId;
     readonly specificationVersion: "v2";
     get provider(): string;
@@ -565,7 +2205,7 @@ declare class SAPAILanguageModelV2 implements LanguageModelV2 {
      * @internal
      */
     constructor(modelId: SAPAIModelId, settings: SAPAISettings, config: SAPAILanguageModelV2Config);
-    doGenerate(options: LanguageModelV2CallOptions): Promise<{
+    doGenerate(options: CompatibleV2CallOptions): Promise<{
         content: LanguageModelV2Content[];
         finishReason: LanguageModelV2FinishReason;
         providerMetadata?: SharedV2ProviderMetadata;
@@ -577,16 +2217,16 @@ declare class SAPAILanguageModelV2 implements LanguageModelV2 {
             headers?: SharedV2Headers;
         };
         usage: LanguageModelV2Usage;
-        warnings: LanguageModelV2CallWarning[];
+        warnings: ReturnType<typeof convertWarningsToV2>;
     }>;
-    doStream(options: LanguageModelV2CallOptions): Promise<{
+    doStream(options: CompatibleV2CallOptions): Promise<{
         request?: {
             body?: unknown;
         };
         response?: {
             headers?: SharedV2Headers;
         };
-        stream: ReadableStream<LanguageModelV2StreamPart>;
+        stream: ReturnType<typeof createV2StreamFromInternal>;
     }>;
 }
 
@@ -598,14 +2238,15 @@ type DeploymentConfig = DeploymentIdConfig | ResourceGroupConfig;
  */
 interface SAPAIProviderSettings {
     /**
-     * SAP AI Core API to use for all models created by this provider.
-     * Can be overridden at model creation time or per-call via providerOptions.
+     * Default SAP AI Core API for models created by this provider.
+     * `defaultSettings.api`, per-model `api`, and per-call `providerOptions` take precedence.
+     * This option does not enable automatic failover between APIs.
      * - `'orchestration'` (default): SAP AI Core Orchestration API - supports filtering, grounding, masking, translation
      * - `'foundation-models'`: SAP AI Core Foundation Models API - supports dataSources, logprobs, seed, etc.
      * @default 'orchestration'
      */
     readonly api?: SAPAIApiType;
-    /** Default model settings applied to every model instance. Per-call settings override these. */
+    /** Default model settings; settings supplied at model creation override these. */
     readonly defaultSettings?: SAPAISettings;
     /** SAP AI Core deployment ID. If not provided, the SDK resolves deployment automatically. */
     readonly deploymentId?: string;
@@ -613,13 +2254,16 @@ interface SAPAIProviderSettings {
     readonly destination?: HttpDestinationOrFetchOptions;
     /**
      * Log level for SAP Cloud SDK loggers.
-     * Controls verbosity of internal SAP SDK logging (e.g., authentication, service binding).
+     * Controls process-wide SAP SDK logging (e.g., authentication, service binding).
+     * Creating another provider resets this level, using warn when logLevel is omitted.
      * Note: SAP_CLOUD_SDK_LOG_LEVEL environment variable takes precedence if set.
      * @default 'warn'
      */
     readonly logLevel?: "debug" | "error" | "info" | "warn";
     /**
-     * Provider name used as key for `providerOptions` and `providerMetadata`.
+     * Name used in model provider identifiers. Call-level `providerOptions` and
+     * `providerMetadata` keys use the prefix before the first dot; avoid dots in names.
+     * Per-part prompt-cache directives always use the fixed `sap-ai` key.
      * @default 'sap-ai'
      */
     readonly name?: string;
@@ -629,8 +2273,9 @@ interface SAPAIProviderSettings {
      *
      * Provider-level only (not overridable per-call via `providerOptions['sap-ai']`). The
      * AI SDK `abortSignal` option always wins over any `signal` on `requestConfig`; the
-     * latter is dropped before the request is forwarded. Node-only knobs (`httpAgent`,
-     * `httpsAgent`) are silently ignored on Edge / Cloudflare Workers runtimes.
+     * latter is dropped before the request is forwarded. Other options, including
+     * Node-only agents (`httpAgent`, `httpsAgent`), are forwarded unchanged. The
+     * published package and SAP SDK transport require a Node-compatible runtime.
      *
      * See the "Note on `requestConfig`" section under `SAPAIProviderSettings` in
      * `API_REFERENCE.md` for the full SAP AI Core `AI-*` header guidance.
@@ -656,7 +2301,8 @@ interface SAPAIProviderV2 extends ProviderV2 {
     textEmbeddingModel(modelId: SAPAIEmbeddingModelId, settings?: SAPAIEmbeddingSettings): SAPAIEmbeddingModelV2;
 }
 /**
- * Creates an SAP AI Provider instance for use with the Vercel AI SDK.
+ * Creates an SAP AI Provider V2 instance for use with AI SDK 5.
+ * AI SDK 6 can also consume this provider through its V2 compatibility layer.
  *
  * Uses the official SAP AI SDK (`@sap-ai-sdk/orchestration` and
  * `@sap-ai-sdk/foundation-models`) for API communication. Authentication is automatic via service binding
@@ -664,12 +2310,12 @@ interface SAPAIProviderV2 extends ProviderV2 {
  * @param options - Provider configuration options.
  * @param options.api - Default API type: `'orchestration'` (default) or `'foundation-models'`.
  * @param options.defaultSettings - Default model settings applied to every model instance.
- * @param options.deploymentId - SAP AI Core deployment ID for automatic deployment resolution.
+ * @param options.deploymentId - Explicit SAP AI Core deployment ID; omit for automatic deployment resolution.
  * @param options.destination - Custom SAP Cloud SDK destination configuration.
  * @param options.logLevel - Log level for SAP Cloud SDK loggers (`'debug'`, `'info'`, `'warn'`, `'error'`).
- * @param options.name - Provider name used as key in `providerOptions` (default: `'sap-ai'`).
+ * @param options.name - Provider name (default: `'sap-ai'`); see {@link SAPAIProviderSettings.name} for namespace rules.
  * @param options.requestConfig - Provider-level custom request configuration. See {@link SAPAIProviderSettings.requestConfig} for scope, portability, and abort semantics.
- * @param options.resourceGroup - SAP AI Core resource group (default: `'default'`).
+ * @param options.resourceGroup - SAP AI Core resource group (default: `'default'`); ignored when deploymentId is set.
  * @param options.warnOnAmbiguousConfig - Whether to warn when both deploymentId and resourceGroup are set.
  * @returns A configured SAP AI provider instance that can be used as a callable or via methods.
  * @example