ai 6.0.0-beta.141 → 6.0.0-beta.143

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # ai
 
+## 6.0.0-beta.143
+
+### Patch Changes
+
+- 81e29ab: feat(ai): allow modifying experimental context in prepareStep
+- Updated dependencies [81e29ab]
+  - @ai-sdk/provider-utils@4.0.0-beta.46
+  - @ai-sdk/gateway@2.0.0-beta.75
+
+## 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

package/dist/index.d.mts

@@ -1051,28 +1051,74 @@ type DownloadFunction = (options: Array<{
 } | null>>;
 
 /**
-Function that you can use to provide different settings for a step.
-
-@param options - The options for the 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.
-
-@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.
-    */
+ * Function that you can use to provide different settings for a step.
+ *
+ * @param options - The options for the 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.
+ */
 type PrepareStepFunction<TOOLS extends Record<string, Tool> = Record<string, Tool>> = (options: {
+    /**
+     * The steps that have been executed so far.
+     */
     steps: Array<StepResult<NoInfer<TOOLS>>>;
+    /**
+     * The number of the step that is being executed.
+     */
     stepNumber: number;
+    /**
+     * The model instance that is being used for this step.
+     */
     model: LanguageModel;
+    /**
+     * The messages that will be sent to the model for the current step.
+     */
     messages: Array<ModelMessage>;
+    /**
+     * The context passed via the experimental_context setting (experimental).
+     */
+    experimental_context: unknown;
 }) => PromiseLike<PrepareStepResult<TOOLS>> | PrepareStepResult<TOOLS>;
+/**
+ * The result type returned by a {@link PrepareStepFunction},
+ * allowing per-step overrides of model, tools, or messages.
+ */
 type PrepareStepResult<TOOLS extends Record<string, Tool> = Record<string, Tool>> = {
+    /**
+     * Optionally override which LanguageModel instance is used for this step.
+     */
     model?: LanguageModel;
+    /**
+     * Optionally set which tool the model must call, or provide tool call configuration
+     * for this step.
+     */
     toolChoice?: ToolChoice<NoInfer<TOOLS>>;
+    /**
+     * If provided, only these tools are enabled/available for this step.
+     */
     activeTools?: Array<keyof NoInfer<TOOLS>>;
+    /**
+     * Optionally override the system message(s) sent to the model for this step.
+     */
     system?: string | SystemModelMessage | Array<SystemModelMessage>;
+    /**
+     * Optionally override the full set of messages sent to the model
+     * for this step.
+     */
     messages?: Array<ModelMessage>;
+    /**
+     * Context that is passed into tool execution. Experimental.
+     *
+     * Changing the context will affect the context in this step
+     * and all subsequent steps.
+     */
+    experimental_context?: unknown;
 } | undefined;
 
 type StopCondition<TOOLS extends ToolSet> = (options: {
@@ -2682,13 +2728,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

@@ -1051,28 +1051,74 @@ type DownloadFunction = (options: Array<{
 } | null>>;
 
 /**
-Function that you can use to provide different settings for a step.
-
-@param options - The options for the 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.
-
-@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.
-    */
+ * Function that you can use to provide different settings for a step.
+ *
+ * @param options - The options for the 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.
+ */
 type PrepareStepFunction<TOOLS extends Record<string, Tool> = Record<string, Tool>> = (options: {
+    /**
+     * The steps that have been executed so far.
+     */
     steps: Array<StepResult<NoInfer<TOOLS>>>;
+    /**
+     * The number of the step that is being executed.
+     */
     stepNumber: number;
+    /**
+     * The model instance that is being used for this step.
+     */
     model: LanguageModel;
+    /**
+     * The messages that will be sent to the model for the current step.
+     */
     messages: Array<ModelMessage>;
+    /**
+     * The context passed via the experimental_context setting (experimental).
+     */
+    experimental_context: unknown;
 }) => PromiseLike<PrepareStepResult<TOOLS>> | PrepareStepResult<TOOLS>;
+/**
+ * The result type returned by a {@link PrepareStepFunction},
+ * allowing per-step overrides of model, tools, or messages.
+ */
 type PrepareStepResult<TOOLS extends Record<string, Tool> = Record<string, Tool>> = {
+    /**
+     * Optionally override which LanguageModel instance is used for this step.
+     */
     model?: LanguageModel;
+    /**
+     * Optionally set which tool the model must call, or provide tool call configuration
+     * for this step.
+     */
     toolChoice?: ToolChoice<NoInfer<TOOLS>>;
+    /**
+     * If provided, only these tools are enabled/available for this step.
+     */
     activeTools?: Array<keyof NoInfer<TOOLS>>;
+    /**
+     * Optionally override the system message(s) sent to the model for this step.
+     */
     system?: string | SystemModelMessage | Array<SystemModelMessage>;
+    /**
+     * Optionally override the full set of messages sent to the model
+     * for this step.
+     */
     messages?: Array<ModelMessage>;
+    /**
+     * Context that is passed into tool execution. Experimental.
+     *
+     * Changing the context will affect the context in this step
+     * and all subsequent steps.
+     */
+    experimental_context?: unknown;
 } | undefined;
 
 type StopCondition<TOOLS extends ToolSet> = (options: {
@@ -2682,13 +2728,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.141" : "0.0.0-test";
+var VERSION = true ? "6.0.0-beta.143" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -3495,7 +3495,7 @@ async function generateText({
       }),
       tracer,
       fn: async (span) => {
-        var _a15, _b, _c, _d, _e, _f, _g;
+        var _a15, _b, _c, _d, _e, _f, _g, _h;
         const initialMessages = initialPrompt.messages;
         const responseMessages = [];
         const { approvedToolApprovals, deniedToolApprovals } = collectToolApprovals({ messages: initialMessages });
@@ -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
@@ -3562,10 +3563,11 @@ async function generateText({
             supportedUrls: await stepModel.supportedUrls,
             download: download2
           });
+          experimental_context = (_d = prepareStepResult == null ? void 0 : prepareStepResult.experimental_context) != null ? _d : experimental_context;
           const { toolChoice: stepToolChoice, tools: stepTools } = await prepareToolsAndToolChoice({
             tools,
-            toolChoice: (_d = prepareStepResult == null ? void 0 : prepareStepResult.toolChoice) != null ? _d : toolChoice,
-            activeTools: (_e = prepareStepResult == null ? void 0 : prepareStepResult.activeTools) != null ? _e : activeTools
+            toolChoice: (_e = prepareStepResult == null ? void 0 : prepareStepResult.toolChoice) != null ? _e : toolChoice,
+            activeTools: (_f = prepareStepResult == null ? void 0 : prepareStepResult.activeTools) != null ? _f : activeTools
           });
           currentModelResponse = await retry(
             () => {
@@ -3608,7 +3610,7 @@ async function generateText({
                 }),
                 tracer,
                 fn: async (span2) => {
-                  var _a17, _b2, _c2, _d2, _e2, _f2, _g2, _h;
+                  var _a17, _b2, _c2, _d2, _e2, _f2, _g2, _h2;
                   const result = await stepModel.doGenerate({
                     ...callSettings2,
                     tools: stepTools,
@@ -3624,7 +3626,7 @@ async function generateText({
                     timestamp: (_d2 = (_c2 = result.response) == null ? void 0 : _c2.timestamp) != null ? _d2 : currentDate(),
                     modelId: (_f2 = (_e2 = result.response) == null ? void 0 : _e2.modelId) != null ? _f2 : stepModel.modelId,
                     headers: (_g2 = result.response) == null ? void 0 : _g2.headers,
-                    body: (_h = result.response) == null ? void 0 : _h.body
+                    body: (_h2 = result.response) == null ? void 0 : _h2.body
                   };
                   span2.setAttributes(
                     await selectTelemetryAttributes({
@@ -3757,7 +3759,7 @@ async function generateText({
             usage: asLanguageModelUsage(currentModelResponse.usage),
             warnings: currentModelResponse.warnings,
             providerMetadata: currentModelResponse.providerMetadata,
-            request: (_f = currentModelResponse.request) != null ? _f : {},
+            request: (_g = currentModelResponse.request) != null ? _g : {},
             response: {
               ...currentModelResponse.response,
               // deep clone msgs to avoid mutating past messages in multi-step:
@@ -3765,7 +3767,7 @@ async function generateText({
             }
           });
           logWarnings({
-            warnings: (_g = currentModelResponse.warnings) != null ? _g : [],
+            warnings: (_h = currentModelResponse.warnings) != null ? _h : [],
             provider: stepModel.provider,
             model: stepModel.modelId
           });
@@ -5935,7 +5937,7 @@ var DefaultStreamTextResult = class {
           responseMessages,
           usage
         }) {
-          var _a15, _b, _c, _d, _e;
+          var _a15, _b, _c, _d, _e, _f;
           const includeRawChunks2 = self.includeRawChunks;
           stepFinish = new import_provider_utils17.DelayedPromise();
           const stepInputMessages = [...initialMessages, ...responseMessages];
@@ -5943,7 +5945,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
@@ -5961,6 +5964,7 @@ var DefaultStreamTextResult = class {
             toolChoice: (_d = prepareStepResult == null ? void 0 : prepareStepResult.toolChoice) != null ? _d : toolChoice,
             activeTools: (_e = prepareStepResult == null ? void 0 : prepareStepResult.activeTools) != null ? _e : activeTools
           });
+          experimental_context = (_f = prepareStepResult == null ? void 0 : prepareStepResult.experimental_context) != null ? _f : experimental_context;
           const {
             result: { stream: stream2, response, request },
             doStreamSpan,