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
- ApprovalRequestedStreamChunk
- 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
- StreamChunkType
- ToolCallState
- ToolResultState
Variable References
SubagentForward
Defined in: packages/ai/src/activities/chat/agents/bound.ts:25
The fields a child chat() needs, in one spread: chat({ adapter, messages, ...ctx.forward }).
Properties#
abortController#
abortController: AbortController;Defined in: packages/ai/src/activities/chat/agents/bound.ts:36
Aborts when the parent run or the subagent group stops.
parentRunId#
parentRunId: string;Defined in: packages/ai/src/activities/chat/agents/bound.ts:28
parentSubagentRunId?#
optional parentSubagentRunId?: string;Defined in: packages/ai/src/activities/chat/agents/bound.ts:33
The subagentRunId of the child that started this one, for a nested child.
promptCache?#
optional promptCache?: PromptCacheRetention;Defined in: packages/ai/src/activities/chat/agents/bound.ts:38
The prompt cache retention of the parent call, when it has one.
resume?#
optional resume?: RunAgentResumeItem[];Defined in: packages/ai/src/activities/chat/agents/bound.ts:34
runId#
runId: string;Defined in: packages/ai/src/activities/chat/agents/bound.ts:27
subagentName#
subagentName: string;Defined in: packages/ai/src/activities/chat/agents/bound.ts:31
The agent name. Middleware reads it as ctx.subagentName.
subagentRunId#
subagentRunId: string;Defined in: packages/ai/src/activities/chat/agents/bound.ts:29
threadId#
threadId: string;Defined in: packages/ai/src/activities/chat/agents/bound.ts:26