ai 5.0.0-canary.20 → 5.0.0-canary.21

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ToolCall, ToolResult, ToolResultContent, Schema, IdGenerator, FetchFunction } from '@ai-sdk/provider-utils';
+import { ToolResultContent, Schema, ToolCall, ToolResult, IdGenerator, FetchFunction } from '@ai-sdk/provider-utils';
 export { IdGenerator, Schema, ToolCall, ToolResult, asSchema, createIdGenerator, generateId, jsonSchema } from '@ai-sdk/provider-utils';
 import { z } from 'zod';
 import { ServerResponse } from 'node:http';
@@ -16,15 +16,6 @@ declare const dataStreamPartSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject
 }, {
     type: "text";
     value: string;
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"data">;
-    value: z.ZodArray<z.ZodAny, "many">;
-}, "strip", z.ZodTypeAny, {
-    type: "data";
-    value: any[];
-}, {
-    type: "data";
-    value: any[];
 }>, z.ZodObject<{
     type: z.ZodLiteral<"error">;
     value: z.ZodString;
@@ -34,15 +25,6 @@ declare const dataStreamPartSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject
 }, {
     type: "error";
     value: string;
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"message-annotations">;
-    value: z.ZodArray<z.ZodAny, "many">;
-}, "strip", z.ZodTypeAny, {
-    type: "message-annotations";
-    value: any[];
-}, {
-    type: "message-annotations";
-    value: any[];
 }>, z.ZodObject<{
     type: z.ZodLiteral<"tool-call">;
     value: z.ZodObject<{
@@ -149,162 +131,6 @@ declare const dataStreamPartSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject
         toolCallId: string;
         argsTextDelta: string;
     };
-}>, 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" | "stop" | "tool-calls" | "content-filter" | "other" | "error" | "unknown";
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    }, {
-        finishReason: "length" | "stop" | "tool-calls" | "content-filter" | "other" | "error" | "unknown";
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    type: "finish-message";
-    value: {
-        finishReason: "length" | "stop" | "tool-calls" | "content-filter" | "other" | "error" | "unknown";
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    };
-}, {
-    type: "finish-message";
-    value: {
-        finishReason: "length" | "stop" | "tool-calls" | "content-filter" | "other" | "error" | "unknown";
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    };
-}>, 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" | "stop" | "tool-calls" | "content-filter" | "other" | "error" | "unknown";
-        isContinued: boolean;
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    }, {
-        finishReason: "length" | "stop" | "tool-calls" | "content-filter" | "other" | "error" | "unknown";
-        isContinued: boolean;
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    type: "finish-step";
-    value: {
-        finishReason: "length" | "stop" | "tool-calls" | "content-filter" | "other" | "error" | "unknown";
-        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" | "stop" | "tool-calls" | "content-filter" | "other" | "error" | "unknown";
-        isContinued: boolean;
-        usage?: {
-            inputTokens?: number | undefined;
-            outputTokens?: number | undefined;
-            totalTokens?: number | undefined;
-            reasoningTokens?: number | undefined;
-            cachedInputTokens?: number | undefined;
-        } | undefined;
-    };
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"start-step">;
-    value: z.ZodObject<{
-        messageId: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        messageId: string;
-    }, {
-        messageId: string;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    type: "start-step";
-    value: {
-        messageId: string;
-    };
-}, {
-    type: "start-step";
-    value: {
-        messageId: string;
-    };
 }>, z.ZodObject<{
     type: z.ZodLiteral<"reasoning">;
     value: z.ZodObject<{
@@ -397,6 +223,106 @@ declare const dataStreamPartSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject
         url: string;
         mediaType: string;
     };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"metadata">;
+    value: z.ZodObject<{
+        metadata: z.ZodUnknown;
+    }, "strip", z.ZodTypeAny, {
+        metadata?: unknown;
+    }, {
+        metadata?: unknown;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "metadata";
+    value: {
+        metadata?: unknown;
+    };
+}, {
+    type: "metadata";
+    value: {
+        metadata?: unknown;
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"start-step">;
+    value: z.ZodObject<{
+        metadata: z.ZodUnknown;
+    }, "strip", z.ZodTypeAny, {
+        metadata?: unknown;
+    }, {
+        metadata?: unknown;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "start-step";
+    value: {
+        metadata?: unknown;
+    };
+}, {
+    type: "start-step";
+    value: {
+        metadata?: unknown;
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"finish-step">;
+    value: z.ZodObject<{
+        metadata: z.ZodUnknown;
+    }, "strip", z.ZodTypeAny, {
+        metadata?: unknown;
+    }, {
+        metadata?: unknown;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "finish-step";
+    value: {
+        metadata?: unknown;
+    };
+}, {
+    type: "finish-step";
+    value: {
+        metadata?: unknown;
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"start">;
+    value: z.ZodObject<{
+        messageId: z.ZodOptional<z.ZodString>;
+        metadata: z.ZodUnknown;
+    }, "strip", z.ZodTypeAny, {
+        metadata?: unknown;
+        messageId?: string | undefined;
+    }, {
+        metadata?: unknown;
+        messageId?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "start";
+    value: {
+        metadata?: unknown;
+        messageId?: string | undefined;
+    };
+}, {
+    type: "start";
+    value: {
+        metadata?: unknown;
+        messageId?: string | undefined;
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"finish">;
+    value: z.ZodObject<{
+        metadata: z.ZodUnknown;
+    }, "strip", z.ZodTypeAny, {
+        metadata?: unknown;
+    }, {
+        metadata?: unknown;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "finish";
+    value: {
+        metadata?: unknown;
+    };
+}, {
+    type: "finish";
+    value: {
+        metadata?: unknown;
+    };
 }>, z.ZodObject<{
     type: z.ZodLiteral<"reasoning-part-finish">;
     value: z.ZodNull;
@@ -440,51 +366,6 @@ declare function pipeDataStreamToResponse({ response, status, statusText, header
     dataStream: ReadableStream<DataStreamPart>;
 } & ResponseInit): void;
 
-declare function processDataStream({ stream, onTextPart, onReasoningPart, onReasoningPartFinish, onSourcePart, onFilePart, onDataPart, onErrorPart, onToolCallStreamingStartPart, onToolCallDeltaPart, onToolCallPart, onToolResultPart, onMessageAnnotationsPart, onFinishMessagePart, onFinishStepPart, onStartStepPart, }: {
-    stream: ReadableStream<Uint8Array>;
-    onTextPart?: (streamPart: (DataStreamPart & {
-        type: 'text';
-    })['value']) => Promise<void> | void;
-    onReasoningPart?: (streamPart: (DataStreamPart & {
-        type: 'reasoning';
-    })['value']) => Promise<void> | void;
-    onReasoningPartFinish?: (streamPart: (DataStreamPart & {
-        type: 'reasoning-part-finish';
-    })['value']) => Promise<void> | void;
-    onFilePart?: (streamPart: (DataStreamPart & {
-        type: 'file';
-    })['value']) => Promise<void> | void;
-    onSourcePart?: (streamPart: (DataStreamPart & {
-        type: 'source';
-    })['value']) => Promise<void> | void;
-    onDataPart?: (streamPart: (DataStreamPart & {
-        type: 'data';
-    })['value']) => Promise<void> | void;
-    onErrorPart?: (streamPart: (DataStreamPart & {
-        type: 'error';
-    })['value']) => Promise<void> | void;
-    onToolCallStreamingStartPart?: (streamPart: (DataStreamPart & {
-        type: 'tool-call-streaming-start';
-    })['value']) => Promise<void> | void;
-    onToolCallDeltaPart?: (streamPart: (DataStreamPart & {
-        type: 'tool-call-delta';
-    })['value']) => Promise<void> | void;
-    onToolCallPart?: (streamPart: ToolCall<string, any>) => Promise<void> | void;
-    onToolResultPart?: (streamPart: ToolResult<string, any, any>) => Promise<void> | void;
-    onMessageAnnotationsPart?: (streamPart: (DataStreamPart & {
-        type: 'message-annotations';
-    })['value']) => Promise<void> | void;
-    onFinishMessagePart?: (streamPart: (DataStreamPart & {
-        type: 'finish-message';
-    })['value']) => Promise<void> | void;
-    onFinishStepPart?: (streamPart: (DataStreamPart & {
-        type: 'finish-step';
-    })['value']) => Promise<void> | void;
-    onStartStepPart?: (streamPart: (DataStreamPart & {
-        type: 'start-step';
-    })['value']) => Promise<void> | void;
-}): Promise<void>;
-
 declare class JsonToSseTransformStream extends TransformStream<unknown, string> {
     constructor();
 }
@@ -1165,20 +1046,20 @@ declare const JSONRPCErrorSchema: z.ZodObject<{
         data?: unknown;
     }>;
 }, "strict", z.ZodTypeAny, {
+    id: string | number;
     error: {
         code: number;
         message: string;
         data?: unknown;
     };
-    id: string | number;
     jsonrpc: "2.0";
 }, {
+    id: string | number;
     error: {
         code: number;
         message: string;
         data?: unknown;
     };
-    id: string | number;
     jsonrpc: "2.0";
 }>;
 type JSONRPCError = z.infer<typeof JSONRPCErrorSchema>;
@@ -1299,20 +1180,20 @@ declare const JSONRPCMessageSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.extendS
         data?: unknown;
     }>;
 }, "strict", z.ZodTypeAny, {
+    id: string | number;
     error: {
         code: number;
         message: string;
         data?: unknown;
     };
-    id: string | number;
     jsonrpc: "2.0";
 }, {
+    id: string | number;
     error: {
         code: number;
         message: string;
         data?: unknown;
     };
-    id: string | number;
     jsonrpc: "2.0";
 }>]>;
 type JSONRPCMessage = z.infer<typeof JSONRPCMessageSchema>;
@@ -2228,6 +2109,39 @@ type ToolCallUnion<TOOLS extends ToolSet> = ValueOf<{
 }>;
 type ToolCallArray<TOOLS extends ToolSet> = Array<ToolCallUnion<TOOLS>>;
 
+type ToToolsWithDefinedExecute<TOOLS extends ToolSet> = {
+    [K in keyof TOOLS as TOOLS[K]['execute'] extends undefined ? never : K]: TOOLS[K];
+};
+type ToToolResultObject<TOOLS extends ToolSet> = ValueOf<{
+    [NAME in keyof TOOLS]: {
+        type: 'tool-result';
+        toolCallId: string;
+        toolName: NAME & string;
+        args: TOOLS[NAME] extends Tool<infer P> ? P : never;
+        result: Awaited<ReturnType<Exclude<TOOLS[NAME]['execute'], undefined>>>;
+    };
+}>;
+type ToolResultUnion<TOOLS extends ToolSet> = ToToolResultObject<ToToolsWithDefinedExecute<TOOLS>>;
+type ToolResultArray<TOOLS extends ToolSet> = Array<ToolResultUnion<TOOLS>>;
+
+type ContentPart<TOOLS extends ToolSet> = {
+    type: 'text';
+    text: string;
+} | {
+    type: 'reasoning';
+    text: string;
+    providerMetadata?: ProviderMetadata;
+} | ({
+    type: 'source';
+} & Source) | {
+    type: 'file';
+    file: GeneratedFile;
+} | ({
+    type: 'tool-call';
+} & ToolCallUnion<TOOLS>) | ({
+    type: 'tool-result';
+} & ToolResultUnion<TOOLS>);
+
 declare const symbol$e: unique symbol;
 declare class InvalidToolArgumentsError extends AISDKError {
     private readonly [symbol$e];
@@ -2261,15 +2175,11 @@ 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.
-  Use `null` to use the provider's default temperature.
-  
-  @default 0
      */
-    temperature?: number | null;
+    temperature?: number;
     /**
   Nucleus sampling. This is a number between 0 and 1.
   
@@ -2377,41 +2287,12 @@ type ToolCallRepairFunction<TOOLS extends ToolSet> = (options: {
     error: NoSuchToolError | InvalidToolArgumentsError;
 }) => Promise<LanguageModelV2ToolCall | null>;
 
-type ToToolsWithDefinedExecute<TOOLS extends ToolSet> = {
-    [K in keyof TOOLS as TOOLS[K]['execute'] extends undefined ? never : K]: TOOLS[K];
-};
-type ToToolResultObject<TOOLS extends ToolSet> = ValueOf<{
-    [NAME in keyof TOOLS]: {
-        type: 'tool-result';
-        toolCallId: string;
-        toolName: NAME & string;
-        args: TOOLS[NAME] extends Tool<infer P> ? P : never;
-        result: Awaited<ReturnType<Exclude<TOOLS[NAME]['execute'], undefined>>>;
-    };
-}>;
-type ToolResultUnion<TOOLS extends ToolSet> = ToToolResultObject<ToToolsWithDefinedExecute<TOOLS>>;
-type ToolResultArray<TOOLS extends ToolSet> = Array<ToolResultUnion<TOOLS>>;
-
-type SingleRequestTextStreamPart<TOOLS extends ToolSet> = {
+type SingleRequestTextStreamPart<TOOLS extends ToolSet> = ContentPart<TOOLS> | {
     type: 'stream-start';
     warnings: LanguageModelV2CallWarning[];
-} | {
-    type: 'text';
-    text: string;
-} | {
-    type: 'reasoning';
-    text: string;
-    providerMetadata?: ProviderMetadata;
 } | {
     type: 'reasoning-part-finish';
 } | {
-    type: 'file';
-    file: GeneratedFile;
-} | ({
-    type: 'source';
-} & Source) | ({
-    type: 'tool-call';
-} & ToolCallUnion<TOOLS>) | {
     type: 'tool-call-streaming-start';
     toolCallId: string;
     toolName: string;
@@ -2420,9 +2301,7 @@ type SingleRequestTextStreamPart<TOOLS extends ToolSet> = {
     toolCallId: string;
     toolName: string;
     argsTextDelta: string;
-} | ({
-    type: 'tool-result';
-} & ToolResultUnion<TOOLS>) | {
+} | {
     type: 'response-metadata';
     id?: string;
     timestamp?: Date;
@@ -2609,23 +2488,19 @@ type ToolInvocation = ({
 /**
  * AI SDK UI Messages. They are used in the client and to communicate between the frontend and the API routes.
  */
-interface UIMessage {
+interface UIMessage<METADATA = unknown> {
     /**
   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
+  The metadata of the message.
      */
-    annotations?: JSONValue$1[] | undefined;
+    metadata?: METADATA;
     /**
   The parts of the message. Use this for rendering the message in the UI.
   
@@ -2710,8 +2585,8 @@ type FileUIPart = {
 type StepStartUIPart = {
     type: 'step-start';
 };
-type CreateUIMessage = Omit<UIMessage, 'id'> & {
-    id?: UIMessage['id'];
+type CreateUIMessage<METADATA = unknown> = Omit<UIMessage<METADATA>, 'id'> & {
+    id?: UIMessage<METADATA>['id'];
 };
 
 declare const symbol$3: unique symbol;
@@ -2773,173 +2648,47 @@ declare function pipeTextStreamToResponse({ response, status, statusText, header
 declare function appendClientMessage({ messages, message, }: {
     messages: UIMessage[];
     message: UIMessage;
-}): UIMessage[];
-
-type ContentPart<TOOLS extends ToolSet> = {
-    type: 'text';
-    text: string;
-} | {
-    type: 'reasoning';
-    text: string;
-    providerMetadata?: ProviderMetadata;
-} | ({
-    type: 'source';
-} & Source) | {
-    type: 'file';
-    file: GeneratedFile;
-} | ({
-    type: 'tool-call';
-} & ToolCallUnion<TOOLS>) | ({
-    type: 'tool-result';
-} & ToolResultUnion<TOOLS>);
+}): UIMessage<unknown>[];
 
-/**
-A message that was generated during the generation process.
-It can be either an assistant message or a tool message.
- */
-type ResponseMessage = (AssistantModelMessage | ToolModelMessage) & {
+type ChatRequestOptions = {
     /**
-  Message ID generated by the AI SDK.
+    Additional headers that should be to be passed to the API endpoint.
      */
-    id: string;
-};
-/**
- * The result of a single step in the generation process.
- */
-type StepResult<TOOLS extends ToolSet> = {
+    headers?: Record<string, string> | Headers;
     /**
-  The content that was generated in the last step.
+    Additional body JSON properties that should be sent to the API endpoint.
      */
-    readonly content: Array<ContentPart<TOOLS>>;
-    /**
-  The generated text.
-  */
-    readonly text: string;
+    body?: object;
     /**
-  The reasoning that was generated during the generation.
-  */
-    readonly reasoning: Array<ReasoningPart>;
+    Additional data to be sent to the API endpoint.
+       */
+    data?: JSONValue$1;
     /**
-  The reasoning text that was generated during the generation.
-  */
-    readonly reasoningText: string | undefined;
+     * Allow submitting an empty message. Defaults to `false`.
+     */
+    allowEmptySubmit?: boolean;
+};
+type UseChatOptions<MESSAGE_METADATA = unknown> = {
     /**
-  The files that were generated during the generation.
-  */
-    readonly files: Array<GeneratedFile>;
+     * Schema for the message metadata. Validates the message metadata.
+     * Message metadata can be undefined or must match the schema.
+     */
+    messageMetadataSchema?: Schema<MESSAGE_METADATA>;
     /**
-  The sources that were used to generate the text.
-  */
-    readonly sources: Array<Source>;
+     * The API endpoint that accepts a `{ messages: Message[] }` object and returns
+     * a stream of tokens of the AI chat response. Defaults to `/api/chat`.
+     */
+    api?: string;
     /**
-  The tool calls that were made during the generation.
-  */
-    readonly toolCalls: ToolCallArray<TOOLS>;
-    /**
-  The results of the tool calls.
-  */
-    readonly toolResults: ToolResultArray<TOOLS>;
-    /**
-  The reason why the generation finished.
-  */
-    readonly finishReason: FinishReason;
-    /**
-  The token usage of the generated text.
-  */
-    readonly usage: LanguageModelUsage;
-    /**
-  Warnings from the model provider (e.g. unsupported settings).
-  */
-    readonly warnings: CallWarning[] | undefined;
-    /**
-  Additional request information.
-     */
-    readonly request: LanguageModelRequestMetadata;
-    /**
-  Additional response information.
-  */
-    readonly response: LanguageModelResponseMetadata & {
-        /**
-    The response messages that were generated during the call.
-    Response messages can be either assistant messages or tool messages.
-    They contain a generated id.
-    */
-        readonly messages: Array<ResponseMessage>;
-        /**
-    Response body (available only for providers that use HTTP requests).
-         */
-        body?: unknown;
-    };
-    /**
-  Additional provider-specific metadata. They are passed through
-  from the provider to the AI SDK and enable provider-specific
-  results that can be fully encapsulated in the provider.
-     */
-    readonly providerMetadata: ProviderMetadata | undefined;
-    /**
-  The type of step that this result is for. The first step is always
-  an "initial" step, and subsequent steps are either "continue" steps
-  or "tool-result" steps.
-     */
-    readonly stepType: 'initial' | 'continue' | 'tool-result';
-    /**
-  True when there will be a continuation step with a continuation text.
-     */
-    readonly isContinued: boolean;
-};
-
-/**
- * Appends the ResponseMessage[] from the response to a Message[] (for useChat).
- * The messages are converted to Messages before being appended.
- * Timestamps are generated for the new messages.
- *
- * @returns A new Message[] with the response messages appended.
- */
-declare function appendResponseMessages({ messages, responseMessages, _internal: { currentDate }, }: {
-    messages: UIMessage[];
-    responseMessages: ResponseMessage[];
-    /**
-  Internal. For test use only. May change without notice.
-       */
-    _internal?: {
-        currentDate?: () => Date;
-    };
-}): UIMessage[];
-
-type ChatRequestOptions = {
-    /**
-    Additional headers that should be to be passed to the API endpoint.
-     */
-    headers?: Record<string, string> | Headers;
-    /**
-    Additional body JSON properties that should be sent to the API endpoint.
-     */
-    body?: object;
-    /**
-    Additional data to be sent to the API endpoint.
-       */
-    data?: JSONValue$1;
-    /**
-     * Allow submitting an empty message. Defaults to `false`.
-     */
-    allowEmptySubmit?: boolean;
-};
-type UseChatOptions = {
-    /**
-     * The API endpoint that accepts a `{ messages: Message[] }` object and returns
-     * a stream of tokens of the AI chat response. Defaults to `/api/chat`.
-     */
-    api?: string;
-    /**
-     * A unique identifier for the chat. If not provided, a random one will be
-     * generated. When provided, the `useChat` hook with the same `id` will
-     * have shared states across components.
-     */
-    id?: string;
+     * A unique identifier for the chat. If not provided, a random one will be
+     * generated. When provided, the `useChat` hook with the same `id` will
+     * have shared states across components.
+     */
+    id?: string;
     /**
      * Initial messages of the chat. Useful to load an existing chat history.
      */
-    initialMessages?: UIMessage[];
+    initialMessages?: UIMessage<NoInfer<MESSAGE_METADATA>>[];
     /**
      * Initial input of the chat.
      */
@@ -2962,12 +2711,9 @@ type UseChatOptions = {
      * Optional callback function that is called when the assistant message is finished streaming.
      *
      * @param message The message that was streamed.
-     * @param options.usage The token usage of the message.
-     * @param options.finishReason The finish reason of the message.
      */
-    onFinish?: (message: UIMessage, options: {
-        usage: LanguageModelUsage;
-        finishReason: LanguageModelV2FinishReason;
+    onFinish?: (options: {
+        message: UIMessage<NoInfer<MESSAGE_METADATA>>;
     }) => void;
     /**
      * Callback function to be called when an error is encountered.
@@ -3022,7 +2768,7 @@ type UseChatOptions = {
 };
 
 declare const getOriginalFetch$1: () => typeof fetch;
-declare function callChatApi({ api, body, streamProtocol, credentials, headers, abortController, onResponse, onUpdate, onFinish, onToolCall, generateId, fetch, lastMessage, getCurrentDate, requestType, }: {
+declare function callChatApi<MESSAGE_METADATA>({ api, body, streamProtocol, credentials, headers, abortController, onResponse, onUpdate, onFinish, onToolCall, generateId, fetch, lastMessage, requestType, messageMetadataSchema, }: {
     api: string;
     body: Record<string, any>;
     streamProtocol: 'data' | 'text' | undefined;
@@ -3031,21 +2777,19 @@ declare function callChatApi({ api, body, streamProtocol, credentials, headers,
     abortController: (() => AbortController | null) | undefined;
     onResponse: ((response: Response) => void | Promise<void>) | undefined;
     onUpdate: (options: {
-        message: UIMessage;
-        data: JSONValue$1[] | undefined;
-        replaceLastMessage: boolean;
+        message: UIMessage<MESSAGE_METADATA>;
     }) => void;
-    onFinish: UseChatOptions['onFinish'];
-    onToolCall: UseChatOptions['onToolCall'];
+    onFinish: UseChatOptions<MESSAGE_METADATA>['onFinish'];
+    onToolCall: UseChatOptions<MESSAGE_METADATA>['onToolCall'];
     generateId: IdGenerator;
     fetch: ReturnType<typeof getOriginalFetch$1> | undefined;
-    lastMessage: UIMessage | undefined;
-    getCurrentDate: () => Date;
+    lastMessage: UIMessage<MESSAGE_METADATA> | undefined;
     requestType?: 'generate' | 'resume';
+    messageMetadataSchema?: Schema<MESSAGE_METADATA>;
 }): Promise<void>;
 
 declare const getOriginalFetch: () => typeof fetch;
-declare function callCompletionApi({ api, prompt, credentials, headers, body, streamProtocol, setCompletion, setLoading, setError, setAbortController, onResponse, onFinish, onError, onData, fetch, }: {
+declare function callCompletionApi({ api, prompt, credentials, headers, body, streamProtocol, setCompletion, setLoading, setError, setAbortController, onResponse, onFinish, onError, fetch, }: {
     api: string;
     prompt: string;
     credentials: RequestCredentials | undefined;
@@ -3059,7 +2803,6 @@ declare function callCompletionApi({ api, prompt, credentials, headers, body, st
     onResponse: ((response: Response) => void | Promise<void>) | undefined;
     onFinish: ((prompt: string, completion: string) => void) | undefined;
     onError: ((error: Error) => void) | undefined;
-    onData: ((data: JSONValue$1[]) => void) | undefined;
     fetch: ReturnType<typeof getOriginalFetch> | undefined;
 }): Promise<string | null | undefined>;
 
@@ -3430,6 +3173,87 @@ declare function embedMany<VALUE>({ model, values, maxParallelCalls, maxRetries:
     maxParallelCalls?: number;
 }): Promise<EmbedManyResult<VALUE>>;
 
+/**
+A message that was generated during the generation process.
+It can be either an assistant message or a tool message.
+ */
+type ResponseMessage = AssistantModelMessage | ToolModelMessage;
+
+/**
+ * The result of a single step in the generation process.
+ */
+type StepResult<TOOLS extends ToolSet> = {
+    /**
+  The content that was generated in the last step.
+     */
+    readonly content: Array<ContentPart<TOOLS>>;
+    /**
+  The generated text.
+  */
+    readonly text: string;
+    /**
+  The reasoning that was generated during the generation.
+  */
+    readonly reasoning: Array<ReasoningPart>;
+    /**
+  The reasoning text that was generated during the generation.
+  */
+    readonly reasoningText: string | undefined;
+    /**
+  The files that were generated during the generation.
+  */
+    readonly files: Array<GeneratedFile>;
+    /**
+  The sources that were used to generate the text.
+  */
+    readonly sources: Array<Source>;
+    /**
+  The tool calls that were made during the generation.
+  */
+    readonly toolCalls: ToolCallArray<TOOLS>;
+    /**
+  The results of the tool calls.
+  */
+    readonly toolResults: ToolResultArray<TOOLS>;
+    /**
+  The reason why the generation finished.
+  */
+    readonly finishReason: FinishReason;
+    /**
+  The token usage of the generated text.
+  */
+    readonly usage: LanguageModelUsage;
+    /**
+  Warnings from the model provider (e.g. unsupported settings).
+  */
+    readonly warnings: CallWarning[] | undefined;
+    /**
+  Additional request information.
+     */
+    readonly request: LanguageModelRequestMetadata;
+    /**
+  Additional response information.
+  */
+    readonly response: LanguageModelResponseMetadata & {
+        /**
+    The response messages that were generated during the call.
+    Response messages can be either assistant messages or tool messages.
+    They contain a generated id.
+    */
+        readonly messages: Array<ResponseMessage>;
+        /**
+    Response body (available only for providers that use HTTP requests).
+         */
+        body?: unknown;
+    };
+    /**
+  Additional provider-specific metadata. They are passed through
+  from the provider to the AI SDK and enable provider-specific
+  results that can be fully encapsulated in the provider.
+     */
+    readonly providerMetadata: ProviderMetadata | undefined;
+};
+
 /**
 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.
@@ -3440,15 +3264,15 @@ interface GenerateTextResult<TOOLS extends ToolSet, OUTPUT> {
      */
     readonly content: Array<ContentPart<TOOLS>>;
     /**
-  The generated text. If you are using continue steps, this can include text from all steps.
+  The text that was generated in the last step.
        */
     readonly text: string;
     /**
-  The full reasoning that the model has generated.
+  The full reasoning that the model has generated in the last step.
      */
     readonly reasoning: Array<ReasoningPart>;
     /**
-  The reasoning text that the model has generated. Can be undefined if the model
+  The reasoning text that the model has generated in the last step. Can be undefined if the model
   has only generated text.
      */
     readonly reasoningText: string | undefined;
@@ -3458,28 +3282,32 @@ interface GenerateTextResult<TOOLS extends ToolSet, OUTPUT> {
        */
     readonly files: Array<GeneratedFile>;
     /**
-  Sources that have been used as input to generate the response.
-  For multi-step generation, the sources are accumulated from all steps.
+  Sources that have been used as references in the last step.
      */
     readonly sources: Array<Source>;
     /**
-    The tool calls that were made during the generation.
+  The tool calls that were made in the last step.
      */
     readonly toolCalls: ToolCallArray<TOOLS>;
     /**
-    The results of the tool calls.
+  The results of the tool calls from the last step.
      */
     readonly toolResults: ToolResultArray<TOOLS>;
     /**
-    The reason why the generation finished.
+  The reason why the generation finished.
      */
     readonly finishReason: FinishReason;
     /**
-    The token usage of the generated text.
+  The token usage of the last step.
      */
     readonly usage: LanguageModelUsage;
     /**
-    Warnings from the model provider (e.g. unsupported settings)
+  The total token usage of all steps.
+  When there are multiple steps, the usage is the sum of all step usages.
+     */
+    readonly totalUsage: LanguageModelUsage;
+    /**
+  Warnings from the model provider (e.g. unsupported settings)
      */
     readonly warnings: CallWarning[] | undefined;
     /**
@@ -3606,7 +3434,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, providerOptions, experimental_activeTools: activeTools, experimental_prepareStep: prepareStep, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_output: output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools: activeTools, experimental_prepareStep: prepareStep, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -3628,16 +3456,6 @@ By default, it's set to 1, which means that only a single LLM call is made.
      */
     maxSteps?: number;
     /**
-Generate a unique ID for each message.
-     */
-    experimental_generateMessageId?: IdGenerator;
-    /**
-When enabled, the model will perform additional steps if the finish reason is "length" (experimental).
-
-By default, it's set to false.
-     */
-    experimental_continueSteps?: boolean;
-    /**
 Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
@@ -3699,16 +3517,42 @@ type AsyncIterableStream<T> = AsyncIterable<T> & ReadableStream<T>;
 
 type DataStreamOptions = {
     /**
-     * Process an error, e.g. to log it. Default to `() => 'An error occurred.'`.
-     *
-     * @return error message to include in the data stream.
+     * Message ID that is sent to the client if a new message is created.
+     * This is intended to be used for the UI message,
+     * if the last original message is not an assistant message
+     * (in which case that message ID is used).
      */
-    onError?: (error: unknown) => string;
+    newMessageId?: string;
     /**
-     * Send usage parts to the client.
-     * Default to true.
+     * The original messages.
+     */
+    originalMessages?: UIMessage[];
+    onFinish?: (options: {
+        /**
+         * The updates list of UI messages.
+         */
+        messages: UIMessage[];
+        /**
+         * Indicates whether the response message is a continuation of the last original message,
+         * or if a new message was created.
+         */
+        isContinuation: boolean;
+        /**
+         * The message that was sent to the client as a response
+         * (including the original message if it was extended).
+         */
+        responseMessage: UIMessage;
+    }) => void;
+    /**
+     * Extracts message metadata that will be send to the client.
+     *
+     * Called on `start` and `finish` events.
      */
-    sendUsage?: boolean;
+    messageMetadata?: (options: {
+        part: TextStreamPart<ToolSet> & {
+            type: 'start' | 'finish' | 'start-step' | 'finish-step';
+        };
+    }) => unknown;
     /**
      * Send reasoning parts to the client.
      * Default to false.
@@ -3738,6 +3582,12 @@ type DataStreamOptions = {
      * the message start event from being sent multiple times.
      */
     experimental_sendStart?: boolean;
+    /**
+     * Process an error, e.g. to log it. Default to `() => 'An error occurred.'`.
+     *
+     * @return error message to include in the data stream.
+     */
+    onError?: (error: unknown) => string;
 };
 type ConsumeStreamOptions = {
     onError?: (error: unknown) => void;
@@ -3777,8 +3627,7 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
      */
     readonly files: Promise<GeneratedFile[]>;
     /**
-  Sources that have been used as input to generate the response.
-  For multi-step generation, the sources are accumulated from all steps.
+  Sources that have been used as references in the last step.
   
   Resolved when the response is finished.
      */
@@ -3802,12 +3651,18 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
        */
     readonly finishReason: Promise<FinishReason>;
     /**
+  The token usage of the last step.
+  
+  Resolved when the response is finished.
+     */
+    readonly usage: Promise<LanguageModelUsage>;
+    /**
   The total token usage of the generated response.
   When there are multiple steps, the usage is the sum of all step usages.
   
   Resolved when the response is finished.
        */
-    readonly usage: Promise<LanguageModelUsage>;
+    readonly totalUsage: Promise<LanguageModelUsage>;
     /**
   Warnings from the model provider (e.g. unsupported settings) for the first step.
        */
@@ -3933,29 +3788,21 @@ type TextStreamPart<TOOLS extends ToolSet> = ContentPart<TOOLS> | {
     toolName: string;
     argsTextDelta: string;
 } | {
-    type: 'step-start';
-    messageId: string;
+    type: 'start-step';
     request: LanguageModelRequestMetadata;
     warnings: CallWarning[];
 } | {
-    type: 'step-finish';
-    messageId: string;
-    request: LanguageModelRequestMetadata;
-    warnings: CallWarning[] | undefined;
+    type: 'finish-step';
     response: LanguageModelResponseMetadata;
     usage: LanguageModelUsage;
     finishReason: FinishReason;
     providerMetadata: ProviderMetadata | undefined;
-    isContinued: boolean;
+} | {
+    type: 'start';
 } | {
     type: 'finish';
     finishReason: FinishReason;
-    usage: LanguageModelUsage;
-    providerMetadata: ProviderMetadata | undefined;
-    /**
-     * @deprecated use response on step-finish instead
-     */
-    response: LanguageModelResponseMetadata;
+    totalUsage: LanguageModelUsage;
 } | {
     type: 'error';
     error: unknown;
@@ -4029,11 +3876,15 @@ Callback that is set using the `onFinish` option.
 
 @param event - The event that is passed to the callback.
  */
-type StreamTextOnFinishCallback<TOOLS extends ToolSet> = (event: Omit<StepResult<TOOLS>, 'stepType' | 'isContinued'> & {
+type StreamTextOnFinishCallback<TOOLS extends ToolSet> = (event: StepResult<TOOLS> & {
     /**
 Details for all steps.
    */
     readonly steps: StepResult<TOOLS>[];
+    /**
+Total usage for all steps. This is the sum of the usage of all steps.
+     */
+    readonly totalUsage: LanguageModelUsage;
 }) => Promise<void> | void;
 /**
 Generate a text and call tools for a given prompt using a language model.
@@ -4073,7 +3924,6 @@ If set and supported by the model, calls will generate deterministic results.
 @param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @param maxSteps - Maximum number of sequential LLM calls (steps), e.g. when you use tool calls.
-@param experimental_generateMessageId - Generate a unique ID for each message.
 
 @param onChunk - Callback that is called for each chunk of the stream. The stream processing will pause until the callback promise is resolved.
 @param onError - Callback that is called when an error occurs during streaming. You can use it to log errors.
@@ -4084,7 +3934,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, providerOptions, experimental_toolCallStreaming, toolCallStreaming, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, onChunk, onError, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxSteps, experimental_output: output, experimental_telemetry: telemetry, providerOptions, experimental_toolCallStreaming, toolCallStreaming, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, onChunk, onError, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -4106,16 +3956,6 @@ By default, it's set to 1, which means that only a single LLM call is made.
  */
     maxSteps?: number;
     /**
-Generate a unique ID for each message.
-     */
-    experimental_generateMessageId?: IdGenerator;
-    /**
-When enabled, the model will perform additional steps if the finish reason is "length" (experimental).
-
-By default, it's set to false.
-     */
-    experimental_continueSteps?: boolean;
-    /**
 Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
@@ -4229,7 +4069,7 @@ as body parameters.
 
 @returns A result object that contains the generated images.
  */
-declare function generateImage({ model, prompt, n, size, aspectRatio, seed, providerOptions, maxRetries: maxRetriesArg, abortSignal, headers, }: {
+declare function generateImage({ model, prompt, n, maxImagesPerCall, size, aspectRatio, seed, providerOptions, maxRetries: maxRetriesArg, abortSignal, headers, }: {
     /**
   The image model to use.
        */
@@ -4243,6 +4083,10 @@ declare function generateImage({ model, prompt, n, size, aspectRatio, seed, prov
      */
     n?: number;
     /**
+  Number of images to generate.
+     */
+    maxImagesPerCall?: number;
+    /**
   Size of the images to generate. Must have the format `{width}x{height}`. If not provided, the default size will be used.
      */
     size?: `${number}x${number}`;
@@ -4347,6 +4191,62 @@ Generate a structured, typed object for a given prompt and schema using a langua
 
 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 tools - Tools that are accessible to and can be called by the model. 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 maxOutputTokens - 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 topK - Only sample from the top K options for each subsequent token.
+Used to remove "long tail" low probability responses.
+Recommended for advanced use cases only. You usually only need to use temperature.
+@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 stopSequences - Stop sequences.
+If set, the model will stop generating text when one of the stop sequences is generated.
+@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.
+@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
+
+@param schema - The schema of the object that the model should generate.
+@param schemaName - Optional name of the output that should be generated.
+Used by some providers for additional LLM guidance, e.g.
+via tool or schema name.
+@param schemaDescription - Optional description of the output that should be generated.
+Used by some providers for additional LLM guidance, e.g.
+via tool or schema description.
+
+@param output - The type of the output.
+
+- 'object': The output is an object.
+- 'array': The output is an array.
+- 'enum': The output is an enum.
+- 'no-schema': The output is not a schema.
+
+@param experimental_repairText - A function that attempts to repair the raw output of the mode
+to enable JSON parsing.
+
+@param experimental_telemetry - Optional telemetry configuration (experimental).
+
+@param providerOptions - 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.
+
 @returns
 A result object that contains the generated object, the finish reason, the token usage, and additional information.
  */
@@ -4548,8 +4448,63 @@ type StreamObjectOnFinishCallback<RESULT> = (event: {
 }) => Promise<void> | void;
 /**
 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.
-@return
+
+@param model - The language model to use.
+@param tools - Tools that are accessible to and can be called by the model. 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 maxOutputTokens - 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 topK - Only sample from the top K options for each subsequent token.
+Used to remove "long tail" low probability responses.
+Recommended for advanced use cases only. You usually only need to use temperature.
+@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 stopSequences - Stop sequences.
+If set, the model will stop generating text when one of the stop sequences is generated.
+@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.
+@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
+
+@param schema - The schema of the object that the model should generate.
+@param schemaName - Optional name of the output that should be generated.
+Used by some providers for additional LLM guidance, e.g.
+via tool or schema name.
+@param schemaDescription - Optional description of the output that should be generated.
+Used by some providers for additional LLM guidance, e.g.
+via tool or schema description.
+
+@param output - The type of the output.
+
+- 'object': The output is an object.
+- 'array': The output is an array.
+- 'enum': The output is an enum.
+- 'no-schema': The output is not a schema.
+
+@param experimental_telemetry - Optional telemetry configuration (experimental).
+
+@param providerOptions - 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.
+
+@returns
 A result object for accessing the partial object stream and additional information.
  */
 declare function streamObject<RESULT extends SCHEMA extends z.Schema ? Output extends 'array' ? Array<z.infer<SCHEMA>> : z.infer<SCHEMA> : SCHEMA extends Schema<infer T> ? Output extends 'array' ? Array<T> : T : never, SCHEMA extends z.Schema | Schema = z.Schema<JSONValue$1>, Output extends 'object' | 'array' | 'enum' | 'no-schema' = RESULT extends string ? 'enum' : 'object'>(options: Omit<CallSettings, 'stopSequences'> & Prompt & (Output extends 'enum' ? {
@@ -4736,17 +4691,17 @@ declare function generateSpeech({ model, text, voice, outputFormat, instructions
  */
 declare function defaultSettingsMiddleware({ settings, }: {
     settings: Partial<{
-        maxOutputTokens?: LanguageModelV2CallOptions['maxOutputTokens'] | null;
-        temperature?: LanguageModelV2CallOptions['temperature'] | null;
-        stopSequences?: LanguageModelV2CallOptions['stopSequences'] | null;
-        topP?: LanguageModelV2CallOptions['topP'] | null;
-        topK?: LanguageModelV2CallOptions['topK'] | null;
-        presencePenalty?: LanguageModelV2CallOptions['presencePenalty'] | null;
-        frequencyPenalty?: LanguageModelV2CallOptions['frequencyPenalty'] | null;
-        responseFormat?: LanguageModelV2CallOptions['responseFormat'] | null;
-        seed?: LanguageModelV2CallOptions['seed'] | null;
-        tools?: LanguageModelV2CallOptions['tools'] | null;
-        toolChoice?: LanguageModelV2CallOptions['toolChoice'] | null;
+        maxOutputTokens?: LanguageModelV2CallOptions['maxOutputTokens'];
+        temperature?: LanguageModelV2CallOptions['temperature'];
+        stopSequences?: LanguageModelV2CallOptions['stopSequences'];
+        topP?: LanguageModelV2CallOptions['topP'];
+        topK?: LanguageModelV2CallOptions['topK'];
+        presencePenalty?: LanguageModelV2CallOptions['presencePenalty'];
+        frequencyPenalty?: LanguageModelV2CallOptions['frequencyPenalty'];
+        responseFormat?: LanguageModelV2CallOptions['responseFormat'];
+        seed?: LanguageModelV2CallOptions['seed'];
+        tools?: LanguageModelV2CallOptions['tools'];
+        toolChoice?: LanguageModelV2CallOptions['toolChoice'];
         headers?: LanguageModelV2CallOptions['headers'];
         providerOptions?: LanguageModelV2CallOptions['providerOptions'];
     }>;
@@ -4958,4 +4913,4 @@ declare function transcribe({ model, audio, providerOptions, maxRetries: maxRetr
     headers?: Record<string, string>;
 }): Promise<TranscriptionResult>;
 
-export { AssistantContent, AssistantModelMessage, CallSettings, CallWarning, ChatRequestOptions, ChunkDetector, CompletionRequestOptions, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateUIMessage, DataContent, DataStreamOptions, DataStreamPart, DataStreamWriter, DeepPartial, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, SpeechResult as Experimental_SpeechResult, TranscriptionResult as Experimental_TranscriptionResult, FilePart, FileUIPart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedAudioFile, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelProviderMetadata, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, MCPClientError, MCPTransport, MessageConversionError, ModelMessage, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Prompt, Provider, ProviderMetadata, ProviderOptions, ProviderRegistryProvider, ReasoningUIPart, RepairTextFunction, RetryError, SourceUIPart, SpeechModel, SpeechModelResponseMetadata, SpeechWarning, StepResult, StepStartUIPart, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, SystemModelMessage, TelemetrySettings, TextPart, TextStreamPart, TextUIPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolInvocation, ToolInvocationUIPart, ToolModelMessage, ToolResultPart, ToolResultUnion, ToolSet, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, UIMessage, UIMessagePart, UseChatOptions, UseCompletionOptions, UserContent, UserModelMessage, appendClientMessage, appendResponseMessages, assistantModelMessageSchema, callChatApi, callCompletionApi, convertFileListToFileUIParts, convertToCoreMessages, convertToModelMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, createProviderRegistry, createTextStreamResponse, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, generateSpeech as experimental_generateSpeech, transcribe as experimental_transcribe, extractMaxToolInvocationStep, extractReasoningMiddleware, generateObject, generateText, getTextFromDataUrl, getToolInvocations, isAssistantMessageWithCompletedToolCalls, isDeepEqualData, modelMessageSchema, parsePartialJson, pipeDataStreamToResponse, pipeTextStreamToResponse, processDataStream, processTextStream, shouldResubmitMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, systemModelMessageSchema, tool, toolModelMessageSchema, updateToolCallResult, userModelMessageSchema, wrapLanguageModel };
+export { AssistantContent, AssistantModelMessage, CallSettings, CallWarning, ChatRequestOptions, ChunkDetector, CompletionRequestOptions, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateUIMessage, DataContent, DataStreamOptions, DataStreamPart, DataStreamWriter, DeepPartial, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, SpeechResult as Experimental_SpeechResult, TranscriptionResult as Experimental_TranscriptionResult, FilePart, FileUIPart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedAudioFile, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelProviderMetadata, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, MCPClientError, MCPTransport, MessageConversionError, ModelMessage, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Prompt, Provider, ProviderMetadata, ProviderOptions, ProviderRegistryProvider, ReasoningUIPart, RepairTextFunction, RetryError, SourceUIPart, SpeechModel, SpeechModelResponseMetadata, SpeechWarning, StepResult, StepStartUIPart, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, SystemModelMessage, TelemetrySettings, TextPart, TextStreamPart, TextUIPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolInvocation, ToolInvocationUIPart, ToolModelMessage, ToolResultPart, ToolResultUnion, ToolSet, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, UIMessage, UIMessagePart, UseChatOptions, UseCompletionOptions, UserContent, UserModelMessage, appendClientMessage, assistantModelMessageSchema, callChatApi, callCompletionApi, convertFileListToFileUIParts, convertToCoreMessages, convertToModelMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, createProviderRegistry, createTextStreamResponse, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, generateSpeech as experimental_generateSpeech, transcribe as experimental_transcribe, extractMaxToolInvocationStep, extractReasoningMiddleware, generateObject, generateText, getTextFromDataUrl, getToolInvocations, isAssistantMessageWithCompletedToolCalls, isDeepEqualData, modelMessageSchema, parsePartialJson, pipeDataStreamToResponse, pipeTextStreamToResponse, processTextStream, shouldResubmitMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, systemModelMessageSchema, tool, toolModelMessageSchema, updateToolCallResult, userModelMessageSchema, wrapLanguageModel };