Defined in: activities/chat/stream/processor.ts:117
StreamProcessor - State machine for processing AI response streams
Manages the full UIMessage[] conversation and emits events on changes.
State tracking:
Tool call completion is detected when:
new StreamProcessor(options): StreamProcessor;
new StreamProcessor(options): StreamProcessor;
Defined in: activities/chat/stream/processor.ts:145
StreamProcessor
addToolApprovalResponse(approvalId, approved): void;
addToolApprovalResponse(approvalId, approved): void;
Defined in: activities/chat/stream/processor.ts:287
Add an approval response (called by client after handling onApprovalRequest)
string
boolean
void
addToolResult(
toolCallId,
output,
error?): void;
addToolResult(
toolCallId,
output,
error?): void;
Defined in: activities/chat/stream/processor.ts:243
Add a tool result (called by client after handling onToolCall)
string
any
string
void
addUserMessage(content, id?): UIMessage;
addUserMessage(content, id?): UIMessage;
Defined in: activities/chat/stream/processor.ts:192
Add a user message to the conversation. Supports both simple string content and multimodal content arrays.
The message content (string or array of content parts)
string | ContentPart[]
string
Optional custom message ID (generated if not provided)
The created UIMessage
// Simple text message
processor.addUserMessage('Hello!')
// Multimodal message with image
processor.addUserMessage([
{ type: 'text', content: 'What is in this image?' },
{ type: 'image', source: { type: 'url', value: 'https://example.com/photo.jpg' } }
])
// With custom ID
processor.addUserMessage('Hello!', 'custom-id-123')
// Simple text message
processor.addUserMessage('Hello!')
// Multimodal message with image
processor.addUserMessage([
{ type: 'text', content: 'What is in this image?' },
{ type: 'image', source: { type: 'url', value: 'https://example.com/photo.jpg' } }
])
// With custom ID
processor.addUserMessage('Hello!', 'custom-id-123')
areAllToolsComplete(): boolean;
areAllToolsComplete(): boolean;
Defined in: activities/chat/stream/processor.ts:318
Check if all tool calls in the last assistant message are complete Useful for auto-continue logic
boolean
clearMessages(): void;
clearMessages(): void;
Defined in: activities/chat/stream/processor.ts:362
Clear all messages
void
finalizeStream(): void;
finalizeStream(): void;
Defined in: activities/chat/stream/processor.ts:859
Finalize the stream - complete all pending operations
void
getMessages(): UIMessage[];
getMessages(): UIMessage[];
Defined in: activities/chat/stream/processor.ts:310
Get current messages
getRecording(): ChunkRecording | null;
getRecording(): ChunkRecording | null;
Defined in: activities/chat/stream/processor.ts:938
Get the current recording
ChunkRecording | null
getState(): ProcessorState;
getState(): ProcessorState;
Defined in: activities/chat/stream/processor.ts:911
Get current processor state
process(stream): Promise<ProcessorResult>;
process(stream): Promise<ProcessorResult>;
Defined in: activities/chat/stream/processor.ts:375
Process a stream and emit events through handlers
AsyncIterable<any>
Promise<ProcessorResult>
processChunk(chunk): void;
processChunk(chunk): void;
Defined in: activities/chat/stream/processor.ts:403
Process a single chunk from the stream
void
removeMessagesAfter(index): void;
removeMessagesAfter(index): void;
Defined in: activities/chat/stream/processor.ts:354
Remove messages after a certain index (for reload/retry)
number
void
reset(): void;
reset(): void;
Defined in: activities/chat/stream/processor.ts:961
Full reset (including messages)
void
setMessages(messages): void;
setMessages(messages): void;
Defined in: activities/chat/stream/processor.ts:164
Set the messages array (e.g., from persisted state)
void
startAssistantMessage(): string;
startAssistantMessage(): string;
Defined in: activities/chat/stream/processor.ts:219
Start streaming a new assistant message Returns the message ID
string
startRecording(): void;
startRecording(): void;
Defined in: activities/chat/stream/processor.ts:925
Start recording chunks
void
toModelMessages(): ModelMessage<
| string
| ContentPart<unknown, unknown, unknown, unknown, unknown>[]
| null>[];
toModelMessages(): ModelMessage<
| string
| ContentPart<unknown, unknown, unknown, unknown, unknown>[]
| null>[];
Defined in: activities/chat/stream/processor.ts:299
Get the conversation as ModelMessages (for sending to LLM)
ModelMessage< | string | ContentPart<unknown, unknown, unknown, unknown, unknown>[] | null>[]
static replay(recording, options?): Promise<ProcessorResult>;
static replay(recording, options?): Promise<ProcessorResult>;
Defined in: activities/chat/stream/processor.ts:970
Replay a recording through the processor
Promise<ProcessorResult>
