StreamProcessorEvents

Defined in: packages/ai/src/activities/chat/stream/processor.ts:102

Events emitted by the StreamProcessor

Properties#

onApprovalRequest?#

optional onApprovalRequest?: (args) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:117

Parameters#

args#

approvalId#

string

input#

any

toolCallId#

string

toolName#

string

Returns#

void

onCustomEvent?#

optional onCustomEvent?: (eventType, data, context) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:125

Parameters#

eventType#

string

data#

unknown

context#

toolCallId?#

string

Returns#

void

onError?#

optional onError?: (error) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:109

Parameters#

error#

Error

Returns#

void

onMessagesChange?#

optional onMessagesChange?: (messages) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:104

Parameters#

messages#

UIMessage<unknown>[]

Returns#

void

onStreamEnd?#

optional onStreamEnd?: (message) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:108

Parameters#

message#

UIMessage

Returns#

void

onStreamStart?#

optional onStreamStart?: () => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:107

Returns#

void

onStructuredOutputChange?#

optional onStructuredOutputChange?: (args) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:144

Parameters#

args#

data?#

unknown

delta?#

string

errorMessage?#

string

messageId#

string

partial?#

unknown

phase#

"error" | "complete" | "update" | "start"

raw#

string

reasoning?#

string

status#

"error" | "complete" | "streaming"

Returns#

void

onTextUpdate?#

optional onTextUpdate?: (messageId, content) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:132

Parameters#

messageId#

string

content#

string

Returns#

void

onThinkingUpdate?#

optional onThinkingUpdate?: (messageId, stepId, content) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:139

Parameters#

messageId#

string

stepId#

string

content#

string

Returns#

void

onToolCall?#

optional onToolCall?: (args) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:112

Parameters#

args#

input#

any

toolCallId#

string

toolName#

string

Returns#

void

onToolCallStateChange?#

optional onToolCallStateChange?: (messageId, toolCallId, state, args) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:133

Parameters#

messageId#

string

toolCallId#

string

state#

ToolCallState

args#

string

Returns#

void