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
TTSAdapter
Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:46
TTS adapter interface with pre-resolved generics.
An adapter is created by a provider function: provider('model') → adapter All type resolution happens at the provider call site, not in this interface.
Generic parameters:
- TModel: The specific model name (e.g., 'tts-1')
- TProviderOptions: Provider-specific options (already resolved)
Type Parameters#
TModel#
TModel extends string = string
TProviderOptions#
TProviderOptions extends object = Record<string, unknown>
Properties#
~types#
~types: object;Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:65
Internal
Type-only properties for inference. Not assigned at runtime.
providerOptions#
providerOptions: TProviderOptions;capabilities?#
readonly optional capabilities?: TTSCapabilities;Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:60
Optional static capability declaration. Absent means "single voice, no timestamps" — the contract every adapter had before dialogue existed.
generateSpeech#
generateSpeech: (options) => Promise<TTSResult>;Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:72
Generate speech from text
Parameters#
options#
TTSOptions<TProviderOptions>
Returns#
Promise<TTSResult>
kind#
readonly kind: "tts";Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:51
Discriminator for adapter kind - used to determine API shape
listVoices?#
optional listVoices?: (options?) => Promise<ListVoicesResult>;Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:84
List the voices this account can use.
Optional, because only some providers have a catalog worth querying at runtime. A provider whose voices are a fixed list known at build time publishes that list from its own package instead (GeminiTTSVoices, or the OpenAITTSVoice union), which is strictly better than a network call. Implement this only when the catalog is per-account and can change, which is the case wherever generateVoice() can add to it.
Parameters#
options?#
Returns#
Promise<ListVoicesResult>
model#
readonly model: TModel;Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:55
The model this adapter is configured for
name#
readonly name: string;Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:53
Adapter name identifier