ai 3.1.6 → 3.1.8

package/dist/index.d.mts

@@ -1,10 +1,107 @@
-import { z } from 'zod';
-import { LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning } from '@ai-sdk/provider';
+import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning } from '@ai-sdk/provider';
 export { APICallError, EmptyResponseBodyError, InvalidArgumentError, InvalidDataContentError, InvalidPromptError, InvalidResponseDataError, InvalidToolArgumentsError, JSONParseError, LoadAPIKeyError, NoObjectGeneratedError, NoSuchToolError, RetryError, ToolCallParseError, TypeValidationError, UnsupportedFunctionalityError, UnsupportedJSONSchemaError } from '@ai-sdk/provider';
+import { z } from 'zod';
 import { ServerResponse } from 'node:http';
 import { AssistantStream } from 'openai/lib/AssistantStream';
 import { Run } from 'openai/resources/beta/threads/runs/runs';
 
+/**
+Embedding model that is used by the AI SDK Core functions.
+*/
+type EmbeddingModel<VALUE> = EmbeddingModelV1<VALUE>;
+/**
+Embedding.
+ */
+type Embedding = EmbeddingModelV1Embedding;
+
+/**
+Language model that is used by the AI SDK Core functions.
+*/
+type LanguageModel = LanguageModelV1;
+/**
+Reason why a language model finished generating a response.
+
+Can be one of the following:
+- `stop`: model generated stop sequence
+- `length`: model generated maximum number of tokens
+- `content-filter`: content filter violation stopped the model
+- `tool-calls`: model triggered tool calls
+- `error`: model stopped because of an error
+- `other`: model stopped for other reasons
+*/
+type FinishReason = LanguageModelV1FinishReason;
+/**
+Log probabilities for each token and its top log probabilities.
+ */
+type LogProbs = LanguageModelV1LogProbs;
+/**
+Warning from the model provider for this call. The call will proceed, but e.g.
+some settings might not be supported, which can lead to suboptimal results.
+*/
+type CallWarning = LanguageModelV1CallWarning;
+
+/**
+Embed a value using an embedding model. The type of the value is defined by the embedding model.
+
+@param model - The embedding model to use.
+@param value - The value that should be embedded.
+
+@param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
+@param abortSignal - An optional abort signal that can be used to cancel the call.
+
+@returns A result object that contains the embedding, the value, and additional information.
+ */
+declare function embed<VALUE>({ model, value, maxRetries, abortSignal, }: {
+    /**
+  The embedding model to use.
+       */
+    model: EmbeddingModel<VALUE>;
+    /**
+  The value that should be embedded.
+     */
+    value: VALUE;
+    /**
+  Maximum number of retries per embedding model call. Set to 0 to disable retries.
+  
+  @default 2
+     */
+    maxRetries?: number;
+    /**
+  Abort signal.
+   */
+    abortSignal?: AbortSignal;
+}): Promise<EmbedResult<VALUE>>;
+/**
+The result of a `embed` call.
+It contains the embedding, the value, and additional information.
+ */
+declare class EmbedResult<VALUE> {
+    /**
+  The value that was embedded.
+     */
+    readonly value: VALUE;
+    /**
+  The embedding of the value.
+    */
+    readonly embedding: Embedding;
+    /**
+  Optional raw response data.
+     */
+    readonly rawResponse?: {
+        /**
+    Response headers.
+         */
+        headers?: Record<string, string>;
+    };
+    constructor(options: {
+        value: VALUE;
+        embedding: Embedding;
+        rawResponse?: {
+            headers?: Record<string, string>;
+        };
+    });
+}
+
 type TokenUsage = {
     promptTokens: number;
     completionTokens: number;
@@ -242,32 +339,6 @@ type Prompt = {
     messages?: Array<CoreMessage>;
 };
 
-/**
-Language model that is used by the AI SDK Core functions.
-*/
-type LanguageModel = LanguageModelV1;
-/**
-Reason why a language model finished generating a response.
-
-Can be one of the following:
-- `stop`: model generated stop sequence
-- `length`: model generated maximum number of tokens
-- `content-filter`: content filter violation stopped the model
-- `tool-calls`: model triggered tool calls
-- `error`: model stopped because of an error
-- `other`: model stopped for other reasons
-*/
-type FinishReason = LanguageModelV1FinishReason;
-/**
-Log probabilities for each token and its top log probabilities.
- */
-type LogProbs = LanguageModelV1LogProbs;
-/**
-Warning from the model provider for this call. The call will proceed, but e.g.
-some settings might not be supported, which can lead to suboptimal results.
-*/
-type CallWarning = LanguageModelV1CallWarning;
-
 /**
 Generate a structured, typed object for a given prompt and schema using a language model.
 
@@ -591,6 +662,24 @@ onlyBar('bar');
 */
 type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
 
+/**
+Typed tool call that is returned by generateText and streamText.
+It contains the tool call ID, the tool name, and the tool arguments.
+ */
+interface ToolCall$1<NAME extends string, ARGS> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that is being called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+}
 type ToToolCall<TOOLS extends Record<string, CoreTool>> = ValueOf<{
     [NAME in keyof TOOLS]: {
         type: 'tool-call';
@@ -601,6 +690,28 @@ type ToToolCall<TOOLS extends Record<string, CoreTool>> = ValueOf<{
 }>;
 type ToToolCallArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolCall<TOOLS>>;
 
+/**
+Typed tool result that is returned by generateText and streamText.
+It contains the tool call ID, the tool name, the tool arguments, and the tool result.
+ */
+interface ToolResult<NAME extends string, ARGS, RESULT> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that was called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+    /**
+  Result of the tool call. This is the result of the tool's execution.
+     */
+    result: RESULT;
+}
 type ToToolsWithExecute<TOOLS extends Record<string, CoreTool>> = {
     [K in keyof TOOLS as TOOLS[K] extends {
         execute: any;
@@ -854,7 +965,7 @@ declare class StreamTextResult<TOOLS extends Record<string, CoreTool>> {
   
   @returns an `AIStream` object.
      */
-    toAIStream(callbacks?: AIStreamCallbacksAndOptions): ReadableStream<any>;
+    toAIStream(callbacks?: AIStreamCallbacksAndOptions): ReadableStream<Uint8Array>;
     /**
   Writes stream data output to a Node.js response-like object.
   It sets a `Content-Type` header to `text/plain; charset=utf-8` and
@@ -902,6 +1013,16 @@ declare class StreamTextResult<TOOLS extends Record<string, CoreTool>> {
  */
 declare const experimental_streamText: typeof streamText;
 
+/**
+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(messages: Array<{
+    role: 'user' | 'assistant';
+    content: string;
+    toolInvocations?: Array<ToolResult<string, unknown, unknown>>;
+}>): CoreMessage[];
+
 interface FunctionCall$1 {
     /**
      * The arguments to call the function with, as generated by the model in JSON
@@ -970,6 +1091,12 @@ interface Function {
     description?: string;
 }
 type IdGenerator = () => string;
+/**
+Tool invocations are either tool calls or tool results. For each assistant tool call,
+there is one tool invocation. While the call is in progress, the invocation is a tool call.
+Once the call is complete, the invocation is a tool result.
+ */
+type ToolInvocation = ToolCall$1<string, any> | ToolResult<string, any, any>;
 /**
  * Shared types between the API and UI packages.
  */
@@ -1005,6 +1132,11 @@ interface Message$1 {
      * Additional message-specific information added on the server via StreamData
      */
     annotations?: JSONValue[] | undefined;
+    /**
+  Tool invocations (that can be tool calls or tool results, depending on whether or not the invocation has finished)
+  that the assistant made as part of this message.
+     */
+    toolInvocations?: Array<ToolInvocation>;
 }
 type CreateMessage = Omit<Message$1, 'id'> & {
     id?: Message$1['id'];
@@ -1210,18 +1342,20 @@ declare const assistantControlDataStreamPart: StreamPart<'5', 'assistant_control
     messageId: string;
 }>;
 declare const dataMessageStreamPart: StreamPart<'6', 'data_message', DataMessage>;
-declare const toolCallStreamPart: StreamPart<'7', 'tool_calls', {
+declare const toolCallsStreamPart: StreamPart<'7', 'tool_calls', {
     tool_calls: ToolCall[];
 }>;
 declare const messageAnnotationsStreamPart: StreamPart<'8', 'message_annotations', Array<JSONValue>>;
-type StreamParts = typeof textStreamPart | typeof functionCallStreamPart | typeof dataStreamPart | typeof errorStreamPart | typeof assistantMessageStreamPart | typeof assistantControlDataStreamPart | typeof dataMessageStreamPart | typeof toolCallStreamPart | typeof messageAnnotationsStreamPart;
+declare const toolCallStreamPart: StreamPart<'9', 'tool_call', ToolCall$1<string, any>>;
+declare const toolResultStreamPart: StreamPart<'a', 'tool_result', ToolResult<string, any, any>>;
+type StreamParts = typeof textStreamPart | typeof functionCallStreamPart | typeof dataStreamPart | typeof errorStreamPart | typeof assistantMessageStreamPart | typeof assistantControlDataStreamPart | typeof dataMessageStreamPart | typeof toolCallsStreamPart | typeof messageAnnotationsStreamPart | typeof toolCallStreamPart | typeof toolResultStreamPart;
 /**
  * Maps the type of a stream part to its value type.
  */
 type StreamPartValueType = {
     [P in StreamParts as P['name']]: ReturnType<P['parse']>['value'];
 };
-type StreamPartType = ReturnType<typeof textStreamPart.parse> | ReturnType<typeof functionCallStreamPart.parse> | ReturnType<typeof dataStreamPart.parse> | ReturnType<typeof errorStreamPart.parse> | ReturnType<typeof assistantMessageStreamPart.parse> | ReturnType<typeof assistantControlDataStreamPart.parse> | ReturnType<typeof dataMessageStreamPart.parse> | ReturnType<typeof toolCallStreamPart.parse> | ReturnType<typeof messageAnnotationsStreamPart.parse>;
+type StreamPartType = ReturnType<typeof textStreamPart.parse> | ReturnType<typeof functionCallStreamPart.parse> | ReturnType<typeof dataStreamPart.parse> | ReturnType<typeof errorStreamPart.parse> | ReturnType<typeof assistantMessageStreamPart.parse> | ReturnType<typeof assistantControlDataStreamPart.parse> | ReturnType<typeof dataMessageStreamPart.parse> | ReturnType<typeof toolCallsStreamPart.parse> | ReturnType<typeof messageAnnotationsStreamPart.parse> | ReturnType<typeof toolCallStreamPart.parse> | ReturnType<typeof toolResultStreamPart.parse>;
 /**
  * The map of prefixes for data in the stream
  *
@@ -1254,6 +1388,8 @@ declare const StreamStringPrefixes: {
     readonly data_message: "6";
     readonly tool_calls: "7";
     readonly message_annotations: "8";
+    readonly tool_call: "9";
+    readonly tool_result: "a";
 };
 /**
 Parses a stream part from a string.
@@ -1296,7 +1432,7 @@ declare function createChunkDecoder(complex: false): (chunk: Uint8Array | undefi
 declare function createChunkDecoder(complex: true): (chunk: Uint8Array | undefined) => StreamPartType[];
 declare function createChunkDecoder(complex?: boolean): (chunk: Uint8Array | undefined) => StreamPartType[] | string;
 
-declare const isStreamStringEqualToType: (type: keyof typeof StreamStringPrefixes, value: string) => value is `0:${string}\n` | `1:${string}\n` | `2:${string}\n` | `3:${string}\n` | `4:${string}\n` | `5:${string}\n` | `6:${string}\n` | `7:${string}\n` | `8:${string}\n`;
+declare const isStreamStringEqualToType: (type: keyof typeof StreamStringPrefixes, value: string) => value is `0:${string}\n` | `1:${string}\n` | `2:${string}\n` | `3:${string}\n` | `4:${string}\n` | `5:${string}\n` | `6:${string}\n` | `7:${string}\n` | `8:${string}\n` | `9:${string}\n` | `a:${string}\n`;
 type StreamString = `${(typeof StreamStringPrefixes)[keyof typeof StreamStringPrefixes]}:${string}\n`;
 
 declare interface AzureChatCompletions {
@@ -2048,4 +2184,4 @@ declare function streamToResponse(res: ReadableStream, response: ServerResponse,
     status?: number;
 }): void;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, Message$1 as Message, MistralStream, ObjectStreamPart, ObjectStreamPartInput, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamData, StreamObjectResult, StreamPart, StreamString, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, Tool, ToolCall, ToolCallHandler, ToolCallPart, ToolCallPayload, ToolChoice, ToolContent, ToolResultPart, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, formatStreamPart, generateId, generateObject, generateText, isStreamStringEqualToType, generateId as nanoid, parseStreamPart, readDataStream, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, EmbedResult, Embedding, EmbeddingModel, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, Message$1 as Message, MistralStream, ObjectStreamPart, ObjectStreamPartInput, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamData, StreamObjectResult, StreamPart, StreamString, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, Tool, ToolCall, ToolCallHandler, ToolCallPart, ToolCallPayload, ToolChoice, ToolContent, ToolInvocation, ToolResultPart, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, convertToCoreMessages, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, embed, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, formatStreamPart, generateId, generateObject, generateText, isStreamStringEqualToType, generateId as nanoid, parseStreamPart, readDataStream, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };

package/dist/index.d.ts

@@ -1,10 +1,107 @@
-import { z } from 'zod';
-import { LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning } from '@ai-sdk/provider';
+import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning } from '@ai-sdk/provider';
 export { APICallError, EmptyResponseBodyError, InvalidArgumentError, InvalidDataContentError, InvalidPromptError, InvalidResponseDataError, InvalidToolArgumentsError, JSONParseError, LoadAPIKeyError, NoObjectGeneratedError, NoSuchToolError, RetryError, ToolCallParseError, TypeValidationError, UnsupportedFunctionalityError, UnsupportedJSONSchemaError } from '@ai-sdk/provider';
+import { z } from 'zod';
 import { ServerResponse } from 'node:http';
 import { AssistantStream } from 'openai/lib/AssistantStream';
 import { Run } from 'openai/resources/beta/threads/runs/runs';
 
+/**
+Embedding model that is used by the AI SDK Core functions.
+*/
+type EmbeddingModel<VALUE> = EmbeddingModelV1<VALUE>;
+/**
+Embedding.
+ */
+type Embedding = EmbeddingModelV1Embedding;
+
+/**
+Language model that is used by the AI SDK Core functions.
+*/
+type LanguageModel = LanguageModelV1;
+/**
+Reason why a language model finished generating a response.
+
+Can be one of the following:
+- `stop`: model generated stop sequence
+- `length`: model generated maximum number of tokens
+- `content-filter`: content filter violation stopped the model
+- `tool-calls`: model triggered tool calls
+- `error`: model stopped because of an error
+- `other`: model stopped for other reasons
+*/
+type FinishReason = LanguageModelV1FinishReason;
+/**
+Log probabilities for each token and its top log probabilities.
+ */
+type LogProbs = LanguageModelV1LogProbs;
+/**
+Warning from the model provider for this call. The call will proceed, but e.g.
+some settings might not be supported, which can lead to suboptimal results.
+*/
+type CallWarning = LanguageModelV1CallWarning;
+
+/**
+Embed a value using an embedding model. The type of the value is defined by the embedding model.
+
+@param model - The embedding model to use.
+@param value - The value that should be embedded.
+
+@param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
+@param abortSignal - An optional abort signal that can be used to cancel the call.
+
+@returns A result object that contains the embedding, the value, and additional information.
+ */
+declare function embed<VALUE>({ model, value, maxRetries, abortSignal, }: {
+    /**
+  The embedding model to use.
+       */
+    model: EmbeddingModel<VALUE>;
+    /**
+  The value that should be embedded.
+     */
+    value: VALUE;
+    /**
+  Maximum number of retries per embedding model call. Set to 0 to disable retries.
+  
+  @default 2
+     */
+    maxRetries?: number;
+    /**
+  Abort signal.
+   */
+    abortSignal?: AbortSignal;
+}): Promise<EmbedResult<VALUE>>;
+/**
+The result of a `embed` call.
+It contains the embedding, the value, and additional information.
+ */
+declare class EmbedResult<VALUE> {
+    /**
+  The value that was embedded.
+     */
+    readonly value: VALUE;
+    /**
+  The embedding of the value.
+    */
+    readonly embedding: Embedding;
+    /**
+  Optional raw response data.
+     */
+    readonly rawResponse?: {
+        /**
+    Response headers.
+         */
+        headers?: Record<string, string>;
+    };
+    constructor(options: {
+        value: VALUE;
+        embedding: Embedding;
+        rawResponse?: {
+            headers?: Record<string, string>;
+        };
+    });
+}
+
 type TokenUsage = {
     promptTokens: number;
     completionTokens: number;
@@ -242,32 +339,6 @@ type Prompt = {
     messages?: Array<CoreMessage>;
 };
 
-/**
-Language model that is used by the AI SDK Core functions.
-*/
-type LanguageModel = LanguageModelV1;
-/**
-Reason why a language model finished generating a response.
-
-Can be one of the following:
-- `stop`: model generated stop sequence
-- `length`: model generated maximum number of tokens
-- `content-filter`: content filter violation stopped the model
-- `tool-calls`: model triggered tool calls
-- `error`: model stopped because of an error
-- `other`: model stopped for other reasons
-*/
-type FinishReason = LanguageModelV1FinishReason;
-/**
-Log probabilities for each token and its top log probabilities.
- */
-type LogProbs = LanguageModelV1LogProbs;
-/**
-Warning from the model provider for this call. The call will proceed, but e.g.
-some settings might not be supported, which can lead to suboptimal results.
-*/
-type CallWarning = LanguageModelV1CallWarning;
-
 /**
 Generate a structured, typed object for a given prompt and schema using a language model.
 
@@ -591,6 +662,24 @@ onlyBar('bar');
 */
 type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
 
+/**
+Typed tool call that is returned by generateText and streamText.
+It contains the tool call ID, the tool name, and the tool arguments.
+ */
+interface ToolCall$1<NAME extends string, ARGS> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that is being called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+}
 type ToToolCall<TOOLS extends Record<string, CoreTool>> = ValueOf<{
     [NAME in keyof TOOLS]: {
         type: 'tool-call';
@@ -601,6 +690,28 @@ type ToToolCall<TOOLS extends Record<string, CoreTool>> = ValueOf<{
 }>;
 type ToToolCallArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolCall<TOOLS>>;
 
+/**
+Typed tool result that is returned by generateText and streamText.
+It contains the tool call ID, the tool name, the tool arguments, and the tool result.
+ */
+interface ToolResult<NAME extends string, ARGS, RESULT> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that was called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+    /**
+  Result of the tool call. This is the result of the tool's execution.
+     */
+    result: RESULT;
+}
 type ToToolsWithExecute<TOOLS extends Record<string, CoreTool>> = {
     [K in keyof TOOLS as TOOLS[K] extends {
         execute: any;
@@ -854,7 +965,7 @@ declare class StreamTextResult<TOOLS extends Record<string, CoreTool>> {
   
   @returns an `AIStream` object.
      */
-    toAIStream(callbacks?: AIStreamCallbacksAndOptions): ReadableStream<any>;
+    toAIStream(callbacks?: AIStreamCallbacksAndOptions): ReadableStream<Uint8Array>;
     /**
   Writes stream data output to a Node.js response-like object.
   It sets a `Content-Type` header to `text/plain; charset=utf-8` and
@@ -902,6 +1013,16 @@ declare class StreamTextResult<TOOLS extends Record<string, CoreTool>> {
  */
 declare const experimental_streamText: typeof streamText;
 
+/**
+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(messages: Array<{
+    role: 'user' | 'assistant';
+    content: string;
+    toolInvocations?: Array<ToolResult<string, unknown, unknown>>;
+}>): CoreMessage[];
+
 interface FunctionCall$1 {
     /**
      * The arguments to call the function with, as generated by the model in JSON
@@ -970,6 +1091,12 @@ interface Function {
     description?: string;
 }
 type IdGenerator = () => string;
+/**
+Tool invocations are either tool calls or tool results. For each assistant tool call,
+there is one tool invocation. While the call is in progress, the invocation is a tool call.
+Once the call is complete, the invocation is a tool result.
+ */
+type ToolInvocation = ToolCall$1<string, any> | ToolResult<string, any, any>;
 /**
  * Shared types between the API and UI packages.
  */
@@ -1005,6 +1132,11 @@ interface Message$1 {
      * Additional message-specific information added on the server via StreamData
      */
     annotations?: JSONValue[] | undefined;
+    /**
+  Tool invocations (that can be tool calls or tool results, depending on whether or not the invocation has finished)
+  that the assistant made as part of this message.
+     */
+    toolInvocations?: Array<ToolInvocation>;
 }
 type CreateMessage = Omit<Message$1, 'id'> & {
     id?: Message$1['id'];
@@ -1210,18 +1342,20 @@ declare const assistantControlDataStreamPart: StreamPart<'5', 'assistant_control
     messageId: string;
 }>;
 declare const dataMessageStreamPart: StreamPart<'6', 'data_message', DataMessage>;
-declare const toolCallStreamPart: StreamPart<'7', 'tool_calls', {
+declare const toolCallsStreamPart: StreamPart<'7', 'tool_calls', {
     tool_calls: ToolCall[];
 }>;
 declare const messageAnnotationsStreamPart: StreamPart<'8', 'message_annotations', Array<JSONValue>>;
-type StreamParts = typeof textStreamPart | typeof functionCallStreamPart | typeof dataStreamPart | typeof errorStreamPart | typeof assistantMessageStreamPart | typeof assistantControlDataStreamPart | typeof dataMessageStreamPart | typeof toolCallStreamPart | typeof messageAnnotationsStreamPart;
+declare const toolCallStreamPart: StreamPart<'9', 'tool_call', ToolCall$1<string, any>>;
+declare const toolResultStreamPart: StreamPart<'a', 'tool_result', ToolResult<string, any, any>>;
+type StreamParts = typeof textStreamPart | typeof functionCallStreamPart | typeof dataStreamPart | typeof errorStreamPart | typeof assistantMessageStreamPart | typeof assistantControlDataStreamPart | typeof dataMessageStreamPart | typeof toolCallsStreamPart | typeof messageAnnotationsStreamPart | typeof toolCallStreamPart | typeof toolResultStreamPart;
 /**
  * Maps the type of a stream part to its value type.
  */
 type StreamPartValueType = {
     [P in StreamParts as P['name']]: ReturnType<P['parse']>['value'];
 };
-type StreamPartType = ReturnType<typeof textStreamPart.parse> | ReturnType<typeof functionCallStreamPart.parse> | ReturnType<typeof dataStreamPart.parse> | ReturnType<typeof errorStreamPart.parse> | ReturnType<typeof assistantMessageStreamPart.parse> | ReturnType<typeof assistantControlDataStreamPart.parse> | ReturnType<typeof dataMessageStreamPart.parse> | ReturnType<typeof toolCallStreamPart.parse> | ReturnType<typeof messageAnnotationsStreamPart.parse>;
+type StreamPartType = ReturnType<typeof textStreamPart.parse> | ReturnType<typeof functionCallStreamPart.parse> | ReturnType<typeof dataStreamPart.parse> | ReturnType<typeof errorStreamPart.parse> | ReturnType<typeof assistantMessageStreamPart.parse> | ReturnType<typeof assistantControlDataStreamPart.parse> | ReturnType<typeof dataMessageStreamPart.parse> | ReturnType<typeof toolCallsStreamPart.parse> | ReturnType<typeof messageAnnotationsStreamPart.parse> | ReturnType<typeof toolCallStreamPart.parse> | ReturnType<typeof toolResultStreamPart.parse>;
 /**
  * The map of prefixes for data in the stream
  *
@@ -1254,6 +1388,8 @@ declare const StreamStringPrefixes: {
     readonly data_message: "6";
     readonly tool_calls: "7";
     readonly message_annotations: "8";
+    readonly tool_call: "9";
+    readonly tool_result: "a";
 };
 /**
 Parses a stream part from a string.
@@ -1296,7 +1432,7 @@ declare function createChunkDecoder(complex: false): (chunk: Uint8Array | undefi
 declare function createChunkDecoder(complex: true): (chunk: Uint8Array | undefined) => StreamPartType[];
 declare function createChunkDecoder(complex?: boolean): (chunk: Uint8Array | undefined) => StreamPartType[] | string;
 
-declare const isStreamStringEqualToType: (type: keyof typeof StreamStringPrefixes, value: string) => value is `0:${string}\n` | `1:${string}\n` | `2:${string}\n` | `3:${string}\n` | `4:${string}\n` | `5:${string}\n` | `6:${string}\n` | `7:${string}\n` | `8:${string}\n`;
+declare const isStreamStringEqualToType: (type: keyof typeof StreamStringPrefixes, value: string) => value is `0:${string}\n` | `1:${string}\n` | `2:${string}\n` | `3:${string}\n` | `4:${string}\n` | `5:${string}\n` | `6:${string}\n` | `7:${string}\n` | `8:${string}\n` | `9:${string}\n` | `a:${string}\n`;
 type StreamString = `${(typeof StreamStringPrefixes)[keyof typeof StreamStringPrefixes]}:${string}\n`;
 
 declare interface AzureChatCompletions {
@@ -2048,4 +2184,4 @@ declare function streamToResponse(res: ReadableStream, response: ServerResponse,
     status?: number;
 }): void;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, Message$1 as Message, MistralStream, ObjectStreamPart, ObjectStreamPartInput, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamData, StreamObjectResult, StreamPart, StreamString, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, Tool, ToolCall, ToolCallHandler, ToolCallPart, ToolCallPayload, ToolChoice, ToolContent, ToolResultPart, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, formatStreamPart, generateId, generateObject, generateText, isStreamStringEqualToType, generateId as nanoid, parseStreamPart, readDataStream, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantMessage, AssistantResponse, CallWarning, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolMessage, CoreUserMessage, CreateMessage, DataContent, DataMessage, DeepPartial, EmbedResult, Embedding, EmbeddingModel, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, Function, FunctionCall$1 as FunctionCall, FunctionCallHandler, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, Message$1 as Message, MistralStream, ObjectStreamPart, ObjectStreamPartInput, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamData, StreamObjectResult, StreamPart, StreamString, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, Tool, ToolCall, ToolCallHandler, ToolCallPart, ToolCallPayload, ToolChoice, ToolContent, ToolInvocation, ToolResultPart, UseChatOptions, UseCompletionOptions, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, convertToCoreMessages, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, embed, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, formatStreamPart, generateId, generateObject, generateText, isStreamStringEqualToType, generateId as nanoid, parseStreamPart, readDataStream, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };