ai 3.1.22 → 3.1.24

package/package.json

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

package/react/dist/index.d.mts

@@ -227,15 +227,39 @@ type FunctionCallHandler = (chatMessages: Message[], functionCall: FunctionCall)
  */
 type ToolCallHandler = (chatMessages: Message[], toolCalls: ToolCall[]) => Promise<ChatRequest | void>;
 type RequestOptions = {
+    /**
+  An optional object of headers to be passed to the API endpoint.
+   */
     headers?: Record<string, string> | Headers;
+    /**
+  An optional object to be passed to the API endpoint.
+     */
     body?: object;
 };
 type ChatRequestOptions = {
+    /**
+  The options to be passed to the fetch call.
+     */
     options?: RequestOptions;
+    /**
+  @deprecated
+  */
     functions?: Array<Function>;
+    /**
+  @deprecated
+  */
     function_call?: FunctionCall;
+    /**
+  @deprecated
+  */
     tools?: Array<Tool>;
+    /**
+  @deprecated
+  */
     tool_choice?: ToolChoice;
+    /**
+  Additional data to be sent to the server.
+     */
     data?: Record<string, string>;
 };
 type UseChatOptions = {
@@ -486,14 +510,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, 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 `maxAutomaticRoundtrips` instead.
+  @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
@@ -505,7 +533,7 @@ declare function useChat({ api, id, initialMessages, initialInput, sendExtraMess
   
   By default, it's set to 0, which will disable the feature.
      */
-    maxAutomaticRoundtrips?: number;
+    maxToolRoundtrips?: number;
 }): UseChatHelpers & {
     /**
      * @deprecated Use `addToolResult` instead.

package/react/dist/index.d.ts

@@ -227,15 +227,39 @@ type FunctionCallHandler = (chatMessages: Message[], functionCall: FunctionCall)
  */
 type ToolCallHandler = (chatMessages: Message[], toolCalls: ToolCall[]) => Promise<ChatRequest | void>;
 type RequestOptions = {
+    /**
+  An optional object of headers to be passed to the API endpoint.
+   */
     headers?: Record<string, string> | Headers;
+    /**
+  An optional object to be passed to the API endpoint.
+     */
     body?: object;
 };
 type ChatRequestOptions = {
+    /**
+  The options to be passed to the fetch call.
+     */
     options?: RequestOptions;
+    /**
+  @deprecated
+  */
     functions?: Array<Function>;
+    /**
+  @deprecated
+  */
     function_call?: FunctionCall;
+    /**
+  @deprecated
+  */
     tools?: Array<Tool>;
+    /**
+  @deprecated
+  */
     tool_choice?: ToolChoice;
+    /**
+  Additional data to be sent to the server.
+     */
     data?: Record<string, string>;
 };
 type UseChatOptions = {
@@ -486,14 +510,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, 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 `maxAutomaticRoundtrips` instead.
+  @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
@@ -505,7 +533,7 @@ declare function useChat({ api, id, initialMessages, initialInput, sendExtraMess
   
   By default, it's set to 0, which will disable the feature.
      */
-    maxAutomaticRoundtrips?: number;
+    maxToolRoundtrips?: number;
 }): UseChatHelpers & {
     /**
      * @deprecated Use `addToolResult` instead.

package/react/dist/index.js

@@ -792,6 +792,7 @@ function useChat({
   onToolCall,
   experimental_maxAutomaticRoundtrips = 0,
   maxAutomaticRoundtrips = experimental_maxAutomaticRoundtrips,
+  maxToolRoundtrips = maxAutomaticRoundtrips,
   streamMode,
   onResponse,
   onFinish,
@@ -882,9 +883,9 @@ function useChat({
       if (
         // ensure there is a last message:
         lastMessage != null && // check if the feature is enabled:
-        maxAutomaticRoundtrips > 0 && // check that roundtrip is possible:
+        maxToolRoundtrips > 0 && // check that roundtrip is possible:
         isAssistantMessageWithCompletedToolCalls(lastMessage) && // limit the number of automatic roundtrips:
-        countTrailingAssistantMessages(messages2) <= maxAutomaticRoundtrips
+        countTrailingAssistantMessages(messages2) <= maxToolRoundtrips
       ) {
         await triggerRequest({ messages: messages2 });
       }
@@ -905,7 +906,7 @@ function useChat({
       experimental_onFunctionCall,
       experimental_onToolCall,
       onToolCall,
-      maxAutomaticRoundtrips,
+      maxToolRoundtrips,
       messagesRef,
       abortControllerRef,
       generateId2