Run.resumeStreamVNext()（実験的）

Experimental API:

This is a new streaming implementation that supports multiple output formats (including AI SDK v5). It will replace .stream() and may change as we refine the feature based on feedback.

.resumeStreamVNext() メソッドは、一時停止中のワークフロー実行を新しいデータで再開し、特定のステップから処理を続行するとともに、イベントストリームを観察できるようにします。

使い方の例


const run = await workflow.createRunAsync();
 
const stream = run.streamVNext({
  inputData: {
    value: "初期データ",
  },
});
 
 
const result = await stream.result;
if (result.status === "保留") {
  const resumedStream = await run.resumeStreamVNext({
    resumeData: { value: "再開データ" }
  });
}

パラメータ

resumeData?:

z.infer<TInput>

ワークフローの入力スキーマに適合する入力データ

runtimeContext?:

RuntimeContext

ワークフロー実行時に使用するランタイムコンテキストデータ

step?:

Step<string, any, any, any, any, TEngineType>

実行を再開する起点となるステップ

戻り値

stream:

MastraWorkflowStream<ChunkType>

ReadableStream<ChunkType> を拡張し、ワークフロー特有のプロパティを追加したカスタムストリーム

stream.status:

Promise<RunStatus>

現在のワークフロー実行ステータスを返す Promise

stream.result:

Promise<WorkflowResult<TState, TOutput, TSteps>>

最終的なワークフロー結果を返す Promise

stream.usage:

Promise<{ inputTokens: number; outputTokens: number; totalTokens: number, reasoningTokens?: number, cacheInputTokens?: number }>

トークン使用状況の統計情報を返す Promise

ストリームイベント

ストリームはワークフロー実行中にさまざまな種類のイベントを発行します。各イベントには type フィールドと、関連データを含む payload が含まれます:

workflow-start: ワークフローの実行が開始される
workflow-step-start: ステップの実行が開始される
workflow-step-output: ステップからのカスタム出力
workflow-step-result: ステップが結果とともに完了する
workflow-finish: ワークフローの実行が使用状況の統計情報とともに完了する