ai 3.1.16 → 3.1.18

package/dist/index.d.mts

@@ -728,34 +728,6 @@ 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';
-        toolCallId: string;
-        toolName: NAME & string;
-        args: z.infer<TOOLS[NAME]['parameters']>;
-    };
-}>;
-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.
@@ -798,6 +770,44 @@ type ToToolResultObject<TOOLS extends Record<string, CoreTool>> = ValueOf<{
 type ToToolResult<TOOLS extends Record<string, CoreTool>> = ToToolResultObject<ToToolsWithDefinedExecute<ToToolsWithExecute<TOOLS>>>;
 type ToToolResultArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolResult<TOOLS>>;
 
+/**
+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[];
+
+/**
+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';
+        toolCallId: string;
+        toolName: NAME & string;
+        args: z.infer<TOOLS[NAME]['parameters']>;
+    };
+}>;
+type ToToolCallArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolCall<TOOLS>>;
+
 /**
 Generate a text and call tools for a given prompt using a language model.
 
@@ -876,6 +886,14 @@ declare class GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
      */
     readonly warnings: CallWarning[] | undefined;
     /**
+  The response messages that were generated during the call. It consists of an assistant message,
+  potentially containing tool calls.
+  When there are tool results, there is an additional tool message with the tool results that are available.
+  If there are tools that do not have execute functions, they are not included in the tool results and
+  need to be added separately.
+     */
+    readonly responseMessages: Array<CoreAssistantMessage | CoreToolMessage>;
+    /**
   Optional raw response data.
      */
     rawResponse?: {
@@ -1143,16 +1161,6 @@ 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[];
-
 type AssistantStatus = 'in_progress' | 'awaiting_message';
 type UseAssistantOptions = {
     /**
@@ -1185,6 +1193,9 @@ type UseAssistantOptions = {
     onError?: (error: Error) => void;
 };
 
+/**
+ * @deprecated use AI SDK 3.1 CoreTool / ToolResult instead
+ */
 interface FunctionCall$1 {
     /**
      * The arguments to call the function with, as generated by the model in JSON
@@ -1199,6 +1210,8 @@ interface FunctionCall$1 {
     name?: string;
 }
 /**
+ * @deprecated use AI SDK 3.1 CoreTool / ToolResult instead
+ *
  * The tool calls generated by the model, such as function calls.
  */
 interface ToolCall {
@@ -1210,6 +1223,8 @@ interface ToolCall {
     };
 }
 /**
+ * @deprecated use AI SDK 3.1 CoreTool / ToolChoice instead
+ *
  * Controls which (if any) function is called by the model.
  * - none means the model will not call a function and instead generates a message.
  * - auto means the model can pick between generating a message or calling a function.
@@ -1223,6 +1238,8 @@ type ToolChoice = 'none' | 'auto' | {
     };
 };
 /**
+ * @deprecated use AI SDK 3.1 CoreTool instead
+ *
  * A list of tools the model may call. Currently, only functions are supported as a tool.
  * Use this to provide a list of functions the model may generate JSON inputs for.
  */
@@ -1230,6 +1247,9 @@ interface Tool {
     type: 'function';
     function: Function;
 }
+/**
+ * @deprecated use AI SDK 3.1 CoreTool instead
+ */
 interface Function {
     /**
      * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
@@ -1260,17 +1280,20 @@ 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.
+ * AI SDK UI Messages. They are used in the client and to communicate between the frontend and the API routes.
  */
 interface Message$1 {
     id: string;
-    tool_call_id?: string;
     createdAt?: Date;
     content: string;
+    tool_call_id?: string;
     /**
   @deprecated Use AI SDK RSC instead: https://sdk.vercel.ai/docs/ai-sdk-rsc
    */
     ui?: string | JSX.Element | JSX.Element[] | null | undefined;
+    /**
+     * `function` and `tool` roles are deprecated.
+     */
     role: 'system' | 'user' | 'assistant' | 'function' | 'data' | 'tool';
     /**
      *
@@ -1279,6 +1302,8 @@ interface Message$1 {
      */
     name?: string;
     /**
+     * @deprecated Use AI SDK 3.1 `toolInvocations` instead.
+     *
      * If the assistant role makes a function call, the `function_call` field
      * contains the function call name and arguments. Otherwise, the field should
      * not be set. (Deprecated and replaced by tool_calls.)
@@ -1286,6 +1311,8 @@ interface Message$1 {
     function_call?: string | FunctionCall$1;
     data?: JSONValue;
     /**
+     * @deprecated Use AI SDK 3.1 `toolInvocations` instead.
+     *
      * If the assistant role makes a tool call, the `tool_calls` field contains
      * the tool call name and arguments. Otherwise, the field should not be set.
      */
@@ -1312,7 +1339,13 @@ type ChatRequest = {
     tools?: Array<Tool>;
     tool_choice?: ToolChoice;
 };
+/**
+ * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
+ */
 type FunctionCallHandler = (chatMessages: Message$1[], functionCall: FunctionCall$1) => Promise<ChatRequest | void>;
+/**
+ * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
+ */
 type ToolCallHandler = (chatMessages: Message$1[], toolCalls: ToolCall[]) => Promise<ChatRequest | void>;
 type RequestOptions = {
     headers?: Record<string, string> | Headers;
@@ -1347,18 +1380,32 @@ type UseChatOptions = {
      */
     initialInput?: string;
     /**
+     * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
+     *
      * Callback function to be called when a function call is received.
      * If the function returns a `ChatRequest` object, the request will be sent
      * automatically to the API and will be used to update the chat.
      */
     experimental_onFunctionCall?: FunctionCallHandler;
     /**
+     * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
+     *
      * Callback function to be called when a tool call is received.
      * If the function returns a `ChatRequest` object, the request will be sent
      * automatically to the API and will be used to update the chat.
      */
     experimental_onToolCall?: ToolCallHandler;
     /**
+  Optional callback function that is invoked when a tool call is received.
+  Intended for automatic client-side tool execution.
+  
+  You can optionally return a result for the tool call,
+  either synchronously or asynchronously.
+     */
+    onToolCall?: ({ toolCall, }: {
+        toolCall: ToolCall$1<string, unknown>;
+    }) => void | Promise<unknown> | unknown;
+    /**
      * Callback function to be called when the API response is received.
      */
     onResponse?: (response: Response) => void | Promise<void>;

package/dist/index.d.ts

@@ -728,34 +728,6 @@ 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';
-        toolCallId: string;
-        toolName: NAME & string;
-        args: z.infer<TOOLS[NAME]['parameters']>;
-    };
-}>;
-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.
@@ -798,6 +770,44 @@ type ToToolResultObject<TOOLS extends Record<string, CoreTool>> = ValueOf<{
 type ToToolResult<TOOLS extends Record<string, CoreTool>> = ToToolResultObject<ToToolsWithDefinedExecute<ToToolsWithExecute<TOOLS>>>;
 type ToToolResultArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolResult<TOOLS>>;
 
+/**
+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[];
+
+/**
+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';
+        toolCallId: string;
+        toolName: NAME & string;
+        args: z.infer<TOOLS[NAME]['parameters']>;
+    };
+}>;
+type ToToolCallArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolCall<TOOLS>>;
+
 /**
 Generate a text and call tools for a given prompt using a language model.
 
@@ -876,6 +886,14 @@ declare class GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
      */
     readonly warnings: CallWarning[] | undefined;
     /**
+  The response messages that were generated during the call. It consists of an assistant message,
+  potentially containing tool calls.
+  When there are tool results, there is an additional tool message with the tool results that are available.
+  If there are tools that do not have execute functions, they are not included in the tool results and
+  need to be added separately.
+     */
+    readonly responseMessages: Array<CoreAssistantMessage | CoreToolMessage>;
+    /**
   Optional raw response data.
      */
     rawResponse?: {
@@ -1143,16 +1161,6 @@ 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[];
-
 type AssistantStatus = 'in_progress' | 'awaiting_message';
 type UseAssistantOptions = {
     /**
@@ -1185,6 +1193,9 @@ type UseAssistantOptions = {
     onError?: (error: Error) => void;
 };
 
+/**
+ * @deprecated use AI SDK 3.1 CoreTool / ToolResult instead
+ */
 interface FunctionCall$1 {
     /**
      * The arguments to call the function with, as generated by the model in JSON
@@ -1199,6 +1210,8 @@ interface FunctionCall$1 {
     name?: string;
 }
 /**
+ * @deprecated use AI SDK 3.1 CoreTool / ToolResult instead
+ *
  * The tool calls generated by the model, such as function calls.
  */
 interface ToolCall {
@@ -1210,6 +1223,8 @@ interface ToolCall {
     };
 }
 /**
+ * @deprecated use AI SDK 3.1 CoreTool / ToolChoice instead
+ *
  * Controls which (if any) function is called by the model.
  * - none means the model will not call a function and instead generates a message.
  * - auto means the model can pick between generating a message or calling a function.
@@ -1223,6 +1238,8 @@ type ToolChoice = 'none' | 'auto' | {
     };
 };
 /**
+ * @deprecated use AI SDK 3.1 CoreTool instead
+ *
  * A list of tools the model may call. Currently, only functions are supported as a tool.
  * Use this to provide a list of functions the model may generate JSON inputs for.
  */
@@ -1230,6 +1247,9 @@ interface Tool {
     type: 'function';
     function: Function;
 }
+/**
+ * @deprecated use AI SDK 3.1 CoreTool instead
+ */
 interface Function {
     /**
      * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
@@ -1260,17 +1280,20 @@ 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.
+ * AI SDK UI Messages. They are used in the client and to communicate between the frontend and the API routes.
  */
 interface Message$1 {
     id: string;
-    tool_call_id?: string;
     createdAt?: Date;
     content: string;
+    tool_call_id?: string;
     /**
   @deprecated Use AI SDK RSC instead: https://sdk.vercel.ai/docs/ai-sdk-rsc
    */
     ui?: string | JSX.Element | JSX.Element[] | null | undefined;
+    /**
+     * `function` and `tool` roles are deprecated.
+     */
     role: 'system' | 'user' | 'assistant' | 'function' | 'data' | 'tool';
     /**
      *
@@ -1279,6 +1302,8 @@ interface Message$1 {
      */
     name?: string;
     /**
+     * @deprecated Use AI SDK 3.1 `toolInvocations` instead.
+     *
      * If the assistant role makes a function call, the `function_call` field
      * contains the function call name and arguments. Otherwise, the field should
      * not be set. (Deprecated and replaced by tool_calls.)
@@ -1286,6 +1311,8 @@ interface Message$1 {
     function_call?: string | FunctionCall$1;
     data?: JSONValue;
     /**
+     * @deprecated Use AI SDK 3.1 `toolInvocations` instead.
+     *
      * If the assistant role makes a tool call, the `tool_calls` field contains
      * the tool call name and arguments. Otherwise, the field should not be set.
      */
@@ -1312,7 +1339,13 @@ type ChatRequest = {
     tools?: Array<Tool>;
     tool_choice?: ToolChoice;
 };
+/**
+ * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
+ */
 type FunctionCallHandler = (chatMessages: Message$1[], functionCall: FunctionCall$1) => Promise<ChatRequest | void>;
+/**
+ * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
+ */
 type ToolCallHandler = (chatMessages: Message$1[], toolCalls: ToolCall[]) => Promise<ChatRequest | void>;
 type RequestOptions = {
     headers?: Record<string, string> | Headers;
@@ -1347,18 +1380,32 @@ type UseChatOptions = {
      */
     initialInput?: string;
     /**
+     * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
+     *
      * Callback function to be called when a function call is received.
      * If the function returns a `ChatRequest` object, the request will be sent
      * automatically to the API and will be used to update the chat.
      */
     experimental_onFunctionCall?: FunctionCallHandler;
     /**
+     * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
+     *
      * Callback function to be called when a tool call is received.
      * If the function returns a `ChatRequest` object, the request will be sent
      * automatically to the API and will be used to update the chat.
      */
     experimental_onToolCall?: ToolCallHandler;
     /**
+  Optional callback function that is invoked when a tool call is received.
+  Intended for automatic client-side tool execution.
+  
+  You can optionally return a result for the tool call,
+  either synchronously or asynchronously.
+     */
+    onToolCall?: ({ toolCall, }: {
+        toolCall: ToolCall$1<string, unknown>;
+    }) => void | Promise<unknown> | unknown;
+    /**
      * Callback function to be called when the API response is received.
      */
     onResponse?: (response: Response) => void | Promise<void>;

package/dist/index.js

@@ -1408,8 +1408,32 @@ var GenerateTextResult = class {
     this.warnings = options.warnings;
     this.rawResponse = options.rawResponse;
     this.logprobs = options.logprobs;
+    this.responseMessages = toResponseMessages(options);
   }
 };
+function toResponseMessages({
+  text,
+  toolCalls,
+  toolResults
+}) {
+  const responseMessages = [];
+  responseMessages.push({
+    role: "assistant",
+    content: [{ type: "text", text }, ...toolCalls]
+  });
+  if (toolResults.length > 0) {
+    responseMessages.push({
+      role: "tool",
+      content: toolResults.map((result) => ({
+        type: "tool-result",
+        toolCallId: result.toolCallId,
+        toolName: result.toolName,
+        result: result.result
+      }))
+    });
+  }
+  return responseMessages;
+}
 var experimental_generateText = generateText;
 
 // core/generate-text/run-tools-transformation.ts
@@ -3304,6 +3328,7 @@ async function parseComplexResponse({
   reader,
   abortControllerRef,
   update,
+  onToolCall,
   onFinish,
   generateId: generateId2 = generateId,
   getCurrentDate = () => /* @__PURE__ */ new Date()
@@ -3344,6 +3369,14 @@ async function parseComplexResponse({
         prefixMap.text.toolInvocations = [];
       }
       prefixMap.text.toolInvocations.push(value);
+      if (onToolCall) {
+        console.log("onToolCall", value);
+        const result = await onToolCall({ toolCall: value });
+        console.log("onToolCall result", result);
+        if (result != null) {
+          prefixMap.text.toolInvocations[prefixMap.text.toolInvocations.length - 1] = { ...value, result };
+        }
+      }
     } else if (type === "tool_result") {
       if (prefixMap.text == null) {
         prefixMap.text = {