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
UIResourcePart
Defined in: packages/ai/src/types.ts:657
Properties#
meta?#
optional meta?: Record<string, unknown>;Defined in: packages/ai/src/types.ts:671
Reserved for future passthrough of the resource/tool _meta.ui (e.g. frame-size hints). Currently always undefined — nothing populates this field yet.
resource#
resource: object;Defined in: packages/ai/src/types.ts:660
The ui:// resource object in MCP-native shape — fed straight to the renderer.
blob?#
optional blob?: string;mimeType#
mimeType: string;text?#
optional text?: string;uri#
uri: string;serverId?#
optional serverId?: string;Defined in: packages/ai/src/types.ts:662
Pool prefix / config key — routes interactive calls to the right MCP server.
toolCallId#
toolCallId: string;Defined in: packages/ai/src/types.ts:665
Links the widget to the originating tool call — correlates it with the sibling ToolCallPart/ToolResultPart in the same message.
toolName#
toolName: string;Defined in: packages/ai/src/types.ts:668
Server-native (unprefixed) MCP tool name whose UI this resource renders. Required by the renderer (@mcp-ui/client's AppRenderer toolName prop).
type#
type: "ui-resource";Defined in: packages/ai/src/types.ts:658