ai 3.3.38 → 3.3.39

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # ai
 
+## 3.3.39
+
+### Patch Changes
+
+- 33cf3e1: feat (ai/core): add providerMetadata to StepResult
+- 17ee757: feat (ai/core): add onStepFinish callback to generateText
+
 ## 3.3.38
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1356,6 +1356,12 @@ type StepResult<TOOLS extends Record<string, CoreTool>> = {
   Additional response information.
   */
     readonly response: LanguageModelResponseMetadataWithHeaders;
+    /**
+  Additional provider-specific metadata. They are passed through
+  from the provider to the AI SDK and enable provider-specific
+  results that can be fully encapsulated in the provider.
+     */
+    readonly experimental_providerMetadata: ProviderMetadata | undefined;
 };
 
 /**
@@ -1479,10 +1485,12 @@ If set and supported by the model, calls will generate deterministic results.
 
 @param maxSteps - Maximum number of sequential LLM calls (steps), e.g. when you use tool calls.
 
+@param onStepFinish - Callback that is called when each step (LLM call) is finished, including intermediate steps.
+
 @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, headers, maxAutomaticRoundtrips, maxToolRoundtrips, maxSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, _internal: { generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, maxSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1532,6 +1540,10 @@ to the provider from the AI SDK and enable provider-specific
 functionality that can be fully encapsulated in the provider.
  */
     experimental_providerMetadata?: ProviderMetadata;
+    /**
+    Callback that is called when each step (LLM call) is finished, including intermediate steps.
+    */
+    onStepFinish?: (event: StepResult<TOOLS>) => Promise<void> | void;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -1800,6 +1812,7 @@ If set and supported by the model, calls will generate deterministic results.
 @param maxSteps - Maximum number of sequential LLM calls (steps), e.g. when you use tool calls.
 
 @param onChunk - Callback that is called for each chunk of the stream. The stream processing will pause until the callback promise is resolved.
+@param onStepFinish - Callback that is called when each step (LLM call) is finished, including intermediate steps.
 @param onFinish - Callback that is called when the LLM response and all request tool executions
 (for tools that have an `execute` function) are finished.
 
@@ -1867,18 +1880,14 @@ Callback that is called for each chunk of the stream. The stream processing will
     /**
 Callback that is called when the LLM response and all request tool executions
 (for tools that have an `execute` function) are finished.
+
+The usage is the combined usage of all steps.
      */
     onFinish?: (event: StepResult<TOOLS> & {
         /**
 Details for all steps.
        */
         steps: StepResult<TOOLS>[];
-        /**
-Additional provider-specific metadata. They are passed through
-from the provider to the AI SDK and enable provider-specific
-results that can be fully encapsulated in the provider.
-   */
-        readonly experimental_providerMetadata: ProviderMetadata | undefined;
     }) => Promise<void> | void;
     /**
     Callback that is called when each step (LLM call) is finished, including intermediate steps.

package/dist/index.d.ts

@@ -1356,6 +1356,12 @@ type StepResult<TOOLS extends Record<string, CoreTool>> = {
   Additional response information.
   */
     readonly response: LanguageModelResponseMetadataWithHeaders;
+    /**
+  Additional provider-specific metadata. They are passed through
+  from the provider to the AI SDK and enable provider-specific
+  results that can be fully encapsulated in the provider.
+     */
+    readonly experimental_providerMetadata: ProviderMetadata | undefined;
 };
 
 /**
@@ -1479,10 +1485,12 @@ If set and supported by the model, calls will generate deterministic results.
 
 @param maxSteps - Maximum number of sequential LLM calls (steps), e.g. when you use tool calls.
 
+@param onStepFinish - Callback that is called when each step (LLM call) is finished, including intermediate steps.
+
 @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, headers, maxAutomaticRoundtrips, maxToolRoundtrips, maxSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, _internal: { generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, maxSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1532,6 +1540,10 @@ to the provider from the AI SDK and enable provider-specific
 functionality that can be fully encapsulated in the provider.
  */
     experimental_providerMetadata?: ProviderMetadata;
+    /**
+    Callback that is called when each step (LLM call) is finished, including intermediate steps.
+    */
+    onStepFinish?: (event: StepResult<TOOLS>) => Promise<void> | void;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -1800,6 +1812,7 @@ If set and supported by the model, calls will generate deterministic results.
 @param maxSteps - Maximum number of sequential LLM calls (steps), e.g. when you use tool calls.
 
 @param onChunk - Callback that is called for each chunk of the stream. The stream processing will pause until the callback promise is resolved.
+@param onStepFinish - Callback that is called when each step (LLM call) is finished, including intermediate steps.
 @param onFinish - Callback that is called when the LLM response and all request tool executions
 (for tools that have an `execute` function) are finished.
 
@@ -1867,18 +1880,14 @@ Callback that is called for each chunk of the stream. The stream processing will
     /**
 Callback that is called when the LLM response and all request tool executions
 (for tools that have an `execute` function) are finished.
+
+The usage is the combined usage of all steps.
      */
     onFinish?: (event: StepResult<TOOLS> & {
         /**
 Details for all steps.
        */
         steps: StepResult<TOOLS>[];
-        /**
-Additional provider-specific metadata. They are passed through
-from the provider to the AI SDK and enable provider-specific
-results that can be fully encapsulated in the provider.
-   */
-        readonly experimental_providerMetadata: ProviderMetadata | undefined;
     }) => Promise<void> | void;
     /**
     Callback that is called when each step (LLM call) is finished, including intermediate steps.

package/dist/index.js

@@ -3059,6 +3059,7 @@ async function generateText({
     generateId: generateId3 = originalGenerateId3,
     currentDate = () => /* @__PURE__ */ new Date()
   } = {},
+  onStepFinish,
   ...settings
 }) {
   var _a11;
@@ -3220,7 +3221,7 @@ async function generateText({
         usage.completionTokens += currentUsage.completionTokens;
         usage.promptTokens += currentUsage.promptTokens;
         usage.totalTokens += currentUsage.totalTokens;
-        steps.push({
+        const currentStep = {
           text: (_b = currentModelResponse.text) != null ? _b : "",
           toolCalls: currentToolCalls,
           toolResults: currentToolResults,
@@ -3231,8 +3232,11 @@ async function generateText({
           response: {
             ...currentModelResponse.response,
             headers: (_c = currentModelResponse.rawResponse) == null ? void 0 : _c.headers
-          }
-        });
+          },
+          experimental_providerMetadata: currentModelResponse.providerMetadata
+        };
+        steps.push(currentStep);
+        await (onStepFinish == null ? void 0 : onStepFinish(currentStep));
         const newResponseMessages = toResponseMessages({
           text: currentModelResponse.text,
           toolCalls: currentToolCalls,
@@ -4098,7 +4102,8 @@ var DefaultStreamTextResult = class {
                 warnings: self.warnings,
                 logprobs: stepLogProbs,
                 response: stepResponse,
-                rawResponse: self.rawResponse
+                rawResponse: self.rawResponse,
+                experimental_providerMetadata: stepProviderMetadata
               };
               stepResults.push(stepResult);
               await (onStepFinish == null ? void 0 : onStepFinish(stepResult));