ai 3.1.0-canary.4 → 3.1.0

package/dist/index.d.mts

@@ -1,9 +1,861 @@
+import { z } from 'zod';
+import { LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning } from '@ai-sdk/provider';
+export { APICallError, EmptyResponseBodyError, InvalidArgumentError, InvalidDataContentError, InvalidPromptError, InvalidResponseDataError, InvalidToolArgumentsError, JSONParseError, LoadAPIKeyError, NoObjectGeneratedError, NoSuchToolError, RetryError, ToolCallParseError, TypeValidationError, UnsupportedFunctionalityError, UnsupportedJSONSchemaError } from '@ai-sdk/provider';
+import { ServerResponse } from 'node:http';
 import { AssistantStream } from 'openai/lib/AssistantStream';
 import { Run } from 'openai/resources/beta/threads/runs/runs';
-import { ChatCompletionResponseChunk } from '@mistralai/mistralai';
-import { ServerResponse } from 'node:http';
 
-interface FunctionCall {
+type TokenUsage = {
+    promptTokens: number;
+    completionTokens: number;
+    totalTokens: number;
+};
+
+type CallSettings = {
+    /**
+  Maximum number of tokens to generate.
+     */
+    maxTokens?: number;
+    /**
+  Temperature setting. This is a number between 0 (almost no randomness) and
+  1 (very random).
+  
+  It is recommended to set either `temperature` or `topP`, but not both.
+  
+  @default 0
+     */
+    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;
+    /**
+  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.
+  
+  @default 0
+     */
+    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.
+  
+  @default 0
+     */
+    frequencyPenalty?: number;
+    /**
+  The seed (integer) to use for random sampling. If set and supported
+  by the model, calls will generate deterministic results.
+     */
+    seed?: number;
+    /**
+  Maximum number of retries. Set to 0 to disable retries.
+  
+  @default 2
+     */
+    maxRetries?: number;
+    /**
+  Abort signal.
+     */
+    abortSignal?: AbortSignal;
+};
+
+/**
+Data content. Can either be a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer.
+ */
+type DataContent = string | Uint8Array | ArrayBuffer | Buffer;
+/**
+Converts data content to a base64-encoded string.
+
+@param content - Data content to convert.
+@returns Base64-encoded string.
+*/
+declare function convertDataContentToBase64String(content: DataContent): string;
+/**
+Converts data content to a Uint8Array.
+
+@param content - Data content to convert.
+@returns Uint8Array.
+ */
+declare function convertDataContentToUint8Array(content: DataContent): Uint8Array;
+
+/**
+Text content part of a prompt. It contains a string of text.
+ */
+interface TextPart$1 {
+    type: 'text';
+    /**
+  The text content.
+     */
+    text: string;
+}
+/**
+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 mime type of the image.
+     */
+    mimeType?: string;
+}
+/**
+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;
+}
+/**
+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;
+    /**
+  Optional flag if the result is an error or an error message.
+     */
+    isError?: boolean;
+}
+
+/**
+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 = CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
+/**
+ * @deprecated Use `CoreMessage` instead.
+ */
+type ExperimentalMessage = CoreMessage;
+/**
+A user message. It can contain text or a combination of text and images.
+ */
+type CoreUserMessage = {
+    role: 'user';
+    content: UserContent;
+};
+/**
+ * @deprecated Use `CoreUserMessage` instead.
+ */
+type ExperimentalUserMessage = CoreUserMessage;
+/**
+Content of a user message. It can be a string or an array of text and image parts.
+ */
+type UserContent = string | Array<TextPart$1 | ImagePart>;
+/**
+An assistant message. It can contain text, tool calls, or a combination of text and tool calls.
+ */
+type CoreAssistantMessage = {
+    role: 'assistant';
+    content: AssistantContent;
+};
+/**
+ * @deprecated Use `CoreAssistantMessage` instead.
+ */
+type ExperimentalAssistantMessage = CoreAssistantMessage;
+/**
+Content of an assistant message. It can be a string or an array of text and tool call parts.
+ */
+type AssistantContent = string | Array<TextPart$1 | ToolCallPart>;
+/**
+A tool message. It contains the result of one or more tool calls.
+ */
+type CoreToolMessage = {
+    role: 'tool';
+    content: ToolContent;
+};
+/**
+ * @deprecated Use `CoreToolMessage` instead.
+ */
+type ExperimentalToolMessage = CoreToolMessage;
+/**
+Content of a tool message. It is an array of tool result parts.
+ */
+type ToolContent = Array<ToolResultPart>;
+
+/**
+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;
+    /**
+  A simple text prompt. You can either use `prompt` or `messages` but not both.
+   */
+    prompt?: string;
+    /**
+  A list of messsages. You can either use `prompt` or `messages` but not both.
+     */
+    messages?: Array<CoreMessage>;
+};
+
+/**
+Language model that is used by the AI SDK Core functions.
+*/
+type LanguageModel = LanguageModelV1;
+/**
+Reason why a language model finished generating a response.
+
+Can be one of the following:
+- `stop`: model generated stop sequence
+- `length`: model generated maximum number of tokens
+- `content-filter`: content filter violation stopped the model
+- `tool-calls`: model triggered tool calls
+- `error`: model stopped because of an error
+- `other`: model stopped for other reasons
+*/
+type FinishReason = LanguageModelV1FinishReason;
+/**
+Log probabilities for each token and its top log probabilities.
+ */
+type LogProbs = LanguageModelV1LogProbs;
+/**
+Warning from the model provider for this call. The call will proceed, but e.g.
+some settings might not be supported, which can lead to suboptimal results.
+*/
+type CallWarning = LanguageModelV1CallWarning;
+
+/**
+Generate a structured, typed object for a given prompt and schema using a language model.
+
+This function does not stream the output. If you want to stream the output, use `streamObject` instead.
+
+@param model - The language model to use.
+
+@param schema - The schema of the object that the model should generate.
+@param mode - The mode to use for object generation. Not all models support all modes. Defaults to 'auto'.
+
+@param system - A system message that will be part of the prompt.
+@param prompt - A simple text prompt. You can either use `prompt` or `messages` but not both.
+@param messages - A list of messages. You can either use `prompt` or `messages` but not both.
+
+@param maxTokens - Maximum number of tokens to generate.
+@param temperature - Temperature setting.
+The value is passed through to the provider. The range depends on the provider and model.
+It is recommended to set either `temperature` or `topP`, but not both.
+@param topP - Nucleus sampling.
+The value is passed through to the provider. The range depends on the provider and model.
+It is recommended to set either `temperature` or `topP`, but not both.
+@param presencePenalty - Presence penalty setting.
+It affects the likelihood of the model to repeat information that is already in the prompt.
+The value is passed through to the provider. The range depends on the provider and model.
+@param frequencyPenalty - Frequency penalty setting.
+It affects the likelihood of the model to repeatedly use the same words or phrases.
+The value is passed through to the provider. The range depends on the provider and model.
+@param seed - The seed (integer) to use for random sampling.
+If set and supported by the model, calls will generate deterministic results.
+
+@param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
+@param abortSignal - An optional abort signal that can be used to cancel the call.
+
+@returns
+A result object that contains the generated object, the finish reason, the token usage, and additional information.
+ */
+declare function generateObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, ...settings }: CallSettings & Prompt & {
+    /**
+The language model to use.
+     */
+    model: LanguageModel;
+    /**
+The schema of the object that the model should generate.
+     */
+    schema: z.Schema<T>;
+    /**
+The mode to use for object generation. Not all models support all modes.
+
+Default and recommended: 'auto' (best mode for the model).
+     */
+    mode?: 'auto' | 'json' | 'tool' | 'grammar';
+}): Promise<GenerateObjectResult<T>>;
+/**
+The result of a `generateObject` call.
+ */
+declare class GenerateObjectResult<T> {
+    /**
+  The generated object (typed according to the schema).
+     */
+    readonly object: T;
+    /**
+  The reason why the generation finished.
+     */
+    readonly finishReason: FinishReason;
+    /**
+  The token usage of the generated text.
+     */
+    readonly usage: TokenUsage;
+    /**
+  Warnings from the model provider (e.g. unsupported settings)
+     */
+    readonly warnings: CallWarning[] | undefined;
+    /**
+  Optional raw response data.
+     */
+    rawResponse?: {
+        /**
+    Response headers.
+     */
+        headers?: Record<string, string>;
+    };
+    /**
+  Logprobs for the completion.
+  `undefined` if the mode does not support logprobs or if was not enabled
+     */
+    readonly logprobs: LogProbs | undefined;
+    constructor(options: {
+        object: T;
+        finishReason: FinishReason;
+        usage: TokenUsage;
+        warnings: CallWarning[] | undefined;
+        rawResponse?: {
+            headers?: Record<string, string>;
+        };
+        logprobs: LogProbs | undefined;
+    });
+}
+/**
+ * @deprecated Use `generateObject` instead.
+ */
+declare const experimental_generateObject: typeof generateObject;
+
+type AsyncIterableStream<T> = AsyncIterable<T> & ReadableStream<T>;
+
+/**
+Create a type from an object with all keys and nested keys set to optional.
+The helper supports normal objects and Zod schemas (which are resolved automatically).
+It always recurses into arrays.
+
+Adopted from [type-fest](https://github.com/sindresorhus/type-fest/tree/main) PartialDeep.
+ */
+type DeepPartial<T> = T extends null | undefined | string | number | boolean | symbol | bigint | void | Date | RegExp | ((...arguments_: any[]) => unknown) | (new (...arguments_: any[]) => unknown) ? T : T extends Map<infer KeyType, infer ValueType> ? PartialMap<KeyType, ValueType> : T extends Set<infer ItemType> ? PartialSet<ItemType> : T extends ReadonlyMap<infer KeyType, infer ValueType> ? PartialReadonlyMap<KeyType, ValueType> : T extends ReadonlySet<infer ItemType> ? PartialReadonlySet<ItemType> : T extends z.Schema<any> ? DeepPartial<T['_type']> : T extends object ? T extends ReadonlyArray<infer ItemType> ? ItemType[] extends T ? readonly ItemType[] extends T ? ReadonlyArray<DeepPartial<ItemType | undefined>> : Array<DeepPartial<ItemType | undefined>> : PartialObject<T> : PartialObject<T> : unknown;
+type PartialMap<KeyType, ValueType> = {} & Map<DeepPartial<KeyType>, DeepPartial<ValueType>>;
+type PartialSet<T> = {} & Set<DeepPartial<T>>;
+type PartialReadonlyMap<KeyType, ValueType> = {} & ReadonlyMap<DeepPartial<KeyType>, DeepPartial<ValueType>>;
+type PartialReadonlySet<T> = {} & ReadonlySet<DeepPartial<T>>;
+type PartialObject<ObjectType extends object> = {
+    [KeyType in keyof ObjectType]?: DeepPartial<ObjectType[KeyType]>;
+};
+
+/**
+Generate a structured, typed object for a given prompt and schema using a language model.
+
+This function streams the output. If you do not want to stream the output, use `generateObject` instead.
+
+@param model - The language model to use.
+
+@param schema - The schema of the object that the model should generate.
+@param mode - The mode to use for object generation. Not all models support all modes. Defaults to 'auto'.
+
+@param system - A system message that will be part of the prompt.
+@param prompt - A simple text prompt. You can either use `prompt` or `messages` but not both.
+@param messages - A list of messages. You can either use `prompt` or `messages` but not both.
+
+@param maxTokens - Maximum number of tokens to generate.
+@param temperature - Temperature setting.
+The value is passed through to the provider. The range depends on the provider and model.
+It is recommended to set either `temperature` or `topP`, but not both.
+@param topP - Nucleus sampling.
+The value is passed through to the provider. The range depends on the provider and model.
+It is recommended to set either `temperature` or `topP`, but not both.
+@param presencePenalty - Presence penalty setting.
+It affects the likelihood of the model to repeat information that is already in the prompt.
+The value is passed through to the provider. The range depends on the provider and model.
+@param frequencyPenalty - Frequency penalty setting.
+It affects the likelihood of the model to repeatedly use the same words or phrases.
+The value is passed through to the provider. The range depends on the provider and model.
+@param seed - The seed (integer) to use for random sampling.
+If set and supported by the model, calls will generate deterministic results.
+
+@param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
+@param abortSignal - An optional abort signal that can be used to cancel the call.
+
+@return
+A result object for accessing the partial object stream and additional information.
+ */
+declare function streamObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, ...settings }: CallSettings & Prompt & {
+    /**
+The language model to use.
+     */
+    model: LanguageModel;
+    /**
+The schema of the object that the model should generate.
+ */
+    schema: z.Schema<T>;
+    /**
+The mode to use for object generation. Not all models support all modes.
+
+Default and recommended: 'auto' (best mode for the model).
+ */
+    mode?: 'auto' | 'json' | 'tool' | 'grammar';
+}): Promise<StreamObjectResult<T>>;
+type ObjectStreamPartInput = {
+    type: 'error';
+    error: unknown;
+} | {
+    type: 'finish';
+    finishReason: FinishReason;
+    logprobs?: LogProbs;
+    usage: {
+        promptTokens: number;
+        completionTokens: number;
+        totalTokens: number;
+    };
+};
+type ObjectStreamPart<T> = ObjectStreamPartInput | {
+    type: 'object';
+    object: DeepPartial<T>;
+};
+/**
+The result of a `streamObject` call that contains the partial object stream and additional information.
+ */
+declare class StreamObjectResult<T> {
+    private readonly originalStream;
+    /**
+  Warnings from the model provider (e.g. unsupported settings)
+     */
+    readonly warnings: CallWarning[] | undefined;
+    /**
+  Optional raw response data.
+     */
+    rawResponse?: {
+        /**
+    Response headers.
+     */
+        headers?: Record<string, string>;
+    };
+    constructor({ stream, warnings, rawResponse, }: {
+        stream: ReadableStream<string | ObjectStreamPartInput>;
+        warnings: CallWarning[] | undefined;
+        rawResponse?: {
+            headers?: Record<string, string>;
+        };
+    });
+    get partialObjectStream(): AsyncIterableStream<DeepPartial<T>>;
+    get fullStream(): AsyncIterableStream<ObjectStreamPart<T>>;
+}
+/**
+ * @deprecated Use `streamObject` instead.
+ */
+declare const experimental_streamObject: typeof streamObject;
+
+/**
+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.
+ */
+interface CoreTool<PARAMETERS extends z.ZodTypeAny = 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.
+     */
+    description?: string;
+    /**
+  The schema of the input that the tool expects. The language model will use this to generate the input.
+  Use descriptions to make the input understandable for the language model.
+     */
+    parameters: PARAMETERS;
+    /**
+  An optional execute function for the actual execution function of the tool.
+  If not provided, the tool will not be executed automatically.
+     */
+    execute?: (args: z.infer<PARAMETERS>) => PromiseLike<RESULT>;
+}
+/**
+Helper function for inferring the execute args of a tool.
+ */
+declare function tool<PARAMETERS extends z.ZodTypeAny, RESULT>(tool: CoreTool<PARAMETERS, RESULT> & {
+    execute: (args: z.infer<PARAMETERS>) => PromiseLike<RESULT>;
+}): CoreTool<PARAMETERS, RESULT> & {
+    execute: (args: z.infer<PARAMETERS>) => PromiseLike<RESULT>;
+};
+declare function tool<PARAMETERS extends z.ZodTypeAny, RESULT>(tool: CoreTool<PARAMETERS, RESULT> & {
+    execute?: undefined;
+}): CoreTool<PARAMETERS, RESULT> & {
+    execute: undefined;
+};
+/**
+ * @deprecated Use `CoreTool` instead.
+ */
+type ExperimentalTool = CoreTool;
+
+/**
+Create a union of the given object's values, and optionally specify which keys to get the values from.
+
+Please upvote [this issue](https://github.com/microsoft/TypeScript/issues/31438) if you want to have this type as a built-in in TypeScript.
+
+@example
+```
+// data.json
+{
+    'foo': 1,
+    'bar': 2,
+    'biz': 3
+}
+
+// main.ts
+import type {ValueOf} from 'type-fest';
+import data = require('./data.json');
+
+export function getData(name: string): ValueOf<typeof data> {
+    return data[name];
+}
+
+export function onlyBar(name: string): ValueOf<typeof data, 'bar'> {
+    return data[name];
+}
+
+// file.ts
+import {getData, onlyBar} from './main';
+
+getData('foo');
+//=> 1
+
+onlyBar('foo');
+//=> TypeError ...
+
+onlyBar('bar');
+//=> 2
+```
+* @see https://github.com/sindresorhus/type-fest/blob/main/source/value-of.d.ts
+*/
+type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
+
+type ToToolCall<TOOLS extends Record<string, CoreTool>> = ValueOf<{
+    [NAME in keyof TOOLS]: {
+        type: 'tool-call';
+        toolCallId: string;
+        toolName: NAME & string;
+        args: z.infer<TOOLS[NAME]['parameters']>;
+    };
+}>;
+type ToToolCallArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolCall<TOOLS>>;
+
+type ToToolsWithExecute<TOOLS extends Record<string, CoreTool>> = {
+    [K in keyof TOOLS as TOOLS[K] extends {
+        execute: any;
+    } ? K : never]: TOOLS[K];
+};
+type ToToolsWithDefinedExecute<TOOLS extends Record<string, CoreTool>> = {
+    [K in keyof TOOLS as TOOLS[K]['execute'] extends undefined ? never : K]: TOOLS[K];
+};
+type ToToolResultObject<TOOLS extends Record<string, CoreTool>> = ValueOf<{
+    [NAME in keyof TOOLS]: {
+        type: 'tool-result';
+        toolCallId: string;
+        toolName: NAME & string;
+        args: z.infer<TOOLS[NAME]['parameters']>;
+        result: Awaited<ReturnType<Exclude<TOOLS[NAME]['execute'], undefined>>>;
+    };
+}>;
+type ToToolResult<TOOLS extends Record<string, CoreTool>> = ToToolResultObject<ToToolsWithDefinedExecute<ToToolsWithExecute<TOOLS>>>;
+type ToToolResultArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolResult<TOOLS>>;
+
+/**
+Generate a text and call tools for a given prompt using a language model.
+
+This function does not stream the output. If you want to stream the output, use `streamText` instead.
+
+@param model - The language model to use.
+@param tools - The tools that the model can call. The model needs to support calling tools.
+
+@param system - A system message that will be part of the prompt.
+@param prompt - A simple text prompt. You can either use `prompt` or `messages` but not both.
+@param messages - A list of messages. You can either use `prompt` or `messages` but not both.
+
+@param maxTokens - Maximum number of tokens to generate.
+@param temperature - Temperature setting.
+The value is passed through to the provider. The range depends on the provider and model.
+It is recommended to set either `temperature` or `topP`, but not both.
+@param topP - Nucleus sampling.
+The value is passed through to the provider. The range depends on the provider and model.
+It is recommended to set either `temperature` or `topP`, but not both.
+@param presencePenalty - Presence penalty setting.
+It affects the likelihood of the model to repeat information that is already in the prompt.
+The value is passed through to the provider. The range depends on the provider and model.
+@param frequencyPenalty - Frequency penalty setting.
+It affects the likelihood of the model to repeatedly use the same words or phrases.
+The value is passed through to the provider. The range depends on the provider and model.
+@param seed - The seed (integer) to use for random sampling.
+If set and supported by the model, calls will generate deterministic results.
+
+@param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
+@param abortSignal - An optional abort signal that can be used to cancel the call.
+
+@returns
+A result object that contains the generated text, the results of the tool calls, and additional information.
+ */
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, system, prompt, messages, maxRetries, abortSignal, ...settings }: CallSettings & Prompt & {
+    /**
+The language model to use.
+     */
+    model: LanguageModel;
+    /**
+The tools that the model can call. The model needs to support calling tools.
+*/
+    tools?: TOOLS;
+}): Promise<GenerateTextResult<TOOLS>>;
+/**
+The result of a `generateText` call.
+It contains the generated text, the tool calls that were made during the generation, and the results of the tool calls.
+ */
+declare class GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
+    /**
+  The generated text.
+     */
+    readonly text: string;
+    /**
+  The tool calls that were made during the generation.
+     */
+    readonly toolCalls: ToToolCallArray<TOOLS>;
+    /**
+  The results of the tool calls.
+     */
+    readonly toolResults: ToToolResultArray<TOOLS>;
+    /**
+  The reason why the generation finished.
+     */
+    readonly finishReason: FinishReason;
+    /**
+  The token usage of the generated text.
+     */
+    readonly usage: TokenUsage;
+    /**
+  Warnings from the model provider (e.g. unsupported settings)
+     */
+    readonly warnings: CallWarning[] | undefined;
+    /**
+  Optional raw response data.
+     */
+    rawResponse?: {
+        /**
+    Response headers.
+       */
+        headers?: Record<string, string>;
+    };
+    /**
+  Logprobs for the completion.
+  `undefined` if the mode does not support logprobs or if was not enabled
+     */
+    readonly logprobs: LogProbs | undefined;
+    constructor(options: {
+        text: string;
+        toolCalls: ToToolCallArray<TOOLS>;
+        toolResults: ToToolResultArray<TOOLS>;
+        finishReason: FinishReason;
+        usage: TokenUsage;
+        warnings: CallWarning[] | undefined;
+        rawResponse?: {
+            headers?: Record<string, string>;
+        };
+        logprobs: LogProbs | undefined;
+    });
+}
+/**
+ * @deprecated Use `generateText` instead.
+ */
+declare const experimental_generateText: typeof generateText;
+
+/**
+Generate a text and call tools for a given prompt using a language model.
+
+This function streams the output. If you do not want to stream the output, use `generateText` instead.
+
+@param model - The language model to use.
+@param tools - The tools that the model can call. The model needs to support calling tools.
+
+@param system - A system message that will be part of the prompt.
+@param prompt - A simple text prompt. You can either use `prompt` or `messages` but not both.
+@param messages - A list of messages. You can either use `prompt` or `messages` but not both.
+
+@param maxTokens - Maximum number of tokens to generate.
+@param temperature - Temperature setting.
+The value is passed through to the provider. The range depends on the provider and model.
+It is recommended to set either `temperature` or `topP`, but not both.
+@param topP - Nucleus sampling.
+The value is passed through to the provider. The range depends on the provider and model.
+It is recommended to set either `temperature` or `topP`, but not both.
+@param presencePenalty - Presence penalty setting.
+It affects the likelihood of the model to repeat information that is already in the prompt.
+The value is passed through to the provider. The range depends on the provider and model.
+@param frequencyPenalty - Frequency penalty setting.
+It affects the likelihood of the model to repeatedly use the same words or phrases.
+The value is passed through to the provider. The range depends on the provider and model.
+@param seed - The seed (integer) to use for random sampling.
+If set and supported by the model, calls will generate deterministic results.
+
+@param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
+@param abortSignal - An optional abort signal that can be used to cancel the call.
+
+@return
+A result object for accessing different stream types and additional information.
+ */
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, system, prompt, messages, maxRetries, abortSignal, ...settings }: CallSettings & Prompt & {
+    /**
+The language model to use.
+     */
+    model: LanguageModel;
+    /**
+The tools that the model can call. The model needs to support calling tools.
+    */
+    tools?: TOOLS;
+}): Promise<StreamTextResult<TOOLS>>;
+type TextStreamPart<TOOLS extends Record<string, CoreTool>> = {
+    type: 'text-delta';
+    textDelta: string;
+} | ({
+    type: 'tool-call';
+} & ToToolCall<TOOLS>) | {
+    type: 'error';
+    error: unknown;
+} | ({
+    type: 'tool-result';
+} & ToToolResult<TOOLS>) | {
+    type: 'finish';
+    finishReason: FinishReason;
+    logprobs?: LogProbs;
+    usage: {
+        promptTokens: number;
+        completionTokens: number;
+        totalTokens: number;
+    };
+};
+/**
+A result object for accessing different stream types and additional information.
+ */
+declare class StreamTextResult<TOOLS extends Record<string, CoreTool>> {
+    private readonly originalStream;
+    /**
+  Warnings from the model provider (e.g. unsupported settings)
+     */
+    readonly warnings: CallWarning[] | undefined;
+    /**
+  Optional raw response data.
+     */
+    rawResponse?: {
+        /**
+    Response headers.
+         */
+        headers?: Record<string, string>;
+    };
+    constructor({ stream, warnings, rawResponse, }: {
+        stream: ReadableStream<TextStreamPart<TOOLS>>;
+        warnings: CallWarning[] | undefined;
+        rawResponse?: {
+            headers?: Record<string, string>;
+        };
+    });
+    /**
+  A text stream that returns only the generated text deltas. You can use it
+  as either an AsyncIterable or a ReadableStream. When an error occurs, the
+  stream will throw the error.
+     */
+    get textStream(): AsyncIterableStream<string>;
+    /**
+  A stream with all events, including text deltas, tool calls, tool results, and
+  errors.
+  You can use it as either an AsyncIterable or a ReadableStream. When an error occurs, the
+  stream will throw the error.
+     */
+    get fullStream(): AsyncIterableStream<TextStreamPart<TOOLS>>;
+    /**
+  Converts the result to an `AIStream` object that is compatible with `StreamingTextResponse`.
+  It can be used with the `useChat` and `useCompletion` hooks.
+  
+  @param callbacks
+  Stream callbacks that will be called when the stream emits events.
+  
+  @returns an `AIStream` object.
+     */
+    toAIStream(callbacks?: AIStreamCallbacksAndOptions): ReadableStream<any>;
+    /**
+  Writes stream data output to a Node.js response-like object.
+  It sets a `Content-Type` header to `text/plain; charset=utf-8` and
+  writes each stream data part as a separate chunk.
+  
+  @param response A Node.js response-like object (ServerResponse).
+  @param init Optional headers and status code.
+     */
+    pipeAIStreamToResponse(response: ServerResponse, init?: {
+        headers?: Record<string, string>;
+        status?: number;
+    }): void;
+    /**
+  Writes text delta output to a Node.js response-like object.
+  It sets a `Content-Type` header to `text/plain; charset=utf-8` and
+  writes each text delta as a separate chunk.
+  
+  @param response A Node.js response-like object (ServerResponse).
+  @param init Optional headers and status code.
+     */
+    pipeTextStreamToResponse(response: ServerResponse, init?: {
+        headers?: Record<string, string>;
+        status?: number;
+    }): void;
+    /**
+  Converts the result to a streamed response object with a stream data part stream.
+  It can be used with the `useChat` and `useCompletion` hooks.
+  
+  @param init Optional headers.
+  
+  @return A response object.
+     */
+    toAIStreamResponse(init?: ResponseInit): Response;
+    /**
+  Creates a simple text stream response.
+  Each text delta is encoded as UTF-8 and sent as a separate chunk.
+  Non-text-delta events are ignored.
+  
+  @param init Optional headers and status code.
+     */
+    toTextStreamResponse(init?: ResponseInit): Response;
+}
+/**
+ * @deprecated Use `streamText` instead.
+ */
+declare const experimental_streamText: typeof streamText;
+
+interface FunctionCall$1 {
     /**
      * The arguments to call the function with, as generated by the model in JSON
      * format. Note that the model does not always generate valid JSON, and may
@@ -91,7 +943,7 @@ interface Message$1 {
      * contains the function call name and arguments. Otherwise, the field should
      * not be set. (Deprecated and replaced by tool_calls.)
      */
-    function_call?: string | FunctionCall;
+    function_call?: string | FunctionCall$1;
     data?: JSONValue;
     /**
      * If the assistant role makes a tool call, the `tool_calls` field contains
@@ -110,12 +962,12 @@ type ChatRequest = {
     messages: Message$1[];
     options?: RequestOptions;
     functions?: Array<Function>;
-    function_call?: FunctionCall;
+    function_call?: FunctionCall$1;
     data?: Record<string, string>;
     tools?: Array<Tool>;
     tool_choice?: ToolChoice;
 };
-type FunctionCallHandler = (chatMessages: Message$1[], functionCall: FunctionCall) => Promise<ChatRequest | void>;
+type FunctionCallHandler = (chatMessages: Message$1[], functionCall: FunctionCall$1) => Promise<ChatRequest | void>;
 type ToolCallHandler = (chatMessages: Message$1[], toolCalls: ToolCall[]) => Promise<ChatRequest | void>;
 type RequestOptions = {
     headers?: Record<string, string> | Headers;
@@ -124,7 +976,7 @@ type RequestOptions = {
 type ChatRequestOptions = {
     options?: RequestOptions;
     functions?: Array<Function>;
-    function_call?: FunctionCall;
+    function_call?: FunctionCall$1;
     tools?: Array<Tool>;
     tool_choice?: ToolChoice;
     data?: Record<string, string>;
@@ -207,6 +1059,8 @@ type UseChatOptions = {
      * handle the extra fields before forwarding the request to the AI service.
      */
     sendExtraMessageFields?: boolean;
+    /** Stream mode (default to "stream-data") */
+    streamMode?: 'stream-data' | 'text';
 };
 type UseCompletionOptions = {
     /**
@@ -263,6 +1117,8 @@ type UseCompletionOptions = {
      * ```
      */
     body?: object;
+    /** Stream mode (default to "stream-data") */
+    streamMode?: 'stream-data' | 'text';
 };
 type JSONValue = null | string | number | boolean | {
     [x: string]: JSONValue;
@@ -293,7 +1149,7 @@ interface StreamPart<CODE extends string, NAME extends string, TYPE> {
 }
 declare const textStreamPart: StreamPart<'0', 'text', string>;
 declare const functionCallStreamPart: StreamPart<'1', 'function_call', {
-    function_call: FunctionCall;
+    function_call: FunctionCall$1;
 }>;
 declare const dataStreamPart: StreamPart<'2', 'data', Array<JSONValue>>;
 declare const errorStreamPart: StreamPart<'3', 'error', string>;
@@ -307,6 +1163,13 @@ declare const toolCallStreamPart: StreamPart<'7', 'tool_calls', {
     tool_calls: ToolCall[];
 }>;
 declare const messageAnnotationsStreamPart: StreamPart<'8', 'message_annotations', Array<JSONValue>>;
+type StreamParts = typeof textStreamPart | typeof functionCallStreamPart | typeof dataStreamPart | typeof errorStreamPart | typeof assistantMessageStreamPart | typeof assistantControlDataStreamPart | typeof dataMessageStreamPart | typeof toolCallStreamPart | typeof messageAnnotationsStreamPart;
+/**
+ * Maps the type of a stream part to its value type.
+ */
+type StreamPartValueType = {
+    [P in StreamParts as P['name']]: ReturnType<P['parse']>['value'];
+};
 type StreamPartType = ReturnType<typeof textStreamPart.parse> | ReturnType<typeof functionCallStreamPart.parse> | ReturnType<typeof dataStreamPart.parse> | ReturnType<typeof errorStreamPart.parse> | ReturnType<typeof assistantMessageStreamPart.parse> | ReturnType<typeof assistantControlDataStreamPart.parse> | ReturnType<typeof dataMessageStreamPart.parse> | ReturnType<typeof toolCallStreamPart.parse> | ReturnType<typeof messageAnnotationsStreamPart.parse>;
 /**
  * The map of prefixes for data in the stream
@@ -341,8 +1204,42 @@ declare const StreamStringPrefixes: {
     readonly tool_calls: "7";
     readonly message_annotations: "8";
 };
+/**
+Parses a stream part from a string.
+
+@param line The string to parse.
+@returns The parsed stream part.
+@throws An error if the string cannot be parsed.
+ */
+declare const parseStreamPart: (line: string) => StreamPartType;
+/**
+Prepends a string with a prefix from the `StreamChunkPrefixes`, JSON-ifies it,
+and appends a new line.
+
+It ensures type-safety for the part type and value.
+ */
+declare function formatStreamPart<T extends keyof StreamPartValueType>(type: T, value: StreamPartValueType[T]): StreamString;
+
+/**
+ * Generates a 7-character random string to use for IDs. Not secure.
+ */
+declare const generateId: (size?: number | undefined) => string;
+
+/**
+Converts a ReadableStreamDefaultReader into an async generator that yields
+StreamPart objects.
+
+@param reader
+       Reader for the stream to read from.
+@param isAborted
+       Optional function that returns true if the request has been aborted.
+       If the function returns true, the generator will stop reading the stream.
+       If the function is not provided, the generator will not stop reading the stream.
+ */
+declare function readDataStream(reader: ReadableStreamDefaultReader<Uint8Array>, { isAborted, }?: {
+    isAborted?: () => boolean;
+}): AsyncGenerator<StreamPartType>;
 
-declare const nanoid: (size?: number | undefined) => string;
 declare function createChunkDecoder(): (chunk: Uint8Array | undefined) => string;
 declare function createChunkDecoder(complex: false): (chunk: Uint8Array | undefined) => string;
 declare function createChunkDecoder(complex: true): (chunk: Uint8Array | undefined) => StreamPartType[];
@@ -350,10 +1247,6 @@ declare function createChunkDecoder(complex?: boolean): (chunk: Uint8Array | und
 
 declare const isStreamStringEqualToType: (type: keyof typeof StreamStringPrefixes, value: string) => value is `0:${string}\n` | `1:${string}\n` | `2:${string}\n` | `3:${string}\n` | `4:${string}\n` | `5:${string}\n` | `6:${string}\n` | `7:${string}\n` | `8:${string}\n`;
 type StreamString = `${(typeof StreamStringPrefixes)[keyof typeof StreamStringPrefixes]}:${string}\n`;
-/**
- * A header sent to the client so it knows how to handle parsing the stream (as a deprecated text response or using the new prefixed protocol)
- */
-declare const COMPLEX_HEADER = "X-Experimental-Stream-Data";
 
 declare interface AzureChatCompletions {
     id: string;
@@ -481,7 +1374,7 @@ interface ChoiceDelta {
      * The name and arguments of a function that should be called, as generated by the
      * model.
      */
-    function_call?: FunctionCall;
+    function_call?: FunctionCall$1;
     /**
      * The role of the author of this message.
      */
@@ -607,10 +1500,8 @@ interface AIStreamCallbacksAndOptions {
     /** `onText`: Called for each text chunk. */
     onText?: (text: string) => Promise<void> | void;
     /**
-     * A flag for enabling the experimental_StreamData class and the new protocol.
-     * @see https://github.com/vercel-labs/ai/pull/425
-     *
-     * When StreamData is rolled out, this will be removed and the new protocol will be used by default.
+     * @deprecated This flag is no longer used and only retained for backwards compatibility.
+     * You can remove it from your code.
      */
     experimental_streamData?: boolean;
 }
@@ -797,18 +1688,54 @@ interface MessageStopEvent {
  */
 declare function AnthropicStream(res: Response | AsyncIterable<CompletionChunk> | AsyncIterable<MessageStreamEvent>, cb?: AIStreamCallbacksAndOptions): ReadableStream;
 
+/**
+You can pass the thread and the latest message into the `AssistantResponse`. This establishes the context for the response.
+ */
 type AssistantResponseSettings = {
+    /**
+  The thread ID that the response is associated with.
+     */
     threadId: string;
+    /**
+  The ID of the latest message that the response is associated with.
+   */
     messageId: string;
 };
+/**
+The process parameter is a callback in which you can run the assistant on threads, and send messages and data messages to the client.
+ */
 type AssistantResponseCallback = (options: {
+    /**
+  @deprecated use variable from outer scope instead.
+     */
     threadId: string;
+    /**
+  @deprecated use variable from outer scope instead.
+     */
     messageId: string;
+    /**
+  Forwards an assistant message (non-streaming) to the client.
+     */
     sendMessage: (message: AssistantMessage) => void;
+    /**
+  Send a data message to the client. You can use this to provide information for rendering custom UIs while the assistant is processing the thread.
+   */
     sendDataMessage: (message: DataMessage) => void;
+    /**
+  Forwards the assistant response stream to the client. Returns the `Run` object after it completes, or when it requires an action.
+     */
     forwardStream: (stream: AssistantStream) => Promise<Run | undefined>;
 }) => Promise<void>;
-declare function experimental_AssistantResponse({ threadId, messageId }: AssistantResponseSettings, process: AssistantResponseCallback): Response;
+/**
+The `AssistantResponse` allows you to send a stream of assistant update to `useAssistant`.
+It is designed to facilitate streaming assistant responses to the `useAssistant` hook.
+It receives an assistant thread and a current message, and can send messages and data messages to the client.
+ */
+declare function AssistantResponse({ threadId, messageId }: AssistantResponseSettings, process: AssistantResponseCallback): Response;
+/**
+@deprecated Use `AssistantResponse` instead.
+ */
+declare const experimental_AssistantResponse: typeof AssistantResponse;
 
 interface AWSBedrockResponse {
     body?: AsyncIterable<{
@@ -817,6 +1744,7 @@ interface AWSBedrockResponse {
         };
     }>;
 }
+declare function AWSBedrockAnthropicMessagesStream(response: AWSBedrockResponse, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
 declare function AWSBedrockAnthropicStream(response: AWSBedrockResponse, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
 declare function AWSBedrockCohereStream(response: AWSBedrockResponse, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
 declare function AWSBedrockLlama2Stream(response: AWSBedrockResponse, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
@@ -881,6 +1809,31 @@ declare function LangChainStream(callbacks?: AIStreamCallbacksAndOptions): {
     };
 };
 
+interface ChatCompletionResponseChunk {
+    id: string;
+    object: 'chat.completion.chunk';
+    created: number;
+    model: string;
+    choices: ChatCompletionResponseChunkChoice[];
+}
+interface ChatCompletionResponseChunkChoice {
+    index: number;
+    delta: {
+        role?: string;
+        content?: string;
+        tool_calls?: ToolCalls[];
+    };
+    finish_reason: string;
+}
+interface FunctionCall {
+    name: string;
+    arguments: string;
+}
+interface ToolCalls {
+    id: 'null';
+    type: 'function';
+    function: FunctionCall;
+}
 declare function MistralStream(response: AsyncGenerator<ChatCompletionResponseChunk, void, unknown>, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
 
 interface Prediction {
@@ -932,7 +1885,7 @@ declare function ReplicateStream(res: Prediction, cb?: AIStreamCallbacksAndOptio
 /**
  * A stream wrapper to send custom JSON-encoded data back to the client.
  */
-declare class experimental_StreamData {
+declare class StreamData {
     private encoder;
     private controller;
     stream: TransformStream<Uint8Array, Uint8Array>;
@@ -950,7 +1903,12 @@ declare class experimental_StreamData {
  * A TransformStream for LLMs that do not have their own transform stream handlers managing encoding (e.g. OpenAIStream has one for function call handling).
  * This assumes every chunk is a 'text' chunk.
  */
-declare function createStreamDataTransformer(experimental_streamData: boolean | undefined): TransformStream<any, any>;
+declare function createStreamDataTransformer(): TransformStream<any, any>;
+/**
+@deprecated Use `StreamData` instead.
+ */
+declare class experimental_StreamData extends StreamData {
+}
 
 /**
  * This is a naive implementation of the streaming React response API.
@@ -979,7 +1937,7 @@ declare class experimental_StreamingReactResponse {
             content: string;
             data?: JSONValue[];
         }) => UINode | Promise<UINode>;
-        data?: experimental_StreamData;
+        data?: StreamData;
         generateId?: IdGenerator;
     });
 }
@@ -988,7 +1946,7 @@ declare class experimental_StreamingReactResponse {
  * A utility class for streaming text responses.
  */
 declare class StreamingTextResponse extends Response {
-    constructor(res: ReadableStream, init?: ResponseInit, data?: experimental_StreamData);
+    constructor(res: ReadableStream, init?: ResponseInit, data?: StreamData);
 }
 /**
  * A utility function to stream a ReadableStream to a Node.js response-like object.
@@ -998,4 +1956,4 @@ declare function streamToResponse(res: ReadableStream, response: ServerResponse,
     status?: number;
 }): void;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantMessage, COMPLEX_HEADER, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CreateMessage, DataMessage, Function, FunctionCall, FunctionCallHandler, FunctionCallPayload, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, LangChainStream, Message$1 as Message, MistralStream, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamString, StreamingTextResponse, Tool, ToolCall, ToolCallHandler, ToolCallPayload, ToolChoice, UseChatOptions, UseCompletionOptions, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, isStreamStringEqualToType, nanoid, readableFromAsyncIterable, streamToResponse, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreTool, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, LangChainStream, LanguageModel, LogProbs, Message$1 as Message, MistralStream, ObjectStreamPart, ObjectStreamPartInput, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamData, StreamObjectResult, StreamPart, StreamString, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, Tool, ToolCall, ToolCallHandler, ToolCallPart, ToolCallPayload, ToolChoice, ToolContent, ToolResultPart, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, formatStreamPart, generateId, generateObject, generateText, isStreamStringEqualToType, generateId as nanoid, parseStreamPart, readDataStream, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };