@ai-sdk/provider 3.0.5 → 3.0.6

package/src/language-model/v2/language-model-v2.ts

@@ -9,127 +9,127 @@ import { LanguageModelV2StreamPart } from './language-model-v2-stream-part';
 import { LanguageModelV2Usage } from './language-model-v2-usage';
 
 /**
-Specification for a language model that implements the language model interface version 2.
+ * Specification for a language model that implements the language model interface version 2.
  */
 export type LanguageModelV2 = {
   /**
-The language model must specify which language model interface version it implements.
+   * The language model must specify which language model interface version it implements.
    */
   readonly specificationVersion: 'v2';
 
   /**
-Name of the provider for logging purposes.
+   * Name of the provider for logging purposes.
    */
   readonly provider: string;
 
   /**
-Provider-specific model ID for logging purposes.
+   * 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).
+   * 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.
+   * 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.
+     * Ordered content that the model has generated.
      */
     content: Array<LanguageModelV2Content>;
 
     /**
-Finish reason.
+     * Finish reason.
      */
     finishReason: LanguageModelV2FinishReason;
 
     /**
-  Usage information.
+     * 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.
+     * 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.
+     * Optional request information for telemetry and debugging purposes.
      */
     request?: {
       /**
-Request HTTP body that was sent to the provider API.
+       * Request HTTP body that was sent to the provider API.
        */
       body?: unknown;
     };
 
     /**
-Optional response information for telemetry and debugging purposes.
+     * Optional response information for telemetry and debugging purposes.
      */
     response?: LanguageModelV2ResponseMetadata & {
       /**
-Response headers.
-      */
+       * Response headers.
+       */
       headers?: SharedV2Headers;
 
       /**
-Response HTTP body.
-*/
+       * Response HTTP body.
+       */
       body?: unknown;
     };
 
     /**
-Warnings for the call, e.g. unsupported settings.
+     * 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.
+   * 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.
+   * @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.
+     * Optional request information for telemetry and debugging purposes.
      */
     request?: {
       /**
-Request HTTP body that was sent to the provider API.
-   */
+       * Request HTTP body that was sent to the provider API.
+       */
       body?: unknown;
     };
 
     /**
-Optional response data.
+     * Optional response data.
      */
     response?: {
       /**
-Response headers.
+       * Response headers.
        */
       headers?: SharedV2Headers;
     };

package/src/language-model/v3/language-model-v3-call-options.ts

@@ -7,62 +7,62 @@ import { LanguageModelV3ToolChoice } from './language-model-v3-tool-choice';
 
 export type LanguageModelV3CallOptions = {
   /**
-A language mode prompt is a standardized prompt type.
-
-Note: This is **not** the user-facing prompt. The AI SDK methods will map the
-user-facing prompt types such as chat or instruction prompts to this format.
-That approach allows us to evolve the user  facing prompts without breaking
-the language model interface.
+   * A language mode prompt is a standardized prompt type.
+   *
+   * Note: This is **not** the user-facing prompt. The AI SDK methods will map the
+   * user-facing prompt types such as chat or instruction prompts to this format.
+   * That approach allows us to evolve the user  facing prompts without breaking
+   * the language model interface.
    */
   prompt: LanguageModelV3Prompt;
 
   /**
-Maximum number of tokens to generate.
+   * Maximum number of tokens to generate.
    */
   maxOutputTokens?: number;
 
   /**
-Temperature setting. The range depends on the provider and model.
- */
+   * 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.
- */
+   * 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.
- */
+   * 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.
- */
+   * 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.
- */
+   * 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.
- */
+   * 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.
- */
+   * 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' }
     | {
@@ -85,35 +85,35 @@ If JSON is selected, a schema can optionally be provided to guide the LLM.
       };
 
   /**
-The seed (integer) to use for random sampling. If set and supported
-by the model, calls will generate deterministic results.
- */
+   * 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.
-  */
+   * The tools that are available for the model.
+   */
   tools?: Array<LanguageModelV3FunctionTool | LanguageModelV3ProviderTool>;
 
   /**
-Specifies how the tool should be selected. Defaults to 'auto'.
-*/
+   * Specifies how the tool should be selected. Defaults to 'auto'.
+   */
   toolChoice?: LanguageModelV3ToolChoice;
 
   /**
-Include raw chunks in the stream. Only applicable for streaming calls.
- */
+   * Include raw chunks in the stream. Only applicable for streaming calls.
+   */
   includeRawChunks?: boolean;
 
   /**
-Abort signal for cancelling the operation.
- */
+   * Abort signal for cancelling the operation.
+   */
   abortSignal?: AbortSignal;
 
   /**
-Additional HTTP headers to be sent with the request.
-Only applicable for HTTP-based providers.
- */
+   * Additional HTTP headers to be sent with the request.
+   * Only applicable for HTTP-based providers.
+   */
   headers?: Record<string, string | undefined>;
 
   /**

package/src/language-model/v3/language-model-v3-data-content.ts

@@ -1,4 +1,4 @@
 /**
-Data content. Can be a Uint8Array, base64 encoded data as a string or a URL.
-*/
+ * Data content. Can be a Uint8Array, base64 encoded data as a string or a URL.
+ */
 export type LanguageModelV3DataContent = Uint8Array | string | URL;

package/src/language-model/v3/language-model-v3-file.ts

@@ -1,28 +1,28 @@
 import { SharedV3ProviderMetadata } from '../../shared';
 
 /**
-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.
+ * 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.
  */
 export type LanguageModelV3File = {
   type: 'file';
 
   /**
-The IANA media type of the file, e.g. `image/png` or `audio/mp3`.
-
-@see https://www.iana.org/assignments/media-types/media-types.xhtml
-       */
+   * 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.
- */
+   * 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;
 
   /**

package/src/language-model/v3/language-model-v3-function-tool.ts

@@ -3,31 +3,31 @@ import { SharedV3ProviderOptions } from '../../shared';
 import { JSONObject } from '../../json-value';
 
 /**
-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.
+ * 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.
  */
 export type LanguageModelV3FunctionTool = {
   /**
-The type of the tool (always 'function').
+   * The type of the tool (always 'function').
    */
   type: 'function';
 
   /**
-The name of the tool. Unique within this model call.
+   * 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.
+   * 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.
+   * 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;
 
@@ -47,7 +47,7 @@ understand the tool's input requirements and to provide matching suggestions.
   strict?: boolean;
 
   /**
-The provider-specific options for the tool.
+   * The provider-specific options for the tool.
    */
   providerOptions?: SharedV3ProviderOptions;
 };

package/src/language-model/v3/language-model-v3-prompt.ts

@@ -3,13 +3,13 @@ import { SharedV3ProviderOptions } from '../../shared/v3/shared-v3-provider-opti
 import { LanguageModelV3DataContent } from './language-model-v3-data-content';
 
 /**
-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.
+ * 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.
  */
 export type LanguageModelV3Prompt = Array<LanguageModelV3Message>;
 
@@ -53,13 +53,13 @@ export type LanguageModelV3Message =
   };
 
 /**
-Text content part of a prompt. It contains a string of text.
+ * Text content part of a prompt. It contains a string of text.
  */
 export interface LanguageModelV3TextPart {
   type: 'text';
 
   /**
-The text content.
+   * The text content.
    */
   text: string;
 
@@ -72,13 +72,13 @@ The text content.
 }
 
 /**
-Reasoning content part of a prompt. It contains a string of reasoning text.
+ * Reasoning content part of a prompt. It contains a string of reasoning text.
  */
 export interface LanguageModelV3ReasoningPart {
   type: 'reasoning';
 
   /**
-The reasoning text.
+   * The reasoning text.
    */
   text: string;
 
@@ -91,7 +91,7 @@ The reasoning text.
 }
 
 /**
-File content part of a prompt. It contains a file.
+ * File content part of a prompt. It contains a file.
  */
 export interface LanguageModelV3FilePart {
   type: 'file';
@@ -102,16 +102,16 @@ export interface LanguageModelV3FilePart {
   filename?: string;
 
   /**
-File data. Can be a Uint8Array, base64 encoded data as a string or a URL.
-*/
+   * File data. Can be a Uint8Array, base64 encoded data as a string or a URL.
+   */
   data: LanguageModelV3DataContent;
 
   /**
-IANA media type of the file.
-
-Can support wildcards, e.g. `image/*` (in which case the provider needs to take appropriate action).
-
-@see https://www.iana.org/assignments/media-types/media-types.xhtml
+   * 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;
 
@@ -124,23 +124,23 @@ Can support wildcards, e.g. `image/*` (in which case the provider needs to take
 }
 
 /**
-Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
+ * Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
  */
 export interface LanguageModelV3ToolCallPart {
   type: 'tool-call';
 
   /**
-ID of the tool call. This ID is used to match the tool call with the tool result.
- */
+   * 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.
- */
+   * 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.
+   * Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
    */
   input: unknown;
 
@@ -159,23 +159,23 @@ Arguments of the tool call. This is a JSON-serializable object that matches the
 }
 
 /**
-Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
+ * Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
  */
 export interface LanguageModelV3ToolResultPart {
   type: 'tool-result';
 
   /**
-ID of the tool call that this result is associated with.
- */
+   * ID of the tool call that this result is associated with.
+   */
   toolCallId: string;
 
   /**
-Name of the tool that generated this result.
-  */
+   * Name of the tool that generated this result.
+   */
   toolName: string;
 
   /**
-Result of the tool call.
+   * Result of the tool call.
    */
   output: LanguageModelV3ToolResultOutput;
 
@@ -283,8 +283,8 @@ export type LanguageModelV3ToolResultOutput =
             type: 'text';
 
             /**
-Text content.
-*/
+             * Text content.
+             */
             text: string;
 
             /**
@@ -296,14 +296,14 @@ Text content.
             type: 'file-data';
 
             /**
-Base-64 encoded media data.
-*/
+             * Base-64 encoded media data.
+             */
             data: string;
 
             /**
-IANA media type.
-@see https://www.iana.org/assignments/media-types/media-types.xhtml
-*/
+             * IANA media type.
+             * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+             */
             mediaType: string;
 
             /**
@@ -354,14 +354,14 @@ IANA media type.
             type: 'image-data';
 
             /**
-Base-64 encoded image data.
-*/
+             * Base-64 encoded image data.
+             */
             data: string;
 
             /**
-IANA media type.
-@see https://www.iana.org/assignments/media-types/media-types.xhtml
-*/
+             * IANA media type.
+             * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+             */
             mediaType: string;
 
             /**

package/src/language-model/v3/language-model-v3-reasoning.ts

@@ -1,7 +1,7 @@
 import { SharedV3ProviderMetadata } from '../../shared';
 
 /**
-Reasoning that the model has generated.
+ * Reasoning that the model has generated.
  */
 export type LanguageModelV3Reasoning = {
   type: 'reasoning';

package/src/language-model/v3/language-model-v3-response-metadata.ts

@@ -1,16 +1,16 @@
 export interface LanguageModelV3ResponseMetadata {
   /**
-ID for the generated response, if the provider sends one.
-     */
+   * 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 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.
-*/
+   * The ID of the response model that was used to generate the response, if the provider sends one.
+   */
   modelId?: string;
 }

package/src/language-model/v3/language-model-v3-source.ts

@@ -1,7 +1,7 @@
 import { SharedV3ProviderMetadata } from '../../shared/v3/shared-v3-provider-metadata';
 
 /**
-A source that has been used as input to generate the response.
+ * A source that has been used as input to generate the response.
  */
 export type LanguageModelV3Source =
   | {

package/src/language-model/v3/language-model-v3-text.ts

@@ -1,13 +1,13 @@
 import { SharedV3ProviderMetadata } from '../../shared/v3/shared-v3-provider-metadata';
 
 /**
-Text that the model has generated.
+ * Text that the model has generated.
  */
 export type LanguageModelV3Text = {
   type: 'text';
 
   /**
-The text content.
+   * The text content.
    */
   text: string;