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
- 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
- ToolCallState
- ToolResultState
Variable References
GeneratedVoice
Defined in: packages/ai/src/types.ts:3111
A single voice produced by VoiceGenerationOptions.
Properties#
audio?#
optional audio?: string;Defined in: packages/ai/src/types.ts:3118
Base64-encoded preview audio, when the provider returns one
contentType?#
optional contentType?: string;Defined in: packages/ai/src/types.ts:3122
Content type of the preview (e.g. 'audio/mpeg')
duration?#
optional duration?: number;Defined in: packages/ai/src/types.ts:3124
Duration of the preview in seconds, if available
format?#
optional format?: string;Defined in: packages/ai/src/types.ts:3120
Audio format of the preview (e.g. 'mp3')
language?#
optional language?: string;Defined in: packages/ai/src/types.ts:3126
Language of the preview, if reported
saved#
saved: boolean;Defined in: packages/ai/src/types.ts:3131
Whether the voice is persisted in the provider's voice library. Unsaved voices are previews and generally expire.
status#
status: VoiceTrainingStatus;Defined in: packages/ai/src/types.ts:3136
Whether the voice can be used in generateSpeech() yet. Required so a caller never has to guess: every adapter states it outright.
voiceId#
voiceId: string;Defined in: packages/ai/src/types.ts:3116
The provider's voice identifier. Pass it straight back as the voice option on generateSpeech().