ChunkType

実験的なAPI: この型は実験的な streamVNext() メソッドの一部です。フィードバックに基づいて機能を改善する中で、API が変更される可能性があります。

ChunkType 型は、エージェントのストリーミング応答で出力されるチャンクの mastra 形式を定義します。

基本プロパティ

すべてのチャンクには次の基本プロパティが含まれます。

type:

string

チャンクの種類を示す識別子

runId:

string

この実行の一意の識別子

from:

ChunkFrom

チャンクの発生元

enum

AGENT:

'AGENT'

エージェントの実行によるチャンク

USER:

'USER'

ユーザー入力によるチャンク

SYSTEM:

'SYSTEM'

システム処理によるチャンク

WORKFLOW:

'WORKFLOW'

ワークフロー実行によるチャンク

テキストチャンク

text-start

テキスト生成の開始を示します。

type:

"text-start"

チャンク種別の識別子

payload:

TextStartPayload

テキスト開始に関する情報

TextStartPayload

id:

string

このテキスト生成の固有識別子

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

text-delta

生成中の逐次的なテキストコンテンツ。

type:

"text-delta"

チャンク種別の識別子

payload:

TextDeltaPayload

逐次的なテキストコンテンツ

TextDeltaPayload

id:

string

このテキスト生成の一意識別子

text:

string

逐次的なテキストコンテンツ

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

text-end

テキスト生成の終了を示します。

type:

"text-end"

チャンクタイプの識別子

payload:

TextEndPayload

テキスト終了に関する情報

TextEndPayload

id:

string

このテキスト生成の固有識別子

providerMetadata?:

SharedV2ProviderMetadata

プロバイダ固有のメタデータ

推論チャンク

reasoning-start

（推論対応モデルで）推論生成の開始を示します。

type:

"reasoning-start"

チャンク種別の識別子

payload:

ReasoningStartPayload

推論開始に関する情報

ReasoningStartPayload

id:

string

この推論生成の一意の識別子

signature?:

string

利用可能な場合の推論シグネチャ

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

reasoning-delta

生成中に逐次出力される推論テキスト。

type:

"reasoning-delta"

チャンク種別の識別子

payload:

ReasoningDeltaPayload

逐次的な推論コンテンツ

ReasoningDeltaPayload

id:

string

この推論生成の一意識別子

text:

string

逐次的な推論テキスト

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

reasoning-end

推論生成の終了を示します。

type:

"reasoning-end"

チャンク種別識別子

payload:

ReasoningEndPayload

推論終了に関する情報

ReasoningEndPayload

id:

string

この推論生成の一意の識別子

signature?:

string

利用可能な場合の最終推論署名

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

reasoning-signature

高度な推論をサポートするモデル（OpenAI の o1 シリーズなど）からの reasoning signature（推論シグネチャ）を含みます。これは、努力度合いや推論アプローチなど、モデルの内部推論プロセスに関するメタデータを表しますが、実際の推論内容そのものは含みません。

type:

"reasoning-signature"

チャンク種別の識別子

payload:

ReasoningSignaturePayload

モデルの推論プロセス特性に関するメタデータ

ReasoningSignaturePayload

id:

string

推論セッションの一意の識別子

signature:

string

推論アプローチや努力度合いを示すシグネチャ（例：推論努力の設定）

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

ツールのチャンク

tool-call

ツールを呼び出しています。

type:

"tool-call"

チャンクタイプの識別子

payload:

ToolCallPayload

ツール呼び出しに関する情報

ToolCallPayload

toolCallId:

string

このツール呼び出しの一意の識別子

toolName:

string

呼び出されるツール名

args?:

Record<string, any>

ツールに渡す引数

providerExecuted?:

boolean

プロバイダーがツールを実行したかどうか

output?:

any

利用可能な場合のツール出力

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

tool-result

ツール実行の結果。

type:

"tool-result"

チャンクタイプの識別子

payload:

ToolResultPayload

ツール実行結果

ToolResultPayload

toolCallId:

string

ツール呼び出しの一意の識別子

toolName:

string

実行されたツールの名称

result:

any

ツール実行の結果

isError?:

boolean

結果がエラーかどうか

providerExecuted?:

boolean

プロバイダーがツールを実行したかどうか

args?:

Record<string, any>

ツールに渡された引数

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

tool-call-input-streaming-start

ツール呼び出し引数のストリーミング開始を示します。

type:

"tool-call-input-streaming-start"

チャンク種別の識別子

payload:

ToolCallInputStreamingStartPayload

ツール呼び出し入力のストリーミング開始情報

ToolCallInputStreamingStartPayload

toolCallId:

string

このツール呼び出しの一意の識別子

toolName:

string

呼び出されるツール名

providerExecuted?:

boolean

プロバイダーがツールを実行したか

dynamic?:

boolean

ツール呼び出しが動的かどうか

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

tool-call-delta

ストリーミング中に逐次送信されるツール呼び出し引数。

type:

"tool-call-delta"

チャンク種別の識別子

payload:

ToolCallDeltaPayload

ツール呼び出し引数の逐次更新

ToolCallDeltaPayload

argsTextDelta:

string

ツール引数に対するテキスト差分の増分

toolCallId:

string

このツール呼び出しの一意な識別子

toolName?:

string

呼び出されるツール名

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

tool-call-input-streaming-end

ツール呼び出しの引数ストリーミングが終了したことを示します。

type:

"tool-call-input-streaming-end"

チャンク種別の識別子

payload:

ToolCallInputStreamingEndPayload

ツール呼び出しの入力ストリーミング終了に関する情報

ToolCallInputStreamingEndPayload

toolCallId:

string

このツール呼び出しのユニークな識別子

providerMetadata?:

SharedV2ProviderMetadata

プロバイダ固有のメタデータ

tool-error

ツールの実行中にエラーが発生しました。

type:

"tool-error"

チャンク種別識別子

payload:

ToolErrorPayload

ツールのエラー情報

ToolErrorPayload

id?:

string

任意の識別子

toolCallId:

string

ツール呼び出しの一意な識別子

toolName:

string

失敗したツール名

args?:

Record<string, any>

ツールに渡された引数

error:

unknown

発生したエラー

providerExecuted?:

boolean

プロバイダーがツールを実行したかどうか

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

ソースとファイルのチャンク

source

コンテンツの出典情報を含みます。

type:

"source"

チャンク種別識別子

payload:

SourcePayload

出典情報

SourcePayload

id:

string

一意の識別子

sourceType:

'url' | 'document'

出典の種類

title:

string

出典のタイトル

mimeType?:

string

出典のMIMEタイプ

filename?:

string

該当する場合のファイル名

url?:

string

該当する場合のURL

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

file

ファイルのデータを含みます。

type:

"file"

チャンク種別識別子

payload:

FilePayload

ファイルデータ

FilePayload

data:

string | Uint8Array

ファイルのデータ

base64?:

string

該当する場合のBase64エンコード済みデータ

mimeType:

string

ファイルのMIMEタイプ

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

制御チャンク

start

ストリーミングの開始を示します。

type:

"start"

チャンクタイプ識別子

payload:

StartPayload

開始情報

StartPayload

[key: string]:

any

追加の開始データ

step-start

処理ステップの開始を示します。

type:

"step-start"

チャンク種別の識別子

payload:

StepStartPayload

ステップ開始に関する情報

StepStartPayload

messageId?:

string

任意のメッセージID

request:

object

ボディやその他のデータを含むリクエスト情報

warnings?:

LanguageModelV2CallWarning[]

言語モデル呼び出しに関する警告

step-finish

処理ステップの完了を示します。

type:

"step-finish"

チャンク種別の識別子

payload:

StepFinishPayload

ステップ完了に関する情報

StepFinishPayload

id?:

string

任意のID

messageId?:

string

任意のメッセージID

stepResult:

object

理由、警告、継続情報を含むステップの実行結果

output:

object

使用量統計を含む出力情報

metadata:

object

リクエストおよびプロバイダー情報を含む実行メタデータ

totalUsage?:

LanguageModelV2Usage

総使用量の統計

response?:

LanguageModelV2ResponseMetadata

レスポンスのメタデータ

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

raw

プロバイダーから提供される生データを含みます。

type:

"raw"

チャンク種別識別子

payload:

RawPayload

プロバイダーの生データ

RawPayload

[key: string]:

any

プロバイダーから提供される生データ

finish

ストリームは正常に完了しました。

type:

"finish"

チャンク種別識別子

payload:

FinishPayload

完了情報

FinishPayload

stepResult:

object

ステップの実行結果

output:

object

使用状況を含む出力情報

metadata:

object

実行に関するメタデータ

messages:

object

メッセージ履歴

error

ストリーミング中にエラーが発生しました。

type:

"error"

チャンクタイプの識別子

payload:

ErrorPayload

エラーに関する情報

ErrorPayload

error:

unknown

発生したエラー

abort

ストリームが中止されました。

type:

"abort"

チャンクタイプ識別子

payload:

AbortPayload

中止情報

AbortPayload

[key: string]:

any

追加の中止データ

オブジェクトと出力チャンク

object

定義済みスキーマを使った出力生成時に発行されます。指定された Zod または JSON スキーマに適合する、部分的または完全な構造化データを含みます。このチャンクは、実行コンテキストによってはスキップされることがあり、構造化オブジェクトのストリーミング生成に用いられます。

type:

"object"

チャンク種別の識別子

object:

PartialSchemaOutput<OUTPUT>

定義されたスキーマに適合する、部分的または完全な構造化データ。型は OUTPUT スキーマパラメータによって決まります。

tool-output

エージェントまたはワークフロー実行の出力を含み、特に使用状況の統計や完了イベントの追跡に用いられます。しばしば他のチャンクタイプ（finish チャンクなど）をラップし、ネストされた実行コンテキストを提供します。

type:

"tool-output"

チャンクタイプの識別子

payload:

ToolOutputPayload

メタデータ付きでラップされた実行出力

ToolOutputPayload

output:

ChunkType

ネストされたチャンクデータ。多くの場合、使用状況の統計を含む完了イベントを格納

step-output

ワークフローの各ステップの実行出力を含み、主に利用状況の追跡やステップ完了イベントに用いられます。tool-output に似ていますが、個別のワークフローステップに特化しています。

type:

"step-output"

チャンク種別を識別する ID

payload:

StepOutputPayload

メタデータ付きのワークフローステップ実行出力

StepOutputPayload

output:

ChunkType

ステップ実行に由来する入れ子のチャンクデータ。通常、完了イベントやその他のステップ結果を含みます

メタデータと特殊チャンク

response-metadata

LLMプロバイダーの応答に関するメタデータを含みます。テキスト生成後に、一部のプロバイダーがモデルID、タイムスタンプ、レスポンスヘッダーなどの追加コンテキストを提供する目的で出力します。このチャンクは内部の状態管理に使用され、メッセージの組み立てには影響しません。

type:

"response-metadata"

チャンク種別を示す識別子

payload:

ResponseMetadataPayload

追跡やデバッグのためのプロバイダーの応答メタデータ

ResponseMetadataPayload

signature?:

string

利用可能な場合の応答署名

[key: string]:

any

プロバイダー固有の追加メタデータフィールド（例：id、modelId、timestamp、headers）

watch

エージェントの実行に関する監視・オブザーバビリティ用のデータを含みます。streamVNext() の使用コンテキストに応じて、ワークフローの状態、実行の進捗、その他のランタイム情報が含まれる場合があります。

type:

"watch"

チャンク種別の識別子

payload:

WatchPayload

エージェント実行のオブザーバビリティおよびデバッグのための監視データ

WatchPayload

workflowState?:

object

現在のワークフロー実行状態（ワークフローで使用される場合）

eventTimestamp?:

number

イベント発生時刻のタイムスタンプ

[key: string]:

any

追加の監視・実行データ

tripwire

出力プロセッサによってコンテンツがブロックされたためにストリームが強制終了された際に発行されます。これは、有害または不適切なコンテンツの配信を防ぐための安全機構として機能します。

type:

"tripwire"

チャンクタイプの識別子

payload:

TripwirePayload

安全機構によってストリームが終了された理由に関する情報

TripwirePayload

tripwireReason:

string

コンテンツがブロックされた理由の説明（例：「Output processor blocked content」）

使用例


const stream = await agent.streamVNext("Hello");
 
for await (const chunk of stream.fullStream) {
  switch (chunk.type) {
    case 'text-delta':
      console.log('テキスト:', chunk.payload.text);
      break;
    
    case 'tool-call':
      console.log('ツールを呼び出し:', chunk.payload.toolName);
      break;
    
    case 'tool-result':
      console.log('ツールの結果:', chunk.payload.result);
      break;
    
    case 'reasoning-delta':
      console.log('推論:', chunk.payload.text);
      break;
    
    case 'finish':
      console.log('終了:', chunk.payload.stepResult.reason);
      console.log('使用状況:', chunk.payload.output.usage);
      break;
    
    case 'error':
      console.error('エラー:', chunk.payload.error);
      break;
  }
}

ChunkType

ChunkType 型は、エージェントのストリーミング応答で出力されるチャンクの mastra 形式を定義します。

基本プロパティ

すべてのチャンクには次の基本プロパティが含まれます。

type:

string

チャンクの種類を示す識別子

runId:

string

この実行の一意の識別子

from:

ChunkFrom

チャンクの発生元

enum

AGENT:

'AGENT'

エージェントの実行によるチャンク

USER:

'USER'

ユーザー入力によるチャンク

SYSTEM:

'SYSTEM'

システム処理によるチャンク

WORKFLOW:

'WORKFLOW'

ワークフロー実行によるチャンク

テキストチャンク

text-start

テキスト生成の開始を示します。

type:

"text-start"

チャンク種別の識別子

payload:

TextStartPayload

テキスト開始に関する情報

TextStartPayload

id:

string

このテキスト生成の固有識別子

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

text-delta

生成中の逐次的なテキストコンテンツ。

type:

"text-delta"

チャンク種別の識別子

payload:

TextDeltaPayload

逐次的なテキストコンテンツ

TextDeltaPayload

id:

string

このテキスト生成の一意識別子

text:

string

逐次的なテキストコンテンツ

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

text-end

テキスト生成の終了を示します。

type:

"text-end"

チャンクタイプの識別子

payload:

TextEndPayload

テキスト終了に関する情報

TextEndPayload

id:

string

このテキスト生成の固有識別子

providerMetadata?:

SharedV2ProviderMetadata

プロバイダ固有のメタデータ

推論チャンク

reasoning-start

（推論対応モデルで）推論生成の開始を示します。

type:

"reasoning-start"

チャンク種別の識別子

payload:

ReasoningStartPayload

推論開始に関する情報

ReasoningStartPayload

id:

string

この推論生成の一意の識別子

signature?:

string

利用可能な場合の推論シグネチャ

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

reasoning-delta

生成中に逐次出力される推論テキスト。

type:

"reasoning-delta"

チャンク種別の識別子

payload:

ReasoningDeltaPayload

逐次的な推論コンテンツ

ReasoningDeltaPayload

id:

string

この推論生成の一意識別子

text:

string

逐次的な推論テキスト

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

reasoning-end

推論生成の終了を示します。

type:

"reasoning-end"

チャンク種別識別子

payload:

ReasoningEndPayload

推論終了に関する情報

ReasoningEndPayload

id:

string

この推論生成の一意の識別子

signature?:

string

利用可能な場合の最終推論署名

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

reasoning-signature

type:

"reasoning-signature"

チャンク種別の識別子

payload:

ReasoningSignaturePayload

モデルの推論プロセス特性に関するメタデータ

ReasoningSignaturePayload

id:

string

推論セッションの一意の識別子

signature:

string

推論アプローチや努力度合いを示すシグネチャ（例：推論努力の設定）

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

ツールのチャンク

tool-call

ツールを呼び出しています。

type:

"tool-call"

チャンクタイプの識別子

payload:

ToolCallPayload

ツール呼び出しに関する情報

ToolCallPayload

toolCallId:

string

このツール呼び出しの一意の識別子

toolName:

string

呼び出されるツール名

args?:

Record<string, any>

ツールに渡す引数

providerExecuted?:

boolean

プロバイダーがツールを実行したかどうか

output?:

any

利用可能な場合のツール出力

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

tool-result

ツール実行の結果。

type:

"tool-result"

チャンクタイプの識別子

payload:

ToolResultPayload

ツール実行結果

ToolResultPayload

toolCallId:

string

ツール呼び出しの一意の識別子

toolName:

string

実行されたツールの名称

result:

any

ツール実行の結果

isError?:

boolean

結果がエラーかどうか

providerExecuted?:

boolean

プロバイダーがツールを実行したかどうか

args?:

Record<string, any>

ツールに渡された引数

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

tool-call-input-streaming-start

ツール呼び出し引数のストリーミング開始を示します。

type:

"tool-call-input-streaming-start"

チャンク種別の識別子

payload:

ToolCallInputStreamingStartPayload

ツール呼び出し入力のストリーミング開始情報

ToolCallInputStreamingStartPayload

toolCallId:

string

このツール呼び出しの一意の識別子

toolName:

string

呼び出されるツール名

providerExecuted?:

boolean

プロバイダーがツールを実行したか

dynamic?:

boolean

ツール呼び出しが動的かどうか

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

tool-call-delta

ストリーミング中に逐次送信されるツール呼び出し引数。

type:

"tool-call-delta"

チャンク種別の識別子

payload:

ToolCallDeltaPayload

ツール呼び出し引数の逐次更新

ToolCallDeltaPayload

argsTextDelta:

string

ツール引数に対するテキスト差分の増分

toolCallId:

string

このツール呼び出しの一意な識別子

toolName?:

string

呼び出されるツール名

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

tool-call-input-streaming-end

ツール呼び出しの引数ストリーミングが終了したことを示します。

type:

"tool-call-input-streaming-end"

チャンク種別の識別子

payload:

ToolCallInputStreamingEndPayload

ツール呼び出しの入力ストリーミング終了に関する情報

ToolCallInputStreamingEndPayload

toolCallId:

string

このツール呼び出しのユニークな識別子

providerMetadata?:

SharedV2ProviderMetadata

プロバイダ固有のメタデータ

tool-error

ツールの実行中にエラーが発生しました。

type:

"tool-error"

チャンク種別識別子

payload:

ToolErrorPayload

ツールのエラー情報

ToolErrorPayload

id?:

string

任意の識別子

toolCallId:

string

ツール呼び出しの一意な識別子

toolName:

string

失敗したツール名

args?:

Record<string, any>

ツールに渡された引数

error:

unknown

発生したエラー

providerExecuted?:

boolean

プロバイダーがツールを実行したかどうか

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

ソースとファイルのチャンク

source

コンテンツの出典情報を含みます。

type:

"source"

チャンク種別識別子

payload:

SourcePayload

出典情報

SourcePayload

id:

string

一意の識別子

sourceType:

'url' | 'document'

出典の種類

title:

string

出典のタイトル

mimeType?:

string

出典のMIMEタイプ

filename?:

string

該当する場合のファイル名

url?:

string

該当する場合のURL

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

file

ファイルのデータを含みます。

type:

"file"

チャンク種別識別子

payload:

FilePayload

ファイルデータ

FilePayload

data:

string | Uint8Array

ファイルのデータ

base64?:

string

該当する場合のBase64エンコード済みデータ

mimeType:

string

ファイルのMIMEタイプ

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

制御チャンク

start

ストリーミングの開始を示します。

type:

"start"

チャンクタイプ識別子

payload:

StartPayload

開始情報

StartPayload

[key: string]:

any

追加の開始データ

step-start

処理ステップの開始を示します。

type:

"step-start"

チャンク種別の識別子

payload:

StepStartPayload

ステップ開始に関する情報

StepStartPayload

messageId?:

string

任意のメッセージID

request:

object

ボディやその他のデータを含むリクエスト情報

warnings?:

LanguageModelV2CallWarning[]

言語モデル呼び出しに関する警告

step-finish

処理ステップの完了を示します。

type:

"step-finish"

チャンク種別の識別子

payload:

StepFinishPayload

ステップ完了に関する情報

StepFinishPayload

id?:

string

任意のID

messageId?:

string

任意のメッセージID

stepResult:

object

理由、警告、継続情報を含むステップの実行結果

output:

object

使用量統計を含む出力情報

metadata:

object

リクエストおよびプロバイダー情報を含む実行メタデータ

totalUsage?:

LanguageModelV2Usage

総使用量の統計

response?:

LanguageModelV2ResponseMetadata

レスポンスのメタデータ

providerMetadata?:

SharedV2ProviderMetadata

プロバイダー固有のメタデータ

raw

プロバイダーから提供される生データを含みます。

type:

"raw"

チャンク種別識別子

payload:

RawPayload

プロバイダーの生データ

RawPayload

[key: string]:

any

プロバイダーから提供される生データ

finish

ストリームは正常に完了しました。

type:

"finish"

チャンク種別識別子

payload:

FinishPayload

完了情報

FinishPayload

stepResult:

object

ステップの実行結果

output:

object

使用状況を含む出力情報

metadata:

object

実行に関するメタデータ

messages:

object

メッセージ履歴

error

ストリーミング中にエラーが発生しました。

type:

"error"

チャンクタイプの識別子

payload:

ErrorPayload

エラーに関する情報

ErrorPayload

error:

unknown

発生したエラー

abort

ストリームが中止されました。

type:

"abort"

チャンクタイプ識別子

payload:

AbortPayload

中止情報

AbortPayload

[key: string]:

any

追加の中止データ

オブジェクトと出力チャンク

object

type:

"object"

チャンク種別の識別子

object:

PartialSchemaOutput<OUTPUT>

定義されたスキーマに適合する、部分的または完全な構造化データ。型は OUTPUT スキーマパラメータによって決まります。

tool-output

type:

"tool-output"

チャンクタイプの識別子

payload:

ToolOutputPayload

メタデータ付きでラップされた実行出力

ToolOutputPayload

output:

ChunkType

ネストされたチャンクデータ。多くの場合、使用状況の統計を含む完了イベントを格納

step-output

type:

"step-output"

チャンク種別を識別する ID

payload:

StepOutputPayload

メタデータ付きのワークフローステップ実行出力

StepOutputPayload

output:

ChunkType

ステップ実行に由来する入れ子のチャンクデータ。通常、完了イベントやその他のステップ結果を含みます

メタデータと特殊チャンク

response-metadata

type:

"response-metadata"

チャンク種別を示す識別子

payload:

ResponseMetadataPayload

追跡やデバッグのためのプロバイダーの応答メタデータ

ResponseMetadataPayload

signature?:

string

利用可能な場合の応答署名

[key: string]:

any

プロバイダー固有の追加メタデータフィールド（例：id、modelId、timestamp、headers）

watch

type:

"watch"

チャンク種別の識別子

payload:

WatchPayload

エージェント実行のオブザーバビリティおよびデバッグのための監視データ

WatchPayload

workflowState?:

object

現在のワークフロー実行状態（ワークフローで使用される場合）

eventTimestamp?:

number

イベント発生時刻のタイムスタンプ

[key: string]:

any

追加の監視・実行データ

tripwire

type:

"tripwire"

チャンクタイプの識別子

payload:

TripwirePayload

安全機構によってストリームが終了された理由に関する情報

TripwirePayload

tripwireReason:

string

コンテンツがブロックされた理由の説明（例：「Output processor blocked content」）

使用例


const stream = await agent.streamVNext("Hello");
 
for await (const chunk of stream.fullStream) {
  switch (chunk.type) {
    case 'text-delta':
      console.log('テキスト:', chunk.payload.text);
      break;
    
    case 'tool-call':
      console.log('ツールを呼び出し:', chunk.payload.toolName);
      break;
    
    case 'tool-result':
      console.log('ツールの結果:', chunk.payload.result);
      break;
    
    case 'reasoning-delta':
      console.log('推論:', chunk.payload.text);
      break;
    
    case 'finish':
      console.log('終了:', chunk.payload.stepResult.reason);
      console.log('使用状況:', chunk.payload.output.usage);
      break;
    
    case 'error':
      console.error('エラー:', chunk.payload.error);
      break;
  }
}