ai 3.3.37 → 3.3.38

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 3.3.38
+
+### Patch Changes
+
+- 83da52c: feat (ai/core): add onStepFinish callback to streamText
+
 ## 3.3.37
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1806,7 +1806,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, maxSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, maxSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1868,57 +1868,22 @@ 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.
      */
-    onFinish?: (event: {
+    onFinish?: (event: StepResult<TOOLS> & {
         /**
-  The reason why the generation finished.
-         */
-        finishReason: FinishReason;
-        /**
-  The token usage of the generated response.
-   */
-        usage: LanguageModelUsage$1;
-        /**
-  The full text that has been generated.
-         */
-        text: string;
-        /**
-  The tool calls that have been executed.
-         */
-        toolCalls?: ToToolCall<TOOLS>[];
-        /**
-  The tool results that have been generated.
-         */
-        toolResults?: ToToolResult<TOOLS>[];
-        /**
-  Optional raw response data.
-  
-  @deprecated Use `response` instead.
-         */
-        rawResponse?: {
-            /**
-    Response headers.
-             */
-            headers?: Record<string, string>;
-        };
-        /**
-  Response metadata.
-         */
-        response: LanguageModelResponseMetadataWithHeaders;
-        /**
-  Details for all steps.
-         */
+Details for all steps.
+       */
         steps: StepResult<TOOLS>[];
         /**
-  Warnings from the model provider (e.g. unsupported settings).
-         */
-        warnings?: CallWarning[];
-        /**
-  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.
-     */
+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.
+    */
+    onStepFinish?: (event: StepResult<TOOLS>) => Promise<void> | void;
     /**
      * Internal. For test use only. May change without notice.
      */

package/dist/index.d.ts

@@ -1806,7 +1806,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, maxSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, maxSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1868,57 +1868,22 @@ 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.
      */
-    onFinish?: (event: {
+    onFinish?: (event: StepResult<TOOLS> & {
         /**
-  The reason why the generation finished.
-         */
-        finishReason: FinishReason;
-        /**
-  The token usage of the generated response.
-   */
-        usage: LanguageModelUsage$1;
-        /**
-  The full text that has been generated.
-         */
-        text: string;
-        /**
-  The tool calls that have been executed.
-         */
-        toolCalls?: ToToolCall<TOOLS>[];
-        /**
-  The tool results that have been generated.
-         */
-        toolResults?: ToToolResult<TOOLS>[];
-        /**
-  Optional raw response data.
-  
-  @deprecated Use `response` instead.
-         */
-        rawResponse?: {
-            /**
-    Response headers.
-             */
-            headers?: Record<string, string>;
-        };
-        /**
-  Response metadata.
-         */
-        response: LanguageModelResponseMetadataWithHeaders;
-        /**
-  Details for all steps.
-         */
+Details for all steps.
+       */
         steps: StepResult<TOOLS>[];
         /**
-  Warnings from the model provider (e.g. unsupported settings).
-         */
-        warnings?: CallWarning[];
-        /**
-  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.
-     */
+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.
+    */
+    onStepFinish?: (event: StepResult<TOOLS>) => Promise<void> | void;
     /**
      * Internal. For test use only. May change without notice.
      */

package/dist/index.js

@@ -3737,6 +3737,7 @@ async function streamText({
   experimental_toolCallStreaming: toolCallStreaming = false,
   onChunk,
   onFinish,
+  onStepFinish,
   _internal: {
     now: now2 = now,
     generateId: generateId3 = originalGenerateId4,
@@ -3869,6 +3870,7 @@ async function streamText({
         rawResponse,
         onChunk,
         onFinish,
+        onStepFinish,
         rootSpan,
         doStreamSpan,
         telemetry,
@@ -3891,6 +3893,7 @@ var DefaultStreamTextResult = class {
     rawResponse,
     onChunk,
     onFinish,
+    onStepFinish,
     rootSpan,
     doStreamSpan,
     telemetry,
@@ -4043,26 +4046,7 @@ var DefaultStreamTextResult = class {
             },
             // invoke onFinish callback and resolve toolResults promise when the stream is about to close:
             async flush(controller) {
-              controller.enqueue({
-                type: "step-finish",
-                finishReason: stepFinishReason,
-                usage: stepUsage,
-                experimental_providerMetadata: stepProviderMetadata,
-                logprobs: stepLogProbs,
-                response: stepResponse
-              });
-              stepResults.push({
-                text: stepText,
-                toolCalls: stepToolCalls,
-                toolResults: stepToolResults,
-                finishReason: stepFinishReason,
-                usage: stepUsage,
-                warnings: self.warnings,
-                logprobs: stepLogProbs,
-                response: stepResponse,
-                rawResponse: self.rawResponse
-              });
-              const telemetryToolCalls = stepToolCalls.length > 0 ? JSON.stringify(stepToolCalls) : void 0;
+              const stepToolCallsJson = stepToolCalls.length > 0 ? JSON.stringify(stepToolCalls) : void 0;
               try {
                 doStreamSpan2.setAttributes(
                   selectTelemetryAttributes({
@@ -4071,7 +4055,7 @@ var DefaultStreamTextResult = class {
                       "ai.response.finishReason": stepFinishReason,
                       "ai.response.text": { output: () => stepText },
                       "ai.response.toolCalls": {
-                        output: () => telemetryToolCalls
+                        output: () => stepToolCallsJson
                       },
                       "ai.response.id": stepResponse.id,
                       "ai.response.model": stepResponse.modelId,
@@ -4082,7 +4066,7 @@ var DefaultStreamTextResult = class {
                       "ai.finishReason": stepFinishReason,
                       "ai.result.text": { output: () => stepText },
                       "ai.result.toolCalls": {
-                        output: () => telemetryToolCalls
+                        output: () => stepToolCallsJson
                       },
                       // standardized gen-ai llm span attributes:
                       "gen_ai.response.finish_reasons": [stepFinishReason],
@@ -4097,6 +4081,27 @@ var DefaultStreamTextResult = class {
               } finally {
                 doStreamSpan2.end();
               }
+              controller.enqueue({
+                type: "step-finish",
+                finishReason: stepFinishReason,
+                usage: stepUsage,
+                experimental_providerMetadata: stepProviderMetadata,
+                logprobs: stepLogProbs,
+                response: stepResponse
+              });
+              const stepResult = {
+                text: stepText,
+                toolCalls: stepToolCalls,
+                toolResults: stepToolResults,
+                finishReason: stepFinishReason,
+                usage: stepUsage,
+                warnings: self.warnings,
+                logprobs: stepLogProbs,
+                response: stepResponse,
+                rawResponse: self.rawResponse
+              };
+              stepResults.push(stepResult);
+              await (onStepFinish == null ? void 0 : onStepFinish(stepResult));
               const combinedUsage = {
                 promptTokens: usage.promptTokens + stepUsage.promptTokens,
                 completionTokens: usage.completionTokens + stepUsage.completionTokens,
@@ -4154,7 +4159,7 @@ var DefaultStreamTextResult = class {
                       "ai.response.finishReason": stepFinishReason,
                       "ai.response.text": { output: () => stepText },
                       "ai.response.toolCalls": {
-                        output: () => telemetryToolCalls
+                        output: () => stepToolCallsJson
                       },
                       "ai.usage.promptTokens": combinedUsage.promptTokens,
                       "ai.usage.completionTokens": combinedUsage.completionTokens,
@@ -4162,7 +4167,7 @@ var DefaultStreamTextResult = class {
                       "ai.finishReason": stepFinishReason,
                       "ai.result.text": { output: () => stepText },
                       "ai.result.toolCalls": {
-                        output: () => telemetryToolCalls
+                        output: () => stepToolCallsJson
                       }
                     }
                   })
@@ -4180,6 +4185,7 @@ var DefaultStreamTextResult = class {
                 resolveSteps(stepResults);
                 await (onFinish == null ? void 0 : onFinish({
                   finishReason: stepFinishReason,
+                  logprobs: stepLogProbs,
                   usage: combinedUsage,
                   text: stepText,
                   toolCalls: stepToolCalls,