AI Docs
API
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
AI/LLM: This documentation page is available in plain markdown format at/ai/latest/docs/reference/interfaces/SubagentHandleData.md
SubagentHandleData
Defined in: packages/ai/src/types.ts:638
One child invocation as the client sees it. AG-UI SubagentInfo names the child; the other AG-UI fields come from its SUBAGENT_STARTED, SUBAGENT_FINISHED and SUBAGENT_ERROR events. id is the AG-UI subagentRunId. status, parentRunId and messages are client state the spec does not model.
Extends#
- SubagentInfo.Pick<AGUISubagentStartedEvent, "parentSubagentRunId" | "parentToolCallId" | "metadata">
Properties#
error?#
ts
optional error?: Pick<SubagentErrorEvent, "message" | "code">;Defined in: packages/ai/src/types.ts:652
id#
ts
id: string;Defined in: packages/ai/src/types.ts:645
interruptIds?#
ts
optional interruptIds?: string[];Defined in: packages/ai/src/types.ts:650
Interrupts this child raised, while status is 'suspended'.
messages#
ts
messages: UIMessage<unknown>[];Defined in: packages/ai/src/types.ts:651
parentRunId?#
ts
optional parentRunId?: string;Defined in: packages/ai/src/types.ts:648
The parent chat run that started this child.
status#
ts
status: SubagentStatus;Defined in: packages/ai/src/types.ts:646