Control Flow
ワークフローを構築する際、通常は操作をより小さなタスクに分解し、それらをリンクして再利用できるようにします。Stepsは、入力、出力、実行ロジックを定義することで、これらのタスクを管理するための構造化された方法を提供します。
- スキーマが一致する場合、各ステップの
outputSchema
は自動的に次のステップのinputSchema
に渡されます。 - スキーマが一致しない場合は、Input data mappingを使用して
outputSchema
を期待されるinputSchema
に変換します。
.then()
を使ったステップのチェーン
.then()
を使用してステップを順次実行するようにチェーンします:
import { createWorkflow, createStep } from "@mastra/core/workflows";
import { z } from "zod";
const step1 = createStep({...});
const step2 = createStep({...});
export const testWorkflow = createWorkflow({...})
.then(step1)
.then(step2)
.commit();
これは期待通りの動作をします:step1
を実行し、次にstep2
を実行します。
.parallel()
による同時実行ステップ
.parallel()
を使用してステップを同時実行します:
import { createWorkflow, createStep } from "@mastra/core/workflows";
import { z } from "zod";
const step1 = createStep({...});
const step2 = createStep({...});
const step3 = createStep({...});
export const testWorkflow = createWorkflow({...})
.parallel([step1, step2])
.then(step3)
.commit();
これはstep1
とstep2
を並行実行し、両方が完了した後にstep3
に進みます。
詳細についてはステップでの並列実行を参照してください。
.branch()
による条件分岐
.branch()
を使用してステップを条件付きで実行します:
import { createWorkflow, createStep } from "@mastra/core/workflows";
import { z } from "zod";
const lessThanStep = createStep({...});
const greaterThanStep = createStep({...});
export const testWorkflow = createWorkflow({...})
.branch([
[async ({ inputData: { value } }) => value <= 10, lessThanStep],
[async ({ inputData: { value } }) => value > 10, greaterThanStep]
])
.commit();
分岐条件は順次評価されますが、条件に一致するステップは並列で実行されます。
詳細については、条件分岐を使用したワークフローを参照してください。
ステップのループ
ワークフローは2種類のループをサポートしています。ステップやネストされたワークフローなどのステップ互換構造をループする場合、初期のinputData
は前のステップの出力から取得されます。
互換性を確保するため、ループの初期入力は前のステップの出力の形状と一致するか、map
関数を使用して明示的に変換される必要があります。
- 前のステップの出力の形状と一致する、または
map
関数を使用して明示的に変換される。
.dowhile()
による繰り返し
条件が真である間、ステップを繰り返し実行します。
import { createWorkflow, createStep } from "@mastra/core/workflows";
import { z } from "zod";
const counterStep = createStep({...});
export const testWorkflow = createWorkflow({...})
.dowhile(counterStep, async ({ inputData: { number } }) => number < 10)
.commit();
.dountil()
による繰り返し
条件が真になるまでステップを繰り返し実行します。
import { createWorkflow, createStep } from "@mastra/core/workflows";
import { z } from "zod";
const counterStep = createStep({...});
export const testWorkflow = createWorkflow({...})
.dountil(counterStep, async ({ inputData: { number } }) => number > 10)
.commit();
.foreach()
による繰り返し
inputSchema
の各アイテムに対して同じステップを順次実行します。
import { createWorkflow, createStep } from "@mastra/core/workflows";
import { z } from "zod";
const mapStep = createStep({...});
export const testWorkflow = createWorkflow({...})
.foreach(mapStep)
.commit();
並行性制限の設定
concurrency
を使用して、同時実行数に制限を設けてステップを並列実行します。
import { createWorkflow, createStep } from "@mastra/core/workflows";
import { z } from "zod";
const mapStep = createStep({...})
export const testWorkflow = createWorkflow({...})
.foreach(mapStep, { concurrency: 2 })
.commit();
ネストされたワークフローの使用
ネストされたワークフローを.then()
に渡すことで、ステップとして使用します。これにより、親ワークフローの一部として、その各ステップが順番に実行されます。
import { createWorkflow, createStep } from "@mastra/core/workflows";
import { z } from "zod";
export const nestedWorkflow = createWorkflow({...})
export const testWorkflow = createWorkflow({...})
.then(nestedWorkflow)
.commit();
ワークフローのクローン
cloneWorkflow
を使用して既存のワークフローを複製します。これにより、id
などのパラメータを上書きしながら、その構造を再利用できます。
import { createWorkflow, createStep, cloneWorkflow } from "@mastra/core/workflows";
import { z } from "zod";
const step1 = createStep({...});
const parentWorkflow = createWorkflow({...})
const clonedWorkflow = cloneWorkflow(parentWorkflow, { id: "cloned-workflow" });
export const testWorkflow = createWorkflow({...})
.then(step1)
.then(clonedWorkflow)
.commit();
bail()
を使用した早期終了
ステップでbail()
を使用して、成功した結果で早期終了します。これは提供されたペイロードをステップの出力として返し、ワークフローの実行を終了します。
import { createWorkflow, createStep } from "@mastra/core/workflows";
import { z } from "zod";
const step1 = createStep({
id: 'step1',
execute: async ({ bail }) => {
return bail({ result: 'bailed' });
},
inputSchema: z.object({ value: z.string() }),
outputSchema: z.object({ result: z.string() }),
});
export const testWorkflow = createWorkflow({...})
.then(step1)
.commit();
Error()
を使用した早期終了
ステップでthrow new Error()
を使用してエラーで終了します。
import { createWorkflow, createStep } from "@mastra/core/workflows";
import { z } from "zod";
const step1 = createStep({
id: 'step1',
execute: async () => {
throw new Error('bailed');
},
inputSchema: z.object({ value: z.string() }),
outputSchema: z.object({ result: z.string() }),
});
export const testWorkflow = createWorkflow({...})
.then(step1)
.commit();
これによりステップからエラーがスローされ、ワークフローの実行が停止し、結果としてエラーが返されます。
実行インスタンスの例
以下の例では、複数の入力を使用してランを開始する方法を示しています。各入力はmapStep
を順次通過します。
import { mastra } from "./mastra";
const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
const result = await run.start({
inputData: [{ number: 10 }, { number: 100 }, { number: 200 }]
});
ターミナルからこのランを実行するには:
npx tsx src/test-workflow.ts