ai 6.0.48 → 6.0.50

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # ai
 
+## 6.0.50
+
+### Patch Changes
+
+- Updated dependencies [cbf1704]
+  - @ai-sdk/gateway@3.0.23
+
+## 6.0.49
+
+### Patch Changes
+
+- ded661b: feat(ai): add onStepFinish to agent.generate and agent.stream
+
 ## 6.0.48
 
 ### Patch Changes

package/dist/index.d.mts

@@ -2793,10 +2793,19 @@ interface GenerateTextResult<TOOLS extends ToolSet, OUTPUT extends Output> {
     readonly output: InferCompleteOutput<OUTPUT>;
 }
 
+/**
+Callback that is set using the `onStepFinish` option.
+
+@param stepResult - The result of the step.
+ */
+type ToolLoopAgentOnStepFinishCallback<TOOLS extends ToolSet = {}> = (stepResult: StepResult<TOOLS>) => Promise<void> | void;
+
 /**
  * Parameters for calling an agent.
  */
-type AgentCallParameters<CALL_OPTIONS> = ([CALL_OPTIONS] extends [never] ? {
+type AgentCallParameters<CALL_OPTIONS, TOOLS extends ToolSet = {}> = ([
+    CALL_OPTIONS
+] extends [never] ? {
     options?: never;
 } : {
     options: CALL_OPTIONS;
@@ -2835,11 +2844,15 @@ type AgentCallParameters<CALL_OPTIONS> = ([CALL_OPTIONS] extends [never] ? {
      * Timeout in milliseconds. Can be specified as a number or as an object with `totalMs`.
      */
     timeout?: TimeoutConfiguration;
+    /**
+     * Callback that is called when each step (LLM call) is finished, including intermediate steps.
+     */
+    onStepFinish?: ToolLoopAgentOnStepFinishCallback<TOOLS>;
 };
 /**
  * Parameters for streaming an output from an agent.
  */
-type AgentStreamParameters<CALL_OPTIONS, TOOLS extends ToolSet> = AgentCallParameters<CALL_OPTIONS> & {
+type AgentStreamParameters<CALL_OPTIONS, TOOLS extends ToolSet> = AgentCallParameters<CALL_OPTIONS, TOOLS> & {
     /**
      * Optional stream transformations.
      * They are applied in the order they are provided.
@@ -2871,7 +2884,7 @@ interface Agent<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends
     /**
      * Generates an output from the agent (non-streaming).
      */
-    generate(options: AgentCallParameters<CALL_OPTIONS>): PromiseLike<GenerateTextResult<TOOLS, OUTPUT>>;
+    generate(options: AgentCallParameters<CALL_OPTIONS, TOOLS>): PromiseLike<GenerateTextResult<TOOLS, OUTPUT>>;
     /**
      * Streams an output from the agent (streaming).
      */
@@ -2902,13 +2915,6 @@ type ToolLoopAgentOnFinishCallback<TOOLS extends ToolSet = {}> = (event: StepRes
     experimental_context?: unknown;
 }) => PromiseLike<void> | void;
 
-/**
-Callback that is set using the `onStepFinish` option.
-
-@param stepResult - The result of the step.
- */
-type ToolLoopAgentOnStepFinishCallback<TOOLS extends ToolSet = {}> = (stepResult: StepResult<TOOLS>) => Promise<void> | void;
-
 /**
  * Configuration options for an agent.
  */
@@ -3000,7 +3006,7 @@ type ToolLoopAgentSettings<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUT
      *
      * You can use this to have templates based on call options.
      */
-    prepareCall?: (options: AgentCallParameters<CALL_OPTIONS> & Pick<ToolLoopAgentSettings<CALL_OPTIONS, TOOLS, OUTPUT>, 'model' | 'tools' | 'maxOutputTokens' | 'temperature' | 'topP' | 'topK' | 'presencePenalty' | 'frequencyPenalty' | 'stopSequences' | 'seed' | 'headers' | 'instructions' | 'stopWhen' | 'experimental_telemetry' | 'activeTools' | 'providerOptions' | 'experimental_context' | 'experimental_download'>) => MaybePromiseLike<Pick<ToolLoopAgentSettings<CALL_OPTIONS, TOOLS, OUTPUT>, 'model' | 'tools' | 'maxOutputTokens' | 'temperature' | 'topP' | 'topK' | 'presencePenalty' | 'frequencyPenalty' | 'stopSequences' | 'seed' | 'headers' | 'instructions' | 'stopWhen' | 'experimental_telemetry' | 'activeTools' | 'providerOptions' | 'experimental_context' | 'experimental_download'> & Omit<Prompt, 'system'>>;
+    prepareCall?: (options: Omit<AgentCallParameters<CALL_OPTIONS, NoInfer<TOOLS>>, 'onStepFinish'> & Pick<ToolLoopAgentSettings<CALL_OPTIONS, TOOLS, OUTPUT>, 'model' | 'tools' | 'maxOutputTokens' | 'temperature' | 'topP' | 'topK' | 'presencePenalty' | 'frequencyPenalty' | 'stopSequences' | 'seed' | 'headers' | 'instructions' | 'stopWhen' | 'experimental_telemetry' | 'activeTools' | 'providerOptions' | 'experimental_context' | 'experimental_download'>) => MaybePromiseLike<Pick<ToolLoopAgentSettings<CALL_OPTIONS, TOOLS, OUTPUT>, 'model' | 'tools' | 'maxOutputTokens' | 'temperature' | 'topP' | 'topK' | 'presencePenalty' | 'frequencyPenalty' | 'stopSequences' | 'seed' | 'headers' | 'instructions' | 'stopWhen' | 'experimental_telemetry' | 'activeTools' | 'providerOptions' | 'experimental_context' | 'experimental_download'> & Omit<Prompt, 'system'>>;
 };
 
 /**
@@ -3027,14 +3033,15 @@ declare class ToolLoopAgent<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OU
      */
     get tools(): TOOLS;
     private prepareCall;
+    private mergeOnStepFinishCallbacks;
     /**
      * Generates an output from the agent (non-streaming).
      */
-    generate({ abortSignal, timeout, ...options }: AgentCallParameters<CALL_OPTIONS>): Promise<GenerateTextResult<TOOLS, OUTPUT>>;
+    generate({ abortSignal, timeout, onStepFinish, ...options }: AgentCallParameters<CALL_OPTIONS, TOOLS>): Promise<GenerateTextResult<TOOLS, OUTPUT>>;
     /**
      * Streams an output from the agent (streaming).
      */
-    stream({ abortSignal, timeout, experimental_transform, ...options }: AgentStreamParameters<CALL_OPTIONS, TOOLS>): Promise<StreamTextResult<TOOLS, OUTPUT>>;
+    stream({ abortSignal, timeout, experimental_transform, onStepFinish, ...options }: AgentStreamParameters<CALL_OPTIONS, TOOLS>): Promise<StreamTextResult<TOOLS, OUTPUT>>;
 }
 
 /**
@@ -3052,6 +3059,7 @@ type InferAgentUIMessage<AGENT, MESSAGE_METADATA = unknown> = UIMessage<MESSAGE_
  *
  * @param agent - The agent to run.
  * @param uiMessages - The input UI messages.
+ * @param onStepFinish - Callback that is called when each step is finished. Optional.
  *
  * @returns The response object.
  */
@@ -3062,6 +3070,7 @@ declare function createAgentUIStreamResponse<CALL_OPTIONS = never, TOOLS extends
     timeout?: TimeoutConfiguration;
     options?: CALL_OPTIONS;
     experimental_transform?: StreamTextTransform<TOOLS> | Array<StreamTextTransform<TOOLS>>;
+    onStepFinish?: ToolLoopAgentOnStepFinishCallback<TOOLS>;
 } & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<Response>;
 
 declare const getOriginalFetch: () => typeof fetch;
@@ -3773,16 +3782,18 @@ declare const UI_MESSAGE_STREAM_HEADERS: {
  * @param timeout - Timeout in milliseconds. Optional.
  * @param options - The options for the agent.
  * @param experimental_transform - The stream transformations. Optional.
+ * @param onStepFinish - Callback that is called when each step is finished. Optional.
  *
  * @returns The UI message stream.
  */
-declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ agent, uiMessages, options, abortSignal, timeout, experimental_transform, ...uiMessageStreamOptions }: {
+declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ agent, uiMessages, options, abortSignal, timeout, experimental_transform, onStepFinish, ...uiMessageStreamOptions }: {
     agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
     uiMessages: unknown[];
     abortSignal?: AbortSignal;
     timeout?: TimeoutConfiguration;
     options?: CALL_OPTIONS;
     experimental_transform?: StreamTextTransform<TOOLS> | Array<StreamTextTransform<TOOLS>>;
+    onStepFinish?: ToolLoopAgentOnStepFinishCallback<TOOLS>;
 } & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<AsyncIterableStream<InferUIMessageChunk<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>>>;
 
 /**
@@ -3790,6 +3801,7 @@ declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet
  *
  * @param agent - The agent to run.
  * @param uiMessages - The input UI messages.
+ * @param onStepFinish - Callback that is called when each step is finished. Optional.
  */
 declare function pipeAgentUIStreamToResponse<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ response, headers, status, statusText, consumeSseStream, ...options }: {
     response: ServerResponse;
@@ -3799,6 +3811,7 @@ declare function pipeAgentUIStreamToResponse<CALL_OPTIONS = never, TOOLS extends
     timeout?: TimeoutConfiguration;
     options?: CALL_OPTIONS;
     experimental_transform?: StreamTextTransform<TOOLS> | Array<StreamTextTransform<TOOLS>>;
+    onStepFinish?: ToolLoopAgentOnStepFinishCallback<TOOLS>;
 } & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<void>;
 
 /**

package/dist/index.d.ts

@@ -2793,10 +2793,19 @@ interface GenerateTextResult<TOOLS extends ToolSet, OUTPUT extends Output> {
     readonly output: InferCompleteOutput<OUTPUT>;
 }
 
+/**
+Callback that is set using the `onStepFinish` option.
+
+@param stepResult - The result of the step.
+ */
+type ToolLoopAgentOnStepFinishCallback<TOOLS extends ToolSet = {}> = (stepResult: StepResult<TOOLS>) => Promise<void> | void;
+
 /**
  * Parameters for calling an agent.
  */
-type AgentCallParameters<CALL_OPTIONS> = ([CALL_OPTIONS] extends [never] ? {
+type AgentCallParameters<CALL_OPTIONS, TOOLS extends ToolSet = {}> = ([
+    CALL_OPTIONS
+] extends [never] ? {
     options?: never;
 } : {
     options: CALL_OPTIONS;
@@ -2835,11 +2844,15 @@ type AgentCallParameters<CALL_OPTIONS> = ([CALL_OPTIONS] extends [never] ? {
      * Timeout in milliseconds. Can be specified as a number or as an object with `totalMs`.
      */
     timeout?: TimeoutConfiguration;
+    /**
+     * Callback that is called when each step (LLM call) is finished, including intermediate steps.
+     */
+    onStepFinish?: ToolLoopAgentOnStepFinishCallback<TOOLS>;
 };
 /**
  * Parameters for streaming an output from an agent.
  */
-type AgentStreamParameters<CALL_OPTIONS, TOOLS extends ToolSet> = AgentCallParameters<CALL_OPTIONS> & {
+type AgentStreamParameters<CALL_OPTIONS, TOOLS extends ToolSet> = AgentCallParameters<CALL_OPTIONS, TOOLS> & {
     /**
      * Optional stream transformations.
      * They are applied in the order they are provided.
@@ -2871,7 +2884,7 @@ interface Agent<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends
     /**
      * Generates an output from the agent (non-streaming).
      */
-    generate(options: AgentCallParameters<CALL_OPTIONS>): PromiseLike<GenerateTextResult<TOOLS, OUTPUT>>;
+    generate(options: AgentCallParameters<CALL_OPTIONS, TOOLS>): PromiseLike<GenerateTextResult<TOOLS, OUTPUT>>;
     /**
      * Streams an output from the agent (streaming).
      */
@@ -2902,13 +2915,6 @@ type ToolLoopAgentOnFinishCallback<TOOLS extends ToolSet = {}> = (event: StepRes
     experimental_context?: unknown;
 }) => PromiseLike<void> | void;
 
-/**
-Callback that is set using the `onStepFinish` option.
-
-@param stepResult - The result of the step.
- */
-type ToolLoopAgentOnStepFinishCallback<TOOLS extends ToolSet = {}> = (stepResult: StepResult<TOOLS>) => Promise<void> | void;
-
 /**
  * Configuration options for an agent.
  */
@@ -3000,7 +3006,7 @@ type ToolLoopAgentSettings<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUT
      *
      * You can use this to have templates based on call options.
      */
-    prepareCall?: (options: AgentCallParameters<CALL_OPTIONS> & Pick<ToolLoopAgentSettings<CALL_OPTIONS, TOOLS, OUTPUT>, 'model' | 'tools' | 'maxOutputTokens' | 'temperature' | 'topP' | 'topK' | 'presencePenalty' | 'frequencyPenalty' | 'stopSequences' | 'seed' | 'headers' | 'instructions' | 'stopWhen' | 'experimental_telemetry' | 'activeTools' | 'providerOptions' | 'experimental_context' | 'experimental_download'>) => MaybePromiseLike<Pick<ToolLoopAgentSettings<CALL_OPTIONS, TOOLS, OUTPUT>, 'model' | 'tools' | 'maxOutputTokens' | 'temperature' | 'topP' | 'topK' | 'presencePenalty' | 'frequencyPenalty' | 'stopSequences' | 'seed' | 'headers' | 'instructions' | 'stopWhen' | 'experimental_telemetry' | 'activeTools' | 'providerOptions' | 'experimental_context' | 'experimental_download'> & Omit<Prompt, 'system'>>;
+    prepareCall?: (options: Omit<AgentCallParameters<CALL_OPTIONS, NoInfer<TOOLS>>, 'onStepFinish'> & Pick<ToolLoopAgentSettings<CALL_OPTIONS, TOOLS, OUTPUT>, 'model' | 'tools' | 'maxOutputTokens' | 'temperature' | 'topP' | 'topK' | 'presencePenalty' | 'frequencyPenalty' | 'stopSequences' | 'seed' | 'headers' | 'instructions' | 'stopWhen' | 'experimental_telemetry' | 'activeTools' | 'providerOptions' | 'experimental_context' | 'experimental_download'>) => MaybePromiseLike<Pick<ToolLoopAgentSettings<CALL_OPTIONS, TOOLS, OUTPUT>, 'model' | 'tools' | 'maxOutputTokens' | 'temperature' | 'topP' | 'topK' | 'presencePenalty' | 'frequencyPenalty' | 'stopSequences' | 'seed' | 'headers' | 'instructions' | 'stopWhen' | 'experimental_telemetry' | 'activeTools' | 'providerOptions' | 'experimental_context' | 'experimental_download'> & Omit<Prompt, 'system'>>;
 };
 
 /**
@@ -3027,14 +3033,15 @@ declare class ToolLoopAgent<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OU
      */
     get tools(): TOOLS;
     private prepareCall;
+    private mergeOnStepFinishCallbacks;
     /**
      * Generates an output from the agent (non-streaming).
      */
-    generate({ abortSignal, timeout, ...options }: AgentCallParameters<CALL_OPTIONS>): Promise<GenerateTextResult<TOOLS, OUTPUT>>;
+    generate({ abortSignal, timeout, onStepFinish, ...options }: AgentCallParameters<CALL_OPTIONS, TOOLS>): Promise<GenerateTextResult<TOOLS, OUTPUT>>;
     /**
      * Streams an output from the agent (streaming).
      */
-    stream({ abortSignal, timeout, experimental_transform, ...options }: AgentStreamParameters<CALL_OPTIONS, TOOLS>): Promise<StreamTextResult<TOOLS, OUTPUT>>;
+    stream({ abortSignal, timeout, experimental_transform, onStepFinish, ...options }: AgentStreamParameters<CALL_OPTIONS, TOOLS>): Promise<StreamTextResult<TOOLS, OUTPUT>>;
 }
 
 /**
@@ -3052,6 +3059,7 @@ type InferAgentUIMessage<AGENT, MESSAGE_METADATA = unknown> = UIMessage<MESSAGE_
  *
  * @param agent - The agent to run.
  * @param uiMessages - The input UI messages.
+ * @param onStepFinish - Callback that is called when each step is finished. Optional.
  *
  * @returns The response object.
  */
@@ -3062,6 +3070,7 @@ declare function createAgentUIStreamResponse<CALL_OPTIONS = never, TOOLS extends
     timeout?: TimeoutConfiguration;
     options?: CALL_OPTIONS;
     experimental_transform?: StreamTextTransform<TOOLS> | Array<StreamTextTransform<TOOLS>>;
+    onStepFinish?: ToolLoopAgentOnStepFinishCallback<TOOLS>;
 } & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<Response>;
 
 declare const getOriginalFetch: () => typeof fetch;
@@ -3773,16 +3782,18 @@ declare const UI_MESSAGE_STREAM_HEADERS: {
  * @param timeout - Timeout in milliseconds. Optional.
  * @param options - The options for the agent.
  * @param experimental_transform - The stream transformations. Optional.
+ * @param onStepFinish - Callback that is called when each step is finished. Optional.
  *
  * @returns The UI message stream.
  */
-declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ agent, uiMessages, options, abortSignal, timeout, experimental_transform, ...uiMessageStreamOptions }: {
+declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ agent, uiMessages, options, abortSignal, timeout, experimental_transform, onStepFinish, ...uiMessageStreamOptions }: {
     agent: Agent<CALL_OPTIONS, TOOLS, OUTPUT>;
     uiMessages: unknown[];
     abortSignal?: AbortSignal;
     timeout?: TimeoutConfiguration;
     options?: CALL_OPTIONS;
     experimental_transform?: StreamTextTransform<TOOLS> | Array<StreamTextTransform<TOOLS>>;
+    onStepFinish?: ToolLoopAgentOnStepFinishCallback<TOOLS>;
 } & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<AsyncIterableStream<InferUIMessageChunk<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>>>;
 
 /**
@@ -3790,6 +3801,7 @@ declare function createAgentUIStream<CALL_OPTIONS = never, TOOLS extends ToolSet
  *
  * @param agent - The agent to run.
  * @param uiMessages - The input UI messages.
+ * @param onStepFinish - Callback that is called when each step is finished. Optional.
  */
 declare function pipeAgentUIStreamToResponse<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUTPUT extends Output = never, MESSAGE_METADATA = unknown>({ response, headers, status, statusText, consumeSseStream, ...options }: {
     response: ServerResponse;
@@ -3799,6 +3811,7 @@ declare function pipeAgentUIStreamToResponse<CALL_OPTIONS = never, TOOLS extends
     timeout?: TimeoutConfiguration;
     options?: CALL_OPTIONS;
     experimental_transform?: StreamTextTransform<TOOLS> | Array<StreamTextTransform<TOOLS>>;
+    onStepFinish?: ToolLoopAgentOnStepFinishCallback<TOOLS>;
 } & UIMessageStreamResponseInit & UIMessageStreamOptions<UIMessage<MESSAGE_METADATA, never, InferUITools<TOOLS>>>): Promise<void>;
 
 /**

package/dist/index.js

@@ -1073,7 +1073,7 @@ var import_provider_utils3 = require("@ai-sdk/provider-utils");
 var import_provider_utils4 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.48" : "0.0.0-test";
+var VERSION = true ? "6.0.50" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -7508,12 +7508,16 @@ var ToolLoopAgent = class {
   }
   async prepareCall(options) {
     var _a18, _b, _c, _d;
+    const { onStepFinish: _settingsOnStepFinish, ...settingsWithoutCallback } = this.settings;
     const baseCallArgs = {
-      ...this.settings,
+      ...settingsWithoutCallback,
       stopWhen: (_a18 = this.settings.stopWhen) != null ? _a18 : stepCountIs(20),
       ...options
     };
-    const preparedCallArgs = (_d = await ((_c = (_b = this.settings).prepareCall) == null ? void 0 : _c.call(_b, baseCallArgs))) != null ? _d : baseCallArgs;
+    const preparedCallArgs = (_d = await ((_c = (_b = this.settings).prepareCall) == null ? void 0 : _c.call(
+      _b,
+      baseCallArgs
+    ))) != null ? _d : baseCallArgs;
     const { instructions, messages, prompt, ...callArgs } = preparedCallArgs;
     return {
       ...callArgs,
@@ -7521,18 +7525,30 @@ var ToolLoopAgent = class {
       ...{ system: instructions, messages, prompt }
     };
   }
+  mergeOnStepFinishCallbacks(methodCallback) {
+    const constructorCallback = this.settings.onStepFinish;
+    if (methodCallback && constructorCallback) {
+      return async (stepResult) => {
+        await constructorCallback(stepResult);
+        await methodCallback(stepResult);
+      };
+    }
+    return methodCallback != null ? methodCallback : constructorCallback;
+  }
   /**
    * Generates an output from the agent (non-streaming).
    */
   async generate({
     abortSignal,
     timeout,
+    onStepFinish,
     ...options
   }) {
     return generateText({
       ...await this.prepareCall(options),
       abortSignal,
-      timeout
+      timeout,
+      onStepFinish: this.mergeOnStepFinishCallbacks(onStepFinish)
     });
   }
   /**
@@ -7542,13 +7558,15 @@ var ToolLoopAgent = class {
     abortSignal,
     timeout,
     experimental_transform,
+    onStepFinish,
     ...options
   }) {
     return streamText({
       ...await this.prepareCall(options),
       abortSignal,
       timeout,
-      experimental_transform
+      experimental_transform,
+      onStepFinish: this.mergeOnStepFinishCallbacks(onStepFinish)
     });
   }
 };
@@ -8307,6 +8325,7 @@ async function createAgentUIStream({
   abortSignal,
   timeout,
   experimental_transform,
+  onStepFinish,
   ...uiMessageStreamOptions
 }) {
   const validatedMessages = await validateUIMessages({
@@ -8321,7 +8340,8 @@ async function createAgentUIStream({
     options,
     abortSignal,
     timeout,
-    experimental_transform
+    experimental_transform,
+    onStepFinish
   });
   return result.toUIMessageStream(uiMessageStreamOptions);
 }