@ai-sdk/provider 0.0.0-01d6317c-20260129172110

package/src/json-value/is-json.ts

@@ -0,0 +1,40 @@
+import { JSONArray, JSONObject, JSONValue } from './json-value';
+
+export function isJSONValue(value: unknown): value is JSONValue {
+  if (
+    value === null ||
+    typeof value === 'string' ||
+    typeof value === 'number' ||
+    typeof value === 'boolean'
+  ) {
+    return true;
+  }
+
+  if (Array.isArray(value)) {
+    return value.every(isJSONValue);
+  }
+
+  if (typeof value === 'object') {
+    return Object.entries(value).every(
+      ([key, val]) =>
+        typeof key === 'string' && (val === undefined || isJSONValue(val)),
+    );
+  }
+
+  return false;
+}
+
+export function isJSONArray(value: unknown): value is JSONArray {
+  return Array.isArray(value) && value.every(isJSONValue);
+}
+
+export function isJSONObject(value: unknown): value is JSONObject {
+  return (
+    value != null &&
+    typeof value === 'object' &&
+    Object.entries(value).every(
+      ([key, val]) =>
+        typeof key === 'string' && (val === undefined || isJSONValue(val)),
+    )
+  );
+}

package/src/json-value/json-value.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+export type JSONValue =
+  | null
+  | string
+  | number
+  | boolean
+  | JSONObject
+  | JSONArray;
+
+export type JSONObject = {
+  [key: string]: JSONValue | undefined;
+};
+
+export type JSONArray = JSONValue[];

package/src/language-model/index.ts

@@ -0,0 +1,2 @@
+export * from './v3/index';
+export * from './v2/index';

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

@@ -0,0 +1,18 @@
+export * from './language-model-v2';
+export * from './language-model-v2-call-options';
+export * from './language-model-v2-call-warning';
+export * from './language-model-v2-content';
+export * from './language-model-v2-data-content';
+export * from './language-model-v2-file';
+export * from './language-model-v2-finish-reason';
+export * from './language-model-v2-function-tool';
+export * from './language-model-v2-prompt';
+export * from './language-model-v2-provider-defined-tool';
+export * from './language-model-v2-reasoning';
+export * from './language-model-v2-response-metadata';
+export * from './language-model-v2-source';
+export * from './language-model-v2-stream-part';
+export * from './language-model-v2-text';
+export * from './language-model-v2-tool-call';
+export * from './language-model-v2-tool-choice';
+export * from './language-model-v2-usage';

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

@@ -0,0 +1,127 @@
+import { JSONSchema7 } from 'json-schema';
+import { SharedV2ProviderOptions } from '../../shared/v2/shared-v2-provider-options';
+import { LanguageModelV2FunctionTool } from './language-model-v2-function-tool';
+import { LanguageModelV2Prompt } from './language-model-v2-prompt';
+import { LanguageModelV2ProviderDefinedTool } from './language-model-v2-provider-defined-tool';
+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.
+   */
+  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;
+};

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

@@ -0,0 +1,23 @@
+import { LanguageModelV2CallOptions } from './language-model-v2-call-options';
+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.
+ */
+export type LanguageModelV2CallWarning =
+  | {
+      type: 'unsupported-setting';
+      setting: Omit<keyof LanguageModelV2CallOptions, 'prompt'>;
+      details?: string;
+    }
+  | {
+      type: 'unsupported-tool';
+      tool: LanguageModelV2FunctionTool | LanguageModelV2ProviderDefinedTool;
+      details?: string;
+    }
+  | {
+      type: 'other';
+      message: string;
+    };

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

@@ -0,0 +1,14 @@
+import { LanguageModelV2File } from './language-model-v2-file';
+import { LanguageModelV2Reasoning } from './language-model-v2-reasoning';
+import { LanguageModelV2Source } from './language-model-v2-source';
+import { LanguageModelV2Text } from './language-model-v2-text';
+import { LanguageModelV2ToolCall } from './language-model-v2-tool-call';
+import { LanguageModelV2ToolResult } from './language-model-v2-tool-result';
+
+export type LanguageModelV2Content =
+  | LanguageModelV2Text
+  | LanguageModelV2Reasoning
+  | LanguageModelV2File
+  | LanguageModelV2Source
+  | LanguageModelV2ToolCall
+  | LanguageModelV2ToolResult;

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

@@ -0,0 +1,4 @@
+/**
+ * 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

@@ -0,0 +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.
+ */
+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
+   */
+  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;
+};

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

@@ -0,0 +1,20 @@
+/**
+ * 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
+  | '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

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

@@ -0,0 +1,37 @@
+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.
+ */
+export 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;
+};

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

@@ -0,0 +1,218 @@
+import { JSONValue } from '../../json-value/json-value';
+import { SharedV2ProviderOptions } from '../../shared/v2/shared-v2-provider-options';
+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.
+ */
+export type LanguageModelV2Prompt = Array<LanguageModelV2Message>;
+
+export type LanguageModelV2Message =
+  // Note: there could be additional parts for each role in the future,
+  // e.g. when the assistant can return images or the user can share files
+  // such as PDFs.
+  (
+    | {
+        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.
+ */
+export 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.
+ */
+export 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.
+ */
+export 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).
+ */
+export 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.
+ */
+export 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;
+}
+
+export 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;
+          }
+      >;
+    };

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

@@ -0,0 +1,24 @@
+/**
+ * The configuration of a tool that is defined by the provider.
+ */
+export 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>;
+};

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

@@ -0,0 +1,14 @@
+import { SharedV2ProviderMetadata } from '../../shared';
+
+/**
+ * Reasoning that the model has generated.
+ */
+export type LanguageModelV2Reasoning = {
+  type: 'reasoning';
+  text: string;
+
+  /**
+   * Optional provider-specific metadata for the reasoning part.
+   */
+  providerMetadata?: SharedV2ProviderMetadata;
+};

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

@@ -0,0 +1,16 @@
+export 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;
+}

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

@@ -0,0 +1,67 @@
+import { SharedV2ProviderMetadata } from '../../shared/v2/shared-v2-provider-metadata';
+
+/**
+ * A source that has been used as input to generate the response.
+ */
+export 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;
+    };