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
uiMessagesToWire
function uiMessagesToWire(messages, options?): WireMessage[];Defined in: packages/ai/src/utilities/ag-ui-wire.ts:101
Serialize TanStack UIMessages and ModelMessages into the AG-UI RunAgentInput.messages wire shape. Anchors are spec-only (id, role, name, content, toolCalls, metadata). Tool results and thinking parts on assistant messages are additionally emitted as fan-out {role:'tool',...} and {role:'reasoning',...} entries for strict AG-UI server consumers. Set includeSnapshotStructuredOutput to retain complete structured-output metadata for UI snapshots. Set includeActivity to emit AG-UI ActivityMessage rows (MESSAGES_SNAPSHOT only — default omit so RunAgentInput never carries activity). An assistant message whose parts leave the default block order goes out as several rows in the real order (see TanStackMessageMetadata.continues). A tool result also ends a row, and its tool row follows that row.
Parameters#
messages#
( | UIMessage<unknown> | ModelMessage< | string | ContentPart<unknown, unknown, unknown, unknown, unknown>[] | null>)[]
options?#
includeActivity?#
boolean
includeSnapshotStructuredOutput?#
boolean