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 シリーズなど）からの推論シグネチャを含みます。シグネチャは、モデルの内部推論プロセスに関するメタデータ（労力レベルや推論アプローチなど）を表しますが、実際の推論内容自体は含みません。

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

任意のID

toolCallId:

string

ツール呼び出しの一意なID

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

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

制御チャンク

開始

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

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

任意の識別子

messageId?:

string

任意のメッセージ識別子

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"

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

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"

チャンク種別識別子

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

任意のID

toolCallId:

string

ツール呼び出しの一意なID

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

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

制御チャンク

開始

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

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

任意の識別子

messageId?:

string

任意のメッセージ識別子

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"

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

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"

チャンク種別識別子

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;
  }
}