ai 5.0.0-canary.9 → 5.0.0

package/dist/internal/index.d.ts

@@ -1,573 +1,14 @@
-import { SharedV2ProviderOptions, 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 { ModelMessage, Tool } from '@ai-sdk/provider-utils';
+export { convertAsyncIteratorToReadableStream } from '@ai-sdk/provider-utils';
+import { LanguageModelV2Prompt, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice } from '@ai-sdk/provider';
 
-type ToolResultContent = Array<{
-    type: 'text';
-    text: string;
-} | {
-    type: 'image';
-    data: string;
-    mediaType?: string;
-    /**
-     * @deprecated Use `mediaType` instead.
-     */
-    mimeType?: string;
+declare function download({ url }: {
+    url: URL;
+}): Promise<{
+    data: Uint8Array;
+    mediaType: 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.
- */
-type ProviderOptions = SharedV2ProviderOptions;
-
-/**
-Data content. Can either be a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer.
- */
-type DataContent = string | Uint8Array | ArrayBuffer | Buffer;
-
-/**
-Text content part of a prompt. It contains a string of text.
- */
-interface TextPart {
-    type: 'text';
-    /**
-  The text content.
-     */
-    text: string;
-    /**
-  Additional provider-specific metadata. 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?: ProviderOptions;
-}
-/**
-Image content part of a prompt. It contains an image.
- */
-interface ImagePart {
-    type: 'image';
-    /**
-  Image data. Can either be:
-  
-  - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
-  - URL: a URL that points to the image
-     */
-    image: DataContent | URL;
-    /**
-  Optional IANA media type of the image.
-  
-  @see https://www.iana.org/assignments/media-types/media-types.xhtml
-     */
-    mediaType?: string;
-    /**
-  @deprecated Use `mediaType` instead.
-     */
-    mimeType?: string;
-    /**
-  Additional provider-specific metadata. 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?: ProviderOptions;
-}
-/**
-File content part of a prompt. It contains a file.
- */
-interface FilePart {
-    type: 'file';
-    /**
-  File data. Can either be:
-  
-  - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
-  - URL: a URL that points to the image
-     */
-    data: DataContent | URL;
-    /**
-  Optional filename of the file.
-     */
-    filename?: string;
-    /**
-  IANA media type of the file.
-  
-  @see https://www.iana.org/assignments/media-types/media-types.xhtml
-     */
-    mediaType: string;
-    /**
-  @deprecated Use `mediaType` instead.
-     */
-    mimeType?: string;
-    /**
-  Additional provider-specific metadata. 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?: ProviderOptions;
-}
-/**
- * Reasoning content part of a prompt. It contains a reasoning.
- */
-interface ReasoningPart {
-    type: 'reasoning';
-    /**
-  The reasoning text.
-     */
-    text: string;
-    /**
-  An optional signature for verifying that the reasoning originated from the model.
-     */
-    signature?: string;
-    /**
-  Additional provider-specific metadata. 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?: ProviderOptions;
-}
-/**
-Redacted reasoning content part of a prompt.
- */
-interface RedactedReasoningPart {
-    type: 'redacted-reasoning';
-    /**
-  Redacted reasoning data.
-     */
-    data: string;
-    /**
-  Additional provider-specific metadata. 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?: ProviderOptions;
-}
-/**
-Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
- */
-interface ToolCallPart {
-    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.
-     */
-    args: unknown;
-    /**
-  Additional provider-specific metadata. 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?: ProviderOptions;
-}
-/**
-Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
- */
-interface ToolResultPart {
-    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. This is a JSON-serializable object.
-     */
-    result: unknown;
-    /**
-  Multi-part content of the tool result. Only for tools that support multipart results.
-     */
-    experimental_content?: ToolResultContent;
-    /**
-  Optional flag if the result is an error or an error message.
-     */
-    isError?: boolean;
-    /**
-  Additional provider-specific metadata. 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?: ProviderOptions;
-}
-
-/**
- A system message. It can contain system information.
-
- Note: using the "system" part of the prompt is strongly preferred
- to increase the resilience against prompt injection attacks,
- and because not all providers support several system messages.
- */
-type CoreSystemMessage = {
-    role: 'system';
-    content: string;
-    /**
-  Additional provider-specific metadata. 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?: ProviderOptions;
-};
-/**
-A user message. It can contain text or a combination of text and images.
- */
-type CoreUserMessage = {
-    role: 'user';
-    content: UserContent;
-    /**
-  Additional provider-specific metadata. 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?: ProviderOptions;
-};
-/**
-Content of a user message. It can be a string or an array of text and image parts.
- */
-type UserContent = string | Array<TextPart | ImagePart | FilePart>;
-/**
-An assistant message. It can contain text, tool calls, or a combination of text and tool calls.
- */
-type CoreAssistantMessage = {
-    role: 'assistant';
-    content: AssistantContent;
-    /**
-  Additional provider-specific metadata. 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?: ProviderOptions;
-};
-/**
-Content of an assistant message.
-It can be a string or an array of text, image, reasoning, redacted reasoning, and tool call parts.
- */
-type AssistantContent = string | Array<TextPart | FilePart | ReasoningPart | RedactedReasoningPart | ToolCallPart>;
-/**
-A tool message. It contains the result of one or more tool calls.
- */
-type CoreToolMessage = {
-    role: 'tool';
-    content: ToolContent;
-    /**
-  Additional provider-specific metadata. 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?: ProviderOptions;
-};
-/**
-Content of a tool message. It is an array of tool result parts.
- */
-type ToolContent = Array<ToolResultPart>;
-/**
-A message that can be used in the `messages` field of a prompt.
-It can be a user message, an assistant message, or a tool message.
- */
-type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
-
-/**
-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.
-     */
-    toolCallId: string;
-    /**
-     * Messages that were sent to the language model to initiate the response that contained the tool call.
-     * The messages **do not** include the system prompt nor the assistant response that contained the tool call.
-     */
-    messages: CoreMessage[];
-    /**
-     * An optional abort signal that indicates that the overall operation should be aborted.
-     */
-    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 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, {
-    /**
-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: [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<never, never> | Tool<any, any> | Tool<any, never> | Tool<never, any>) & Pick<Tool<any, any>, 'execute'>>;
-
 /**
 Prompt part of the AI function options.
 It contains a system message, a simple text prompt, or a list of messages.
@@ -578,21 +19,20 @@ type Prompt = {
      */
     system?: string;
     /**
-  A simple text prompt. You can either use `prompt` or `messages` but not both.
-   */
-    prompt?: string;
+  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.
+  A list of messages.
+  
+  You can either use `prompt` or `messages` but not both.
      */
-    messages?: Array<CoreMessage> | Array<Omit<Message, 'id'>>;
+    messages?: Array<ModelMessage>;
 };
 
 type StandardizedPrompt = {
-    /**
-     * Original prompt type. This is forwarded to the providers and can be used
-     * to write send raw text to providers that support it.
-     */
-    type: 'prompt' | 'messages';
     /**
      * System message.
      */
@@ -600,12 +40,15 @@ type StandardizedPrompt = {
     /**
      * Messages.
      */
-    messages: CoreMessage[];
+    messages: ModelMessage[];
 };
-declare function standardizePrompt<TOOLS extends ToolSet>({ prompt, tools, }: {
-    prompt: Prompt;
-    tools: undefined | TOOLS;
-}): StandardizedPrompt;
+declare function standardizePrompt(prompt: Prompt): Promise<StandardizedPrompt>;
+
+declare function convertToLanguageModelPrompt({ prompt, supportedUrls, downloadImplementation, }: {
+    prompt: StandardizedPrompt;
+    supportedUrls: Record<string, RegExp[]>;
+    downloadImplementation?: typeof download;
+}): Promise<LanguageModelV2Prompt>;
 
 type CallSettings = {
     /**
@@ -613,12 +56,9 @@ type CallSettings = {
      */
     maxOutputTokens?: number;
     /**
-  Temperature setting. This is a number between 0 (almost no randomness) and
-  1 (very random).
+  Temperature setting. The range depends on the provider and model.
   
   It is recommended to set either `temperature` or `topP`, but not both.
-  
-  @default 0
      */
     temperature?: number;
     /**
@@ -681,6 +121,21 @@ type CallSettings = {
     headers?: Record<string, string | undefined>;
 };
 
+/**
+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>;
+};
+
+type ToolSet = Record<string, (Tool<never, never> | Tool<any, any> | Tool<any, never> | Tool<never, any>) & Pick<Tool<any, any>, 'execute' | 'onInputAvailable' | 'onInputStart' | 'onInputDelta'>>;
+
 declare function prepareToolsAndToolChoice<TOOLS extends ToolSet>({ tools, toolChoice, activeTools, }: {
     tools: TOOLS | undefined;
     toolChoice: ToolChoice<TOOLS> | undefined;
@@ -690,41 +145,22 @@ declare function prepareToolsAndToolChoice<TOOLS extends ToolSet>({ tools, toolC
     toolChoice: LanguageModelV2ToolChoice | undefined;
 };
 
+/**
+ * Validates call settings and returns a new object with limited values.
+ */
+declare function prepareCallSettings({ maxOutputTokens, temperature, topP, topK, presencePenalty, frequencyPenalty, seed, stopSequences, }: Omit<CallSettings, 'abortSignal' | 'headers' | 'maxRetries'>): Omit<CallSettings, 'abortSignal' | 'headers' | 'maxRetries'>;
+
 type RetryFunction = <OUTPUT>(fn: () => PromiseLike<OUTPUT>) => PromiseLike<OUTPUT>;
 
 /**
  * Validate and prepare retries.
  */
-declare function prepareRetries({ maxRetries, }: {
+declare function prepareRetries({ maxRetries, abortSignal, }: {
     maxRetries: number | undefined;
+    abortSignal: AbortSignal | undefined;
 }): {
     maxRetries: number;
     retry: RetryFunction;
 };
 
-/**
- * Validates call settings and sets default values.
- */
-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;
-}): Promise<{
-    data: Uint8Array;
-    mediaType: string | undefined;
-}>;
-
-declare function convertToLanguageModelPrompt({ prompt, modelSupportsImageUrls, modelSupportsUrl, downloadImplementation, }: {
-    prompt: StandardizedPrompt;
-    modelSupportsImageUrls: boolean | undefined;
-    modelSupportsUrl: undefined | ((url: URL) => boolean);
-    downloadImplementation?: typeof download;
-}): Promise<LanguageModelV2Prompt>;
-
-/**
- * Warning time for notifying developers that a stream is hanging in dev mode
- * using a console.warn.
- */
-declare const HANGING_STREAM_WARNING_TIME_MS: number;
-
-export { HANGING_STREAM_WARNING_TIME_MS, calculateLanguageModelUsage, convertToLanguageModelPrompt, prepareCallSettings, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };
+export { convertToLanguageModelPrompt, prepareCallSettings, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };