ai 3.1.16 → 3.1.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "3.1.16",
+  "version": "3.1.18",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -80,7 +80,7 @@
     "@mistralai/mistralai": "0.1.3",
     "@solidjs/testing-library": "0.8.4",
     "@testing-library/jest-dom": "^6.4.5",
-    "@testing-library/react": "^14.0.0",
+    "@testing-library/react": "^15.0.7",
     "@testing-library/user-event": "^14.5.1",
     "@testing-library/vue": "^8.0.1",
     "@types/json-schema": "7.0.15",

package/prompts/dist/index.d.mts

@@ -40,6 +40,9 @@ interface ToolResult<NAME extends string, ARGS, RESULT> {
     result: RESULT;
 }
 
+/**
+ * @deprecated use AI SDK 3.1 CoreTool / ToolResult instead
+ */
 interface FunctionCall {
     /**
      * The arguments to call the function with, as generated by the model in JSON
@@ -54,6 +57,8 @@ interface FunctionCall {
     name?: string;
 }
 /**
+ * @deprecated use AI SDK 3.1 CoreTool / ToolResult instead
+ *
  * The tool calls generated by the model, such as function calls.
  */
 interface ToolCall {
@@ -71,17 +76,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 {
     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';
     /**
      *
@@ -90,6 +98,8 @@ interface Message {
      */
     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.)
@@ -97,6 +107,8 @@ interface Message {
     function_call?: string | FunctionCall;
     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.
      */

package/prompts/dist/index.d.ts

@@ -40,6 +40,9 @@ interface ToolResult<NAME extends string, ARGS, RESULT> {
     result: RESULT;
 }
 
+/**
+ * @deprecated use AI SDK 3.1 CoreTool / ToolResult instead
+ */
 interface FunctionCall {
     /**
      * The arguments to call the function with, as generated by the model in JSON
@@ -54,6 +57,8 @@ interface FunctionCall {
     name?: string;
 }
 /**
+ * @deprecated use AI SDK 3.1 CoreTool / ToolResult instead
+ *
  * The tool calls generated by the model, such as function calls.
  */
 interface ToolCall {
@@ -71,17 +76,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 {
     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';
     /**
      *
@@ -90,6 +98,8 @@ interface Message {
      */
     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.)
@@ -97,6 +107,8 @@ interface Message {
     function_call?: string | FunctionCall;
     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.
      */

package/react/dist/index.d.mts

@@ -72,6 +72,9 @@ type UseAssistantOptions = {
     onError?: (error: Error) => void;
 };
 
+/**
+ * @deprecated use AI SDK 3.1 CoreTool / ToolResult instead
+ */
 interface FunctionCall {
     /**
      * The arguments to call the function with, as generated by the model in JSON
@@ -86,6 +89,8 @@ interface FunctionCall {
     name?: string;
 }
 /**
+ * @deprecated use AI SDK 3.1 CoreTool / ToolResult instead
+ *
  * The tool calls generated by the model, such as function calls.
  */
 interface ToolCall {
@@ -97,6 +102,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.
@@ -110,6 +117,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.
  */
@@ -117,6 +126,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
@@ -147,17 +159,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 {
     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';
     /**
      *
@@ -166,6 +181,8 @@ interface Message {
      */
     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.)
@@ -173,6 +190,8 @@ interface Message {
     function_call?: string | FunctionCall;
     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.
      */
@@ -199,7 +218,13 @@ type ChatRequest = {
     tools?: Array<Tool>;
     tool_choice?: ToolChoice;
 };
+/**
+ * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
+ */
 type FunctionCallHandler = (chatMessages: Message[], functionCall: FunctionCall) => Promise<ChatRequest | void>;
+/**
+ * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
+ */
 type ToolCallHandler = (chatMessages: Message[], toolCalls: ToolCall[]) => Promise<ChatRequest | void>;
 type RequestOptions = {
     headers?: Record<string, string> | Headers;
@@ -234,18 +259,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>;
@@ -447,7 +486,7 @@ type StreamingReactResponseAction = (payload: {
     messages: Message[];
     data?: Record<string, string>;
 }) => Promise<experimental_StreamingReactResponse>;
-declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, experimental_onToolCall, experimental_maxAutomaticRoundtrips, streamMode, onResponse, onFinish, onError, credentials, headers, body, generateId, }?: Omit<UseChatOptions, 'api'> & {
+declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, experimental_onToolCall, onToolCall, experimental_maxAutomaticRoundtrips, streamMode, onResponse, onFinish, onError, credentials, headers, body, generateId, }?: Omit<UseChatOptions, 'api'> & {
     api?: string | StreamingReactResponseAction;
     key?: string;
     /**

package/react/dist/index.d.ts

@@ -72,6 +72,9 @@ type UseAssistantOptions = {
     onError?: (error: Error) => void;
 };
 
+/**
+ * @deprecated use AI SDK 3.1 CoreTool / ToolResult instead
+ */
 interface FunctionCall {
     /**
      * The arguments to call the function with, as generated by the model in JSON
@@ -86,6 +89,8 @@ interface FunctionCall {
     name?: string;
 }
 /**
+ * @deprecated use AI SDK 3.1 CoreTool / ToolResult instead
+ *
  * The tool calls generated by the model, such as function calls.
  */
 interface ToolCall {
@@ -97,6 +102,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.
@@ -110,6 +117,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.
  */
@@ -117,6 +126,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
@@ -147,17 +159,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 {
     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';
     /**
      *
@@ -166,6 +181,8 @@ interface Message {
      */
     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.)
@@ -173,6 +190,8 @@ interface Message {
     function_call?: string | FunctionCall;
     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.
      */
@@ -199,7 +218,13 @@ type ChatRequest = {
     tools?: Array<Tool>;
     tool_choice?: ToolChoice;
 };
+/**
+ * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
+ */
 type FunctionCallHandler = (chatMessages: Message[], functionCall: FunctionCall) => Promise<ChatRequest | void>;
+/**
+ * @deprecated Use AI SDK 3.1 `streamText` and `onToolCall` instead.
+ */
 type ToolCallHandler = (chatMessages: Message[], toolCalls: ToolCall[]) => Promise<ChatRequest | void>;
 type RequestOptions = {
     headers?: Record<string, string> | Headers;
@@ -234,18 +259,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>;
@@ -447,7 +486,7 @@ type StreamingReactResponseAction = (payload: {
     messages: Message[];
     data?: Record<string, string>;
 }) => Promise<experimental_StreamingReactResponse>;
-declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, experimental_onToolCall, experimental_maxAutomaticRoundtrips, streamMode, onResponse, onFinish, onError, credentials, headers, body, generateId, }?: Omit<UseChatOptions, 'api'> & {
+declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, experimental_onToolCall, onToolCall, experimental_maxAutomaticRoundtrips, streamMode, onResponse, onFinish, onError, credentials, headers, body, generateId, }?: Omit<UseChatOptions, 'api'> & {
     api?: string | StreamingReactResponseAction;
     key?: string;
     /**

package/react/dist/index.js

@@ -310,6 +310,7 @@ async function parseComplexResponse({
   reader,
   abortControllerRef,
   update,
+  onToolCall,
   onFinish,
   generateId: generateId2 = generateId,
   getCurrentDate = () => /* @__PURE__ */ new Date()
@@ -350,6 +351,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 = {
@@ -474,6 +483,7 @@ async function callChatApi({
   onResponse,
   onUpdate,
   onFinish,
+  onToolCall,
   generateId: generateId2
 }) {
   var _a;
@@ -543,6 +553,7 @@ async function callChatApi({
         reader,
         abortControllerRef: abortController != null ? { current: abortController() } : void 0,
         update: onUpdate,
+        onToolCall,
         onFinish(prefixMap) {
           if (onFinish && prefixMap.text != null) {
             onFinish(prefixMap.text);
@@ -675,7 +686,7 @@ async function processChatStream({
 }
 
 // react/use-chat.ts
-var getStreamedResponse = async (api, chatRequest, mutate, mutateStreamData, existingData, extraMetadataRef, messagesRef, abortControllerRef, generateId2, streamMode, onFinish, onResponse, sendExtraMessageFields) => {
+var getStreamedResponse = async (api, chatRequest, mutate, mutateStreamData, existingData, extraMetadataRef, messagesRef, abortControllerRef, generateId2, streamMode, onFinish, onResponse, onToolCall, sendExtraMessageFields) => {
   var _a, _b;
   const previousMessages = messagesRef.current;
   mutate(chatRequest.messages, false);
@@ -767,6 +778,7 @@ var getStreamedResponse = async (api, chatRequest, mutate, mutateStreamData, exi
       mutate([...chatRequest.messages, ...merged], false);
       mutateStreamData([...existingData || [], ...data || []], false);
     },
+    onToolCall,
     onFinish,
     generateId: generateId2
   });
@@ -779,6 +791,7 @@ function useChat({
   sendExtraMessageFields,
   experimental_onFunctionCall,
   experimental_onToolCall,
+  onToolCall,
   experimental_maxAutomaticRoundtrips = 0,
   streamMode,
   onResponse,
@@ -842,6 +855,7 @@ function useChat({
             streamMode,
             onFinish,
             onResponse,
+            onToolCall,
             sendExtraMessageFields
           ),
           experimental_onFunctionCall,
@@ -891,6 +905,7 @@ function useChat({
       sendExtraMessageFields,
       experimental_onFunctionCall,
       experimental_onToolCall,
+      onToolCall,
       experimental_maxAutomaticRoundtrips,
       messagesRef,
       abortControllerRef,