ai 3.1.19 → 3.1.20

package/dist/index.d.mts

@@ -814,7 +814,9 @@ Generate a text and call tools for a given prompt using a language model.
 This function does not stream the output. If you want to stream the output, use `streamText` instead.
 
 @param model - The language model to use.
+
 @param tools - Tools that are accessible to and can be called by the model. The model needs to support calling tools.
+@param toolChoice - The tool choice strategy. Default: 'auto'.
 
 @param system - A system message that will be part of the prompt.
 @param prompt - A simple text prompt. You can either use `prompt` or `messages` but not both.
@@ -839,10 +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.
+
 @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, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, maxAutomaticRoundtrips, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -855,6 +859,19 @@ The tools that the model can call. The model needs to support calling tools.
 The tool choice strategy. Default: 'auto'.
      */
     toolChoice?: CoreToolChoice<TOOLS>;
+    /**
+Maximal number of automatic roundtrips for tool calls.
+
+An automatic tool call roundtrip is another LLM call with the
+tool call results when all tool calls of the last assistant
+message have results.
+
+A maximum number is required to prevent infinite loops in the
+case of misconfigured tools.
+
+By default, it's set to 0, which will disable the feature.
+     */
+    maxAutomaticRoundtrips?: number;
 }): Promise<GenerateTextResult<TOOLS>>;
 /**
 The result of a `generateText` call.
@@ -918,6 +935,7 @@ declare class GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
             headers?: Record<string, string>;
         };
         logprobs: LogProbs | undefined;
+        responseMessages: Array<CoreAssistantMessage | CoreToolMessage>;
     });
 }
 /**

package/dist/index.d.ts

@@ -814,7 +814,9 @@ Generate a text and call tools for a given prompt using a language model.
 This function does not stream the output. If you want to stream the output, use `streamText` instead.
 
 @param model - The language model to use.
+
 @param tools - Tools that are accessible to and can be called by the model. The model needs to support calling tools.
+@param toolChoice - The tool choice strategy. Default: 'auto'.
 
 @param system - A system message that will be part of the prompt.
 @param prompt - A simple text prompt. You can either use `prompt` or `messages` but not both.
@@ -839,10 +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.
+
 @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, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, maxAutomaticRoundtrips, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -855,6 +859,19 @@ The tools that the model can call. The model needs to support calling tools.
 The tool choice strategy. Default: 'auto'.
      */
     toolChoice?: CoreToolChoice<TOOLS>;
+    /**
+Maximal number of automatic roundtrips for tool calls.
+
+An automatic tool call roundtrip is another LLM call with the
+tool call results when all tool calls of the last assistant
+message have results.
+
+A maximum number is required to prevent infinite loops in the
+case of misconfigured tools.
+
+By default, it's set to 0, which will disable the feature.
+     */
+    maxAutomaticRoundtrips?: number;
 }): Promise<GenerateTextResult<TOOLS>>;
 /**
 The result of a `generateText` call.
@@ -918,6 +935,7 @@ declare class GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
             headers?: Record<string, string>;
         };
         logprobs: LogProbs | undefined;
+        responseMessages: Array<CoreAssistantMessage | CoreToolMessage>;
     });
 }
 /**

package/dist/index.js

@@ -309,7 +309,8 @@ function convertToLanguageModelPrompt(prompt) {
   if (prompt.system != null) {
     languageModelMessages.push({ role: "system", content: prompt.system });
   }
-  switch (prompt.type) {
+  const promptType = prompt.type;
+  switch (promptType) {
     case "prompt": {
       languageModelMessages.push({
         role: "user",
@@ -319,72 +320,75 @@ function convertToLanguageModelPrompt(prompt) {
     }
     case "messages": {
       languageModelMessages.push(
-        ...prompt.messages.map((message) => {
-          switch (message.role) {
-            case "system": {
-              return { role: "system", content: message.content };
-            }
-            case "user": {
-              if (typeof message.content === "string") {
-                return {
-                  role: "user",
-                  content: [{ type: "text", text: message.content }]
-                };
+        ...prompt.messages.map(convertToLanguageModelMessage)
+      );
+      break;
+    }
+    default: {
+      const _exhaustiveCheck = promptType;
+      throw new Error(`Unsupported prompt type: ${_exhaustiveCheck}`);
+    }
+  }
+  return languageModelMessages;
+}
+function convertToLanguageModelMessage(message) {
+  switch (message.role) {
+    case "system": {
+      return { role: "system", content: message.content };
+    }
+    case "user": {
+      if (typeof message.content === "string") {
+        return {
+          role: "user",
+          content: [{ type: "text", text: message.content }]
+        };
+      }
+      return {
+        role: "user",
+        content: message.content.map(
+          (part) => {
+            var _a;
+            switch (part.type) {
+              case "text": {
+                return part;
               }
-              return {
-                role: "user",
-                content: message.content.map(
-                  (part) => {
-                    var _a;
-                    switch (part.type) {
-                      case "text": {
-                        return part;
-                      }
-                      case "image": {
-                        if (part.image instanceof URL) {
-                          return {
-                            type: "image",
-                            image: part.image,
-                            mimeType: part.mimeType
-                          };
-                        }
-                        const imageUint8 = convertDataContentToUint8Array(
-                          part.image
-                        );
-                        return {
-                          type: "image",
-                          image: imageUint8,
-                          mimeType: (_a = part.mimeType) != null ? _a : detectImageMimeType(imageUint8)
-                        };
-                      }
-                    }
-                  }
-                )
-              };
-            }
-            case "assistant": {
-              if (typeof message.content === "string") {
+              case "image": {
+                if (part.image instanceof URL) {
+                  return {
+                    type: "image",
+                    image: part.image,
+                    mimeType: part.mimeType
+                  };
+                }
+                const imageUint8 = convertDataContentToUint8Array(part.image);
                 return {
-                  role: "assistant",
-                  content: [{ type: "text", text: message.content }]
+                  type: "image",
+                  image: imageUint8,
+                  mimeType: (_a = part.mimeType) != null ? _a : detectImageMimeType(imageUint8)
                 };
               }
-              return { role: "assistant", content: message.content };
-            }
-            case "tool": {
-              return message;
             }
           }
-        })
-      );
-      break;
+        )
+      };
+    }
+    case "assistant": {
+      if (typeof message.content === "string") {
+        return {
+          role: "assistant",
+          content: [{ type: "text", text: message.content }]
+        };
+      }
+      return { role: "assistant", content: message.content };
+    }
+    case "tool": {
+      return message;
     }
     default: {
-      const _exhaustiveCheck = prompt;
-      throw new Error(`Unsupported prompt type: ${_exhaustiveCheck}`);
+      const _exhaustiveCheck = message;
+      throw new Error(`Unsupported message role: ${_exhaustiveCheck}`);
     }
   }
-  return languageModelMessages;
 }
 
 // core/prompt/get-validated-prompt.ts
@@ -1339,40 +1343,66 @@ async function generateText({
   messages,
   maxRetries,
   abortSignal,
+  maxAutomaticRoundtrips = 0,
   ...settings
 }) {
-  var _a, _b;
+  var _a, _b, _c;
   const retry = retryWithExponentialBackoff({ maxRetries });
   const validatedPrompt = getValidatedPrompt({ system, prompt, messages });
-  const modelResponse = await retry(() => {
-    return model.doGenerate({
-      mode: {
-        type: "regular",
-        ...prepareToolsAndToolChoice({ tools, toolChoice })
-      },
-      ...prepareCallSettings(settings),
-      inputFormat: validatedPrompt.type,
-      prompt: convertToLanguageModelPrompt(validatedPrompt),
-      abortSignal
+  const mode = {
+    type: "regular",
+    ...prepareToolsAndToolChoice({ tools, toolChoice })
+  };
+  const callSettings = prepareCallSettings(settings);
+  const promptMessages = convertToLanguageModelPrompt(validatedPrompt);
+  let currentModelResponse;
+  let currentToolCalls = [];
+  let currentToolResults = [];
+  let roundtrips = 0;
+  const responseMessages = [];
+  do {
+    currentModelResponse = await retry(() => {
+      return model.doGenerate({
+        mode,
+        ...callSettings,
+        // once we have a roundtrip, we need to switch to messages format:
+        inputFormat: roundtrips === 0 ? validatedPrompt.type : "messages",
+        prompt: promptMessages,
+        abortSignal
+      });
     });
-  });
-  const toolCalls = [];
-  for (const modelToolCall of (_a = modelResponse.toolCalls) != null ? _a : []) {
-    toolCalls.push(parseToolCall({ toolCall: modelToolCall, tools }));
-  }
-  const toolResults = tools == null ? [] : await executeTools({ toolCalls, tools });
+    currentToolCalls = ((_a = currentModelResponse.toolCalls) != null ? _a : []).map(
+      (modelToolCall) => parseToolCall({ toolCall: modelToolCall, tools })
+    );
+    currentToolResults = tools == null ? [] : await executeTools({ toolCalls: currentToolCalls, tools });
+    const newResponseMessages = toResponseMessages({
+      text: (_b = currentModelResponse.text) != null ? _b : "",
+      toolCalls: currentToolCalls,
+      toolResults: currentToolResults
+    });
+    responseMessages.push(...newResponseMessages);
+    promptMessages.push(
+      ...newResponseMessages.map(convertToLanguageModelMessage)
+    );
+  } while (
+    // 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
+  );
   return new GenerateTextResult({
     // Always return a string so that the caller doesn't have to check for undefined.
     // If they need to check if the model did not return any text,
     // they can check the length of the string:
-    text: (_b = modelResponse.text) != null ? _b : "",
-    toolCalls,
-    toolResults,
-    finishReason: modelResponse.finishReason,
-    usage: calculateTokenUsage(modelResponse.usage),
-    warnings: modelResponse.warnings,
-    rawResponse: modelResponse.rawResponse,
-    logprobs: modelResponse.logprobs
+    text: (_c = currentModelResponse.text) != null ? _c : "",
+    toolCalls: currentToolCalls,
+    toolResults: currentToolResults,
+    finishReason: currentModelResponse.finishReason,
+    usage: calculateTokenUsage(currentModelResponse.usage),
+    warnings: currentModelResponse.warnings,
+    rawResponse: currentModelResponse.rawResponse,
+    logprobs: currentModelResponse.logprobs,
+    responseMessages
   });
 }
 async function executeTools({
@@ -1408,7 +1438,7 @@ var GenerateTextResult = class {
     this.warnings = options.warnings;
     this.rawResponse = options.rawResponse;
     this.logprobs = options.logprobs;
-    this.responseMessages = toResponseMessages(options);
+    this.responseMessages = options.responseMessages;
   }
 };
 function toResponseMessages({