メインコンテンツへ移動

Run.resumeStream()

.resumeStream() メソッドは、新しいデータを使用して中断された Workflow の実行を再開します。特定のステップから実行を続けながら、イベントのストリームを監視できます。

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

const run = await workflow.createRun()

const stream = run.stream({
  inputData: {
    value: 'initial data',
  },
})

const result = await stream.result

if (result!.status === 'suspended') {
  const resumedStream = await run.resumeStream({
    resumeData: {
      value: 'resume data',
    },
  })
}

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

resumeData?:

z.infer<TInput>
Workflow の入力スキーマに一致する入力データ

requestContext?:

RequestContext
Workflow の実行中に使用する Request Context データ

step?:

Step<string, any, any, any, any, TEngineType>
実行を再開するステップ

forEachIndex?:

number
中断された .foreach() ステップの特定の反復を対象にします。再開する反復のゼロ始まりのインデックスを渡します。他の反復は中断されたままになります。省略すると、同じ resumeData を使用して、そのステップで中断されているすべての反復を再開します。

tracingOptions?:

TracingOptions
Tracing 設定のオプション。

metadata?:

Record<string, any>
ルート Trace span に追加するメタデータ。ユーザー ID、セッション ID、機能フラグなどのカスタム属性を追加する場合に便利です。

requestContextKeys?:

string[]
この Trace のメタデータとして抽出する追加の RequestContext キー。ネストされた値にはドット記法（例: 'user.id'）を使用できます。

traceId?:

string
この実行で使用する Trace ID（1〜32文字の16進数）。指定すると、この Trace は指定された Trace の一部になります。

parentSpanId?:

string
この実行で使用する親 span ID（1〜16文字の16進数）。指定すると、ルート span はこの span の子として作成されます。

tags?:

string[]
この Trace に適用するタグ。Trace の分類とフィルタリングに使用する文字列ラベルです。

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

stream:

MastraWorkflowStream<ChunkType>
ReadableStream<ChunkType> を拡張し、Workflow 固有のプロパティを追加したカスタムストリーム

stream.status:

Promise<RunStatus>
現在の Workflow 実行ステータスに解決される Promise

stream.result:

Promise<WorkflowResult<TState, TOutput, TSteps>>
Workflow の最終結果に解決される Promise

stream.usage:

Promise<{ inputTokens: number; outputTokens: number; totalTokens: number, reasoningTokens?: number, cacheInputTokens?: number }>
トークン使用量の統計に解決される Promise

ストリームイベント
ストリームイベントへの直接リンク

ストリームは、Workflow の実行中にイベントを発行します。各イベントには type フィールドと、関連データを含む payload があります。

  • workflow-start: Workflow の実行が開始されます
  • workflow-step-start: ステップの実行が開始されます
  • workflow-step-output: ステップからカスタム出力が生成されます
  • workflow-step-result: ステップが結果とともに完了します
  • workflow-finish: Workflow の実行が使用量の統計とともに完了します。実行が成功した場合、payload.finalWorkflowResult に Workflow の最終結果が格納されます
On this page