ai 4.3.9 → 4.3.10

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 4.3.10
+
+### Patch Changes
+
+- 0432959: feat (ai): add experimental prepareStep callback to generateText
+
 ## 4.3.9
 
 ### Patch Changes

package/dist/index.d.mts

@@ -2463,7 +2463,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata, providerOptions, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata, providerOptions, experimental_activeTools: activeTools, experimental_prepareStep: prepareStep, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -2518,6 +2518,28 @@ Optional specification for parsing structured outputs from the LLM response.
      */
     experimental_output?: Output<OUTPUT, OUTPUT_PARTIAL>;
     /**
+Optional 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.maxSteps - The maximum number of steps.
+@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.
+    */
+    experimental_prepareStep?: (options: {
+        steps: Array<StepResult<TOOLS>>;
+        stepNumber: number;
+        maxSteps: number;
+        model: LanguageModel;
+    }) => PromiseLike<{
+        model?: LanguageModel;
+        toolChoice?: ToolChoice<TOOLS>;
+        experimental_activeTools?: Array<keyof TOOLS>;
+    } | undefined>;
+    /**
 A function that attempts to repair a tool call that failed to parse.
      */
     experimental_repairToolCall?: ToolCallRepairFunction<TOOLS>;

package/dist/index.d.ts

@@ -2463,7 +2463,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata, providerOptions, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_generateMessageId: generateMessageId, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata, providerOptions, experimental_activeTools: activeTools, experimental_prepareStep: prepareStep, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -2518,6 +2518,28 @@ Optional specification for parsing structured outputs from the LLM response.
      */
     experimental_output?: Output<OUTPUT, OUTPUT_PARTIAL>;
     /**
+Optional 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.maxSteps - The maximum number of steps.
+@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.
+    */
+    experimental_prepareStep?: (options: {
+        steps: Array<StepResult<TOOLS>>;
+        stepNumber: number;
+        maxSteps: number;
+        model: LanguageModel;
+    }) => PromiseLike<{
+        model?: LanguageModel;
+        toolChoice?: ToolChoice<TOOLS>;
+        experimental_activeTools?: Array<keyof TOOLS>;
+    } | undefined>;
+    /**
 A function that attempts to repair a tool call that failed to parse.
      */
     experimental_repairToolCall?: ToolCallRepairFunction<TOOLS>;

package/dist/index.js

@@ -4175,6 +4175,7 @@ async function generateText({
   experimental_providerMetadata,
   providerOptions = experimental_providerMetadata,
   experimental_activeTools: activeTools,
+  experimental_prepareStep: prepareStep,
   experimental_repairToolCall: repairToolCall,
   _internal: {
     generateId: generateId3 = originalGenerateId3,
@@ -4217,6 +4218,9 @@ async function generateText({
           telemetry
         }),
         ...baseTelemetryAttributes,
+        // model:
+        "ai.model.provider": model.provider,
+        "ai.model.id": model.modelId,
         // specific settings that only make sense on the outer level:
         "ai.prompt": {
           input: () => JSON.stringify({ system, prompt, messages })
@@ -4226,11 +4230,7 @@ async function generateText({
     }),
     tracer,
     fn: async (span) => {
-      var _a18, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k;
-      const mode = {
-        type: "regular",
-        ...prepareToolsAndToolChoice({ tools, toolChoice, activeTools })
-      };
+      var _a18, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n;
       const callSettings = prepareCallSettings(settings);
       let currentModelResponse;
       let currentToolCalls = [];
@@ -4253,16 +4253,33 @@ async function generateText({
           ...initialPrompt.messages,
           ...responseMessages
         ];
+        const prepareStepResult = await (prepareStep == null ? void 0 : prepareStep({
+          model,
+          steps,
+          maxSteps,
+          stepNumber: stepCount
+        }));
+        const stepToolChoice = (_a18 = prepareStepResult == null ? void 0 : prepareStepResult.toolChoice) != null ? _a18 : toolChoice;
+        const stepActiveTools = (_b = prepareStepResult == null ? void 0 : prepareStepResult.experimental_activeTools) != null ? _b : activeTools;
+        const stepModel = (_c = prepareStepResult == null ? void 0 : prepareStepResult.model) != null ? _c : model;
         const promptMessages = await convertToLanguageModelPrompt({
           prompt: {
             type: promptFormat,
             system: initialPrompt.system,
             messages: stepInputMessages
           },
-          modelSupportsImageUrls: model.supportsImageUrls,
-          modelSupportsUrl: (_a18 = model.supportsUrl) == null ? void 0 : _a18.bind(model)
+          modelSupportsImageUrls: stepModel.supportsImageUrls,
+          modelSupportsUrl: (_d = stepModel.supportsUrl) == null ? void 0 : _d.bind(stepModel)
           // support 'this' context
         });
+        const mode = {
+          type: "regular",
+          ...prepareToolsAndToolChoice({
+            tools,
+            toolChoice: stepToolChoice,
+            activeTools: stepActiveTools
+          })
+        };
         currentModelResponse = await retry(
           () => recordSpan({
             name: "ai.generateText.doGenerate",
@@ -4274,6 +4291,10 @@ async function generateText({
                   telemetry
                 }),
                 ...baseTelemetryAttributes,
+                // model:
+                "ai.model.provider": stepModel.provider,
+                "ai.model.id": stepModel.modelId,
+                // prompt:
                 "ai.prompt.format": { input: () => promptFormat },
                 "ai.prompt.messages": {
                   input: () => JSON.stringify(promptMessages)
@@ -4289,8 +4310,8 @@ async function generateText({
                   input: () => mode.toolChoice != null ? JSON.stringify(mode.toolChoice) : void 0
                 },
                 // standardized gen-ai llm span attributes:
-                "gen_ai.system": model.provider,
-                "gen_ai.request.model": model.modelId,
+                "gen_ai.system": stepModel.provider,
+                "gen_ai.request.model": stepModel.modelId,
                 "gen_ai.request.frequency_penalty": settings.frequencyPenalty,
                 "gen_ai.request.max_tokens": settings.maxTokens,
                 "gen_ai.request.presence_penalty": settings.presencePenalty,
@@ -4303,7 +4324,7 @@ async function generateText({
             tracer,
             fn: async (span2) => {
               var _a19, _b2, _c2, _d2, _e2, _f2;
-              const result = await model.doGenerate({
+              const result = await stepModel.doGenerate({
                 mode,
                 ...callSettings,
                 inputFormat: promptFormat,
@@ -4316,7 +4337,7 @@ async function generateText({
               const responseData = {
                 id: (_b2 = (_a19 = result.response) == null ? void 0 : _a19.id) != null ? _b2 : generateId3(),
                 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 : model.modelId
+                modelId: (_f2 = (_e2 = result.response) == null ? void 0 : _e2.modelId) != null ? _f2 : stepModel.modelId
               };
               span2.setAttributes(
                 selectTelemetryAttributes({
@@ -4348,7 +4369,7 @@ async function generateText({
           })
         );
         currentToolCalls = await Promise.all(
-          ((_b = currentModelResponse.toolCalls) != null ? _b : []).map(
+          ((_e = currentModelResponse.toolCalls) != null ? _e : []).map(
             (toolCall) => parseToolCall({
               toolCall,
               tools,
@@ -4383,7 +4404,7 @@ async function generateText({
             nextStepType = "tool-result";
           }
         }
-        const originalText = (_c = currentModelResponse.text) != null ? _c : "";
+        const originalText = (_f = currentModelResponse.text) != null ? _f : "";
         const stepTextLeadingWhitespaceTrimmed = stepType === "continue" && // only for continue steps
         text2.trimEnd() !== text2 ? originalText.trimStart() : originalText;
         const stepText = nextStepType === "continue" ? removeTextAfterLastWhitespace(stepTextLeadingWhitespaceTrimmed) : stepTextLeadingWhitespaceTrimmed;
@@ -4391,7 +4412,7 @@ async function generateText({
         currentReasoningDetails = asReasoningDetails(
           currentModelResponse.reasoning
         );
-        sources.push(...(_d = currentModelResponse.sources) != null ? _d : []);
+        sources.push(...(_g = currentModelResponse.sources) != null ? _g : []);
         if (stepType === "continue") {
           const lastMessage = responseMessages[responseMessages.length - 1];
           if (typeof lastMessage.content === "string") {
@@ -4423,18 +4444,18 @@ async function generateText({
           reasoning: asReasoningText(currentReasoningDetails),
           reasoningDetails: currentReasoningDetails,
           files: asFiles(currentModelResponse.files),
-          sources: (_e = currentModelResponse.sources) != null ? _e : [],
+          sources: (_h = currentModelResponse.sources) != null ? _h : [],
           toolCalls: currentToolCalls,
           toolResults: currentToolResults,
           finishReason: currentModelResponse.finishReason,
           usage: currentUsage,
           warnings: currentModelResponse.warnings,
           logprobs: currentModelResponse.logprobs,
-          request: (_f = currentModelResponse.request) != null ? _f : {},
+          request: (_i = currentModelResponse.request) != null ? _i : {},
           response: {
             ...currentModelResponse.response,
-            headers: (_g = currentModelResponse.rawResponse) == null ? void 0 : _g.headers,
-            body: (_h = currentModelResponse.rawResponse) == null ? void 0 : _h.body,
+            headers: (_j = currentModelResponse.rawResponse) == null ? void 0 : _j.headers,
+            body: (_k = currentModelResponse.rawResponse) == null ? void 0 : _k.body,
             // deep clone msgs to avoid mutating past messages in multi-step:
             messages: structuredClone(responseMessages)
           },
@@ -4486,11 +4507,11 @@ async function generateText({
         finishReason: currentModelResponse.finishReason,
         usage,
         warnings: currentModelResponse.warnings,
-        request: (_i = currentModelResponse.request) != null ? _i : {},
+        request: (_l = currentModelResponse.request) != null ? _l : {},
         response: {
           ...currentModelResponse.response,
-          headers: (_j = currentModelResponse.rawResponse) == null ? void 0 : _j.headers,
-          body: (_k = currentModelResponse.rawResponse) == null ? void 0 : _k.body,
+          headers: (_m = currentModelResponse.rawResponse) == null ? void 0 : _m.headers,
+          body: (_n = currentModelResponse.rawResponse) == null ? void 0 : _n.body,
           messages: responseMessages
         },
         logprobs: currentModelResponse.logprobs,