ai 3.1.21 → 3.1.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "3.1.21",
+  "version": "3.1.23",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",

package/react/dist/index.d.mts

@@ -486,10 +486,18 @@ type StreamingReactResponseAction = (payload: {
     messages: Message[];
     data?: Record<string, string>;
 }) => Promise<experimental_StreamingReactResponse>;
-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'> & {
+declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, experimental_onToolCall, onToolCall, experimental_maxAutomaticRoundtrips, maxAutomaticRoundtrips, maxToolRoundtrips, streamMode, onResponse, onFinish, onError, credentials, headers, body, generateId, }?: Omit<UseChatOptions, 'api'> & {
     api?: string | StreamingReactResponseAction;
     key?: string;
     /**
+  @deprecated Use `maxToolRoundtrips` instead.
+     */
+    experimental_maxAutomaticRoundtrips?: number;
+    /**
+  @deprecated Use `maxToolRoundtrips` instead.
+     */
+    maxAutomaticRoundtrips?: number;
+    /**
   Maximal number of automatic roundtrips for tool calls.
   
   An automatic tool call roundtrip is a call to the server with the
@@ -501,12 +509,19 @@ declare function useChat({ api, id, initialMessages, initialInput, sendExtraMess
   
   By default, it's set to 0, which will disable the feature.
      */
-    experimental_maxAutomaticRoundtrips?: number;
+    maxToolRoundtrips?: number;
 }): UseChatHelpers & {
+    /**
+     * @deprecated Use `addToolResult` instead.
+     */
     experimental_addToolResult: ({ toolCallId, result, }: {
         toolCallId: string;
         result: any;
     }) => void;
+    addToolResult: ({ toolCallId, result, }: {
+        toolCallId: string;
+        result: any;
+    }) => void;
 };
 
 type UseCompletionHelpers = {

package/react/dist/index.d.ts

@@ -486,10 +486,18 @@ type StreamingReactResponseAction = (payload: {
     messages: Message[];
     data?: Record<string, string>;
 }) => Promise<experimental_StreamingReactResponse>;
-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'> & {
+declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, experimental_onToolCall, onToolCall, experimental_maxAutomaticRoundtrips, maxAutomaticRoundtrips, maxToolRoundtrips, streamMode, onResponse, onFinish, onError, credentials, headers, body, generateId, }?: Omit<UseChatOptions, 'api'> & {
     api?: string | StreamingReactResponseAction;
     key?: string;
     /**
+  @deprecated Use `maxToolRoundtrips` instead.
+     */
+    experimental_maxAutomaticRoundtrips?: number;
+    /**
+  @deprecated Use `maxToolRoundtrips` instead.
+     */
+    maxAutomaticRoundtrips?: number;
+    /**
   Maximal number of automatic roundtrips for tool calls.
   
   An automatic tool call roundtrip is a call to the server with the
@@ -501,12 +509,19 @@ declare function useChat({ api, id, initialMessages, initialInput, sendExtraMess
   
   By default, it's set to 0, which will disable the feature.
      */
-    experimental_maxAutomaticRoundtrips?: number;
+    maxToolRoundtrips?: number;
 }): UseChatHelpers & {
+    /**
+     * @deprecated Use `addToolResult` instead.
+     */
     experimental_addToolResult: ({ toolCallId, result, }: {
         toolCallId: string;
         result: any;
     }) => void;
+    addToolResult: ({ toolCallId, result, }: {
+        toolCallId: string;
+        result: any;
+    }) => void;
 };
 
 type UseCompletionHelpers = {

package/react/dist/index.js

@@ -791,6 +791,8 @@ function useChat({
   experimental_onToolCall,
   onToolCall,
   experimental_maxAutomaticRoundtrips = 0,
+  maxAutomaticRoundtrips = experimental_maxAutomaticRoundtrips,
+  maxToolRoundtrips = maxAutomaticRoundtrips,
   streamMode,
   onResponse,
   onFinish,
@@ -881,9 +883,9 @@ function useChat({
       if (
         // ensure there is a last message:
         lastMessage != null && // check if the feature is enabled:
-        experimental_maxAutomaticRoundtrips > 0 && // check that roundtrip is possible:
+        maxToolRoundtrips > 0 && // check that roundtrip is possible:
         isAssistantMessageWithCompletedToolCalls(lastMessage) && // limit the number of automatic roundtrips:
-        countTrailingAssistantMessages(messages2) <= experimental_maxAutomaticRoundtrips
+        countTrailingAssistantMessages(messages2) <= maxToolRoundtrips
       ) {
         await triggerRequest({ messages: messages2 });
       }
@@ -904,7 +906,7 @@ function useChat({
       experimental_onFunctionCall,
       experimental_onToolCall,
       onToolCall,
-      experimental_maxAutomaticRoundtrips,
+      maxToolRoundtrips,
       messagesRef,
       abortControllerRef,
       generateId2
@@ -1009,6 +1011,27 @@ function useChat({
   const handleInputChange = (e) => {
     setInput(e.target.value);
   };
+  const addToolResult = ({
+    toolCallId,
+    result
+  }) => {
+    const updatedMessages = messagesRef.current.map(
+      (message, index, arr) => (
+        // update the tool calls in the last assistant message:
+        index === arr.length - 1 && message.role === "assistant" && message.toolInvocations ? {
+          ...message,
+          toolInvocations: message.toolInvocations.map(
+            (toolInvocation) => toolInvocation.toolCallId === toolCallId ? { ...toolInvocation, result } : toolInvocation
+          )
+        } : message
+      )
+    );
+    mutate(updatedMessages, false);
+    const lastMessage = updatedMessages[updatedMessages.length - 1];
+    if (isAssistantMessageWithCompletedToolCalls(lastMessage)) {
+      triggerRequest({ messages: updatedMessages });
+    }
+  };
   return {
     messages: messages || [],
     error,
@@ -1022,27 +1045,8 @@ function useChat({
     handleSubmit,
     isLoading,
     data: streamData,
-    experimental_addToolResult: ({
-      toolCallId,
-      result
-    }) => {
-      const updatedMessages = messagesRef.current.map(
-        (message, index, arr) => (
-          // update the tool calls in the last assistant message:
-          index === arr.length - 1 && message.role === "assistant" && message.toolInvocations ? {
-            ...message,
-            toolInvocations: message.toolInvocations.map(
-              (toolInvocation) => toolInvocation.toolCallId === toolCallId ? { ...toolInvocation, result } : toolInvocation
-            )
-          } : message
-        )
-      );
-      mutate(updatedMessages, false);
-      const lastMessage = updatedMessages[updatedMessages.length - 1];
-      if (isAssistantMessageWithCompletedToolCalls(lastMessage)) {
-        triggerRequest({ messages: updatedMessages });
-      }
-    }
+    addToolResult,
+    experimental_addToolResult: addToolResult
   };
 }
 function isAssistantMessageWithCompletedToolCalls(message) {