ai 3.1.21 → 3.1.23

package/dist/index.d.mts

@@ -841,12 +841,12 @@ If set and supported by the model, calls will generate deterministic results.
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
 
-@param maxAutomaticRoundtrips - Maximal number of automatic roundtrips for tool calls.
+@param maxToolRoundtrips - Maximal number of automatic roundtrips for tool calls.
 
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, maxAutomaticRoundtrips, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, maxAutomaticRoundtrips, maxToolRoundtrips, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -860,6 +860,10 @@ The tool choice strategy. Default: 'auto'.
      */
     toolChoice?: CoreToolChoice<TOOLS>;
     /**
+@deprecated Use `maxToolRoundtrips` instead.
+     */
+    maxAutomaticRoundtrips?: number;
+    /**
 Maximal number of automatic roundtrips for tool calls.
 
 An automatic tool call roundtrip is another LLM call with the
@@ -871,7 +875,7 @@ case of misconfigured tools.
 
 By default, it's set to 0, which will disable the feature.
      */
-    maxAutomaticRoundtrips?: number;
+    maxToolRoundtrips?: number;
 }): Promise<GenerateTextResult<TOOLS>>;
 /**
 The result of a `generateText` call.

package/dist/index.d.ts

@@ -841,12 +841,12 @@ If set and supported by the model, calls will generate deterministic results.
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
 
-@param maxAutomaticRoundtrips - Maximal number of automatic roundtrips for tool calls.
+@param maxToolRoundtrips - Maximal number of automatic roundtrips for tool calls.
 
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, maxAutomaticRoundtrips, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, maxAutomaticRoundtrips, maxToolRoundtrips, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -860,6 +860,10 @@ The tool choice strategy. Default: 'auto'.
      */
     toolChoice?: CoreToolChoice<TOOLS>;
     /**
+@deprecated Use `maxToolRoundtrips` instead.
+     */
+    maxAutomaticRoundtrips?: number;
+    /**
 Maximal number of automatic roundtrips for tool calls.
 
 An automatic tool call roundtrip is another LLM call with the
@@ -871,7 +875,7 @@ case of misconfigured tools.
 
 By default, it's set to 0, which will disable the feature.
      */
-    maxAutomaticRoundtrips?: number;
+    maxToolRoundtrips?: number;
 }): Promise<GenerateTextResult<TOOLS>>;
 /**
 The result of a `generateText` call.

package/dist/index.js

@@ -1344,6 +1344,7 @@ async function generateText({
   maxRetries,
   abortSignal,
   maxAutomaticRoundtrips = 0,
+  maxToolRoundtrips = maxAutomaticRoundtrips,
   ...settings
 }) {
   var _a, _b, _c;
@@ -1388,7 +1389,7 @@ async function generateText({
     // there are tool calls:
     currentToolCalls.length > 0 && // all current tool calls have results:
     currentToolResults.length === currentToolCalls.length && // the number of roundtrips is less than the maximum:
-    roundtrips++ < maxAutomaticRoundtrips
+    roundtrips++ < maxToolRoundtrips
   );
   return new GenerateTextResult({
     // Always return a string so that the caller doesn't have to check for undefined.