ai 5.0.0-canary.19 → 5.0.0-canary.20

package/dist/internal/index.d.ts

@@ -1,5 +1,6 @@
-import { SharedV2ProviderOptions, JSONValue, LanguageModelV2Source, JSONObject, LanguageModelV2Prompt, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice } from '@ai-sdk/provider';
-import { ToolResultContent, ToolCall, ToolResult, Schema } from '@ai-sdk/provider-utils';
+import { ToolResultContent, Schema } from '@ai-sdk/provider-utils';
+export { convertAsyncIteratorToReadableStream } from '@ai-sdk/provider-utils';
+import { SharedV2ProviderOptions, LanguageModelV2Prompt, JSONValue, JSONObject, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice } from '@ai-sdk/provider';
 import { z } from 'zod';
 
 declare function download({ url }: {
@@ -240,215 +241,6 @@ It can be a user message, an assistant message, or a tool message.
  */
 type ModelMessage = SystemModelMessage | UserModelMessage | AssistantModelMessage | ToolModelMessage;
 
-/**
-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>;
-};
-
-/**
-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>);
-/**
- * AI SDK UI Messages. They are used in the client and to communicate between the frontend and the API routes.
- */
-interface UIMessage {
-    /**
-  A unique identifier for the message.
-     */
-    id: string;
-    /**
-  The timestamp of the message.
-     */
-    createdAt?: Date;
-    /**
-  The role of the message.
-     */
-    role: 'system' | 'user' | 'assistant';
-    /**
-  Additional message-specific information added on the server via StreamData
-     */
-    annotations?: JSONValue[] | undefined;
-    /**
-  The parts of the message. Use this for rendering the message in the UI.
-  
-  System messages should be avoided (set the system prompt on the server instead).
-  They can have text parts.
-  
-  User messages can have text parts and file parts.
-  
-  Assistant messages can have text, reasoning, tool invocation, and file parts.
-     */
-    parts: Array<UIMessagePart>;
-}
-type UIMessagePart = 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.
-     */
-    text: string;
-    /**
-     * The provider metadata.
-     */
-    providerMetadata?: Record<string, any>;
-};
-/**
- * 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;
-    /**
-     * Optional filename of the file.
-     */
-    filename?: string;
-    /**
-     * The URL of the file.
-     * 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;
-};
-/**
- * A step boundary part of a message.
- */
-type StepStartUIPart = {
-    type: 'step-start';
-};
-
-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: ModelMessage[];
-    /**
-     * 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 | 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.
@@ -459,13 +251,17 @@ 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<ModelMessage> | Array<Omit<UIMessage, 'id'>>;
+    messages?: Array<ModelMessage>;
 };
 
 type StandardizedPrompt = {
@@ -478,10 +274,7 @@ type StandardizedPrompt = {
      */
     messages: ModelMessage[];
 };
-declare function standardizePrompt<TOOLS extends ToolSet>({ prompt, tools, }: {
-    prompt: Prompt;
-    tools: undefined | TOOLS;
-}): Promise<StandardizedPrompt>;
+declare function standardizePrompt(prompt: Prompt): Promise<StandardizedPrompt>;
 
 declare function convertToLanguageModelPrompt({ prompt, supportedUrls, downloadImplementation, }: {
     prompt: StandardizedPrompt;
@@ -571,436 +364,90 @@ declare function prepareCallSettings({ maxOutputTokens, temperature, topP, topK,
     temperature?: number;
 };
 
-type RetryFunction = <OUTPUT>(fn: () => PromiseLike<OUTPUT>) => PromiseLike<OUTPUT>;
-
 /**
- * Validate and prepare retries.
+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
  */
-declare function prepareRetries({ maxRetries, }: {
-    maxRetries: number | undefined;
-}): {
-    maxRetries: number;
-    retry: RetryFunction;
+type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'required' | {
+    type: 'tool';
+    toolName: Extract<keyof TOOLS, string>;
 };
 
-declare const dataStreamPartSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
-    type: z.ZodLiteral<"text">;
-    value: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    value: string;
-    type: "text";
-}, {
-    value: string;
-    type: "text";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"data">;
-    value: z.ZodArray<z.ZodAny, "many">;
-}, "strip", z.ZodTypeAny, {
-    value: any[];
-    type: "data";
-}, {
-    value: any[];
-    type: "data";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"error">;
-    value: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    value: string;
-    type: "error";
-}, {
-    value: string;
-    type: "error";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"message-annotations">;
-    value: z.ZodArray<z.ZodAny, "many">;
-}, "strip", z.ZodTypeAny, {
-    value: any[];
-    type: "message-annotations";
-}, {
-    value: any[];
-    type: "message-annotations";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"tool-call">;
-    value: z.ZodObject<{
-        toolCallId: z.ZodString;
-        toolName: z.ZodString;
-        args: z.ZodUnknown;
-    }, "strip", z.ZodTypeAny, {
-        toolCallId: string;
-        toolName: string;
-        args?: unknown;
-    }, {
-        toolCallId: string;
-        toolName: string;
-        args?: unknown;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    value: {
-        toolCallId: string;
-        toolName: string;
-        args?: unknown;
-    };
-    type: "tool-call";
-}, {
-    value: {
-        toolCallId: string;
-        toolName: string;
-        args?: unknown;
-    };
-    type: "tool-call";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"tool-result">;
-    value: z.ZodObject<{
-        toolCallId: z.ZodString;
-        result: z.ZodUnknown;
-        providerMetadata: z.ZodOptional<z.ZodAny>;
-    }, "strip", z.ZodTypeAny, {
-        toolCallId: string;
-        result?: unknown;
-        providerMetadata?: any;
-    }, {
-        toolCallId: string;
-        result?: unknown;
-        providerMetadata?: any;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    value: {
-        toolCallId: string;
-        result?: unknown;
-        providerMetadata?: any;
-    };
-    type: "tool-result";
-}, {
-    value: {
-        toolCallId: string;
-        result?: unknown;
-        providerMetadata?: any;
-    };
-    type: "tool-result";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"tool-call-streaming-start">;
-    value: z.ZodObject<{
-        toolCallId: z.ZodString;
-        toolName: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        toolCallId: string;
-        toolName: string;
-    }, {
-        toolCallId: string;
-        toolName: string;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    value: {
-        toolCallId: string;
-        toolName: string;
-    };
-    type: "tool-call-streaming-start";
-}, {
-    value: {
-        toolCallId: string;
-        toolName: string;
-    };
-    type: "tool-call-streaming-start";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"tool-call-delta">;
-    value: z.ZodObject<{
-        toolCallId: z.ZodString;
-        argsTextDelta: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        toolCallId: string;
-        argsTextDelta: string;
-    }, {
-        toolCallId: string;
-        argsTextDelta: string;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    value: {
-        toolCallId: string;
-        argsTextDelta: string;
-    };
-    type: "tool-call-delta";
-}, {
-    value: {
-        toolCallId: string;
-        argsTextDelta: string;
-    };
-    type: "tool-call-delta";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"finish-message">;
-    value: z.ZodObject<{
-        finishReason: z.ZodEnum<["stop", "length", "tool-calls", "content-filter", "other", "error", "unknown"]>;
-        usage: z.ZodOptional<z.ZodObject<{
-            inputTokens: z.ZodOptional<z.ZodNumber>;
-            outputTokens: z.ZodOptional<z.ZodNumber>;
-            totalTokens: z.ZodOptional<z.ZodNumber>;
-            reasoningTokens: z.ZodOptional<z.ZodNumber>;
-            cachedInputTokens: z.ZodOptional<z.ZodNumber>;
-        }, "strip", z.ZodTypeAny, {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        }, {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        }>>;
-    }, "strip", z.ZodTypeAny, {
-        finishReason: "length" | "unknown" | "stop" | "content-filter" | "tool-calls" | "error" | "other";
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    }, {
-        finishReason: "length" | "unknown" | "stop" | "content-filter" | "tool-calls" | "error" | "other";
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    value: {
-        finishReason: "length" | "unknown" | "stop" | "content-filter" | "tool-calls" | "error" | "other";
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    };
-    type: "finish-message";
-}, {
-    value: {
-        finishReason: "length" | "unknown" | "stop" | "content-filter" | "tool-calls" | "error" | "other";
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    };
-    type: "finish-message";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"finish-step">;
-    value: z.ZodObject<{
-        isContinued: z.ZodBoolean;
-        finishReason: z.ZodEnum<["stop", "length", "tool-calls", "content-filter", "other", "error", "unknown"]>;
-        usage: z.ZodOptional<z.ZodObject<{
-            inputTokens: z.ZodOptional<z.ZodNumber>;
-            outputTokens: z.ZodOptional<z.ZodNumber>;
-            totalTokens: z.ZodOptional<z.ZodNumber>;
-            reasoningTokens: z.ZodOptional<z.ZodNumber>;
-            cachedInputTokens: z.ZodOptional<z.ZodNumber>;
-        }, "strip", z.ZodTypeAny, {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        }, {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        }>>;
-    }, "strip", z.ZodTypeAny, {
-        finishReason: "length" | "unknown" | "stop" | "content-filter" | "tool-calls" | "error" | "other";
-        isContinued: boolean;
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    }, {
-        finishReason: "length" | "unknown" | "stop" | "content-filter" | "tool-calls" | "error" | "other";
-        isContinued: boolean;
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    value: {
-        finishReason: "length" | "unknown" | "stop" | "content-filter" | "tool-calls" | "error" | "other";
-        isContinued: boolean;
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    };
-    type: "finish-step";
-}, {
-    value: {
-        finishReason: "length" | "unknown" | "stop" | "content-filter" | "tool-calls" | "error" | "other";
-        isContinued: boolean;
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    };
-    type: "finish-step";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"start-step">;
-    value: z.ZodObject<{
-        messageId: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        messageId: string;
-    }, {
-        messageId: string;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    value: {
-        messageId: string;
-    };
-    type: "start-step";
-}, {
-    value: {
-        messageId: string;
-    };
-    type: "start-step";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"reasoning">;
-    value: z.ZodObject<{
-        text: z.ZodString;
-        providerMetadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    }, "strip", z.ZodTypeAny, {
-        text: string;
-        providerMetadata?: Record<string, any> | undefined;
-    }, {
-        text: string;
-        providerMetadata?: Record<string, any> | undefined;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    value: {
-        text: string;
-        providerMetadata?: Record<string, any> | undefined;
-    };
-    type: "reasoning";
-}, {
-    value: {
-        text: string;
-        providerMetadata?: Record<string, any> | undefined;
-    };
-    type: "reasoning";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"source">;
-    value: z.ZodObject<{
-        type: z.ZodLiteral<"source">;
-        sourceType: z.ZodLiteral<"url">;
-        id: z.ZodString;
-        url: z.ZodString;
-        title: z.ZodOptional<z.ZodString>;
-        providerMetadata: z.ZodOptional<z.ZodAny>;
-    }, "strip", z.ZodTypeAny, {
-        url: string;
-        type: "source";
-        id: string;
-        sourceType: "url";
-        providerMetadata?: any;
-        title?: string | undefined;
-    }, {
-        url: string;
-        type: "source";
-        id: string;
-        sourceType: "url";
-        providerMetadata?: any;
-        title?: string | undefined;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    value: {
-        url: string;
-        type: "source";
-        id: string;
-        sourceType: "url";
-        providerMetadata?: any;
-        title?: string | undefined;
-    };
-    type: "source";
-}, {
-    value: {
-        url: string;
-        type: "source";
-        id: string;
-        sourceType: "url";
-        providerMetadata?: any;
-        title?: string | undefined;
-    };
-    type: "source";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"file">;
-    value: z.ZodObject<{
-        url: z.ZodString;
-        mediaType: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        url: string;
-        mediaType: string;
-    }, {
-        url: string;
-        mediaType: string;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    value: {
-        url: string;
-        mediaType: string;
-    };
-    type: "file";
-}, {
-    value: {
-        url: string;
-        mediaType: string;
-    };
-    type: "file";
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"reasoning-part-finish">;
-    value: z.ZodNull;
-}, "strip", z.ZodTypeAny, {
-    value: null;
-    type: "reasoning-part-finish";
-}, {
-    value: null;
-    type: "reasoning-part-finish";
-}>]>;
-type DataStreamPart = z.infer<typeof dataStreamPartSchema>;
-
-interface DataStreamWriter {
+type ToolParameters<T = JSONObject> = z.Schema<T> | Schema<T>;
+interface ToolExecutionOptions {
     /**
-     * Appends a data stream part to the stream.
+     * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.
      */
-    write(part: DataStreamPart): void;
+    toolCallId: string;
     /**
-     * Merges the contents of another stream to this stream.
+     * 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.
      */
-    merge(stream: ReadableStream<DataStreamPart>): void;
+    messages: ModelMessage[];
     /**
-     * Error handler that is used by the data stream writer.
-     * This is intended for forwarding when merging streams
-     * to prevent duplicated error masking.
+     * An optional abort signal that indicates that the overall operation should be aborted.
      */
-    onError: ((error: unknown) => string) | undefined;
+    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 | 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'>>;
 
 declare function prepareToolsAndToolChoice<TOOLS extends ToolSet>({ tools, toolChoice, activeTools, }: {
     tools: TOOLS | undefined;
@@ -1011,45 +458,16 @@ declare function prepareToolsAndToolChoice<TOOLS extends ToolSet>({ tools, toolC
     toolChoice: LanguageModelV2ToolChoice | undefined;
 };
 
-/**
- * Configuration options and helper callback methods for stream lifecycle events.
- */
-interface StreamCallbacks {
-    /** `onStart`: Called once when the stream is initialized. */
-    onStart?: () => Promise<void> | void;
-    /** `onFinal`: Called once when the stream is closed with the final completion message. */
-    onFinal?: (completion: string) => Promise<void> | void;
-    /** `onToken`: Called for each tokenized message. */
-    onToken?: (token: string) => Promise<void> | void;
-    /** `onText`: Called for each text chunk. */
-    onText?: (text: string) => Promise<void> | void;
-}
-/**
- * Creates a transform stream that encodes input messages and invokes optional callback functions.
- * The transform stream uses the provided callbacks to execute custom logic at different stages of the stream's lifecycle.
- * - `onStart`: Called once when the stream is initialized.
- * - `onToken`: Called for each tokenized message.
- * - `onFinal`: Called once when the stream is closed with the final completion message.
- *
- * This function is useful when you want to process a stream of messages and perform specific actions during the stream's lifecycle.
- *
- * @param {StreamCallbacks} [callbacks] - An object containing the callback functions.
- * @return {TransformStream<string, Uint8Array>} A transform stream that encodes input messages as Uint8Array and allows the execution of custom logic through callbacks.
- *
- * @example
- * const callbacks = {
- *   onStart: async () => console.log('Stream started'),
- *   onToken: async (token) => console.log(`Token: ${token}`),
- *   onFinal: async () => data.close()
- * };
- * const transformer = createCallbacksTransformer(callbacks);
- */
-declare function createCallbacksTransformer(callbacks?: StreamCallbacks | undefined): TransformStream<string, string>;
+type RetryFunction = <OUTPUT>(fn: () => PromiseLike<OUTPUT>) => PromiseLike<OUTPUT>;
 
 /**
- * Warning time for notifying developers that a stream is hanging in dev mode
- * using a console.warn.
+ * Validate and prepare retries.
  */
-declare const HANGING_STREAM_WARNING_TIME_MS: number;
+declare function prepareRetries({ maxRetries, }: {
+    maxRetries: number | undefined;
+}): {
+    maxRetries: number;
+    retry: RetryFunction;
+};
 
-export { DataStreamWriter, HANGING_STREAM_WARNING_TIME_MS, StreamCallbacks, convertToLanguageModelPrompt, createCallbacksTransformer, prepareCallSettings, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };
+export { convertToLanguageModelPrompt, prepareCallSettings, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };