ai 6.0.92 → 6.0.94

package/src/generate-text/index.ts

@@ -1,7 +1,11 @@
 export {
   generateText,
   type GenerateTextOnFinishCallback,
+  type GenerateTextOnStartCallback,
+  type GenerateTextOnStepStartCallback,
   type GenerateTextOnStepFinishCallback,
+  type GenerateTextOnToolCallStartCallback,
+  type GenerateTextOnToolCallFinishCallback,
 } from './generate-text';
 export type { ContentPart } from './content-part';
 export type { GenerateTextResult } from './generate-text-result';

package/src/generate-text/step-result.ts

@@ -23,6 +23,38 @@ import { ToolSet } from './tool-set';
  * The result of a single step in the generation process.
  */
 export type StepResult<TOOLS extends ToolSet> = {
+  /**
+   * Zero-based index of this step.
+   */
+  readonly stepNumber: number;
+
+  /**
+   * Information about the model that produced this step.
+   */
+  readonly model: {
+    /** The provider of the model. */
+    readonly provider: string;
+    /** The ID of the model. */
+    readonly modelId: string;
+  };
+
+  /**
+   * Identifier from telemetry settings for grouping related operations.
+   */
+  readonly functionId: string | undefined;
+
+  /**
+   * Additional metadata from telemetry settings.
+   */
+  readonly metadata: Record<string, unknown> | undefined;
+
+  /**
+   * User-defined context object flowing through the generation.
+   *
+   * Experimental (can break in patch releases).
+   */
+  readonly experimental_context: unknown;
+
   /**
    * The content that was generated in the last step.
    */
@@ -136,6 +168,11 @@ export type StepResult<TOOLS extends ToolSet> = {
 export class DefaultStepResult<TOOLS extends ToolSet>
   implements StepResult<TOOLS>
 {
+  readonly stepNumber: StepResult<TOOLS>['stepNumber'];
+  readonly model: StepResult<TOOLS>['model'];
+  readonly functionId: StepResult<TOOLS>['functionId'];
+  readonly metadata: StepResult<TOOLS>['metadata'];
+  readonly experimental_context: StepResult<TOOLS>['experimental_context'];
   readonly content: StepResult<TOOLS>['content'];
   readonly finishReason: StepResult<TOOLS>['finishReason'];
   readonly rawFinishReason: StepResult<TOOLS>['rawFinishReason'];
@@ -146,6 +183,11 @@ export class DefaultStepResult<TOOLS extends ToolSet>
   readonly providerMetadata: StepResult<TOOLS>['providerMetadata'];
 
   constructor({
+    stepNumber,
+    model,
+    functionId,
+    metadata,
+    experimental_context,
     content,
     finishReason,
     rawFinishReason,
@@ -155,6 +197,11 @@ export class DefaultStepResult<TOOLS extends ToolSet>
     response,
     providerMetadata,
   }: {
+    stepNumber: StepResult<TOOLS>['stepNumber'];
+    model: StepResult<TOOLS>['model'];
+    functionId: StepResult<TOOLS>['functionId'];
+    metadata: StepResult<TOOLS>['metadata'];
+    experimental_context: StepResult<TOOLS>['experimental_context'];
     content: StepResult<TOOLS>['content'];
     finishReason: StepResult<TOOLS>['finishReason'];
     rawFinishReason: StepResult<TOOLS>['rawFinishReason'];
@@ -164,6 +211,11 @@ export class DefaultStepResult<TOOLS extends ToolSet>
     response: StepResult<TOOLS>['response'];
     providerMetadata: StepResult<TOOLS>['providerMetadata'];
   }) {
+    this.stepNumber = stepNumber;
+    this.model = model;
+    this.functionId = functionId;
+    this.metadata = metadata;
+    this.experimental_context = experimental_context;
     this.content = content;
     this.finishReason = finishReason;
     this.rawFinishReason = rawFinishReason;

package/src/generate-text/stream-text.ts

@@ -917,6 +917,16 @@ class DefaultStreamTextResult<TOOLS extends ToolSet, OUTPUT extends Output>
 
           // Add step information (after response messages are updated):
           const currentStepResult: StepResult<TOOLS> = new DefaultStepResult({
+            stepNumber: recordedSteps.length,
+            model: {
+              provider: model.provider,
+              modelId: model.modelId,
+            },
+            functionId: telemetry?.functionId,
+            metadata: telemetry?.metadata as
+              | Record<string, unknown>
+              | undefined,
+            experimental_context,
             content: recordedContent,
             finishReason: part.finishReason,
             rawFinishReason: part.rawFinishReason,
@@ -987,6 +997,11 @@ class DefaultStreamTextResult<TOOLS extends ToolSet, OUTPUT extends Output>
           // call onFinish callback:
           const finalStep = recordedSteps[recordedSteps.length - 1];
           await onFinish?.({
+            stepNumber: finalStep.stepNumber,
+            model: finalStep.model,
+            functionId: finalStep.functionId,
+            metadata: finalStep.metadata,
+            experimental_context: finalStep.experimental_context,
             finishReason: finalStep.finishReason,
             rawFinishReason: finalStep.rawFinishReason,
             totalUsage,
@@ -1008,7 +1023,6 @@ class DefaultStreamTextResult<TOOLS extends ToolSet, OUTPUT extends Output>
             warnings: finalStep.warnings,
             providerMetadata: finalStep.providerMetadata,
             steps: recordedSteps,
-            experimental_context,
           });
 
           // Add response information to the root span: