AI Docs
API
Class References
Function References
- text
- textOptions
- combineStrategies
- convertMessagesToModelMessages
- convertZodToJsonSchema
- createReplayStream
- embedding
- generateMessageId
- maxIterations
- messages
- modelMessageToUIMessage
- modelMessagesToUIMessages
- normalizeToUIMessage
- parsePartialJSON
- summarize
- toServerSentEventsStream
- toServerSentEventsResponse
- toolDefinition
- uiMessageToModelMessages
- realtimeToken
- untilFinishReason
Interface References
- AIAdapter
- AIAdapterConfig
- AgentLoopState
- ApprovalRequestedStreamChunk
- AudioPart
- AudioVisualization
- BaseStreamChunk
- TextCompletionChunk
- TextOptions
- ChunkRecording
- ChunkStrategy
- ClientTool
- ContentPartSource
- ContentStreamChunk
- DefaultMessageMetadataByModality
- DocumentPart
- DoneStreamChunk
- EmbeddingOptions
- EmbeddingResult
- ErrorStreamChunk
- ImagePart
- InternalToolCallState
- JSONParser
- ModelMessage
- ProcessorResult
- ProcessorState
- RealtimeAdapter
- RealtimeClientOptions
- RealtimeConnection
- RealtimeMessage
- RealtimeSessionConfig
- RealtimeToken
- RealtimeTokenAdapter
- RealtimeTokenOptions
- ResponseFormat
- ServerTool
- StreamProcessorEvents
- StreamProcessorHandlers
- StreamProcessorOptions
- SummarizationOptions
- SummarizationResult
- TextPart
- ThinkingPart
- ThinkingStreamChunk
- Tool
- ToolCall
- ToolCallPart
- ToolCallStreamChunk
- ToolConfig
- ToolDefinition
- ToolDefinitionConfig
- ToolDefinitionInstance
- ToolInputAvailableStreamChunk
- ToolResultPart
- ToolResultStreamChunk
- UIMessage
- VideoPart
Type Alias References
- AgentLoopStrategy
- AnyClientTool
- TextStreamOptionsForModel
- TextStreamOptionsUnion
- ConstrainedContent
- ConstrainedModelMessage
- ContentPart
- ContentPartForModalities
- ExtractModalitiesForModel
- ExtractModelsFromAdapter
- InferToolInput
- InferToolName
- InferToolOutput
- MessagePart
- RealtimeEvent
- RealtimeMessagePart
- RealtimeMode
- RealtimeStatus
- ModalitiesArrayToUnion
- Modality
- StreamChunk
- StreamChunkType
- ToolCallState
- ToolResultState
Variable References
AI/LLM: This documentation page is available in plain markdown format at/ai/latest/docs/reference/interfaces/RealtimeEventPayloads.md
RealtimeEventPayloads
Defined in: packages/ai/src/realtime/types.ts:258
Event payloads for realtime events
Properties#
audio_chunk#
ts
audio_chunk: object;Defined in: packages/ai/src/realtime/types.ts:266
data#
ts
data: ArrayBuffer;sampleRate#
ts
sampleRate: number;error#
ts
error: object;Defined in: packages/ai/src/realtime/types.ts:270
error#
ts
error: Error;go_away#
ts
go_away: object;Defined in: packages/ai/src/realtime/types.ts:271
timeLeft?#
ts
optional timeLeft?: string;interrupted#
ts
interrupted: object;Defined in: packages/ai/src/realtime/types.ts:269
messageId?#
ts
optional messageId?: string;message_complete#
ts
message_complete: object;Defined in: packages/ai/src/realtime/types.ts:268
message#
ts
message: RealtimeMessage;mode_change#
ts
mode_change: object;Defined in: packages/ai/src/realtime/types.ts:260
mode#
ts
mode: RealtimeMode;status_change#
ts
status_change: object;Defined in: packages/ai/src/realtime/types.ts:259
status#
ts
status: RealtimeStatus;tool_call#
ts
tool_call: object;Defined in: packages/ai/src/realtime/types.ts:267
input#
ts
input: unknown;toolCallId#
ts
toolCallId: string;toolName#
ts
toolName: string;transcript#
ts
transcript: object;Defined in: packages/ai/src/realtime/types.ts:261
isFinal#
ts
isFinal: boolean;role#
ts
role: "assistant" | "user";transcript#
ts
transcript: string;usage#
ts
usage: UsageInfo;Defined in: packages/ai/src/realtime/types.ts:272