メインコンテンツへ移動

Mastra.addDynamicWorkflow()

beta

動的 Workflow はベータ版です。API が安定するまでは、メジャーバージョンを上げずに破壊的変更が加わる場合があります。

.addDynamicWorkflow() メソッドは動的 Workflow 定義を検証し、インスタンス上で実行可能な Workflow として登録するとともに、workflowDefinitions Storage ドメインに永続化します。登録後は、ほかの Workflow と同様に getWorkflow() から実行できます。

完全なセットアップ例は動的 Workflow、使用できるフィールドとグラフエントリは動的 Workflow 定義リファレンスを参照してください。

使用例
使用例への直接リンク

await mastra.addDynamicWorkflow({
  id: 'greeting-workflow',
  description: 'Returns a greeting for the supplied name',
  inputSchema: {
    type: 'object',
    properties: { name: { type: 'string' } },
    required: ['name'],
  },
  outputSchema: {
    type: 'object',
    properties: { message: { type: 'string' } },
    required: ['message'],
  },
  graph: [
    {
      type: 'mapping',
      id: 'create-greeting',
      mapConfig: JSON.stringify({
        message: { template: 'Hello, ${initData.name}!' },
      }),
    },
  ],
})

const run = await mastra.getWorkflow('greeting-workflow').createRun()
const result = await run.start({ inputData: { name: 'Ada' } })

パラメータ
パラメータへの直接リンク

def:

DynamicWorkflowGraph
Workflow 定義。id、任意の description と metadata、入出力の JSON Schema、任意の state と request-context のスキーマ、およびステップグラフを含みます。

戻り値
戻り値への直接リンク

定義の検証、登録、永続化が完了すると解決される Promise。

動作
動作への直接リンク

  • 何らかの状態を変更する前に、定義全体（構造、参照、スキーマの流れ）を検証します。グラフが参照する Agent、Tool、Workflow は、あらかじめインスタンスに登録されている必要があります。
  • 既存の ID と同じ定義を追加すると、保存済みの定義と実行中インスタンスの登録がどちらも置き換えられます。実行中の Run は、開始時のグラフを引き続き使用します。
  • workflowDefinitions ドメイン対応の Storage アダプターがなくても、Workflow は検証され、メモリ内に登録されます。ただし、再起動すると定義は失われます。
  • ルート Workflow と、その内部で使用する補助 Workflow をまとめて追加するには、addDynamicWorkflows() を使用します。
On this page