ai 6.0.0-beta.140 → 6.0.0-beta.142

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # ai
 
+## 6.0.0-beta.142
+
+### Patch Changes
+
+- 7169511: feat(agent): support context in onFinish callback
+- bbdcb81: Add experimental_context parameter to prepareStep callback
+
+## 6.0.0-beta.141
+
+### Patch Changes
+
+- b1405bf: feat(ai): send context into streamText / generateText onFinish callbacks
+
 ## 6.0.0-beta.140
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1057,6 +1057,8 @@ Function that you can use to provide different settings for a step.
 @param options.steps - The steps that have been executed so far.
 @param options.stepNumber - The number of the step that is being executed.
 @param options.model - The model that is being used.
+@param options.messages - The messages that will be sent to the model for the current step.
+@param options.experimental_context - The context passed via the experimental_context setting (experimental).
 
 @returns An object that contains the settings for the step.
 If you return undefined (or for undefined settings), the settings from the outer level will be used.
@@ -1066,6 +1068,7 @@ type PrepareStepFunction<TOOLS extends Record<string, Tool> = Record<string, Too
     stepNumber: number;
     model: LanguageModel;
     messages: Array<ModelMessage>;
+    experimental_context?: unknown;
 }) => PromiseLike<PrepareStepResult<TOOLS>> | PrepareStepResult<TOOLS>;
 type PrepareStepResult<TOOLS extends Record<string, Tool> = Record<string, Tool>> = {
     model?: LanguageModel;
@@ -1151,13 +1154,21 @@ Callback that is set using the `onFinish` option.
  */
 type GenerateTextOnFinishCallback<TOOLS extends ToolSet> = (event: StepResult<TOOLS> & {
     /**
-Details for all steps.
-   */
+     * Details for all steps.
+     */
     readonly steps: StepResult<TOOLS>[];
     /**
-Total usage for all steps. This is the sum of the usage of all steps.
+     * Total usage for all steps. This is the sum of the usage of all steps.
      */
     readonly totalUsage: LanguageModelUsage;
+    /**
+     * Context that is passed into tool execution.
+     *
+     * Experimental (can break in patch releases).
+     *
+     * @default undefined
+     */
+    experimental_context: unknown;
 }) => PromiseLike<void> | void;
 /**
 Generate a text and call tools for a given prompt using a language model.
@@ -2389,13 +2400,21 @@ Callback that is set using the `onFinish` option.
  */
 type StreamTextOnFinishCallback<TOOLS extends ToolSet> = (event: StepResult<TOOLS> & {
     /**
-Details for all steps.
-   */
+     * Details for all steps.
+     */
     readonly steps: StepResult<TOOLS>[];
     /**
-Total usage for all steps. This is the sum of the usage of all steps.
+     * Total usage for all steps. This is the sum of the usage of all steps.
      */
     readonly totalUsage: LanguageModelUsage;
+    /**
+     * Context that is passed into tool execution.
+     *
+     * Experimental (can break in patch releases).
+     *
+     * @default undefined
+     */
+    experimental_context: unknown;
 }) => PromiseLike<void> | void;
 /**
 Callback that is set using the `onAbort` option.
@@ -2666,13 +2685,21 @@ Callback that is set using the `onFinish` option.
  */
 type ToolLoopAgentOnFinishCallback<TOOLS extends ToolSet = {}> = (event: StepResult<TOOLS> & {
     /**
-Details for all steps.
-   */
+     * Details for all steps.
+     */
     readonly steps: StepResult<TOOLS>[];
     /**
-Total usage for all steps. This is the sum of the usage of all steps.
+     * Total usage for all steps. This is the sum of the usage of all steps.
      */
     readonly totalUsage: LanguageModelUsage;
+    /**
+     * Context that is passed into tool calls.
+     *
+     * Experimental (can break in patch releases).
+     *
+     * @default undefined
+     */
+    experimental_context?: unknown;
 }) => PromiseLike<void> | void;
 
 /**

package/dist/index.d.ts

@@ -1057,6 +1057,8 @@ Function that you can use to provide different settings for a step.
 @param options.steps - The steps that have been executed so far.
 @param options.stepNumber - The number of the step that is being executed.
 @param options.model - The model that is being used.
+@param options.messages - The messages that will be sent to the model for the current step.
+@param options.experimental_context - The context passed via the experimental_context setting (experimental).
 
 @returns An object that contains the settings for the step.
 If you return undefined (or for undefined settings), the settings from the outer level will be used.
@@ -1066,6 +1068,7 @@ type PrepareStepFunction<TOOLS extends Record<string, Tool> = Record<string, Too
     stepNumber: number;
     model: LanguageModel;
     messages: Array<ModelMessage>;
+    experimental_context?: unknown;
 }) => PromiseLike<PrepareStepResult<TOOLS>> | PrepareStepResult<TOOLS>;
 type PrepareStepResult<TOOLS extends Record<string, Tool> = Record<string, Tool>> = {
     model?: LanguageModel;
@@ -1151,13 +1154,21 @@ Callback that is set using the `onFinish` option.
  */
 type GenerateTextOnFinishCallback<TOOLS extends ToolSet> = (event: StepResult<TOOLS> & {
     /**
-Details for all steps.
-   */
+     * Details for all steps.
+     */
     readonly steps: StepResult<TOOLS>[];
     /**
-Total usage for all steps. This is the sum of the usage of all steps.
+     * Total usage for all steps. This is the sum of the usage of all steps.
      */
     readonly totalUsage: LanguageModelUsage;
+    /**
+     * Context that is passed into tool execution.
+     *
+     * Experimental (can break in patch releases).
+     *
+     * @default undefined
+     */
+    experimental_context: unknown;
 }) => PromiseLike<void> | void;
 /**
 Generate a text and call tools for a given prompt using a language model.
@@ -2389,13 +2400,21 @@ Callback that is set using the `onFinish` option.
  */
 type StreamTextOnFinishCallback<TOOLS extends ToolSet> = (event: StepResult<TOOLS> & {
     /**
-Details for all steps.
-   */
+     * Details for all steps.
+     */
     readonly steps: StepResult<TOOLS>[];
     /**
-Total usage for all steps. This is the sum of the usage of all steps.
+     * Total usage for all steps. This is the sum of the usage of all steps.
      */
     readonly totalUsage: LanguageModelUsage;
+    /**
+     * Context that is passed into tool execution.
+     *
+     * Experimental (can break in patch releases).
+     *
+     * @default undefined
+     */
+    experimental_context: unknown;
 }) => PromiseLike<void> | void;
 /**
 Callback that is set using the `onAbort` option.
@@ -2666,13 +2685,21 @@ Callback that is set using the `onFinish` option.
  */
 type ToolLoopAgentOnFinishCallback<TOOLS extends ToolSet = {}> = (event: StepResult<TOOLS> & {
     /**
-Details for all steps.
-   */
+     * Details for all steps.
+     */
     readonly steps: StepResult<TOOLS>[];
     /**
-Total usage for all steps. This is the sum of the usage of all steps.
+     * Total usage for all steps. This is the sum of the usage of all steps.
      */
     readonly totalUsage: LanguageModelUsage;
+    /**
+     * Context that is passed into tool calls.
+     *
+     * Experimental (can break in patch releases).
+     *
+     * @default undefined
+     */
+    experimental_context?: unknown;
 }) => PromiseLike<void> | void;
 
 /**

package/dist/index.js

@@ -962,7 +962,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.0-beta.140" : "0.0.0-test";
+var VERSION = true ? "6.0.0-beta.142" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -3549,7 +3549,8 @@ async function generateText({
             model,
             steps,
             stepNumber: steps.length,
-            messages: stepInputMessages
+            messages: stepInputMessages,
+            experimental_context
           }));
           const stepModel = resolveLanguageModel(
             (_a15 = prepareStepResult == null ? void 0 : prepareStepResult.model) != null ? _a15 : model
@@ -3833,7 +3834,8 @@ async function generateText({
           warnings: lastStep.warnings,
           providerMetadata: lastStep.providerMetadata,
           steps,
-          totalUsage
+          totalUsage,
+          experimental_context
         }));
         let resolvedOutput;
         if (lastStep.finishReason === "stop") {
@@ -5742,7 +5744,8 @@ var DefaultStreamTextResult = class {
             response: finalStep.response,
             warnings: finalStep.warnings,
             providerMetadata: finalStep.providerMetadata,
-            steps: recordedSteps
+            steps: recordedSteps,
+            experimental_context
           }));
           rootSpan.setAttributes(
             await selectTelemetryAttributes({
@@ -5941,7 +5944,8 @@ var DefaultStreamTextResult = class {
             model,
             steps: recordedSteps,
             stepNumber: recordedSteps.length,
-            messages: stepInputMessages
+            messages: stepInputMessages,
+            experimental_context
           }));
           const stepModel = resolveLanguageModel(
             (_a15 = prepareStepResult == null ? void 0 : prepareStepResult.model) != null ? _a15 : model