ai 3.1.16 → 3.1.18

package/vue/dist/index.d.mts

@@ -42,6 +42,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
@@ -56,6 +59,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 {
@@ -67,6 +72,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.
@@ -80,6 +87,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.
  */
@@ -87,6 +96,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
@@ -117,17 +129,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';
     /**
      *
@@ -136,6 +151,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.)
@@ -143,6 +160,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.
      */
@@ -169,7 +188,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;
@@ -204,18 +229,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/vue/dist/index.d.ts

@@ -42,6 +42,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
@@ -56,6 +59,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 {
@@ -67,6 +72,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.
@@ -80,6 +87,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.
  */
@@ -87,6 +96,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
@@ -117,17 +129,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';
     /**
      *
@@ -136,6 +151,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.)
@@ -143,6 +160,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.
      */
@@ -169,7 +188,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;
@@ -204,18 +229,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/vue/dist/index.js

@@ -307,6 +307,7 @@ async function parseComplexResponse({
   reader,
   abortControllerRef,
   update,
+  onToolCall,
   onFinish,
   generateId: generateId2 = generateId,
   getCurrentDate = () => /* @__PURE__ */ new Date()
@@ -347,6 +348,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 = {
@@ -471,6 +480,7 @@ async function callChatApi({
   onResponse,
   onUpdate,
   onFinish,
+  onToolCall,
   generateId: generateId2
 }) {
   var _a;
@@ -540,6 +550,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);