@ai-sdk/workflow 1.0.0-beta.4 → 1.0.0-beta.5

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @ai-sdk/workflow
 
+## 1.0.0-beta.5
+
+### Patch Changes
+
+- bf6c17b: Add `id` property to WorkflowAgent for telemetry identification, matching ToolLoopAgent's API surface.
+- 3ca592a: Add `prompt` as an alternative to `messages` in `WorkflowAgent.stream()`, matching the `AgentCallParameters` pattern from ToolLoopAgent.
+- eb49d29: Add constructor-level defaults for `stopWhen`, `activeTools`, `output`, `experimental_repairToolCall`, and `experimental_download` to WorkflowAgent, matching ToolLoopAgent's pattern. Stream-level values override constructor defaults.
+
 ## 1.0.0-beta.4
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { LanguageModelV4, SharedV4ProviderOptions, LanguageModelV4Prompt, LanguageModelV4CallOptions, LanguageModelV4StreamPart } from '@ai-sdk/provider';
-import { ToolSet, LanguageModel, SystemModelMessage, ToolChoice, StepResult, StreamTextOnStepFinishCallback, ModelMessage, FinishReason, LanguageModelUsage, Experimental_LanguageModelStreamPart, StopCondition, LanguageModelResponseMetadata, ToolCallRepairFunction, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
+import { LanguageModelV4, SharedV4ProviderOptions, LanguageModelV4CallOptions, LanguageModelV4Prompt, LanguageModelV4StreamPart } from '@ai-sdk/provider';
+import { ToolSet, LanguageModel, SystemModelMessage, ToolChoice, StopCondition, LanguageModelResponseMetadata, LanguageModelUsage, FinishReason, ToolCallRepairFunction, StepResult, StreamTextOnStepFinishCallback, ModelMessage, Experimental_LanguageModelStreamPart, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
 export { Experimental_LanguageModelStreamPart as ModelCallStreamPart, Output, ToolCallRepairFunction } from 'ai';
 
 /**
@@ -271,6 +271,10 @@ type PrepareCallCallback<TTools extends ToolSet = ToolSet> = (options: PrepareCa
  * Configuration options for creating a {@link WorkflowAgent} instance.
  */
 interface WorkflowAgentOptions<TTools extends ToolSet = ToolSet> extends GenerationSettings {
+    /**
+     * The id of the agent.
+     */
+    id?: string;
     /**
      * The model provider to use for the agent.
      *
@@ -310,6 +314,39 @@ interface WorkflowAgentOptions<TTools extends ToolSet = ToolSet> extends Generat
      * @default undefined
      */
     experimental_context?: unknown;
+    /**
+     * Default stop condition for the agent loop. When the condition is an array,
+     * any of the conditions can be met to stop the generation.
+     *
+     * Per-stream `stopWhen` values passed to `stream()` override this default.
+     */
+    stopWhen?: StopCondition<NoInfer<ToolSet>, any> | Array<StopCondition<NoInfer<ToolSet>, any>>;
+    /**
+     * Default set of active tools that limits which tools the model can call,
+     * without changing the tool call and result types in the result.
+     *
+     * Per-stream `activeTools` values passed to `stream()` override this default.
+     */
+    activeTools?: Array<keyof NoInfer<TTools>>;
+    /**
+     * Default output specification for structured outputs.
+     * Use `Output.object({ schema })` for structured output or `Output.text()` for text output.
+     *
+     * Per-stream `output` values passed to `stream()` override this default.
+     */
+    output?: OutputSpecification<any, any>;
+    /**
+     * Default function that attempts to repair a tool call that failed to parse.
+     *
+     * Per-stream `experimental_repairToolCall` values passed to `stream()` override this default.
+     */
+    experimental_repairToolCall?: ToolCallRepairFunction<TTools>;
+    /**
+     * Default custom download function to use for URLs.
+     *
+     * Per-stream `experimental_download` values passed to `stream()` override this default.
+     */
+    experimental_download?: DownloadFunction;
     /**
      * Default callback function called before each step in the agent loop.
      * Use this to modify settings, manage context, or inject messages dynamically
@@ -439,11 +476,33 @@ type WorkflowAgentOnToolCallFinishCallback = (event: {
 /**
  * Options for the {@link WorkflowAgent.stream} method.
  */
-interface WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never> extends Partial<GenerationSettings> {
+type WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never> = Partial<GenerationSettings> & ({
+    /**
+     * A prompt. It can be either a text prompt or a list of messages.
+     *
+     * You can either use `prompt` or `messages` but not both.
+     */
+    prompt: string | Array<ModelMessage>;
+    /**
+     * A list of messages.
+     *
+     * You can either use `prompt` or `messages` but not both.
+     */
+    messages?: never;
+} | {
     /**
      * The conversation messages to process. Should follow the AI SDK's ModelMessage format.
+     *
+     * You can either use `prompt` or `messages` but not both.
      */
-    messages: ModelMessage[];
+    messages: Array<ModelMessage>;
+    /**
+     * A prompt. It can be either a text prompt or a list of messages.
+     *
+     * You can either use `prompt` or `messages` but not both.
+     */
+    prompt?: never;
+}) & {
     /**
      * Optional system prompt override. If provided, overrides the system prompt from the constructor.
      */
@@ -617,7 +676,7 @@ interface WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, OUTPUT =
      * @default false
      */
     preventClose?: boolean;
-}
+};
 /**
  * A tool call made by the model. Matches the AI SDK's tool call shape.
  */
@@ -717,6 +776,10 @@ interface WorkflowAgentStreamResult<TTools extends ToolSet = ToolSet, OUTPUT = n
  * ```
  */
 declare class WorkflowAgent<TBaseTools extends ToolSet = ToolSet> {
+    /**
+     * The id of the agent.
+     */
+    readonly id: string | undefined;
     private model;
     /**
      * The tool set configured for this agent.
@@ -727,6 +790,11 @@ declare class WorkflowAgent<TBaseTools extends ToolSet = ToolSet> {
     private toolChoice?;
     private telemetry?;
     private experimentalContext;
+    private stopWhen?;
+    private activeTools?;
+    private output?;
+    private experimentalRepairToolCall?;
+    private experimentalDownload?;
     private prepareStep?;
     private constructorOnStepFinish?;
     private constructorOnFinish?;

package/dist/index.mjs

@@ -548,12 +548,18 @@ function sanitizeProviderMetadataForToolCall(metadata) {
 var WorkflowAgent = class {
   constructor(options) {
     var _a, _b;
+    this.id = options.id;
     this.model = options.model;
     this.tools = (_a = options.tools) != null ? _a : {};
     this.instructions = (_b = options.instructions) != null ? _b : options.system;
     this.toolChoice = options.toolChoice;
     this.telemetry = options.experimental_telemetry;
     this.experimentalContext = options.experimental_context;
+    this.stopWhen = options.stopWhen;
+    this.activeTools = options.activeTools;
+    this.output = options.output;
+    this.experimentalRepairToolCall = options.experimental_repairToolCall;
+    this.experimentalDownload = options.experimental_download;
     this.prepareStep = options.prepareStep;
     this.constructorOnStepFinish = options.onStepFinish;
     this.constructorOnFinish = options.onFinish;
@@ -581,14 +587,16 @@ var WorkflowAgent = class {
     throw new Error("Not implemented");
   }
   async stream(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _A;
     let effectiveModel = this.model;
     let effectiveInstructions = (_a = options.system) != null ? _a : this.instructions;
+    let effectivePrompt = options.prompt;
     let effectiveMessages = options.messages;
     let effectiveGenerationSettings = { ...this.generationSettings };
     let effectiveExperimentalContext = (_b = options.experimental_context) != null ? _b : this.experimentalContext;
     let effectiveToolChoiceFromPrepare = (_c = options.toolChoice) != null ? _c : this.toolChoice;
     let effectiveTelemetryFromPrepare = (_d = options.experimental_telemetry) != null ? _d : this.telemetry;
+    const resolvedMessagesForPrepareCall = (_e = effectiveMessages != null ? effectiveMessages : typeof effectivePrompt === "string" ? [{ role: "user", content: effectivePrompt }] : effectivePrompt) != null ? _e : [];
     if (this.prepareCall) {
       const prepared = await this.prepareCall({
         model: effectiveModel,
@@ -597,14 +605,16 @@ var WorkflowAgent = class {
         toolChoice: effectiveToolChoiceFromPrepare,
         experimental_telemetry: effectiveTelemetryFromPrepare,
         experimental_context: effectiveExperimentalContext,
-        messages: effectiveMessages,
+        messages: resolvedMessagesForPrepareCall,
         ...effectiveGenerationSettings
       });
       if (prepared.model !== void 0) effectiveModel = prepared.model;
       if (prepared.instructions !== void 0)
         effectiveInstructions = prepared.instructions;
-      if (prepared.messages !== void 0)
+      if (prepared.messages !== void 0) {
         effectiveMessages = prepared.messages;
+        effectivePrompt = void 0;
+      }
       if (prepared.experimental_context !== void 0)
         effectiveExperimentalContext = prepared.experimental_context;
       if (prepared.toolChoice !== void 0)
@@ -634,7 +644,7 @@ var WorkflowAgent = class {
     }
     const prompt = await standardizePrompt({
       system: effectiveInstructions,
-      messages: effectiveMessages
+      ...effectivePrompt != null ? { prompt: effectivePrompt } : { messages: effectiveMessages }
     });
     const { approvedToolApprovals, deniedToolApprovals } = collectToolApprovalsFromMessages(prompt.messages);
     if (approvedToolApprovals.length > 0 || deniedToolApprovals.length > 0) {
@@ -730,10 +740,10 @@ var WorkflowAgent = class {
     const modelPrompt = await convertToLanguageModelPrompt({
       prompt,
       supportedUrls: {},
-      download: options.experimental_download
+      download: (_f = options.experimental_download) != null ? _f : this.experimentalDownload
     });
     const effectiveAbortSignal = mergeAbortSignals(
-      (_e = options.abortSignal) != null ? _e : effectiveGenerationSettings.abortSignal,
+      (_g = options.abortSignal) != null ? _g : effectiveGenerationSettings.abortSignal,
       options.timeout != null ? AbortSignal.timeout(options.timeout) : void 0
     );
     const mergedGenerationSettings = {
@@ -793,7 +803,8 @@ var WorkflowAgent = class {
     );
     const effectiveToolChoice = effectiveToolChoiceFromPrepare;
     const effectiveTelemetry = effectiveTelemetryFromPrepare;
-    const effectiveTools = options.activeTools && options.activeTools.length > 0 ? filterTools(this.tools, options.activeTools) : this.tools;
+    const effectiveActiveTools = (_h = options.activeTools) != null ? _h : this.activeTools;
+    const effectiveTools = effectiveActiveTools && effectiveActiveTools.length > 0 ? filterTools(this.tools, effectiveActiveTools) : this.tools;
     let experimentalContext = effectiveExperimentalContext;
     const steps = [];
     let lastStepToolCalls = [];
@@ -801,7 +812,7 @@ var WorkflowAgent = class {
     if (mergedOnStart) {
       await mergedOnStart({
         model: effectiveModel,
-        messages: effectiveMessages
+        messages: prompt.messages
       });
     }
     const executeToolWithCallbacks = async (toolCall, tools, messages2, context) => {
@@ -850,12 +861,12 @@ var WorkflowAgent = class {
       }
       return result;
     };
-    if ((_f = mergedGenerationSettings.abortSignal) == null ? void 0 : _f.aborted) {
+    if ((_i = mergedGenerationSettings.abortSignal) == null ? void 0 : _i.aborted) {
       if (options.onAbort) {
         await options.onAbort({ steps });
       }
       return {
-        messages: options.messages,
+        messages: prompt.messages,
         steps,
         toolCalls: [],
         toolResults: [],
@@ -867,19 +878,19 @@ var WorkflowAgent = class {
       tools: effectiveTools,
       writable: options.writable,
       prompt: modelPrompt,
-      stopConditions: options.stopWhen,
+      stopConditions: (_j = options.stopWhen) != null ? _j : this.stopWhen,
       maxSteps: options.maxSteps,
       onStepFinish: mergedOnStepFinish,
       onStepStart: mergedOnStepStart,
       onError: options.onError,
-      prepareStep: (_g = options.prepareStep) != null ? _g : this.prepareStep,
+      prepareStep: (_k = options.prepareStep) != null ? _k : this.prepareStep,
       generationSettings: mergedGenerationSettings,
       toolChoice: effectiveToolChoice,
       experimental_context: experimentalContext,
       experimental_telemetry: effectiveTelemetry,
-      includeRawChunks: (_h = options.includeRawChunks) != null ? _h : false,
-      repairToolCall: options.experimental_repairToolCall,
-      responseFormat: await ((_i = options.output) == null ? void 0 : _i.responseFormat)
+      includeRawChunks: (_l = options.includeRawChunks) != null ? _l : false,
+      repairToolCall: (_m = options.experimental_repairToolCall) != null ? _m : this.experimentalRepairToolCall,
+      responseFormat: await ((_o = (_n = options.output) != null ? _n : this.output) == null ? void 0 : _o.responseFormat)
     });
     let finalMessages;
     let encounteredError;
@@ -887,7 +898,7 @@ var WorkflowAgent = class {
     try {
       let result = await iterator.next();
       while (!result.done) {
-        if ((_j = mergedGenerationSettings.abortSignal) == null ? void 0 : _j.aborted) {
+        if ((_p = mergedGenerationSettings.abortSignal) == null ? void 0 : _p.aborted) {
           wasAborted = true;
           if (options.onAbort) {
             await options.onAbort({ steps });
@@ -980,8 +991,8 @@ var WorkflowAgent = class {
               await mergedOnFinish({
                 steps,
                 messages: messages2,
-                text: (_k = lastStep == null ? void 0 : lastStep.text) != null ? _k : "",
-                finishReason: (_l = lastStep == null ? void 0 : lastStep.finishReason) != null ? _l : "other",
+                text: (_q = lastStep == null ? void 0 : lastStep.text) != null ? _q : "",
+                finishReason: (_r = lastStep == null ? void 0 : lastStep.finishReason) != null ? _r : "other",
                 totalUsage: aggregateUsage(steps),
                 experimental_context: experimentalContext,
                 output: void 0
@@ -1005,8 +1016,8 @@ var WorkflowAgent = class {
               }
             }
             if (options.writable) {
-              const sendFinish = (_m = options.sendFinish) != null ? _m : true;
-              const preventClose = (_n = options.preventClose) != null ? _n : false;
+              const sendFinish = (_s = options.sendFinish) != null ? _s : true;
+              const preventClose = (_t = options.preventClose) != null ? _t : false;
               if (sendFinish || !preventClose) {
                 await closeStream(options.writable, preventClose, sendFinish);
               }
@@ -1099,14 +1110,15 @@ var WorkflowAgent = class {
         await options.onError({ error });
       }
     }
-    const messages = finalMessages != null ? finalMessages : options.messages;
+    const messages = finalMessages != null ? finalMessages : prompt.messages;
+    const effectiveOutput = (_u = options.output) != null ? _u : this.output;
     let experimentalOutput = void 0;
-    if (options.output && steps.length > 0) {
+    if (effectiveOutput && steps.length > 0) {
       const lastStep = steps[steps.length - 1];
       const text = lastStep.text;
       if (text) {
         try {
-          experimentalOutput = await options.output.parseCompleteOutput(
+          experimentalOutput = await effectiveOutput.parseCompleteOutput(
             { text },
             {
               response: lastStep.response,
@@ -1126,8 +1138,8 @@ var WorkflowAgent = class {
       await mergedOnFinish({
         steps,
         messages,
-        text: (_o = lastStep == null ? void 0 : lastStep.text) != null ? _o : "",
-        finishReason: (_p = lastStep == null ? void 0 : lastStep.finishReason) != null ? _p : "other",
+        text: (_v = lastStep == null ? void 0 : lastStep.text) != null ? _v : "",
+        finishReason: (_w = lastStep == null ? void 0 : lastStep.finishReason) != null ? _w : "other",
         totalUsage: aggregateUsage(steps),
         experimental_context: experimentalContext,
         output: experimentalOutput
@@ -1135,8 +1147,8 @@ var WorkflowAgent = class {
     }
     if (encounteredError) {
       if (options.writable) {
-        const sendFinish = (_q = options.sendFinish) != null ? _q : true;
-        const preventClose = (_r = options.preventClose) != null ? _r : false;
+        const sendFinish = (_x = options.sendFinish) != null ? _x : true;
+        const preventClose = (_y = options.preventClose) != null ? _y : false;
         if (sendFinish || !preventClose) {
           await closeStream(options.writable, preventClose, sendFinish);
         }
@@ -1144,8 +1156,8 @@ var WorkflowAgent = class {
       throw encounteredError;
     }
     if (options.writable) {
-      const sendFinish = (_s = options.sendFinish) != null ? _s : true;
-      const preventClose = (_t = options.preventClose) != null ? _t : false;
+      const sendFinish = (_z = options.sendFinish) != null ? _z : true;
+      const preventClose = (_A = options.preventClose) != null ? _A : false;
       if (sendFinish || !preventClose) {
         await closeStream(options.writable, preventClose, sendFinish);
       }