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
ResolvedMediaPrompt
Defined in: packages/ai/src/utilities/media-prompt.ts:23
A MediaPrompt decomposed into the views adapters consume.
Adapters with native multimodal prompts (Gemini contents, OpenRouter chat content parts) consume parts to preserve interleaving; named-field providers (fal, OpenAI) consume text plus the typed media buckets.
Prompt text is never rewritten: text parts are concatenated verbatim. Providers that support referencing inputs from the prompt (e.g. fal's @Image1, OpenAI's "image 1" prose) expect the user to write that syntax themselves — the SDK does not inject or substitute markers.
Properties#
audios#
audios: AudioPart<MediaInputMetadata>[];Defined in: packages/ai/src/utilities/media-prompt.ts:36
Audio parts in prompt order.
images#
images: ImagePart<MediaInputMetadata>[];Defined in: packages/ai/src/utilities/media-prompt.ts:32
Image parts in prompt order.
parts#
parts: MediaPromptPart[];Defined in: packages/ai/src/utilities/media-prompt.ts:30
The prompt as ordered parts; a string prompt becomes one text part.
text#
text: string;Defined in: packages/ai/src/utilities/media-prompt.ts:28
Text parts concatenated verbatim (paragraph-separated). Empty string for media-only prompts.
videos#
videos: VideoPart<MediaInputMetadata>[];Defined in: packages/ai/src/utilities/media-prompt.ts:34
Video parts in prompt order.