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

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/workflow
 
+## 1.0.0-beta.4
+
+### Patch Changes
+
+- ai@7.0.0-beta.92
+
+## 1.0.0-beta.3
+
+### Patch Changes
+
+- 0e462a7: Use `LanguageModel` type for model parameter, aligning with `ToolLoopAgent`. Remove async factory model form. Rename callback types to use `WorkflowAgentOn*` prefix.
+
 ## 1.0.0-beta.2
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import { LanguageModelV4, SharedV4ProviderOptions, LanguageModelV4Prompt, LanguageModelV4CallOptions, LanguageModelV4StreamPart } from '@ai-sdk/provider';
-import { ToolSet, SystemModelMessage, ToolChoice, StepResult, StreamTextOnStepFinishCallback, ModelMessage, FinishReason, LanguageModelUsage, Experimental_LanguageModelStreamPart, StopCondition, LanguageModelResponseMetadata, ToolCallRepairFunction, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
+import { ToolSet, LanguageModel, SystemModelMessage, ToolChoice, StepResult, StreamTextOnStepFinishCallback, ModelMessage, FinishReason, LanguageModelUsage, Experimental_LanguageModelStreamPart, StopCondition, LanguageModelResponseMetadata, ToolCallRepairFunction, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
 export { Experimental_LanguageModelStreamPart as ModelCallStreamPart, Output, ToolCallRepairFunction } from 'ai';
 
 /**
@@ -13,6 +13,12 @@ export { Experimental_LanguageModelStreamPart as ModelCallStreamPart, Output, To
  */
 type CompatibleLanguageModel = LanguageModelV4;
 
+/**
+ * Callback function to be called after each step completes.
+ * Alias for the AI SDK's StreamTextOnStepFinishCallback, using
+ * WorkflowAgent-consistent naming.
+ */
+type WorkflowAgentOnStepFinishCallback<TTools extends ToolSet = ToolSet> = StreamTextOnStepFinishCallback<TTools, any>;
 /**
  * Infer the type of the tools of a workflow agent.
  */
@@ -181,7 +187,7 @@ interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
      * The current model configuration (string or function).
      * The function should return a LanguageModelV4 instance.
      */
-    model: string | CompatibleLanguageModel | (() => Promise<CompatibleLanguageModel>);
+    model: LanguageModel;
     /**
      * The current step number (0-indexed).
      */
@@ -207,9 +213,8 @@ interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
 interface PrepareStepResult extends Partial<GenerationSettings> {
     /**
      * Override the model for this step.
-     * The function should return a LanguageModelV4 instance.
      */
-    model?: string | CompatibleLanguageModel | (() => Promise<CompatibleLanguageModel>);
+    model?: LanguageModel;
     /**
      * Override the system message for this step.
      */
@@ -243,7 +248,7 @@ type PrepareStepCallback<TTools extends ToolSet = ToolSet> = (info: PrepareStepI
  * Options passed to the prepareCall callback.
  */
 interface PrepareCallOptions<TTools extends ToolSet = ToolSet> extends Partial<GenerationSettings> {
-    model: string | CompatibleLanguageModel | (() => Promise<CompatibleLanguageModel>);
+    model: LanguageModel;
     tools: TTools;
     instructions?: string | SystemModelMessage | Array<SystemModelMessage>;
     toolChoice?: ToolChoice<TTools>;
@@ -270,9 +275,9 @@ interface WorkflowAgentOptions<TTools extends ToolSet = ToolSet> extends Generat
      * The model provider to use for the agent.
      *
      * This should be a string compatible with the Vercel AI Gateway (e.g., 'anthropic/claude-opus'),
-     * or a step function that returns a LanguageModelV4 instance.
+     * or a LanguageModelV4 instance from a provider.
      */
-    model: string | CompatibleLanguageModel | (() => Promise<CompatibleLanguageModel>);
+    model: LanguageModel;
     /**
      * A set of tools available to the agent.
      * Tools can be implemented as workflow steps for automatic retries and persistence,
@@ -316,11 +321,11 @@ interface WorkflowAgentOptions<TTools extends ToolSet = ToolSet> extends Generat
     /**
      * Callback function to be called after each step completes.
      */
-    onStepFinish?: StreamTextOnStepFinishCallback<ToolSet, any>;
+    onStepFinish?: WorkflowAgentOnStepFinishCallback<ToolSet>;
     /**
      * Callback that is called when the LLM response and all request tool executions are finished.
      */
-    onFinish?: StreamTextOnFinishCallback<ToolSet>;
+    onFinish?: WorkflowAgentOnFinishCallback<ToolSet>;
     /**
      * Callback called when the agent starts streaming, before any LLM calls.
      */
@@ -347,7 +352,7 @@ interface WorkflowAgentOptions<TTools extends ToolSet = ToolSet> extends Generat
 /**
  * Callback that is called when the LLM response and all request tool executions are finished.
  */
-type StreamTextOnFinishCallback<TTools extends ToolSet = ToolSet, OUTPUT = never> = (event: {
+type WorkflowAgentOnFinishCallback<TTools extends ToolSet = ToolSet, OUTPUT = never> = (event: {
     /**
      * Details for all steps.
      */
@@ -381,13 +386,13 @@ type StreamTextOnFinishCallback<TTools extends ToolSet = ToolSet, OUTPUT = never
 /**
  * Callback that is invoked when an error occurs during streaming.
  */
-type StreamTextOnErrorCallback = (event: {
+type WorkflowAgentOnErrorCallback = (event: {
     error: unknown;
 }) => PromiseLike<void> | void;
 /**
  * Callback that is set using the `onAbort` option.
  */
-type StreamTextOnAbortCallback<TTools extends ToolSet = ToolSet> = (event: {
+type WorkflowAgentOnAbortCallback<TTools extends ToolSet = ToolSet> = (event: {
     /**
      * Details for all previously finished steps.
      */
@@ -398,7 +403,7 @@ type StreamTextOnAbortCallback<TTools extends ToolSet = ToolSet> = (event: {
  */
 type WorkflowAgentOnStartCallback = (event: {
     /** The model being used */
-    readonly model: string | CompatibleLanguageModel | (() => Promise<CompatibleLanguageModel>);
+    readonly model: LanguageModel;
     /** The messages being sent */
     readonly messages: ModelMessage[];
 }) => PromiseLike<void> | void;
@@ -409,7 +414,7 @@ type WorkflowAgentOnStepStartCallback = (event: {
     /** The current step number (0-based) */
     readonly stepNumber: number;
     /** The model being used for this step */
-    readonly model: string | CompatibleLanguageModel | (() => Promise<CompatibleLanguageModel>);
+    readonly model: LanguageModel;
     /** The messages being sent for this step */
     readonly messages: ModelMessage[];
 }) => PromiseLike<void> | void;
@@ -546,21 +551,21 @@ interface WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, OUTPUT =
     /**
      * Callback function to be called after each step completes.
      */
-    onStepFinish?: StreamTextOnStepFinishCallback<TTools, any>;
+    onStepFinish?: WorkflowAgentOnStepFinishCallback<TTools>;
     /**
      * Callback that is invoked when an error occurs during streaming.
      * You can use it to log errors.
      */
-    onError?: StreamTextOnErrorCallback;
+    onError?: WorkflowAgentOnErrorCallback;
     /**
      * Callback that is called when the LLM response and all request tool executions
      * (for tools that have an `execute` function) are finished.
      */
-    onFinish?: StreamTextOnFinishCallback<TTools, OUTPUT>;
+    onFinish?: WorkflowAgentOnFinishCallback<TTools, OUTPUT>;
     /**
      * Callback that is called when the operation is aborted.
      */
-    onAbort?: StreamTextOnAbortCallback<TTools>;
+    onAbort?: WorkflowAgentOnAbortCallback<TTools>;
     /**
      * Callback called when the agent starts streaming, before any LLM calls.
      */
@@ -901,4 +906,4 @@ declare class WorkflowChatTransport<UI_MESSAGE extends UIMessage> implements Cha
     private onFinish;
 }
 
-export { type CompatibleLanguageModel, type DownloadFunction, type GenerationSettings, type InferWorkflowAgentTools, type InferWorkflowAgentUIMessage, type OutputSpecification, type PrepareCallCallback, type PrepareCallOptions, type PrepareCallResult, type PrepareStepCallback, type PrepareStepInfo, type PrepareStepResult, type ProviderOptions, type ReconnectToStreamOptions, type SendMessagesOptions, type StreamTextOnAbortCallback, type StreamTextOnErrorCallback, type StreamTextOnFinishCallback, type StreamTextTransform, type TelemetrySettings, WorkflowAgent, type WorkflowAgentOnStartCallback, type WorkflowAgentOnStepStartCallback, type WorkflowAgentOnToolCallFinishCallback, type WorkflowAgentOnToolCallStartCallback, type WorkflowAgentOptions, type WorkflowAgentStreamOptions, type WorkflowAgentStreamResult, WorkflowChatTransport, type WorkflowChatTransportOptions, createModelCallToUIChunkTransform, toUIMessageChunk };
+export { type CompatibleLanguageModel, type DownloadFunction, type GenerationSettings, type InferWorkflowAgentTools, type InferWorkflowAgentUIMessage, type OutputSpecification, type PrepareCallCallback, type PrepareCallOptions, type PrepareCallResult, type PrepareStepCallback, type PrepareStepInfo, type PrepareStepResult, type ProviderOptions, type ReconnectToStreamOptions, type SendMessagesOptions, type StreamTextTransform, type TelemetrySettings, WorkflowAgent, type WorkflowAgentOnAbortCallback, type WorkflowAgentOnErrorCallback, type WorkflowAgentOnFinishCallback, type WorkflowAgentOnStartCallback, type WorkflowAgentOnStepFinishCallback, type WorkflowAgentOnStepStartCallback, type WorkflowAgentOnToolCallFinishCallback, type WorkflowAgentOnToolCallStartCallback, type WorkflowAgentOptions, type WorkflowAgentStreamOptions, type WorkflowAgentStreamResult, WorkflowChatTransport, type WorkflowChatTransportOptions, createModelCallToUIChunkTransform, toUIMessageChunk };

package/dist/index.mjs

@@ -77,18 +77,7 @@ function resolveSerializableTools(tools) {
 async function doStreamStep(conversationPrompt, modelInit, writable, serializedTools, options) {
   "use step";
   var _a, _b, _c, _d, _e, _f, _g, _h, _i;
-  let model;
-  if (typeof modelInit === "string") {
-    model = gateway.languageModel(modelInit);
-  } else if (typeof modelInit === "function") {
-    model = await modelInit();
-  } else if (typeof modelInit === "object" && modelInit !== null && "modelId" in modelInit) {
-    model = modelInit;
-  } else {
-    throw new Error(
-      'Invalid "model initialization" argument. Must be a string, a LanguageModel instance, or a function that returns a LanguageModel instance.'
-    );
-  }
+  const model = typeof modelInit === "string" ? gateway.languageModel(modelInit) : modelInit;
   const tools = serializedTools ? resolveSerializableTools(serializedTools) : void 0;
   const { stream: modelStream } = await streamModelCall({
     model,