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
RealtimeSessionConfig
Defined in: packages/ai/src/realtime/types.ts:35
Configuration for a realtime session
Properties#
instructions?#
optional instructions?: string;Defined in: packages/ai/src/realtime/types.ts:41
System instructions for the assistant
maxOutputTokens?#
optional maxOutputTokens?: number | "inf";Defined in: packages/ai/src/realtime/types.ts:53
Maximum number of tokens in a response
model?#
optional model?: string;Defined in: packages/ai/src/realtime/types.ts:37
Model to use for the session
outputModalities?#
optional outputModalities?: ("text" | "audio")[];Defined in: packages/ai/src/realtime/types.ts:49
Output modalities for responses (e.g., ['audio', 'text'], ['text'])
providerOptions?#
optional providerOptions?: Record<string, any>;Defined in: packages/ai/src/realtime/types.ts:57
Provider-specific options
semanticEagerness?#
optional semanticEagerness?: "low" | "medium" | "high";Defined in: packages/ai/src/realtime/types.ts:55
Eagerness level for semantic VAD ('low', 'medium', 'high')
temperature?#
optional temperature?: number;Defined in: packages/ai/src/realtime/types.ts:51
Temperature for generation (provider-specific range, e.g., 0.6-1.2 for OpenAI)
tools?#
optional tools?: RealtimeToolConfig[];Defined in: packages/ai/src/realtime/types.ts:43
Tools available in the session
vadConfig?#
optional vadConfig?: VADConfig;Defined in: packages/ai/src/realtime/types.ts:47
VAD configuration
vadMode?#
optional vadMode?: "server" | "semantic" | "manual";Defined in: packages/ai/src/realtime/types.ts:45
VAD mode
voice?#
optional voice?: string;Defined in: packages/ai/src/realtime/types.ts:39
Voice to use for audio output