ai 5.0.0-canary.5 → 5.0.0-canary.7

package/dist/internal/index.d.ts

@@ -1,246 +1,7 @@
+import { LanguageModelV2ProviderMetadata, LanguageModelV2Usage, LanguageModelV2Source, JSONValue as JSONValue$1, JSONObject, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice, LanguageModelV2Prompt } from '@ai-sdk/provider';
 import { z } from 'zod';
 import { ToolCall, ToolResult, Validator } from '@ai-sdk/provider-utils';
 import { JSONSchema7 } from 'json-schema';
-import { LanguageModelV2ProviderMetadata, LanguageModelV2Source, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice, LanguageModelV2Prompt } from '@ai-sdk/provider';
-
-/**
-Tool choice for the generation. It supports the following settings:
-
-- `auto` (default): the model can choose whether and which tools to call.
-- `required`: the model must call a tool. It can choose which tool to call.
-- `none`: the model must not call tools
-- `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool
- */
-type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
-    type: 'tool';
-    toolName: keyof TOOLS;
-};
-
-/**
-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.
- */
-type ProviderMetadata = LanguageModelV2ProviderMetadata;
-/**
-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.
- */
-type ProviderOptions = LanguageModelV2ProviderMetadata;
-
-/**
-Represents the number of tokens used in a prompt and completion.
- */
-type LanguageModelUsage = {
-    /**
-  The number of tokens used in the prompt.
-     */
-    promptTokens: number;
-    /**
-  The number of tokens used in the completion.
-   */
-    completionTokens: number;
-    /**
-  The total number of tokens used (promptTokens + completionTokens).
-     */
-    totalTokens: number;
-};
-declare function calculateLanguageModelUsage({ promptTokens, completionTokens, }: {
-    promptTokens: number;
-    completionTokens: number;
-}): LanguageModelUsage;
-
-/**
-Tool invocations are either tool calls or tool results. For each assistant tool call,
-there is one tool invocation. While the call is in progress, the invocation is a tool call.
-Once the call is complete, the invocation is a tool result.
-
-The step is used to track how to map an assistant UI message with many tool invocations
-back to a sequence of LLM assistant/tool result message pairs.
-It is optional for backwards compatibility.
- */
-type ToolInvocation = ({
-    state: 'partial-call';
-    step?: number;
-} & ToolCall<string, any>) | ({
-    state: 'call';
-    step?: number;
-} & ToolCall<string, any>) | ({
-    state: 'result';
-    step?: number;
-} & ToolResult<string, any, any>);
-/**
- * An attachment that can be sent along with a message.
- */
-interface Attachment {
-    /**
-     * The name of the attachment, usually the file name.
-     */
-    name?: string;
-    /**
-     * A string indicating the [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type).
-     * By default, it's extracted from the pathname's extension.
-     */
-    contentType?: string;
-    /**
-     * The URL of the attachment. It can either be a URL to a hosted file or a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
-     */
-    url: string;
-}
-/**
- * AI SDK UI Messages. They are used in the client and to communicate between the frontend and the API routes.
- */
-interface Message {
-    /**
-  A unique identifier for the message.
-     */
-    id: string;
-    /**
-  The timestamp of the message.
-     */
-    createdAt?: Date;
-    /**
-  Text content of the message. Use parts when possible.
-     */
-    content: string;
-    /**
-  Reasoning for the message.
-  
-  @deprecated Use `parts` instead.
-     */
-    reasoning?: string;
-    /**
-     * Additional attachments to be sent along with the message.
-     */
-    experimental_attachments?: Attachment[];
-    /**
-  The 'data' role is deprecated.
-     */
-    role: 'system' | 'user' | 'assistant' | 'data';
-    /**
-  For data messages.
-  
-  @deprecated Data messages will be removed.
-     */
-    data?: JSONValue;
-    /**
-     * Additional message-specific information added on the server via StreamData
-     */
-    annotations?: JSONValue[] | undefined;
-    /**
-  Tool invocations (that can be tool calls or tool results, depending on whether or not the invocation has finished)
-  that the assistant made as part of this message.
-  
-  @deprecated Use `parts` instead.
-     */
-    toolInvocations?: Array<ToolInvocation>;
-    /**
-     * The parts of the message. Use this for rendering the message in the UI.
-     *
-     * Assistant messages can have text, reasoning and tool invocation parts.
-     * User messages can have text parts.
-     */
-    parts?: Array<TextUIPart | ReasoningUIPart | ToolInvocationUIPart | SourceUIPart | FileUIPart | StepStartUIPart>;
-}
-/**
- * A text part of a message.
- */
-type TextUIPart = {
-    type: 'text';
-    /**
-     * The text content.
-     */
-    text: string;
-};
-/**
- * A reasoning part of a message.
- */
-type ReasoningUIPart = {
-    type: 'reasoning';
-    /**
-     * The reasoning text.
-     */
-    reasoning: string;
-    details: Array<{
-        type: 'text';
-        text: string;
-        signature?: string;
-    } | {
-        type: 'redacted';
-        data: string;
-    }>;
-};
-/**
- * A tool invocation part of a message.
- */
-type ToolInvocationUIPart = {
-    type: 'tool-invocation';
-    /**
-     * The tool invocation.
-     */
-    toolInvocation: ToolInvocation;
-};
-/**
- * A source part of a message.
- */
-type SourceUIPart = {
-    type: 'source';
-    /**
-     * The source.
-     */
-    source: LanguageModelV2Source;
-};
-/**
- * A file part of a message.
- */
-type FileUIPart = {
-    type: 'file';
-    /**
-     * IANA media type of the file.
-     *
-     * @see https://www.iana.org/assignments/media-types/media-types.xhtml
-     */
-    mediaType: string;
-    /**
-     * The base64 encoded data.
-     */
-    data: string;
-};
-/**
- * A step boundary part of a message.
- */
-type StepStartUIPart = {
-    type: 'step-start';
-};
-/**
-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 | {
-    [value: string]: JSONValue;
-} | Array<JSONValue>;
-
-/**
- * Used to mark schemas so we can support both Zod and custom schemas.
- */
-declare const schemaSymbol: unique symbol;
-type Schema<OBJECT = unknown> = Validator<OBJECT> & {
-    /**
-     * Used to mark schemas so we can support both Zod and custom schemas.
-     */
-    [schemaSymbol]: true;
-    /**
-     * Schema type for inference.
-     */
-    _type: OBJECT;
-    /**
-     * The JSON Schema for the schema. It is passed to the providers.
-     */
-    readonly jsonSchema: JSONSchema7;
-};
 
 type ToolResultContent = Array<{
     type: 'text';
@@ -255,6 +16,14 @@ type ToolResultContent = Array<{
     mimeType?: 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.
+ */
+type ProviderOptions = LanguageModelV2ProviderMetadata;
+
 /**
 Data content. Can either be a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer.
  */
@@ -275,10 +44,6 @@ interface TextPart {
   functionality that can be fully encapsulated in the provider.
    */
     providerOptions?: ProviderOptions;
-    /**
-  @deprecated Use `providerOptions` instead.
-   */
-    experimental_providerMetadata?: ProviderMetadata;
 }
 /**
 Image content part of a prompt. It contains an image.
@@ -308,10 +73,6 @@ interface ImagePart {
   functionality that can be fully encapsulated in the provider.
    */
     providerOptions?: ProviderOptions;
-    /**
-  @deprecated Use `providerOptions` instead.
-   */
-    experimental_providerMetadata?: ProviderMetadata;
 }
 /**
 File content part of a prompt. It contains a file.
@@ -345,10 +106,6 @@ interface FilePart {
   functionality that can be fully encapsulated in the provider.
    */
     providerOptions?: ProviderOptions;
-    /**
-  @deprecated Use `providerOptions` instead.
-   */
-    experimental_providerMetadata?: ProviderMetadata;
 }
 /**
  * Reasoning content part of a prompt. It contains a reasoning.
@@ -369,10 +126,6 @@ interface ReasoningPart {
   functionality that can be fully encapsulated in the provider.
    */
     providerOptions?: ProviderOptions;
-    /**
-  @deprecated Use `providerOptions` instead.
-   */
-    experimental_providerMetadata?: ProviderMetadata;
 }
 /**
 Redacted reasoning content part of a prompt.
@@ -389,10 +142,6 @@ interface RedactedReasoningPart {
   functionality that can be fully encapsulated in the provider.
    */
     providerOptions?: ProviderOptions;
-    /**
-  @deprecated Use `providerOptions` instead.
-   */
-    experimental_providerMetadata?: ProviderMetadata;
 }
 /**
 Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
@@ -417,10 +166,6 @@ interface ToolCallPart {
   functionality that can be fully encapsulated in the provider.
    */
     providerOptions?: ProviderOptions;
-    /**
-  @deprecated Use `providerOptions` instead.
-   */
-    experimental_providerMetadata?: ProviderMetadata;
 }
 /**
 Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
@@ -453,10 +198,6 @@ interface ToolResultPart {
   functionality that can be fully encapsulated in the provider.
    */
     providerOptions?: ProviderOptions;
-    /**
-  @deprecated Use `providerOptions` instead.
-   */
-    experimental_providerMetadata?: ProviderMetadata;
 }
 
 /**
@@ -475,10 +216,6 @@ type CoreSystemMessage = {
   functionality that can be fully encapsulated in the provider.
    */
     providerOptions?: ProviderOptions;
-    /**
-  @deprecated Use `providerOptions` instead.
-   */
-    experimental_providerMetadata?: ProviderMetadata;
 };
 /**
 A user message. It can contain text or a combination of text and images.
@@ -492,10 +229,6 @@ type CoreUserMessage = {
   functionality that can be fully encapsulated in the provider.
    */
     providerOptions?: ProviderOptions;
-    /**
-  @deprecated Use `providerOptions` instead.
-  */
-    experimental_providerMetadata?: ProviderMetadata;
 };
 /**
 Content of a user message. It can be a string or an array of text and image parts.
@@ -513,10 +246,6 @@ type CoreAssistantMessage = {
   functionality that can be fully encapsulated in the provider.
    */
     providerOptions?: ProviderOptions;
-    /**
-  @deprecated Use `providerOptions` instead.
-  */
-    experimental_providerMetadata?: ProviderMetadata;
 };
 /**
 Content of an assistant message.
@@ -535,10 +264,6 @@ type CoreToolMessage = {
   functionality that can be fully encapsulated in the provider.
    */
     providerOptions?: ProviderOptions;
-    /**
-  @deprecated Use `providerOptions` instead.
-  */
-    experimental_providerMetadata?: ProviderMetadata;
 };
 /**
 Content of a tool message. It is an array of tool result parts.
@@ -550,8 +275,228 @@ It can be a user message, an assistant message, or a tool message.
  */
 type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
 
-type ToolParameters = z.ZodTypeAny | Schema<any>;
-type inferParameters<PARAMETERS extends ToolParameters> = PARAMETERS extends Schema<any> ? PARAMETERS['_type'] : PARAMETERS extends z.ZodTypeAny ? z.infer<PARAMETERS> : never;
+/**
+Tool choice for the generation. It supports the following settings:
+
+- `auto` (default): the model can choose whether and which tools to call.
+- `required`: the model must call a tool. It can choose which tool to call.
+- `none`: the model must not call tools
+- `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool
+ */
+type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
+    type: 'tool';
+    toolName: Extract<keyof TOOLS, string>;
+};
+
+/**
+Represents the number of tokens used in a prompt and completion.
+ */
+type LanguageModelUsage = {
+    /**
+  The number of tokens used in the prompt.
+     */
+    promptTokens: number;
+    /**
+  The number of tokens used in the completion.
+   */
+    completionTokens: number;
+    /**
+  The total number of tokens used (promptTokens + completionTokens).
+     */
+    totalTokens: number;
+};
+declare function calculateLanguageModelUsage({ inputTokens, outputTokens, }: LanguageModelV2Usage): LanguageModelUsage;
+
+/**
+Tool invocations are either tool calls or tool results. For each assistant tool call,
+there is one tool invocation. While the call is in progress, the invocation is a tool call.
+Once the call is complete, the invocation is a tool result.
+
+The step is used to track how to map an assistant UI message with many tool invocations
+back to a sequence of LLM assistant/tool result message pairs.
+It is optional for backwards compatibility.
+ */
+type ToolInvocation = ({
+    state: 'partial-call';
+    step?: number;
+} & ToolCall<string, any>) | ({
+    state: 'call';
+    step?: number;
+} & ToolCall<string, any>) | ({
+    state: 'result';
+    step?: number;
+} & ToolResult<string, any, any>);
+/**
+ * An attachment that can be sent along with a message.
+ */
+interface Attachment {
+    /**
+     * The name of the attachment, usually the file name.
+     */
+    name?: string;
+    /**
+     * A string indicating the [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type).
+     * By default, it's extracted from the pathname's extension.
+     */
+    contentType?: string;
+    /**
+     * The URL of the attachment. It can either be a URL to a hosted file or a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
+     */
+    url: string;
+}
+/**
+ * AI SDK UI Messages. They are used in the client and to communicate between the frontend and the API routes.
+ */
+interface Message {
+    /**
+  A unique identifier for the message.
+     */
+    id: string;
+    /**
+  The timestamp of the message.
+     */
+    createdAt?: Date;
+    /**
+  Text content of the message. Use parts when possible.
+     */
+    content: string;
+    /**
+  Reasoning for the message.
+  
+  @deprecated Use `parts` instead.
+     */
+    reasoning?: string;
+    /**
+     * Additional attachments to be sent along with the message.
+     */
+    experimental_attachments?: Attachment[];
+    /**
+  The 'data' role is deprecated.
+     */
+    role: 'system' | 'user' | 'assistant' | 'data';
+    /**
+  For data messages.
+  
+  @deprecated Data messages will be removed.
+     */
+    data?: JSONValue;
+    /**
+     * Additional message-specific information added on the server via StreamData
+     */
+    annotations?: JSONValue[] | undefined;
+    /**
+  Tool invocations (that can be tool calls or tool results, depending on whether or not the invocation has finished)
+  that the assistant made as part of this message.
+  
+  @deprecated Use `parts` instead.
+     */
+    toolInvocations?: Array<ToolInvocation>;
+    /**
+     * The parts of the message. Use this for rendering the message in the UI.
+     *
+     * Assistant messages can have text, reasoning and tool invocation parts.
+     * User messages can have text parts.
+     */
+    parts?: Array<TextUIPart | ReasoningUIPart | ToolInvocationUIPart | SourceUIPart | FileUIPart | StepStartUIPart>;
+}
+/**
+ * A text part of a message.
+ */
+type TextUIPart = {
+    type: 'text';
+    /**
+     * The text content.
+     */
+    text: string;
+};
+/**
+ * A reasoning part of a message.
+ */
+type ReasoningUIPart = {
+    type: 'reasoning';
+    /**
+     * The reasoning text.
+     */
+    reasoning: string;
+    details: Array<{
+        type: 'text';
+        text: string;
+        signature?: string;
+    } | {
+        type: 'redacted';
+        data: string;
+    }>;
+};
+/**
+ * A tool invocation part of a message.
+ */
+type ToolInvocationUIPart = {
+    type: 'tool-invocation';
+    /**
+     * The tool invocation.
+     */
+    toolInvocation: ToolInvocation;
+};
+/**
+ * A source part of a message.
+ */
+type SourceUIPart = {
+    type: 'source';
+    /**
+     * The source.
+     */
+    source: LanguageModelV2Source;
+};
+/**
+ * A file part of a message.
+ */
+type FileUIPart = {
+    type: 'file';
+    /**
+     * IANA media type of the file.
+     *
+     * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+     */
+    mediaType: string;
+    /**
+     * The base64 encoded data.
+     */
+    data: string;
+};
+/**
+ * A step boundary part of a message.
+ */
+type StepStartUIPart = {
+    type: 'step-start';
+};
+/**
+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 | {
+    [value: string]: JSONValue;
+} | Array<JSONValue>;
+
+/**
+ * Used to mark schemas so we can support both Zod and custom schemas.
+ */
+declare const schemaSymbol: unique symbol;
+type Schema<OBJECT = unknown> = Validator<OBJECT> & {
+    /**
+     * Used to mark schemas so we can support both Zod and custom schemas.
+     */
+    [schemaSymbol]: true;
+    /**
+     * Schema type for inference.
+     */
+    _type: OBJECT;
+    /**
+     * The JSON Schema for the schema. It is passed to the providers.
+     */
+    readonly jsonSchema: JSONSchema7;
+};
+
+type ToolParameters<T = JSONObject> = z.Schema<T> | Schema<T>;
 interface ToolExecutionOptions {
     /**
      * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.
@@ -567,58 +512,61 @@ interface ToolExecutionOptions {
      */
     abortSignal?: AbortSignal;
 }
+type NeverOptional<N, T> = 0 extends 1 & N ? Partial<T> : [N] extends [never] ? Partial<Record<keyof T, undefined>> : T;
 /**
 A tool contains the description and the schema of the input that the tool expects.
 This enables the language model to generate the input.
 
 The tool can also contain an optional execute function for the actual execution function of the tool.
  */
-type Tool<PARAMETERS extends ToolParameters = any, RESULT = any> = {
-    /**
-  The schema of the input that the tool expects. The language model will use this to generate the input.
-  It is also used to validate the output of the language model.
-  Use descriptions to make the input understandable for the language model.
-     */
-    parameters: PARAMETERS;
+type Tool<PARAMETERS extends JSONValue$1 | unknown | never = any, RESULT = any> = {
     /**
   An optional description of what the tool does.
   Will be used by the language model to decide whether to use the tool.
   Not used for provider-defined tools.
      */
     description?: string;
+} & NeverOptional<PARAMETERS, {
     /**
-  Optional conversion function that maps the tool result to multi-part tool content for LLMs.
-     */
-    experimental_toToolResultContent?: (result: RESULT) => ToolResultContent;
+The schema of the input that the tool expects. The language model will use this to generate the input.
+It is also used to validate the output of the language model.
+Use descriptions to make the input understandable for the language model.
+   */
+    parameters: ToolParameters<PARAMETERS>;
+}> & NeverOptional<RESULT, {
     /**
-  An async function that is called with the arguments from the tool call and produces a result.
-  If not provided, the tool will not be executed automatically.
-  
-  @args is the input of the tool call.
-  @options.abortSignal is a signal that can be used to abort the tool call.
-     */
-    execute?: (args: inferParameters<PARAMETERS>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
-} & ({
+An async function that is called with the arguments from the tool call and produces a result.
+If not provided, the tool will not be executed automatically.
+
+@args is the input of the tool call.
+@options.abortSignal is a signal that can be used to abort the tool call.
+    */
+    execute: (args: [PARAMETERS] extends [never] ? undefined : PARAMETERS, options: ToolExecutionOptions) => PromiseLike<RESULT>;
+    /**
+Optional conversion function that maps the tool result to multi-part tool content for LLMs.
+    */
+    experimental_toToolResultContent?: (result: RESULT) => ToolResultContent;
+}> & ({
     /**
 Function tool.
-     */
+   */
     type?: undefined | 'function';
 } | {
     /**
 Provider-defined tool.
-     */
+   */
     type: 'provider-defined';
     /**
 The ID of the tool. Should follow the format `<provider-name>.<tool-name>`.
-     */
+   */
     id: `${string}.${string}`;
     /**
 The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
-     */
+   */
     args: Record<string, unknown>;
 });
 
-type ToolSet = Record<string, Tool>;
+type ToolSet = Record<string, (Tool<never, never> | Tool<any, any> | Tool<any, never> | Tool<never, any>) & Pick<Tool<any, any>, 'execute'>>;
 
 /**
 Prompt part of the AI function options.
@@ -663,7 +611,7 @@ type CallSettings = {
     /**
   Maximum number of tokens to generate.
      */
-    maxTokens?: number;
+    maxOutputTokens?: number;
     /**
   Temperature setting. This is a number between 0 (almost no randomness) and
   1 (very random).
@@ -757,7 +705,7 @@ declare function prepareRetries({ maxRetries, }: {
 /**
  * Validates call settings and sets default values.
  */
-declare function prepareCallSettings({ maxTokens, temperature, topP, topK, presencePenalty, frequencyPenalty, stopSequences, seed, }: Omit<CallSettings, 'abortSignal' | 'headers' | 'maxRetries'>): Omit<CallSettings, 'abortSignal' | 'headers' | 'maxRetries'>;
+declare function prepareCallSettings({ maxOutputTokens, temperature, topP, topK, presencePenalty, frequencyPenalty, stopSequences, seed, }: Omit<CallSettings, 'abortSignal' | 'headers' | 'maxRetries'>): Omit<CallSettings, 'abortSignal' | 'headers' | 'maxRetries'>;
 
 declare function download({ url }: {
     url: URL;