Run クラス
Run
クラスはワークフローの実行インスタンスを表し、実行の開始、再開、ストリーミング、および監視のためのメソッドを提供します。
使用例
const run = await workflow.createRunAsync();
const result = await run.start({
inputData: { value: "初期データ" }
});
if (result.status === "suspended") {
const resumedResult = await run.resume({
resumeData: { value: "再開データ" }
});
}
実行メソッド
start:
(options?: StartOptions) => Promise<WorkflowResult>
入力データを用いてワークフローの実行を開始します
resume:
(options?: ResumeOptions) => Promise<WorkflowResult>
特定のステップから一時停止中のワークフローを再開します
stream:
(options?: StreamOptions) => Promise<StreamResult>
イベントストリームとしてワークフローの実行を監視します
streamVNext:
(options?: StreamOptions) => MastraWorkflowStream
拡張機能によりリアルタイムストリーミングを有効化します
watch:
(callback: WatchCallback, type?: WatchType) => UnwatchFunction
コールバックベースのイベントでワークフローの実行を監視します
cancel:
() => Promise<void>
ワークフローの実行を取り消します
実行ステータス
ワークフロー実行のstatus
は、現在の実行状態を示します。取りうる値は次のとおりです:
success:
string
すべてのステップが正常に完了し、有効な結果が出力されました
failed:
string
実行中にエラーが発生し、エラーの詳細を参照できます
suspended:
string
再開待ちのため実行が一時停止されており、一時停止中のステップ情報があります