Workflow クラス
Workflow クラスは、条件分岐やデータ検証を含む複雑な一連の操作のためのステートマシンを作成できるようにします。
import { Workflow } from "@mastra/core/workflows";
const workflow = new Workflow({ name: "my-workflow" });APIリファレンス
コンストラクタ
name:
string
ワークフローの識別子
logger?:
Logger<WorkflowLogMessage>
ワークフロー実行の詳細を記録するためのオプションのロガーインスタンス
steps:
Step[]
ワークフローに含めるステップの配列
triggerSchema:
z.Schema
ワークフロートリガーデータを検証するためのオプションのスキーマ
コアメソッド
step()
Step をワークフローに追加し、他のステップへの遷移も含めます。チェーンのためにワークフローインスタンスを返します。ステップの詳細はこちら。
commit()
ワークフローの設定を検証し、確定します。すべてのステップを追加した後に呼び出す必要があります。
execute()
オプションのトリガーデータとともにワークフローを実行します。トリガースキーマに基づいて型付けされます。
トリガースキーマ
トリガースキーマは、Zod を使用してワークフローに渡される初期データを検証します。
const workflow = new Workflow({
name: "order-process",
triggerSchema: z.object({
orderId: z.string(),
customer: z.object({
id: z.string(),
email: z.string().email(),
}),
}),
});このスキーマは以下を行います：
execute()に渡されるデータを検証します- ワークフロー入力のための TypeScript 型を提供します
バリデーション
ワークフローのバリデーションは、主に2つのタイミングで行われます。
1. コミット時
.commit() を呼び出すと、ワークフローは次の点をバリデートします:
workflow
.step('step1', {...})
.step('step2', {...})
.commit(); // ワークフロー構造のバリデーション- ステップ間の循環依存
- 終端パス（すべてのパスが終了していること）
- 到達不能なステップ
- 存在しないステップへの変数参照
- ステップIDの重複
2. 実行時
start() を呼び出すと、次の点をバリデートします:
const { runId, start } = workflow.createRun();
// トリガーデータがスキーマに合致しているかバリデート
await start({
triggerData: {
orderId: "123",
customer: {
id: "cust_123",
email: "invalid-email", // バリデーションに失敗します
},
},
});- トリガーデータがトリガースキーマに合致しているか
- 各ステップの入力データがその inputSchema に合致しているか
- 参照されているステップ出力内に変数パスが存在するか
- 必須変数が存在しているか
ワークフローのステータス
ワークフローのステータスは、その現在の実行状態を示します。考えられる値は以下の通りです。
CREATED:
string
ワークフローインスタンスが作成されたが、まだ開始されていません
RUNNING:
string
ワークフローがアクティブにステップを実行しています
SUSPENDED:
string
ワークフローの実行が一時停止され、再開を待っています
COMPLETED:
string
すべてのステップが正常に実行完了しました
FAILED:
string
ワークフローの実行中にエラーが発生しました
例：異なるステータスの処理
const { runId, start, watch } = workflow.createRun();
watch(async ({ status }) => {
switch (status) {
case "SUSPENDED":
// Handle suspended state
break;
case "COMPLETED":
// Process results
break;
case "FAILED":
// Handle error state
break;
}
});
await start({ triggerData: data });エラー処理
try {
const { runId, start, watch, resume } = workflow.createRun();
await start({ triggerData: data });
} catch (error) {
if (error instanceof ValidationError) {
// Handle validation errors
console.log(error.type); // 'circular_dependency' | 'no_terminal_path' | 'unreachable_step'
console.log(error.details); // { stepId?: string, path?: string[] }
}
}ステップ間でのコンテキストの受け渡し
各ステップは、コンテキストオブジェクトを通じてワークフロー内の前のステップからデータにアクセスできます。各ステップは、実行されたすべての前のステップから蓄積されたコンテキストを受け取ります。
workflow
.step({
id: "getData",
execute: async ({ context }) => {
return {
data: { id: "123", value: "example" },
};
},
})
.step({
id: "processData",
execute: async ({ context }) => {
// Access data from previous step through context.steps
const previousData = context.steps.getData.output.data;
// Process previousData.id and previousData.value
},
});コンテキストオブジェクトは以下の特徴があります：
context.stepsにすべての完了したステップの結果が含まれていますcontext.steps.[stepId].outputを通じてステップの出力にアクセスできます- ステップの出力スキーマに基づいて型付けされています
- データの一貫性を保つためにイミュータブルです