DOCSAPI reference

INTERFACE

StreamingChunk

Defined in: packages/components/src/agents/StreamingAgent.ts:26

Event emitted by StreamingAgent.runStream().

Properties

Property Type Description Defined in
allToolCalls? ToolCallRecord[] completed: every tool call that ran. packages/components/src/agents/StreamingAgent.ts:51
content? string assistant_message: text accumulated so far in this iteration. packages/components/src/agents/StreamingAgent.ts:39
error? string error: error message. packages/components/src/agents/StreamingAgent.ts:53
finalMessage? string completed: final assistant text. packages/components/src/agents/StreamingAgent.ts:47
history? AgentMessage[] completed: full message history. packages/components/src/agents/StreamingAgent.ts:49
iteration? number iteration_start: 1-based iteration number. packages/components/src/agents/StreamingAgent.ts:37
result? unknown tool_result: tool result, or { error }. packages/components/src/agents/StreamingAgent.ts:45
toolCalls? AgentToolCall[] assistant_message: tool calls accumulated so far in this iteration. packages/components/src/agents/StreamingAgent.ts:41
toolName? string tool_start and tool_result: tool name. packages/components/src/agents/StreamingAgent.ts:43
type | "error" | "iteration_start" | "model_thinking" | "assistant_message" | "tool_start" | "tool_result" | "completed" Event kind. Each kind sets the fields documented below. packages/components/src/agents/StreamingAgent.ts:28
usage? TokenUsage completed: token usage summed over every model call. packages/components/src/agents/StreamingAgent.ts:55