ai 6.0.95 → 6.0.97

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

@@ -54,6 +54,14 @@ import { DownloadFunction } from '../util/download/download-function';
 import { mergeObjects } from '../util/merge-objects';
 import { prepareRetries } from '../util/prepare-retries';
 import { VERSION } from '../version';
+import type {
+  OnFinishEvent,
+  OnStartEvent,
+  OnStepFinishEvent,
+  OnStepStartEvent,
+  OnToolCallFinishEvent,
+  OnToolCallStartEvent,
+} from './callback-events';
 import { collectToolApprovals } from './collect-tool-approvals';
 import { ContentPart } from './content-part';
 import { executeToolCall } from './execute-tool-call';
@@ -88,6 +96,14 @@ const originalGenerateId = createIdGenerator({
   size: 24,
 });
 
+/**
+ * Include settings for generateText (requestBody and responseBody).
+ */
+type GenerateTextIncludeSettings = {
+  requestBody?: boolean;
+  responseBody?: boolean;
+};
+
 /**
  * Callback that is set using the `experimental_onStart` option.
  *
@@ -100,106 +116,9 @@ const originalGenerateId = createIdGenerator({
 export type GenerateTextOnStartCallback<
   TOOLS extends ToolSet = ToolSet,
   OUTPUT extends Output = Output,
-> = (event: {
-  /** The model being used for generation. */
-  readonly model: {
-    /** The provider identifier (e.g., 'openai', 'anthropic'). */
-    readonly provider: string;
-    /** The specific model identifier (e.g., 'gpt-4o'). */
-    readonly modelId: string;
-  };
-
-  /** The system message(s) provided to the model. */
-  readonly system:
-    | string
-    | SystemModelMessage
-    | Array<SystemModelMessage>
-    | undefined;
-
-  /** The prompt string or array of messages if using the prompt option. */
-  readonly prompt: string | Array<ModelMessage> | undefined;
-
-  /** The messages array if using the messages option. */
-  readonly messages: Array<ModelMessage> | undefined;
-
-  /** The tools available for this generation. */
-  readonly tools: TOOLS | undefined;
-
-  /** The tool choice strategy for this generation. */
-  readonly toolChoice: ToolChoice<NoInfer<TOOLS>> | undefined;
-
-  /** Limits which tools are available for the model to call. */
-  readonly activeTools: Array<keyof TOOLS> | undefined;
-
-  /** Maximum number of tokens to generate. */
-  readonly maxOutputTokens: number | undefined;
-  /** Sampling temperature for generation. */
-  readonly temperature: number | undefined;
-  /** Top-p (nucleus) sampling parameter. */
-  readonly topP: number | undefined;
-  /** Top-k sampling parameter. */
-  readonly topK: number | undefined;
-  /** Presence penalty for generation. */
-  readonly presencePenalty: number | undefined;
-  /** Frequency penalty for generation. */
-  readonly frequencyPenalty: number | undefined;
-  /** Sequences that will stop generation. */
-  readonly stopSequences: string[] | undefined;
-  /** Random seed for reproducible generation. */
-  readonly seed: number | undefined;
-  /** Maximum number of retries for failed requests. */
-  readonly maxRetries: number;
-
-  /**
-   * Timeout configuration for the generation.
-   * Can be a number (milliseconds) or an object with totalMs, stepMs, chunkMs.
-   */
-  readonly timeout: TimeoutConfiguration | undefined;
-
-  /** Additional HTTP headers sent with the request. */
-  readonly headers: Record<string, string | undefined> | undefined;
-
-  /** Additional provider-specific options. */
-  readonly providerOptions: ProviderOptions | undefined;
-
-  /**
-   * Condition(s) for stopping the generation.
-   * When the condition is an array, any of the conditions can be met to stop.
-   */
-  readonly stopWhen:
-    | StopCondition<TOOLS>
-    | Array<StopCondition<TOOLS>>
-    | undefined;
-
-  /** The output specification for structured outputs, if configured. */
-  readonly output: OUTPUT | undefined;
-
-  /** Abort signal for cancelling the operation. */
-  readonly abortSignal: AbortSignal | undefined;
-
-  /**
-   * Settings for controlling what data is included in step results.
-   * `requestBody` and `responseBody` control whether these are retained.
-   */
-  readonly include:
-    | {
-        requestBody?: boolean;
-        responseBody?: boolean;
-      }
-    | undefined;
-
-  /** Identifier from telemetry settings for grouping related operations. */
-  readonly functionId: string | undefined;
-
-  /** Additional metadata passed to the generation. */
-  readonly metadata: Record<string, unknown> | undefined;
-
-  /**
-   * User-defined context object that flows through the entire generation lifecycle.
-   * Can be accessed and modified in `prepareStep` and tool `execute` functions.
-   */
-  readonly experimental_context: unknown;
-}) => PromiseLike<void> | void;
+> = (
+  event: OnStartEvent<TOOLS, OUTPUT, GenerateTextIncludeSettings>,
+) => PromiseLike<void> | void;
 
 /**
  * Callback that is set using the `experimental_onStepStart` option.
@@ -213,94 +132,9 @@ export type GenerateTextOnStartCallback<
 export type GenerateTextOnStepStartCallback<
   TOOLS extends ToolSet = ToolSet,
   OUTPUT extends Output = Output,
-> = (event: {
-  /** Zero-based index of the current step. */
-  readonly stepNumber: number;
-
-  /** The model being used for this step. */
-  readonly model: {
-    /** The provider identifier. */
-    readonly provider: string;
-    /** The specific model identifier. */
-    readonly modelId: string;
-  };
-
-  /**
-   * The system message for this step.
-   */
-  readonly system:
-    | string
-    | SystemModelMessage
-    | Array<SystemModelMessage>
-    | undefined;
-
-  /**
-   * The messages that will be sent to the model for this step.
-   * Uses the user-facing `ModelMessage` format.
-   * May be overridden by prepareStep.
-   */
-  readonly messages: Array<ModelMessage>;
-
-  /** The tools available for this generation. */
-  readonly tools: TOOLS | undefined;
-
-  /** The tool choice configuration for this step. */
-  readonly toolChoice: LanguageModelV3ToolChoice | undefined;
-
-  /** Limits which tools are available for this step. */
-  readonly activeTools: Array<keyof TOOLS> | undefined;
-
-  /** Array of results from previous steps (empty for first step). */
-  readonly steps: ReadonlyArray<StepResult<TOOLS>>;
-
-  /** Additional provider-specific options for this step. */
-  readonly providerOptions: ProviderOptions | undefined;
-
-  /**
-   * Timeout configuration for the generation.
-   * Can be a number (milliseconds) or an object with totalMs, stepMs, chunkMs.
-   */
-  readonly timeout: TimeoutConfiguration | undefined;
-
-  /** Additional HTTP headers sent with the request. */
-  readonly headers: Record<string, string | undefined> | undefined;
-
-  /**
-   * Condition(s) for stopping the generation.
-   * When the condition is an array, any of the conditions can be met to stop.
-   */
-  readonly stopWhen:
-    | StopCondition<TOOLS>
-    | Array<StopCondition<TOOLS>>
-    | undefined;
-
-  /** The output specification for structured outputs, if configured. */
-  readonly output: OUTPUT | undefined;
-
-  /** Abort signal for cancelling the operation. */
-  readonly abortSignal: AbortSignal | undefined;
-
-  /**
-   * Settings for controlling what data is included in step results.
-   */
-  readonly include:
-    | {
-        requestBody?: boolean;
-        responseBody?: boolean;
-      }
-    | undefined;
-
-  /** 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. May be updated from `prepareStep` between steps.
-   */
-  readonly experimental_context: unknown;
-}) => PromiseLike<void> | void;
+> = (
+  event: OnStepStartEvent<TOOLS, OUTPUT, GenerateTextIncludeSettings>,
+) => PromiseLike<void> | void;
 
 /**
  * Callback that is set using the `experimental_onToolCallStart` option.
@@ -309,42 +143,10 @@ export type GenerateTextOnStepStartCallback<
  * Use this for logging tool invocations, tracking tool usage, or pre-execution validation.
  *
  * @param event - The event object containing tool call information.
- * @param event.stepNumber - Zero-based index of the current step where this tool call occurs.
- * @param event.model - Information about the model being used (provider and modelId).
- * @param event.toolCall - The full tool call object containing toolName, toolCallId, input, and metadata.
- * @param event.messages - The conversation messages available at tool execution time.
- * @param event.abortSignal - Signal for cancelling the operation.
- * @param event.functionId - Identifier from telemetry settings for grouping related operations.
- * @param event.metadata - Additional metadata from telemetry settings.
- * @param event.experimental_context - User-defined context object flowing through the generation.
  */
 export type GenerateTextOnToolCallStartCallback<
   TOOLS extends ToolSet = ToolSet,
-> = (event: {
-  /** Zero-based index of the current step where this tool call occurs. May be undefined in streaming contexts. */
-  readonly stepNumber: number | undefined;
-  /** Information about the model being used. May be undefined in streaming contexts. */
-  readonly model:
-    | {
-        /** The provider of the model. */
-        readonly provider: string;
-        /** The ID of the model. */
-        readonly modelId: string;
-      }
-    | undefined;
-  /** The full tool call object. */
-  readonly toolCall: TypedToolCall<TOOLS>;
-  /** The conversation messages available at tool execution time. */
-  readonly messages: Array<ModelMessage>;
-  /** Signal for cancelling the operation. */
-  readonly abortSignal: AbortSignal | undefined;
-  /** 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. */
-  readonly experimental_context: unknown;
-}) => PromiseLike<void> | void;
+> = (event: OnToolCallStartEvent<TOOLS>) => PromiseLike<void> | void;
 
 /**
  * Callback that is set using the `experimental_onToolCallFinish` option.
@@ -357,65 +159,10 @@ export type GenerateTextOnToolCallStartCallback<
  * - When `success: false`: `error` contains the error, `output` is never present.
  *
  * @param event - The event object containing tool call result information.
- * @param event.stepNumber - Zero-based index of the current step where this tool call occurred.
- * @param event.model - Information about the model being used (provider and modelId).
- * @param event.toolCall - The full tool call object containing toolName, toolCallId, input, and metadata.
- * @param event.messages - The conversation messages available at tool execution time.
- * @param event.abortSignal - Signal for cancelling the operation.
- * @param event.durationMs - Execution time of the tool call in milliseconds.
- * @param event.functionId - Identifier from telemetry settings for grouping related operations.
- * @param event.metadata - Additional metadata from telemetry settings.
- * @param event.experimental_context - User-defined context object flowing through the generation.
- * @param event.success - Discriminator indicating whether the tool call succeeded.
- * @param event.output - The tool's return value (only present when `success: true`).
- * @param event.error - The error that occurred (only present when `success: false`).
  */
 export type GenerateTextOnToolCallFinishCallback<
   TOOLS extends ToolSet = ToolSet,
-> = (
-  event: {
-    /** Zero-based index of the current step where this tool call occurred. May be undefined in streaming contexts. */
-    readonly stepNumber: number | undefined;
-    /** Information about the model being used. May be undefined in streaming contexts. */
-    readonly model:
-      | {
-          /** The provider of the model. */
-          readonly provider: string;
-          /** The ID of the model. */
-          readonly modelId: string;
-        }
-      | undefined;
-    /** The full tool call object. */
-    readonly toolCall: TypedToolCall<TOOLS>;
-    /** The conversation messages available at tool execution time. */
-    readonly messages: Array<ModelMessage>;
-    /** Signal for cancelling the operation. */
-    readonly abortSignal: AbortSignal | undefined;
-    /** Execution time of the tool call in milliseconds. */
-    readonly durationMs: number;
-    /** 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. */
-    readonly experimental_context: unknown;
-  } & (
-    | {
-        /** Indicates the tool call succeeded. */
-        readonly success: true;
-        /** The tool's return value. */
-        readonly output: unknown;
-        readonly error?: never;
-      }
-    | {
-        /** Indicates the tool call failed. */
-        readonly success: false;
-        readonly output?: never;
-        /** The error that occurred during tool execution. */
-        readonly error: unknown;
-      }
-  ),
-) => PromiseLike<void> | void;
+> = (event: OnToolCallFinishEvent<TOOLS>) => PromiseLike<void> | void;
 
 /**
  * Callback that is set using the `onStepFinish` option.
@@ -426,7 +173,7 @@ export type GenerateTextOnToolCallFinishCallback<
  * @param stepResult - The result of the step.
  */
 export type GenerateTextOnStepFinishCallback<TOOLS extends ToolSet> = (
-  stepResult: StepResult<TOOLS>,
+  event: OnStepFinishEvent<TOOLS>,
 ) => Promise<void> | void;
 
 /**
@@ -437,60 +184,9 @@ export type GenerateTextOnStepFinishCallback<TOOLS extends ToolSet> = (
  * aggregated data from all steps.
  *
  * @param event - The final result along with aggregated step data.
- *
- * Inherited from StepResult (reflects the final step):
- * @param event.content - Array of content parts from the final step.
- * @param event.text - The generated text from the final step.
- * @param event.reasoning - Array of reasoning parts from the final step.
- * @param event.reasoningText - Combined reasoning text from the final step.
- * @param event.files - Array of generated files from the final step.
- * @param event.sources - Array of sources from the final step.
- * @param event.toolCalls - Array of tool calls from the final step.
- * @param event.toolResults - Array of tool results from the final step.
- * @param event.finishReason - Finish reason from the final step.
- * @param event.usage - Token usage from the final step only.
- * @param event.warnings - Warnings from the final step.
- * @param event.request - Request metadata from the final step.
- * @param event.response - Response metadata from the final step.
- * @param event.providerMetadata - Provider metadata from the final step.
- *
- * Additional properties:
- * @param event.steps - Array containing results from all steps in the generation.
- * @param event.totalUsage - Aggregated token usage across all steps.
- * @param event.experimental_context - The final state of the user-defined context object.
- * @param event.functionId - Identifier from telemetry settings for grouping related operations.
- * @param event.metadata - Additional metadata from telemetry settings.
  */
 export type GenerateTextOnFinishCallback<TOOLS extends ToolSet> = (
-  event: StepResult<TOOLS> & {
-    /**
-     * Array containing results from all steps in the generation.
-     */
-    readonly steps: StepResult<TOOLS>[];
-
-    /**
-     * Aggregated token usage across all steps.
-     * This is the sum of the usage from each individual step.
-     */
-    readonly totalUsage: LanguageModelUsage;
-
-    /**
-     * The final state of the user-defined context object.
-     * This reflects any modifications made during the generation lifecycle
-     * via `prepareStep` or tool execution.
-     *
-     * Experimental (can break in patch releases).
-     *
-     * @default undefined
-     */
-    experimental_context: unknown;
-
-    /** Identifier from telemetry settings for grouping related operations. */
-    readonly functionId: string | undefined;
-
-    /** Additional metadata from telemetry settings. */
-    readonly metadata: Record<string, unknown> | undefined;
-  },
+  event: OnFinishEvent<TOOLS>,
 ) => PromiseLike<void> | void;
 
 /**
@@ -775,6 +471,8 @@ export async function generateText<
     settings: { ...callSettings, maxRetries },
   });
 
+  const modelInfo = { provider: model.provider, modelId: model.modelId };
+
   const initialPrompt = await standardizePrompt({
     system,
     prompt,
@@ -783,7 +481,7 @@ export async function generateText<
 
   try {
     await onStart?.({
-      model: { provider: model.provider, modelId: model.modelId },
+      model: modelInfo,
       system,
       prompt,
       messages,
@@ -863,7 +561,7 @@ export async function generateText<
             abortSignal: mergedAbortSignal,
             experimental_context,
             stepNumber: 0,
-            model: { provider: model.provider, modelId: model.modelId },
+            model: modelInfo,
             onToolCallStart: onToolCallStart,
             onToolCallFinish: onToolCallFinish,
           });
@@ -976,6 +674,10 @@ export async function generateText<
             const stepModel = resolveLanguageModel(
               prepareStepResult?.model ?? model,
             );
+            const stepModelInfo = {
+              provider: stepModel.provider,
+              modelId: stepModel.modelId,
+            };
 
             const promptMessages = await convertToLanguageModelPrompt({
               prompt: {
@@ -1013,10 +715,7 @@ export async function generateText<
             try {
               await onStepStart?.({
                 stepNumber: steps.length,
-                model: {
-                  provider: stepModel.provider,
-                  modelId: stepModel.modelId,
-                },
+                model: stepModelInfo,
                 system: stepSystem,
                 messages: stepMessages,
                 tools,
@@ -1258,10 +957,7 @@ export async function generateText<
                   abortSignal: mergedAbortSignal,
                   experimental_context,
                   stepNumber: steps.length,
-                  model: {
-                    provider: stepModel.provider,
-                    modelId: stepModel.modelId,
-                  },
+                  model: stepModelInfo,
                   onToolCallStart: onToolCallStart,
                   onToolCallFinish: onToolCallFinish,
                 })),
@@ -1337,10 +1033,7 @@ export async function generateText<
 
             const currentStepResult: StepResult<TOOLS> = new DefaultStepResult({
               stepNumber,
-              model: {
-                provider: stepModel.provider,
-                modelId: stepModel.modelId,
-              },
+              model: stepModelInfo,
               functionId: telemetry?.functionId,
               metadata: telemetry?.metadata as
                 | Record<string, unknown>
@@ -1358,8 +1051,8 @@ export async function generateText<
 
             logWarnings({
               warnings: currentModelResponse.warnings ?? [],
-              provider: stepModel.provider,
-              model: stepModel.modelId,
+              provider: stepModelInfo.provider,
+              model: stepModelInfo.modelId,
             });
 
             steps.push(currentStepResult);

package/src/generate-text/index.ts

@@ -30,7 +30,11 @@ export {
   type StreamTextOnChunkCallback,
   type StreamTextOnErrorCallback,
   type StreamTextOnFinishCallback,
+  type StreamTextOnStartCallback,
   type StreamTextOnStepFinishCallback,
+  type StreamTextOnStepStartCallback,
+  type StreamTextOnToolCallFinishCallback,
+  type StreamTextOnToolCallStartCallback,
   type StreamTextTransform,
 } from './stream-text';
 export type {

package/src/generate-text/run-tools-transformation.ts

@@ -12,6 +12,10 @@ import { FinishReason, LanguageModelUsage, ProviderMetadata } from '../types';
 import { Source } from '../types/language-model';
 import { asLanguageModelUsage } from '../types/usage';
 import { executeToolCall } from './execute-tool-call';
+import {
+  StreamTextOnToolCallFinishCallback,
+  StreamTextOnToolCallStartCallback,
+} from './stream-text';
 import { DefaultGeneratedFileWithType, GeneratedFile } from './generated-file';
 import { isApprovalNeeded } from './is-approval-needed';
 import { parseToolCall } from './parse-tool-call';
@@ -116,6 +120,10 @@ export function runToolsTransformation<TOOLS extends ToolSet>({
   repairToolCall,
   experimental_context,
   generateId,
+  stepNumber,
+  model,
+  onToolCallStart,
+  onToolCallFinish,
 }: {
   tools: TOOLS | undefined;
   generatorStream: ReadableStream<LanguageModelV3StreamPart>;
@@ -127,6 +135,10 @@ export function runToolsTransformation<TOOLS extends ToolSet>({
   repairToolCall: ToolCallRepairFunction<TOOLS> | undefined;
   experimental_context: unknown;
   generateId: IdGenerator;
+  stepNumber?: number;
+  model?: { provider: string; modelId: string };
+  onToolCallStart?: StreamTextOnToolCallStartCallback<TOOLS>;
+  onToolCallFinish?: StreamTextOnToolCallFinishCallback<TOOLS>;
 }): ReadableStream<SingleRequestTextStreamPart<TOOLS>> {
   // tool results stream
   let toolResultsStreamController: ReadableStreamDefaultController<
@@ -323,6 +335,10 @@ export function runToolsTransformation<TOOLS extends ToolSet>({
                 messages,
                 abortSignal,
                 experimental_context,
+                stepNumber,
+                model,
+                onToolCallStart,
+                onToolCallFinish,
                 onPreliminaryToolResult: result => {
                   toolResultsStreamController!.enqueue(result);
                 },