@ai-sdk/provider 3.0.4 → 3.0.6

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

@@ -7,62 +7,62 @@ import { LanguageModelV2ToolChoice } from './language-model-v2-tool-choice';
 
 export 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.
+   * 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.
+   * 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,37 +85,37 @@ 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<
     LanguageModelV2FunctionTool | LanguageModelV2ProviderDefinedTool
   >;
 
   /**
-Specifies how the tool should be selected. Defaults to 'auto'.
-*/
+   * Specifies how the tool should be selected. Defaults to 'auto'.
+   */
   toolChoice?: LanguageModelV2ToolChoice;
 
   /**
-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/v2/language-model-v2-call-warning.ts

@@ -3,8 +3,8 @@ import { LanguageModelV2FunctionTool } from './language-model-v2-function-tool';
 import { LanguageModelV2ProviderDefinedTool } from './language-model-v2-provider-defined-tool';
 
 /**
-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.
+ * 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.
  */
 export type LanguageModelV2CallWarning =
   | {

package/src/language-model/v2/language-model-v2-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 LanguageModelV2DataContent = Uint8Array | string | URL;

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

@@ -1,25 +1,25 @@
 /**
-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 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
-       */
+   * 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/v2/language-model-v2-finish-reason.ts

@@ -1,14 +1,14 @@
 /**
-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
+ * 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
  */
 export type LanguageModelV2FinishReason =
   | 'stop' // model generated stop sequence

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

@@ -2,36 +2,36 @@ import { JSONSchema7 } from 'json-schema';
 import { SharedV2ProviderOptions } from '../../shared';
 
 /**
-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 LanguageModelV2FunctionTool = {
   /**
-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;
 
   /**
-The provider-specific options for the tool.
+   * The provider-specific options for the tool.
    */
   providerOptions?: SharedV2ProviderOptions;
 };

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

@@ -3,13 +3,13 @@ import { SharedV2ProviderOptions } from '../../shared/v2/shared-v2-provider-opti
 import { LanguageModelV2DataContent } from './language-model-v2-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 LanguageModelV2Prompt = Array<LanguageModelV2Message>;
 
@@ -50,13 +50,13 @@ export type LanguageModelV2Message =
   };
 
 /**
-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 LanguageModelV2TextPart {
   type: 'text';
 
   /**
-The text content.
+   * The text content.
    */
   text: string;
 
@@ -69,13 +69,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 LanguageModelV2ReasoningPart {
   type: 'reasoning';
 
   /**
-The reasoning text.
+   * The reasoning text.
    */
   text: string;
 
@@ -88,7 +88,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 LanguageModelV2FilePart {
   type: 'file';
@@ -99,16 +99,16 @@ export interface LanguageModelV2FilePart {
   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: 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
+   * 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;
 
@@ -121,23 +121,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 LanguageModelV2ToolCallPart {
   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;
 
@@ -156,23 +156,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 LanguageModelV2ToolResultPart {
   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: LanguageModelV2ToolResultOutput;
 
@@ -196,22 +196,22 @@ export type LanguageModelV2ToolResultOutput =
             type: 'text';
 
             /**
-Text content.
-*/
+             * Text content.
+             */
             text: string;
           }
         | {
             type: 'media';
 
             /**
-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;
           }
       >;

package/src/language-model/v2/language-model-v2-provider-defined-tool.ts

@@ -1,24 +1,24 @@
 /**
-The configuration of a tool that is defined by the provider.
+ * The configuration of a tool that is defined by the provider.
  */
 export type LanguageModelV2ProviderDefinedTool = {
   /**
-The type of the tool (always 'provider-defined').
+   * 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>`.
+   * 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.
+   * 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.
-  */
+   * The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
+   */
   args: Record<string, unknown>;
 };

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

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

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

@@ -1,16 +1,16 @@
 export interface LanguageModelV2ResponseMetadata {
   /**
-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/v2/language-model-v2-source.ts

@@ -1,7 +1,7 @@
 import { SharedV2ProviderMetadata } from '../../shared/v2/shared-v2-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 LanguageModelV2Source =
   | {

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

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

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

@@ -1,7 +1,7 @@
 import { SharedV2ProviderMetadata } from '../../shared/v2/shared-v2-provider-metadata';
 
 /**
-Result of a tool call that has been executed by the provider.
+ * Result of a tool call that has been executed by the provider.
  */
 export type LanguageModelV2ToolResult = {
   type: 'tool-result';

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

@@ -1,34 +1,34 @@
 /**
-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.
+ * 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.
  */
 export type LanguageModelV2Usage = {
   /**
-The number of input (prompt) tokens used.
+   * The number of input (prompt) tokens used.
    */
   inputTokens: number | undefined;
 
   /**
-The number of output (completion) tokens used.
+   * 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.
+   * 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.
+   * The number of reasoning tokens used.
    */
   reasoningTokens?: number | undefined;
 
   /**
-The number of cached input tokens.
+   * The number of cached input tokens.
    */
   cachedInputTokens?: number | undefined;
 };