Run.observeStream()

.observeStream() メソッドは、現在実行中の Workflow run に対する新しい ReadableStream を開きます。これにより、元のストリームが利用できなくなった場合でも、イベントのストリームを監視できます。

使用例

const run = await workflow.createRun()

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

const stream = await run.observeStream()

for await (const chunk of stream) {
  console.log(chunk)
}

戻り値

ReadableStream<ChunkType>

ストリームイベント

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

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

関連情報

• Workflow の概要
• Workflow.createRun()
• Run.stream()
• Run.resumeStream()