Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
Persistence (Advanced)
Embeddings
Reranking
Evaluate
Sandboxes (Advanced)
Class References
Function References
Interface References
Type Alias References
Variable References
Interface References

StreamProcessorEvents

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

Events emitted by the StreamProcessor

Properties

onApprovalRequest?

ts
optional onApprovalRequest?: (args) => void;
optional onApprovalRequest?: (args) => void;

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

Parameters

args
approvalId

string

input

any

toolCallId

string

toolName

string

Returns

void


onCustomEvent?

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

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

Parameters

eventType

string

data

unknown

context
toolCallId?

string

Returns

void


onError?

ts
optional onError?: (error) => void;
optional onError?: (error) => void;

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

Parameters

error

Error

Returns

void


onMessagesChange?

ts
optional onMessagesChange?: (messages) => void;
optional onMessagesChange?: (messages) => void;

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

Parameters

messages

UIMessage<unknown>[]

Returns

void


onStreamEnd?

ts
optional onStreamEnd?: (message) => void;
optional onStreamEnd?: (message) => void;

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

Parameters

message

UIMessage

Returns

void


onStreamStart?

ts
optional onStreamStart?: () => void;
optional onStreamStart?: () => void;

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

Returns

void


onStructuredOutputChange?

ts
optional onStructuredOutputChange?: (args) => void;
optional onStructuredOutputChange?: (args) => void;

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

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?

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

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

Parameters

messageId

string

content

string

Returns

void


onThinkingUpdate?

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

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

Parameters

messageId

string

stepId

string

content

string

Returns

void


onToolCall?

ts
optional onToolCall?: (args) => void;
optional onToolCall?: (args) => void;

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

Parameters

args
input

any

toolCallId

string

toolName

string

Returns

void


onToolCallStateChange?

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

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

Parameters

messageId

string

toolCallId

string

state

ToolCallState

args

string

Returns

void