ai 7.0.0-beta.113 → 7.0.0-beta.115

package/dist/internal/index.d.ts

@@ -1,122 +1,12 @@
-import { SystemModelMessage, ModelMessage, ToolSet, ProviderOptions, Arrayable, InferToolInput, InferToolOutput, AssistantModelMessage, ToolModelMessage, Context, InferToolSetContext, ReasoningPart, ReasoningFilePart, InferToolContext } from '@ai-sdk/provider-utils';
-export { convertAsyncIteratorToReadableStream } from '@ai-sdk/provider-utils';
-import { LanguageModelV4Prompt, LanguageModelV4, LanguageModelV3, LanguageModelV2, SharedV4Warning, LanguageModelV4Source, LanguageModelV4ToolChoice, LanguageModelV4FunctionTool, LanguageModelV4ProviderTool, LanguageModelV4CallOptions, LanguageModelV4Usage, JSONObject, EmbeddingModelV4Embedding, SharedV4ProviderMetadata, ProviderV4, ProviderV3, ProviderV2 } from '@ai-sdk/provider';
+import { EmbeddingModelV4Embedding, LanguageModelV4, LanguageModelV3, LanguageModelV2, SharedV4Warning, LanguageModelV4Source, SharedV4ProviderMetadata, LanguageModelV4Usage, JSONObject, LanguageModelV4Prompt, LanguageModelV4CallOptions, ProviderV4, ProviderV3, ProviderV2, LanguageModelV4ToolChoice, LanguageModelV4FunctionTool, LanguageModelV4ProviderTool } from '@ai-sdk/provider';
 import { GatewayModelId } from '@ai-sdk/gateway';
+import { ProviderOptions, SystemModelMessage, ModelMessage, ToolSet, Arrayable, InferToolInput, InferToolOutput, AssistantModelMessage, ToolModelMessage, Context, InferToolSetContext, ReasoningPart, ReasoningFilePart, InferToolContext } from '@ai-sdk/provider-utils';
+export { convertAsyncIteratorToReadableStream } from '@ai-sdk/provider-utils';
 
 /**
- * A type that combines AsyncIterable and ReadableStream.
- * This allows a ReadableStream to be consumed using for-await-of syntax.
- */
-type AsyncIterableStream<T> = AsyncIterable<T> & ReadableStream<T>;
-/**
- * Wraps a ReadableStream and returns an object that is both a ReadableStream and an AsyncIterable.
- * This enables consumption of the stream using for-await-of, with proper resource cleanup on early exit or error.
- *
- * @template T The type of the stream's chunks.
- * @param source The source ReadableStream to wrap.
- * @returns An AsyncIterableStream that can be used as both a ReadableStream and an AsyncIterable.
- */
-declare function createAsyncIterableStream<T>(source: ReadableStream<T>): AsyncIterableStream<T>;
-
-/**
- * Experimental. Can change in patch versions without warning.
- *
- * Download function. Called with the array of URLs and a boolean indicating
- * whether the URL is supported by the model.
- *
- * The download function can decide for each URL:
- * - to return null (which means that the URL should be passed to the model)
- * - to download the asset and return the data (incl. retries, authentication, etc.)
- *
- * Should throw DownloadError if the download fails.
- *
- * Should return an array of objects sorted by the order of the requested downloads.
- * For each object, the data should be a Uint8Array if the URL was downloaded.
- * For each object, the mediaType should be the media type of the downloaded asset.
- * For each object, the data should be null if the URL should be passed through as is.
- */
-type DownloadFunction = (options: Array<{
-    url: URL;
-    isUrlSupportedByModel: boolean;
-}>) => PromiseLike<Array<{
-    data: Uint8Array;
-    mediaType: string | undefined;
-} | null>>;
-
-/**
- * Prompt part of the AI function options.
- * It contains a system message, a simple text prompt, or a list of messages.
- */
-type Prompt = {
-    /**
-     * System message to include in the prompt. Can be used with `prompt` or `messages`.
-     */
-    system?: string | SystemModelMessage | Array<SystemModelMessage>;
-    /**
-     * Whether system messages are allowed in the `prompt` or `messages` fields.
-     *
-     * When disabled, system messages must be provided through the `system` option.
-     *
-     * @default false
-     */
-    allowSystemInMessages?: boolean;
-} & ({
-    /**
-     * A prompt. It can be either a text prompt or a list of messages.
-     *
-     * You can either use `prompt` or `messages` but not both.
-     */
-    prompt: string | Array<ModelMessage>;
-    /**
-     * A list of messages.
-     *
-     * You can either use `prompt` or `messages` but not both.
-     */
-    messages?: never;
-} | {
-    /**
-     * A list of messages.
-     *
-     * You can either use `prompt` or `messages` but not both.
-     */
-    messages: Array<ModelMessage>;
-    /**
-     * A prompt. It can be either a text prompt or a list of messages.
-     *
-     * You can either use `prompt` or `messages` but not both.
-     */
-    prompt?: never;
-});
-
-type StandardizedPrompt = {
-    /**
-     * System message.
-     */
-    system?: string | SystemModelMessage | Array<SystemModelMessage>;
-    /**
-     * Messages.
-     */
-    messages: ModelMessage[];
-};
-/**
- * Converts a prompt input into a standardized prompt with validated model
- * messages.
- *
- * @param prompt - The prompt definition to standardize.
- * Set `allowSystemInMessages` to true to allow system messages in the
- * `prompt` or `messages` fields. System messages in the `system` option are
- * always allowed.
- * @returns The standardized prompt.
- * @throws {InvalidPromptError} When the prompt is invalid.
+ * Embedding.
  */
-declare function standardizePrompt({ allowSystemInMessages, system, prompt, messages, }: Prompt): Promise<StandardizedPrompt>;
-
-declare function convertToLanguageModelPrompt({ prompt, supportedUrls, download, provider, }: {
-    prompt: StandardizedPrompt;
-    supportedUrls: Record<string, RegExp[]>;
-    download: DownloadFunction | undefined;
-    provider?: string;
-}): Promise<LanguageModelV4Prompt>;
+type Embedding = EmbeddingModelV4Embedding;
 
 declare global {
     /**
@@ -196,100 +86,39 @@ type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'requ
     toolName: Extract<keyof TOOLS, string>;
 };
 
-declare function prepareToolChoice({ toolChoice, }: {
-    toolChoice: ToolChoice<any> | undefined;
-}): LanguageModelV4ToolChoice;
-
-declare function prepareTools<TOOLS extends ToolSet>({ tools, }: {
-    tools: TOOLS | undefined;
-}): Promise<Array<LanguageModelV4FunctionTool | LanguageModelV4ProviderTool> | undefined>;
-
-/**
- * Model-facing generation controls. These settings influence how the model
- * generates its response (token limits, sampling, penalties, stop sequences,
- * seed, reasoning).
- */
-type LanguageModelCallOptions = {
-    /**
-     * Maximum number of tokens to generate.
-     */
-    maxOutputTokens?: number;
-    /**
-     * Temperature setting. The range depends on the provider and model.
-     *
-     * It is recommended to set either `temperature` or `topP`, but not both.
-     */
-    temperature?: number;
-    /**
-     * Nucleus sampling. This is a number between 0 and 1.
-     *
-     * E.g. 0.1 would mean that only tokens with the top 10% probability mass
-     * are considered.
-     *
-     * It is recommended to set either `temperature` or `topP`, but not both.
-     */
-    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;
+type LanguageModelRequestMetadata = {
     /**
-     * Presence penalty setting. It affects the likelihood of the model to
-     * repeat information that is already in the prompt.
-     *
-     * The presence penalty is a number between -1 (increase repetition)
-     * and 1 (maximum penalty, decrease repetition). 0 means no penalty.
+     * Request HTTP body that was sent to the provider API.
      */
-    presencePenalty?: number;
+    body?: unknown;
+};
+
+type LanguageModelResponseMetadata = {
     /**
-     * Frequency penalty setting. It affects the likelihood of the model
-     * to repeatedly use the same words or phrases.
-     *
-     * The frequency penalty is a number between -1 (increase repetition)
-     * and 1 (maximum penalty, decrease repetition). 0 means no penalty.
+     * ID for the generated response.
      */
-    frequencyPenalty?: number;
+    id: string;
     /**
-     * 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.
+     * Timestamp for the start of the generated response.
      */
-    stopSequences?: string[];
+    timestamp: Date;
     /**
-     * The seed (integer) to use for random sampling. If set and supported
-     * by the model, calls will generate deterministic results.
+     * The ID of the response model that was used to generate the response.
      */
-    seed?: number;
+    modelId: string;
     /**
-     * Reasoning effort level for the model. Controls how much reasoning
-     * the model performs before generating a response.
-     *
-     * Use `'provider-default'` to use the provider's default reasoning level.
-     * Use `'none'` to disable reasoning (if supported by the provider).
+     * Response headers (available only for providers that use HTTP requests).
      */
-    reasoning?: LanguageModelV4CallOptions['reasoning'];
+    headers?: Record<string, string>;
 };
 
 /**
- * Validates model call options and returns a new object with normalized values.
- */
-declare function prepareLanguageModelCallOptions({ maxOutputTokens, temperature, topP, topK, presencePenalty, frequencyPenalty, seed, stopSequences, reasoning, }: LanguageModelCallOptions): LanguageModelCallOptions;
-
-type RetryFunction = <OUTPUT>(fn: () => PromiseLike<OUTPUT>) => PromiseLike<OUTPUT>;
-
-/**
- * Validate and prepare retries.
+ * Additional provider-specific metadata that is returned from the provider.
+ *
+ * This is needed to enable provider-specific functionality that can be
+ * fully encapsulated in the provider.
  */
-declare function prepareRetries({ maxRetries, abortSignal, }: {
-    maxRetries: number | undefined;
-    abortSignal: AbortSignal | undefined;
-}): {
-    maxRetries: number;
-    retry: RetryFunction;
-};
+type ProviderMetadata = SharedV4ProviderMetadata;
 
 /**
  * Represents the number of tokens used in a prompt and completion.
@@ -351,87 +180,18 @@ type LanguageModelUsage = {
      * This is the usage information in the shape that the provider returns.
      * It can include additional information that is not part of the standard usage information.
      */
-    raw?: JSONObject;
-};
-/**
- * Represents the number of tokens used in an embedding.
- */
-type EmbeddingModelUsage = {
-    /**
-     * The number of tokens used in the embedding.
-     */
-    tokens: number;
-};
-declare function asLanguageModelUsage(usage: LanguageModelV4Usage): LanguageModelUsage;
-
-/**
- * Embedding.
- */
-type Embedding = EmbeddingModelV4Embedding;
-
-declare function resolveLanguageModel(model: LanguageModel): LanguageModelV4;
-
-/**
- * Merges multiple abort sources into a single `AbortSignal`.
- * The returned signal will abort when any input signal aborts or when any
- * numeric timeout elapses, using the reason from the first source to abort.
- *
- * @param signals - Abort signals or timeout durations in milliseconds.
- * `null` and `undefined` values are ignored.
- * @returns An `AbortSignal` that aborts when any valid source aborts,
- * or `undefined` if no valid sources are provided.
- */
-declare function mergeAbortSignals(...signals: (AbortSignal | null | undefined | number)[]): AbortSignal | undefined;
-
-/**
- * A callback function that can be used with `notify`.
- */
-type Callback<EVENT> = (event: EVENT) => PromiseLike<void> | void;
-
-/**
- * Creates an async callback that invokes the provided callbacks in parallel.
- * Undefined callbacks are skipped, and thrown or rejected callback errors are
- * ignored.
- *
- * @param callbacks The callbacks to invoke for each event.
- * @returns A callback that forwards each event to all callbacks and waits for
- * them to settle.
- */
-declare function mergeCallbacks<EVENT>(...callbacks: Array<Callback<EVENT> | undefined>): Callback<EVENT>;
-
-type LanguageModelRequestMetadata = {
-    /**
-     * Request HTTP body that was sent to the provider API.
-     */
-    body?: unknown;
-};
-
-type LanguageModelResponseMetadata = {
-    /**
-     * ID for the generated response.
-     */
-    id: string;
-    /**
-     * 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 (available only for providers that use HTTP requests).
-     */
-    headers?: Record<string, string>;
+    raw?: JSONObject;
 };
-
 /**
- * Additional provider-specific metadata that is returned from the provider.
- *
- * This is needed to enable provider-specific functionality that can be
- * fully encapsulated in the provider.
+ * Represents the number of tokens used in an embedding.
  */
-type ProviderMetadata = SharedV4ProviderMetadata;
+type EmbeddingModelUsage = {
+    /**
+     * The number of tokens used in the embedding.
+     */
+    tokens: number;
+};
+declare function asLanguageModelUsage(usage: LanguageModelV4Usage): LanguageModelUsage;
 
 /**
  * Warning from the model provider for this call. The call will proceed, but e.g.
@@ -724,6 +484,75 @@ interface GenerateObjectEndEvent<RESULT> {
     readonly providerMetadata: ProviderMetadata | undefined;
 }
 
+/**
+ * Model-facing generation controls. These settings influence how the model
+ * generates its response (token limits, sampling, penalties, stop sequences,
+ * seed, reasoning).
+ */
+type LanguageModelCallOptions = {
+    /**
+     * Maximum number of tokens to generate.
+     */
+    maxOutputTokens?: number;
+    /**
+     * Temperature setting. The range depends on the provider and model.
+     *
+     * It is recommended to set either `temperature` or `topP`, but not both.
+     */
+    temperature?: number;
+    /**
+     * Nucleus sampling. This is a number between 0 and 1.
+     *
+     * E.g. 0.1 would mean that only tokens with the top 10% probability mass
+     * are considered.
+     *
+     * It is recommended to set either `temperature` or `topP`, but not both.
+     */
+    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.
+     *
+     * The presence penalty is a number between -1 (increase repetition)
+     * and 1 (maximum penalty, decrease repetition). 0 means no penalty.
+     */
+    presencePenalty?: number;
+    /**
+     * Frequency penalty setting. It affects the likelihood of the model
+     * to repeatedly use the same words or phrases.
+     *
+     * The frequency penalty is a number between -1 (increase repetition)
+     * and 1 (maximum penalty, decrease repetition). 0 means no penalty.
+     */
+    frequencyPenalty?: 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[];
+    /**
+     * The seed (integer) to use for random sampling. If set and supported
+     * by the model, calls will generate deterministic results.
+     */
+    seed?: number;
+    /**
+     * Reasoning effort level for the model. Controls how much reasoning
+     * the model performs before generating a response.
+     *
+     * Use `'provider-default'` to use the provider's default reasoning level.
+     * Use `'none'` to disable reasoning (if supported by the provider).
+     */
+    reasoning?: LanguageModelV4CallOptions['reasoning'];
+};
+
 /**
  * Timeout configuration for API calls. Can be specified as:
  * - A number representing milliseconds
@@ -741,6 +570,79 @@ type TimeoutConfiguration<TOOLS extends ToolSet> = number | {
     tools?: Partial<Record<`${keyof TOOLS & string}Ms`, number>>;
 };
 
+/**
+ * Prompt part of the AI function options.
+ * It contains a system message, a simple text prompt, or a list of messages.
+ */
+type Prompt = {
+    /**
+     * System message to include in the prompt. Can be used with `prompt` or `messages`.
+     */
+    system?: string | SystemModelMessage | Array<SystemModelMessage>;
+    /**
+     * Whether system messages are allowed in the `prompt` or `messages` fields.
+     *
+     * When disabled, system messages must be provided through the `system` option.
+     *
+     * @default false
+     */
+    allowSystemInMessages?: boolean;
+} & ({
+    /**
+     * A prompt. It can be either a text prompt or a list of messages.
+     *
+     * You can either use `prompt` or `messages` but not both.
+     */
+    prompt: string | Array<ModelMessage>;
+    /**
+     * A list of messages.
+     *
+     * You can either use `prompt` or `messages` but not both.
+     */
+    messages?: never;
+} | {
+    /**
+     * A list of messages.
+     *
+     * You can either use `prompt` or `messages` but not both.
+     */
+    messages: Array<ModelMessage>;
+    /**
+     * A prompt. It can be either a text prompt or a list of messages.
+     *
+     * You can either use `prompt` or `messages` but not both.
+     */
+    prompt?: never;
+});
+
+type StandardizedPrompt = {
+    /**
+     * System message.
+     */
+    system?: string | SystemModelMessage | Array<SystemModelMessage>;
+    /**
+     * Messages.
+     */
+    messages: ModelMessage[];
+};
+/**
+ * Converts a prompt input into a standardized prompt with validated model
+ * messages.
+ *
+ * @param prompt - The prompt definition to standardize.
+ * Set `allowSystemInMessages` to true to allow system messages in the
+ * `prompt` or `messages` fields. System messages in the `system` option are
+ * always allowed.
+ * @returns The standardized prompt.
+ * @throws {InvalidPromptError} When the prompt is invalid.
+ */
+declare function standardizePrompt({ allowSystemInMessages, system, prompt, messages, }: Prompt): Promise<StandardizedPrompt>;
+
+/**
+ * A callback function that can be used with `notify`.
+ */
+type Callback<EVENT> = (event: EVENT) => PromiseLike<void> | void;
+
 /**
  * Tool names that are enabled for a generation step.
  *
@@ -786,6 +688,31 @@ type TelemetryOptions = {
     integrations?: Arrayable<Telemetry>;
 };
 
+/**
+ * Experimental. Can change in patch versions without warning.
+ *
+ * Download function. Called with the array of URLs and a boolean indicating
+ * whether the URL is supported by the model.
+ *
+ * The download function can decide for each URL:
+ * - to return null (which means that the URL should be passed to the model)
+ * - to download the asset and return the data (incl. retries, authentication, etc.)
+ *
+ * Should throw DownloadError if the download fails.
+ *
+ * Should return an array of objects sorted by the order of the requested downloads.
+ * For each object, the data should be a Uint8Array if the URL was downloaded.
+ * For each object, the mediaType should be the media type of the downloaded asset.
+ * For each object, the data should be null if the URL should be passed through as is.
+ */
+type DownloadFunction = (options: Array<{
+    url: URL;
+    isUrlSupportedByModel: boolean;
+}>) => PromiseLike<Array<{
+    data: Uint8Array;
+    mediaType: string | undefined;
+} | null>>;
+
 /**
  * A generated file.
  */
@@ -1226,6 +1153,21 @@ type StepResult<TOOLS extends ToolSet, RUNTIME_CONTEXT extends Context = Context
     readonly providerMetadata: ProviderMetadata | undefined;
 };
 
+/**
+ * A type that combines AsyncIterable and ReadableStream.
+ * This allows a ReadableStream to be consumed using for-await-of syntax.
+ */
+type AsyncIterableStream<T> = AsyncIterable<T> & ReadableStream<T>;
+/**
+ * Wraps a ReadableStream and returns an object that is both a ReadableStream and an AsyncIterable.
+ * This enables consumption of the stream using for-await-of, with proper resource cleanup on early exit or error.
+ *
+ * @template T The type of the stream's chunks.
+ * @param source The source ReadableStream to wrap.
+ * @returns An AsyncIterableStream that can be used as both a ReadableStream and an AsyncIterable.
+ */
+declare function createAsyncIterableStream<T>(source: ReadableStream<T>): AsyncIterableStream<T>;
+
 /**
  * Tool output when the tool execution has been denied (for static tools).
  */
@@ -1887,4 +1829,62 @@ declare global {
     var AI_SDK_TELEMETRY_INTEGRATIONS: Telemetry[] | undefined;
 }
 
+declare function convertToLanguageModelPrompt({ prompt, supportedUrls, download, provider, }: {
+    prompt: StandardizedPrompt;
+    supportedUrls: Record<string, RegExp[]>;
+    download: DownloadFunction | undefined;
+    provider?: string;
+}): Promise<LanguageModelV4Prompt>;
+
+declare function prepareToolChoice({ toolChoice, }: {
+    toolChoice: ToolChoice<any> | undefined;
+}): LanguageModelV4ToolChoice;
+
+declare function prepareTools<TOOLS extends ToolSet>({ tools, }: {
+    tools: TOOLS | undefined;
+}): Promise<Array<LanguageModelV4FunctionTool | LanguageModelV4ProviderTool> | undefined>;
+
+/**
+ * Validates model call options and returns a new object with normalized values.
+ */
+declare function prepareLanguageModelCallOptions({ maxOutputTokens, temperature, topP, topK, presencePenalty, frequencyPenalty, seed, stopSequences, reasoning, }: LanguageModelCallOptions): LanguageModelCallOptions;
+
+type RetryFunction = <OUTPUT>(fn: () => PromiseLike<OUTPUT>) => PromiseLike<OUTPUT>;
+
+/**
+ * Validate and prepare retries.
+ */
+declare function prepareRetries({ maxRetries, abortSignal, }: {
+    maxRetries: number | undefined;
+    abortSignal: AbortSignal | undefined;
+}): {
+    maxRetries: number;
+    retry: RetryFunction;
+};
+
+declare function resolveLanguageModel(model: LanguageModel): LanguageModelV4;
+
+/**
+ * Merges multiple abort sources into a single `AbortSignal`.
+ * The returned signal will abort when any input signal aborts or when any
+ * numeric timeout elapses, using the reason from the first source to abort.
+ *
+ * @param signals - Abort signals or timeout durations in milliseconds.
+ * `null` and `undefined` values are ignored.
+ * @returns An `AbortSignal` that aborts when any valid source aborts,
+ * or `undefined` if no valid sources are provided.
+ */
+declare function mergeAbortSignals(...signals: (AbortSignal | null | undefined | number)[]): AbortSignal | undefined;
+
+/**
+ * Creates an async callback that invokes the provided callbacks in parallel.
+ * Undefined callbacks are skipped, and thrown or rejected callback errors are
+ * ignored.
+ *
+ * @param callbacks The callbacks to invoke for each event.
+ * @returns A callback that forwards each event to all callbacks and waits for
+ * them to settle.
+ */
+declare function mergeCallbacks<EVENT>(...callbacks: Array<Callback<EVENT> | undefined>): Callback<EVENT>;
+
 export { asLanguageModelUsage, convertToLanguageModelPrompt, createAsyncIterableStream, mergeAbortSignals, mergeCallbacks, prepareLanguageModelCallOptions as prepareCallSettings, prepareLanguageModelCallOptions, prepareRetries, prepareToolChoice, prepareTools, resolveLanguageModel, standardizePrompt };