ai 3.2.23 → 3.2.24

package/README.md

@@ -52,12 +52,13 @@ The [AI SDK UI](https://sdk.vercel.ai/docs/ai-sdk-ui/overview) module provides a
 ###### @/app/page.tsx (Next.js App Router)
 
 ```tsx
-"use client"
+'use client';
 
-import { useChat } from 'ai/react'
+import { useChat } from 'ai/react';
 
 export default function Page() {
-  const { messages, input, handleSubmit, handleInputChange, isLoading } = useChat()
+  const { messages, input, handleSubmit, handleInputChange, isLoading } =
+    useChat();
 
   return (
     <div>
@@ -66,7 +67,7 @@ export default function Page() {
           <div>{message.role}</div>
           <div>{message.content}</div>
         </div>
-      )}
+      ))}
 
       <form onSubmit={handleSubmit}>
         <input
@@ -77,7 +78,7 @@ export default function Page() {
         />
       </form>
     </div>
-  )
+  );
 }
 ```
 

package/dist/index.d.mts

@@ -1062,31 +1062,74 @@ declare class GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
      */
     readonly responseMessages: Array<CoreAssistantMessage | CoreToolMessage>;
     /**
+  Response information for every roundtrip.
+  You can use this to get information about intermediate steps, such as the tool calls or the response headers.
+     */
+    readonly roundtrips: Array<{
+        /**
+    The generated text.
+       */
+        readonly text: string;
+        /**
+    The tool calls that were made during the generation.
+     */
+        readonly toolCalls: ToToolCallArray<TOOLS>;
+        /**
+    The results of the tool calls.
+     */
+        readonly toolResults: ToToolResultArray<TOOLS>;
+        /**
+    The reason why the generation finished.
+       */
+        readonly finishReason: FinishReason;
+        /**
+    The token usage of the generated text.
+     */
+        readonly usage: CompletionTokenUsage$1;
+        /**
+    Warnings from the model provider (e.g. unsupported settings)
+       */
+        readonly warnings: CallWarning[] | undefined;
+        /**
+    Logprobs for the completion.
+    `undefined` if the mode does not support logprobs or if was not enabled.
+       */
+        readonly logprobs: LogProbs | undefined;
+        /**
+      Optional raw response data.
+         */
+        readonly rawResponse?: {
+            /**
+        Response headers.
+           */
+            readonly headers?: Record<string, string>;
+        };
+    }>;
+    /**
   Optional raw response data.
      */
-    rawResponse?: {
+    readonly rawResponse?: {
         /**
     Response headers.
        */
-        headers?: Record<string, string>;
+        readonly headers?: Record<string, string>;
     };
     /**
   Logprobs for the completion.
-  `undefined` if the mode does not support logprobs or if was not enabled
+  `undefined` if the mode does not support logprobs or if was not enabled.
      */
     readonly logprobs: LogProbs | undefined;
     constructor(options: {
-        text: string;
-        toolCalls: ToToolCallArray<TOOLS>;
-        toolResults: ToToolResultArray<TOOLS>;
-        finishReason: FinishReason;
-        usage: CompletionTokenUsage$1;
-        warnings: CallWarning[] | undefined;
-        rawResponse?: {
-            headers?: Record<string, string>;
-        };
-        logprobs: LogProbs | undefined;
-        responseMessages: Array<CoreAssistantMessage | CoreToolMessage>;
+        text: GenerateTextResult<TOOLS>['text'];
+        toolCalls: GenerateTextResult<TOOLS>['toolCalls'];
+        toolResults: GenerateTextResult<TOOLS>['toolResults'];
+        finishReason: GenerateTextResult<TOOLS>['finishReason'];
+        usage: GenerateTextResult<TOOLS>['usage'];
+        warnings: GenerateTextResult<TOOLS>['warnings'];
+        rawResponse?: GenerateTextResult<TOOLS>['rawResponse'];
+        logprobs: GenerateTextResult<TOOLS>['logprobs'];
+        responseMessages: GenerateTextResult<TOOLS>['responseMessages'];
+        roundtrips: GenerateTextResult<TOOLS>['roundtrips'];
     });
 }
 /**

package/dist/index.d.ts

@@ -1062,31 +1062,74 @@ declare class GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
      */
     readonly responseMessages: Array<CoreAssistantMessage | CoreToolMessage>;
     /**
+  Response information for every roundtrip.
+  You can use this to get information about intermediate steps, such as the tool calls or the response headers.
+     */
+    readonly roundtrips: Array<{
+        /**
+    The generated text.
+       */
+        readonly text: string;
+        /**
+    The tool calls that were made during the generation.
+     */
+        readonly toolCalls: ToToolCallArray<TOOLS>;
+        /**
+    The results of the tool calls.
+     */
+        readonly toolResults: ToToolResultArray<TOOLS>;
+        /**
+    The reason why the generation finished.
+       */
+        readonly finishReason: FinishReason;
+        /**
+    The token usage of the generated text.
+     */
+        readonly usage: CompletionTokenUsage$1;
+        /**
+    Warnings from the model provider (e.g. unsupported settings)
+       */
+        readonly warnings: CallWarning[] | undefined;
+        /**
+    Logprobs for the completion.
+    `undefined` if the mode does not support logprobs or if was not enabled.
+       */
+        readonly logprobs: LogProbs | undefined;
+        /**
+      Optional raw response data.
+         */
+        readonly rawResponse?: {
+            /**
+        Response headers.
+           */
+            readonly headers?: Record<string, string>;
+        };
+    }>;
+    /**
   Optional raw response data.
      */
-    rawResponse?: {
+    readonly rawResponse?: {
         /**
     Response headers.
        */
-        headers?: Record<string, string>;
+        readonly headers?: Record<string, string>;
     };
     /**
   Logprobs for the completion.
-  `undefined` if the mode does not support logprobs or if was not enabled
+  `undefined` if the mode does not support logprobs or if was not enabled.
      */
     readonly logprobs: LogProbs | undefined;
     constructor(options: {
-        text: string;
-        toolCalls: ToToolCallArray<TOOLS>;
-        toolResults: ToToolResultArray<TOOLS>;
-        finishReason: FinishReason;
-        usage: CompletionTokenUsage$1;
-        warnings: CallWarning[] | undefined;
-        rawResponse?: {
-            headers?: Record<string, string>;
-        };
-        logprobs: LogProbs | undefined;
-        responseMessages: Array<CoreAssistantMessage | CoreToolMessage>;
+        text: GenerateTextResult<TOOLS>['text'];
+        toolCalls: GenerateTextResult<TOOLS>['toolCalls'];
+        toolResults: GenerateTextResult<TOOLS>['toolResults'];
+        finishReason: GenerateTextResult<TOOLS>['finishReason'];
+        usage: GenerateTextResult<TOOLS>['usage'];
+        warnings: GenerateTextResult<TOOLS>['warnings'];
+        rawResponse?: GenerateTextResult<TOOLS>['rawResponse'];
+        logprobs: GenerateTextResult<TOOLS>['logprobs'];
+        responseMessages: GenerateTextResult<TOOLS>['responseMessages'];
+        roundtrips: GenerateTextResult<TOOLS>['roundtrips'];
     });
 }
 /**

package/dist/index.js

@@ -1428,7 +1428,7 @@ async function generateText({
     },
     tracer,
     fn: async (span) => {
-      var _a2, _b, _c;
+      var _a2, _b, _c, _d;
       const retry = retryWithExponentialBackoff({ maxRetries });
       const validatedPrompt = getValidatedPrompt({
         system,
@@ -1444,10 +1444,11 @@ async function generateText({
       let currentModelResponse;
       let currentToolCalls = [];
       let currentToolResults = [];
-      let roundtrips = 0;
+      let roundtripCount = 0;
       const responseMessages = [];
+      const roundtrips = [];
       do {
-        const currentInputFormat = roundtrips === 0 ? validatedPrompt.type : "messages";
+        const currentInputFormat = roundtripCount === 0 ? validatedPrompt.type : "messages";
         currentModelResponse = await retry(
           () => recordSpan({
             name: "ai.generateText.doGenerate",
@@ -1485,9 +1486,18 @@ async function generateText({
           tools,
           tracer
         });
-        const newResponseMessages = toResponseMessages({
+        roundtrips.push({
           text: (_b = currentModelResponse.text) != null ? _b : "",
           toolCalls: currentToolCalls,
+          toolResults: currentToolResults,
+          finishReason: currentModelResponse.finishReason,
+          usage: calculateCompletionTokenUsage(currentModelResponse.usage),
+          warnings: currentModelResponse.warnings,
+          logprobs: currentModelResponse.logprobs
+        });
+        const newResponseMessages = toResponseMessages({
+          text: (_c = currentModelResponse.text) != null ? _c : "",
+          toolCalls: currentToolCalls,
           toolResults: currentToolResults
         });
         responseMessages.push(...newResponseMessages);
@@ -1498,7 +1508,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++ < maxToolRoundtrips
+        roundtripCount++ < maxToolRoundtrips
       );
       span.setAttributes({
         "ai.finishReason": currentModelResponse.finishReason,
@@ -1511,7 +1521,7 @@ async function generateText({
         // 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: (_c = currentModelResponse.text) != null ? _c : "",
+        text: (_d = currentModelResponse.text) != null ? _d : "",
         toolCalls: currentToolCalls,
         toolResults: currentToolResults,
         finishReason: currentModelResponse.finishReason,
@@ -1519,7 +1529,8 @@ async function generateText({
         warnings: currentModelResponse.warnings,
         rawResponse: currentModelResponse.rawResponse,
         logprobs: currentModelResponse.logprobs,
-        responseMessages
+        responseMessages,
+        roundtrips
       });
     }
   });
@@ -1577,6 +1588,7 @@ var GenerateTextResult = class {
     this.rawResponse = options.rawResponse;
     this.logprobs = options.logprobs;
     this.responseMessages = options.responseMessages;
+    this.roundtrips = options.roundtrips;
   }
 };
 function toResponseMessages({