ai 5.0.0-canary.15 → 5.0.0-canary.17

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { ToolCall, ToolResult, FetchFunction, Schema, IDGenerator } from '@ai-sdk/provider-utils';
 export { IDGenerator, Schema, ToolCall, ToolResult, asSchema, createIdGenerator, generateId, jsonSchema } from '@ai-sdk/provider-utils';
 import * as _ai_sdk_provider from '@ai-sdk/provider';
-import { EmbeddingModelV2, EmbeddingModelV2Embedding, ImageModelV2, ImageModelV2CallWarning, JSONValue as JSONValue$1, LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2CallWarning, LanguageModelV2Source, SharedV2ProviderMetadata, SharedV2ProviderOptions, SpeechModelV1, SpeechModelV1CallWarning, TranscriptionModelV1, TranscriptionModelV1CallWarning, JSONObject, LanguageModelV2CallOptions, AISDKError, LanguageModelV2ToolCall, JSONSchema7, JSONParseError, TypeValidationError, LanguageModelV2Middleware, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
+import { EmbeddingModelV2, EmbeddingModelV2Embedding, ImageModelV2, ImageModelV2CallWarning, ImageModelV2ProviderMetadata, JSONValue as JSONValue$1, LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2CallWarning, LanguageModelV2Source, SharedV2ProviderMetadata, SharedV2ProviderOptions, SpeechModelV1, SpeechModelV1CallWarning, TranscriptionModelV1, TranscriptionModelV1CallWarning, JSONObject, LanguageModelV2CallOptions, AISDKError, LanguageModelV2ToolCall, JSONSchema7, JSONParseError, TypeValidationError, LanguageModelV2Middleware, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
 export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, JSONSchema7, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
 import { ServerResponse } from 'node:http';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
@@ -26,6 +26,10 @@ 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 ImageGenerationWarning = ImageModelV2CallWarning;
+/**
+Metadata from the model provider for this call
+  */
+type ImageModelProviderMetadata = ImageModelV2ProviderMetadata;
 
 type ImageModelResponseMetadata = {
     /**
@@ -252,28 +256,10 @@ type ToolInvocation = ({
     state: 'result';
     step?: number;
 } & ToolResult<string, any, any>);
-/**
- * An attachment that can be sent along with a message.
- */
-interface Attachment {
-    /**
-     * The name of the attachment, usually the file name.
-     */
-    name?: string;
-    /**
-     * A string indicating the [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type).
-     * By default, it's extracted from the pathname's extension.
-     */
-    contentType?: string;
-    /**
-     * The URL of the attachment. It can either be a URL to a hosted file or a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
-     */
-    url: string;
-}
 /**
  * AI SDK UI Messages. They are used in the client and to communicate between the frontend and the API routes.
  */
-interface Message {
+interface UIMessage {
     /**
   A unique identifier for the message.
      */
@@ -287,41 +273,26 @@ interface Message {
      */
     content: string;
     /**
-     * Additional attachments to be sent along with the message.
-     */
-    experimental_attachments?: Attachment[];
-    /**
-  The 'data' role is deprecated.
+  The role of the message.
      */
-    role: 'system' | 'user' | 'assistant' | 'data';
+    role: 'system' | 'user' | 'assistant';
     /**
-     * Additional message-specific information added on the server via StreamData
+  Additional message-specific information added on the server via StreamData
      */
     annotations?: JSONValue$1[] | undefined;
     /**
-  Tool invocations (that can be tool calls or tool results, depending on whether or not the invocation has finished)
-  that the assistant made as part of this message.
+  The parts of the message. Use this for rendering the message in the UI.
   
-  @deprecated Use `parts` instead.
-     */
-    toolInvocations?: Array<ToolInvocation>;
-    /**
-     * The parts of the message. Use this for rendering the message in the UI.
-     *
-     * Assistant messages can have text, reasoning and tool invocation parts.
-     * User messages can have text parts.
+  System messages should be avoided (set the system prompt on the server instead).
+  They can have text parts.
+  
+  User messages can have text parts and file parts.
+  
+  Assistant messages can have text, reasoning, tool invocation, and file parts.
      */
-    parts?: Array<TextUIPart | ReasoningUIPart | ToolInvocationUIPart | SourceUIPart | FileUIPart | StepStartUIPart>;
+    parts: Array<UIMessagePart>;
 }
-type UIMessage = Message & {
-    /**
-     * The parts of the message. Use this for rendering the message in the UI.
-     *
-     * Assistant messages can have text, reasoning and tool invocation parts.
-     * User messages can have text parts.
-     */
-    parts: Array<TextUIPart | ReasoningUIPart | ToolInvocationUIPart | SourceUIPart | FileUIPart | StepStartUIPart>;
-};
+type UIMessagePart = TextUIPart | ReasoningUIPart | ToolInvocationUIPart | SourceUIPart | FileUIPart | StepStartUIPart;
 /**
  * A text part of a message.
  */
@@ -340,7 +311,7 @@ type ReasoningUIPart = {
     /**
      * The reasoning text.
      */
-    reasoning: string;
+    text: string;
     /**
      * The provider metadata.
      */
@@ -378,9 +349,14 @@ type FileUIPart = {
      */
     mediaType: string;
     /**
-     * The base64 encoded data.
+     * Optional filename of the file.
      */
-    data: string;
+    filename?: string;
+    /**
+     * The URL of the file.
+     * It can either be a URL to a hosted file or a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
+     */
+    url: string;
 };
 /**
  * A step boundary part of a message.
@@ -388,8 +364,8 @@ type FileUIPart = {
 type StepStartUIPart = {
     type: 'step-start';
 };
-type CreateMessage = Omit<Message, 'id'> & {
-    id?: Message['id'];
+type CreateUIMessage = Omit<UIMessage, 'id'> & {
+    id?: UIMessage['id'];
 };
 type ChatRequest = {
     /**
@@ -403,7 +379,7 @@ type ChatRequest = {
     /**
   The messages of the chat.
      */
-    messages: Message[];
+    messages: UIMessage[];
     /**
   Additional data to be sent to the server.
      */
@@ -432,10 +408,6 @@ type ChatRequestOptions = {
   Additional data to be sent to the API endpoint.
      */
     data?: JSONValue$1;
-    /**
-     * Additional files to be sent to the server.
-     */
-    experimental_attachments?: FileList | Array<Attachment>;
     /**
      * Allow submitting an empty message. Defaults to `false`.
      */
@@ -462,7 +434,7 @@ type UseChatOptions = {
     /**
      * Initial messages of the chat. Useful to load an existing chat history.
      */
-    initialMessages?: Message[];
+    initialMessages?: UIMessage[];
     /**
      * Initial input of the chat.
      */
@@ -488,7 +460,7 @@ type UseChatOptions = {
      * @param options.usage The token usage of the message.
      * @param options.finishReason The finish reason of the message.
      */
-    onFinish?: (message: Message, options: {
+    onFinish?: (message: UIMessage, options: {
         usage: LanguageModelUsage$1;
         finishReason: LanguageModelV2FinishReason;
     }) => void;
@@ -634,7 +606,7 @@ type EmbeddingModelUsage = {
 };
 
 declare const getOriginalFetch$1: () => typeof fetch;
-declare function callChatApi({ api, body, streamProtocol, credentials, headers, abortController, restoreMessagesOnFailure, onResponse, onUpdate, onFinish, onToolCall, generateId, fetch, lastMessage, }: {
+declare function callChatApi({ api, body, streamProtocol, credentials, headers, abortController, restoreMessagesOnFailure, onResponse, onUpdate, onFinish, onToolCall, generateId, fetch, lastMessage, getCurrentDate, requestType, }: {
     api: string;
     body: Record<string, any>;
     streamProtocol: 'data' | 'text' | undefined;
@@ -653,6 +625,8 @@ declare function callChatApi({ api, body, streamProtocol, credentials, headers,
     generateId: IdGenerator;
     fetch: ReturnType<typeof getOriginalFetch$1> | undefined;
     lastMessage: UIMessage | undefined;
+    getCurrentDate: () => Date;
+    requestType?: 'generate' | 'resume';
 }): Promise<void>;
 
 declare const getOriginalFetch: () => typeof fetch;
@@ -674,6 +648,8 @@ declare function callCompletionApi({ api, prompt, credentials, headers, body, st
     fetch: ReturnType<typeof getOriginalFetch> | undefined;
 }): Promise<string | null | undefined>;
 
+declare function convertFileListToFileUIParts(files: FileList | undefined): Promise<Array<FileUIPart>>;
+
 type DataStreamString = `${(typeof DataStreamStringPrefixes)[keyof typeof DataStreamStringPrefixes]}:${string}\n`;
 interface DataStreamPart<CODE extends string, NAME extends string, TYPE> {
     code: CODE;
@@ -708,8 +684,8 @@ declare const dataStreamParts: readonly [DataStreamPart<"0", "text", string>, Da
     text: string;
     providerMetadata?: Record<string, any> | undefined;
 }>, DataStreamPart<"h", "source", LanguageModelV2Source>, DataStreamPart<"l", "reasoning_part_finish", {}>, DataStreamPart<"k", "file", {
-    data: string;
-    mimeType: string;
+    url: string;
+    mediaType: string;
 }>];
 type DataStreamParts = (typeof dataStreamParts)[number];
 /**
@@ -751,7 +727,7 @@ Parses a stream part from a string.
  */
 declare const parseDataStreamPart: (line: string) => DataStreamPartType;
 /**
-Prepends a string with a prefix from the `StreamChunkPrefixes`, JSON-ifies it,
+Prepends a string with a prefix from the `StreamChunkPrefixes`, converts it to JSON,
 and appends a new line.
 
 It ensures type-safety for the part type and value.
@@ -782,10 +758,6 @@ type PartialObject<ObjectType extends object> = {
 
 declare function extractMaxToolInvocationStep(toolInvocations: ToolInvocation[] | undefined): number | undefined;
 
-declare function fillMessageParts(messages: Message[]): UIMessage[];
-
-declare function getMessageParts(message: Message | CreateMessage | UIMessage): (TextUIPart | ReasoningUIPart | ToolInvocationUIPart | SourceUIPart | FileUIPart | StepStartUIPart)[];
-
 /**
  * Performs a deep-equal comparison of two parsed JSON objects.
  *
@@ -800,8 +772,6 @@ declare function parsePartialJson(jsonText: string | undefined): Promise<{
     state: 'undefined-input' | 'successful-parse' | 'repaired-parse' | 'failed-parse';
 }>;
 
-declare function prepareAttachmentsForRequest(attachmentsFromOptions: FileList | Array<Attachment> | undefined): Promise<Attachment[]>;
-
 declare function processDataStream({ stream, onTextPart, onReasoningPart, onReasoningPartFinish, onSourcePart, onFilePart, onDataPart, onErrorPart, onToolCallStreamingStartPart, onToolCallDeltaPart, onToolCallPart, onToolResultPart, onMessageAnnotationsPart, onFinishMessagePart, onFinishStepPart, onStartStepPart, }: {
     stream: ReadableStream<Uint8Array>;
     onTextPart?: (streamPart: (DataStreamPartType & {
@@ -856,21 +826,6 @@ declare function processTextStream({ stream, onTextPart, }: {
     onTextPart: (chunk: string) => Promise<void> | void;
 }): Promise<void>;
 
-/**
- * Updates the result of a specific tool invocation in the last message of the given messages array.
- *
- * @param {object} params - The parameters object.
- * @param {UIMessage[]} params.messages - An array of messages, from which the last one is updated.
- * @param {string} params.toolCallId - The unique identifier for the tool invocation to update.
- * @param {unknown} params.toolResult - The result object to attach to the tool invocation.
- * @returns {void} This function does not return anything.
- */
-declare function updateToolCallResult({ messages, toolCallId, toolResult: result, }: {
-    messages: UIMessage[];
-    toolCallId: string;
-    toolResult: unknown;
-}): void;
-
 declare function shouldResubmitMessages({ originalMaxToolInvocationStep, originalMessageCount, maxSteps, messages, }: {
     originalMaxToolInvocationStep: number | undefined;
     originalMessageCount: number;
@@ -886,6 +841,21 @@ declare function isAssistantMessageWithCompletedToolCalls(message: UIMessage): m
     role: 'assistant';
 };
 
+/**
+ * Updates the result of a specific tool invocation in the last message of the given messages array.
+ *
+ * @param {object} params - The parameters object.
+ * @param {UIMessage[]} params.messages - An array of messages, from which the last one is updated.
+ * @param {string} params.toolCallId - The unique identifier for the tool invocation to update.
+ * @param {unknown} params.toolResult - The result object to attach to the tool invocation.
+ * @returns {void} This function does not return anything.
+ */
+declare function updateToolCallResult({ messages, toolCallId, toolResult: result, }: {
+    messages: UIMessage[];
+    toolCallId: string;
+    toolResult: unknown;
+}): void;
+
 interface DataStreamWriter {
     /**
      * Appends a data part to the stream.
@@ -1258,10 +1228,6 @@ interface ImagePart {
      */
     mediaType?: string;
     /**
-  @deprecated Use `mediaType` instead.
-     */
-    mimeType?: string;
-    /**
   Additional provider-specific metadata. They are passed through
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
@@ -1291,10 +1257,6 @@ interface FilePart {
      */
     mediaType: string;
     /**
-  @deprecated Use `mediaType` instead.
-     */
-    mimeType?: string;
-    /**
   Additional provider-specific metadata. They are passed through
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
@@ -1381,7 +1343,7 @@ interface ToolResultPart {
  to increase the resilience against prompt injection attacks,
  and because not all providers support several system messages.
  */
-type CoreSystemMessage = {
+type SystemModelMessage = {
     role: 'system';
     content: string;
     /**
@@ -1391,11 +1353,19 @@ type CoreSystemMessage = {
    */
     providerOptions?: ProviderOptions;
 };
-declare const coreSystemMessageSchema: z.ZodType<CoreSystemMessage>;
+/**
+@deprecated Use `SystemModelMessage` instead.
+ */
+type CoreSystemMessage = SystemModelMessage;
+declare const systemModelMessageSchema: z.ZodType<SystemModelMessage>;
+/**
+@deprecated Use `systemModelMessageSchema` instead.
+ */
+declare const coreSystemMessageSchema: z.ZodType<SystemModelMessage, z.ZodTypeDef, SystemModelMessage>;
 /**
 A user message. It can contain text or a combination of text and images.
  */
-type CoreUserMessage = {
+type UserModelMessage = {
     role: 'user';
     content: UserContent;
     /**
@@ -1405,7 +1375,15 @@ type CoreUserMessage = {
    */
     providerOptions?: ProviderOptions;
 };
-declare const coreUserMessageSchema: z.ZodType<CoreUserMessage>;
+/**
+@deprecated Use `UserModelMessage` instead.
+ */
+type CoreUserMessage = UserModelMessage;
+declare const userModelMessageSchema: z.ZodType<UserModelMessage>;
+/**
+@deprecated Use `userModelMessageSchema` instead.
+ */
+declare const coreUserMessageSchema: z.ZodType<UserModelMessage, z.ZodTypeDef, UserModelMessage>;
 /**
 Content of a user message. It can be a string or an array of text and image parts.
  */
@@ -1413,7 +1391,7 @@ type UserContent = string | Array<TextPart | ImagePart | FilePart>;
 /**
 An assistant message. It can contain text, tool calls, or a combination of text and tool calls.
  */
-type CoreAssistantMessage = {
+type AssistantModelMessage = {
     role: 'assistant';
     content: AssistantContent;
     /**
@@ -1423,7 +1401,15 @@ type CoreAssistantMessage = {
    */
     providerOptions?: ProviderOptions;
 };
-declare const coreAssistantMessageSchema: z.ZodType<CoreAssistantMessage>;
+/**
+@deprecated Use `AssistantModelMessage` instead.
+ */
+type CoreAssistantMessage = AssistantModelMessage;
+declare const assistantModelMessageSchema: z.ZodType<AssistantModelMessage>;
+/**
+@deprecated Use `assistantModelMessageSchema` instead.
+ */
+declare const coreAssistantMessageSchema: z.ZodType<AssistantModelMessage, z.ZodTypeDef, AssistantModelMessage>;
 /**
 Content of an assistant message.
 It can be a string or an array of text, image, reasoning, redacted reasoning, and tool call parts.
@@ -1432,7 +1418,7 @@ type AssistantContent = string | Array<TextPart | FilePart | ReasoningPart | Too
 /**
 A tool message. It contains the result of one or more tool calls.
  */
-type CoreToolMessage = {
+type ToolModelMessage = {
     role: 'tool';
     content: ToolContent;
     /**
@@ -1442,7 +1428,15 @@ type CoreToolMessage = {
    */
     providerOptions?: ProviderOptions;
 };
-declare const coreToolMessageSchema: z.ZodType<CoreToolMessage>;
+/**
+@deprecated Use `ToolModelMessage` instead.
+ */
+type CoreToolMessage = ToolModelMessage;
+declare const toolModelMessageSchema: z.ZodType<ToolModelMessage>;
+/**
+@deprecated Use `toolModelMessageSchema` instead.
+ */
+declare const coreToolMessageSchema: z.ZodType<ToolModelMessage, z.ZodTypeDef, ToolModelMessage>;
 /**
 Content of a tool message. It is an array of tool result parts.
  */
@@ -1451,7 +1445,15 @@ type ToolContent = Array<ToolResultPart>;
 A message that can be used in the `messages` field of a prompt.
 It can be a user message, an assistant message, or a tool message.
  */
-type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
+type ModelMessage = SystemModelMessage | UserModelMessage | AssistantModelMessage | ToolModelMessage;
+/**
+@deprecated Use `ModelMessage` instead.
+   */
+type CoreMessage = ModelMessage;
+declare const modelMessageSchema: z.ZodType<ModelMessage>;
+/**
+@deprecated Use `modelMessageSchema` instead.
+ */
 declare const coreMessageSchema: z.ZodType<CoreMessage>;
 
 /**
@@ -1470,7 +1472,7 @@ type Prompt = {
     /**
   A list of messages. You can either use `prompt` or `messages` but not both.
      */
-    messages?: Array<CoreMessage> | Array<Omit<Message, 'id'>>;
+    messages?: Array<ModelMessage> | Array<Omit<UIMessage, 'id'>>;
 };
 
 /**
@@ -1566,20 +1568,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>;
@@ -1700,20 +1702,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>;
@@ -1771,7 +1773,7 @@ interface ToolExecutionOptions {
      * Messages that were sent to the language model to initiate the response that contained the tool call.
      * The messages **do not** include the system prompt nor the assistant response that contained the tool call.
      */
-    messages: CoreMessage[];
+    messages: ModelMessage[];
     /**
      * An optional abort signal that indicates that the overall operation should be aborted.
      */
@@ -2581,9 +2583,13 @@ declare function createMCPClient(config: MCPClientConfig): Promise<MCPClient>;
  * Tool parameters are automatically inferred from the server's JSON schema
  * if not explicitly provided in the tools configuration
  *
+ * This client is meant to be used to communicate with a single server. To communicate and fetch tools across multiple servers, it's recommended to create a new client instance per server.
+ *
  * Not supported:
  * - Client options (e.g. sampling, roots) as they are not needed for tool conversion
  * - Accepting notifications
+ * - Session management (when passing a sessionId to an instance of the Streamable HTTP transport)
+ * - Resumable SSE streams
  */
 declare class MCPClient {
     private transport;
@@ -2596,6 +2602,7 @@ declare class MCPClient {
     constructor({ transport: transportConfig, name, onUncaughtError, }: MCPClientConfig);
     init(): Promise<this>;
     close(): Promise<void>;
+    private assertCapability;
     private request;
     private listTools;
     private callTool;
@@ -2923,9 +2930,9 @@ declare class NoSuchToolError extends AISDKError {
  * Otherwise, the new message will be appended.
  */
 declare function appendClientMessage({ messages, message, }: {
-    messages: Message[];
-    message: Message;
-}): Message[];
+    messages: UIMessage[];
+    message: UIMessage;
+}): UIMessage[];
 
 /**
  * Appends the ResponseMessage[] from the response to a Message[] (for useChat).
@@ -2935,7 +2942,7 @@ declare function appendClientMessage({ messages, message, }: {
  * @returns A new Message[] with the response messages appended.
  */
 declare function appendResponseMessages({ messages, responseMessages, _internal: { currentDate }, }: {
-    messages: Message[];
+    messages: UIMessage[];
     responseMessages: ResponseMessage[];
     /**
   Internal. For test use only. May change without notice.
@@ -2943,15 +2950,19 @@ declare function appendResponseMessages({ messages, responseMessages, _internal:
     _internal?: {
         currentDate?: () => Date;
     };
-}): Message[];
+}): UIMessage[];
 
 /**
 Converts an array of messages from useChat into an array of CoreMessages that can be used
 with the AI core functions (e.g. `streamText`).
  */
-declare function convertToCoreMessages<TOOLS extends ToolSet = never>(messages: Array<Omit<Message, 'id'>>, options?: {
+declare function convertToModelMessages<TOOLS extends ToolSet = never>(messages: Array<Omit<UIMessage, 'id'>>, options?: {
     tools?: TOOLS;
-}): CoreMessage[];
+}): ModelMessage[];
+/**
+@deprecated Use `convertToModelMessages` instead.
+ */
+declare const convertToCoreMessages: typeof convertToModelMessages;
 
 /**
  * A function that attempts to repair a tool call that failed to parse.
@@ -2968,7 +2979,7 @@ declare function convertToCoreMessages<TOOLS extends ToolSet = never>(messages:
  */
 type ToolCallRepairFunction<TOOLS extends ToolSet> = (options: {
     system: string | undefined;
-    messages: CoreMessage[];
+    messages: ModelMessage[];
     toolCall: LanguageModelV2ToolCall;
     tools: TOOLS;
     parameterSchema: (options: {
@@ -3670,6 +3681,11 @@ interface GenerateImageResult {
   Response metadata from the provider. There may be multiple responses if we made multiple calls to the model.
      */
     readonly responses: Array<ImageModelResponseMetadata>;
+    /**
+     * 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: ImageModelProviderMetadata;
 }
 
 /**
@@ -4012,7 +4028,14 @@ This function streams the output. If you do not want to stream the output, use `
 @return
 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' | 'no-schema' = 'object'>(options: Omit<CallSettings, 'stopSequences'> & Prompt & (Output extends 'no-schema' ? {} : {
+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' ? {
+    /**
+The enum values that the model should use.
+  */
+    enum: Array<RESULT>;
+    mode?: 'json';
+    output: 'enum';
+} : Output extends 'no-schema' ? {} : {
     /**
 The schema of the object that the model should generate.
 */
@@ -4077,7 +4100,7 @@ Callback that is called when the LLM response and the final object validation ar
         currentDate?: () => Date;
         now?: () => number;
     };
-}): StreamObjectResult<Output extends 'array' ? RESULT : DeepPartial<RESULT>, Output extends 'array' ? RESULT : RESULT, Output extends 'array' ? RESULT extends Array<infer U> ? AsyncIterableStream<U> : never : never>;
+}): StreamObjectResult<Output extends 'enum' ? string : Output extends 'array' ? RESULT : DeepPartial<RESULT>, Output extends 'array' ? RESULT : RESULT, Output extends 'array' ? RESULT extends Array<infer U> ? AsyncIterableStream<U> : never : never>;
 
 /**
  * A generated audio file.
@@ -4411,6 +4434,8 @@ declare function createProviderRegistry<PROVIDERS extends Record<string, Provide
  */
 declare const experimental_createProviderRegistry: typeof createProviderRegistry;
 
+declare function getToolInvocations(message: UIMessage): ToolInvocation[];
+
 /**
  * Calculates the cosine similarity between two vectors. This is a useful metric for
  * comparing the similarity of two vectors such as embeddings.
@@ -4654,9 +4679,9 @@ declare class InvalidMessageRoleError extends AISDKError {
 declare const symbol$2: unique symbol;
 declare class MessageConversionError extends AISDKError {
     private readonly [symbol$2];
-    readonly originalMessage: Omit<Message, 'id'>;
+    readonly originalMessage: Omit<UIMessage, 'id'>;
     constructor({ originalMessage, message, }: {
-        originalMessage: Omit<Message, 'id'>;
+        originalMessage: Omit<UIMessage, 'id'>;
         message: string;
     });
     static isInstance(error: unknown): error is MessageConversionError;
@@ -4693,4 +4718,4 @@ declare class RetryError extends AISDKError {
     static isInstance(error: unknown): error is RetryError;
 }
 
-export { AssistantContent, Attachment, CallSettings, CallWarning, ChatRequest, ChatRequestOptions, ChunkDetector, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataStreamOptions, DataStreamPart, DataStreamString, 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, IdGenerator, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, JSONValue, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, MCPClientError, MCPTransport, Message, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Prompt, Provider, ProviderMetadata, ProviderOptions, ProviderRegistryProvider, ReasoningUIPart, RepairTextFunction, RequestOptions, RetryError, SourceUIPart, SpeechModel, SpeechModelResponseMetadata, SpeechWarning, StepResult, StepStartUIPart, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, TextUIPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolInvocation, ToolInvocationUIPart, ToolResultPart, ToolResultUnion, ToolSet, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, UIMessage, UseChatOptions, UseCompletionOptions, UserContent, appendClientMessage, appendResponseMessages, callChatApi, callCompletionApi, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, createProviderRegistry, 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, fillMessageParts, formatDataStreamPart, generateObject, generateText, getMessageParts, getTextFromDataUrl, isAssistantMessageWithCompletedToolCalls, isDeepEqualData, parseDataStreamPart, parsePartialJson, pipeDataStreamToResponse, prepareAttachmentsForRequest, processDataStream, processTextStream, shouldResubmitMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, tool, updateToolCallResult, wrapLanguageModel };
+export { AssistantContent, AssistantModelMessage, CallSettings, CallWarning, ChatRequest, ChatRequestOptions, ChunkDetector, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateUIMessage, DataContent, DataStreamOptions, DataStreamPart, DataStreamString, 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, IdGenerator, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelProviderMetadata, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, JSONValue, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, MCPClientError, MCPTransport, MessageConversionError, ModelMessage, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Prompt, Provider, ProviderMetadata, ProviderOptions, ProviderRegistryProvider, ReasoningUIPart, RepairTextFunction, RequestOptions, RetryError, SourceUIPart, SpeechModel, SpeechModelResponseMetadata, SpeechWarning, StepResult, StepStartUIPart, StreamData, 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, 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, formatDataStreamPart, generateObject, generateText, getTextFromDataUrl, getToolInvocations, isAssistantMessageWithCompletedToolCalls, isDeepEqualData, modelMessageSchema, parseDataStreamPart, parsePartialJson, pipeDataStreamToResponse, processDataStream, processTextStream, shouldResubmitMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, systemModelMessageSchema, tool, toolModelMessageSchema, updateToolCallResult, userModelMessageSchema, wrapLanguageModel };