Interface: StreamProcessorEvents#
Defined in: packages/ai/src/activities/chat/stream/processor.ts:67
Events emitted by the StreamProcessor
Properties#
onApprovalRequest()?#
optional onApprovalRequest: (args) => void;
Defined in: packages/ai/src/activities/chat/stream/processor.ts:82
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:90
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:74
Parameters#
error#
Error
Returns#
void
onMessagesChange()?#
optional onMessagesChange: (messages) => void;
Defined in: packages/ai/src/activities/chat/stream/processor.ts:69
Parameters#
messages#
UIMessage<unknown>[]
Returns#
void
onStreamEnd()?#
optional onStreamEnd: (message) => void;
Defined in: packages/ai/src/activities/chat/stream/processor.ts:73
Parameters#
message#
Returns#
void
onStreamStart()?#
optional onStreamStart: () => void;
Defined in: packages/ai/src/activities/chat/stream/processor.ts:72
Returns#
void
onStructuredOutputChange()?#
optional onStructuredOutputChange: (args) => void;
Defined in: packages/ai/src/activities/chat/stream/processor.ts:109
Parameters#
args#
data?#
unknown
delta?#
string
errorMessage?#
string
messageId#
string
partial?#
unknown
phase#
"error" | "complete" | "start" | "update"
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:97
Parameters#
messageId#
string
content#
string
Returns#
void
onThinkingUpdate()?#
optional onThinkingUpdate: (messageId, stepId, content) => void;
Defined in: packages/ai/src/activities/chat/stream/processor.ts:104
Parameters#
messageId#
string
stepId#
string
content#
string
Returns#
void
onToolCall()?#
optional onToolCall: (args) => void;
Defined in: packages/ai/src/activities/chat/stream/processor.ts:77
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:98
Parameters#
messageId#
string
toolCallId#
string
state#
args#
string
Returns#
void