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
SubagentsBag
Defined in: packages/ai/src/activities/chat/agents/spawn.ts:84
Type Parameters#
TAgents#
TAgents extends ReadonlyArray<DefinedAgent> = ReadonlyArray<DefinedAgent>
Properties#
agents#
agents: TAgents;Defined in: packages/ai/src/activities/chat/agents/spawn.ts:87
order?#
optional order?: "parallel" | "sequence";Defined in: packages/ai/src/activities/chat/agents/spawn.ts:99
How a router list runs. parallel starts every name together. sequence runs each name after the previous one finishes, and passes that child's text to the next child.
router?#
optional router?: (ctx) =>
| SubagentRouterPick
| Promise<SubagentRouterPick>;Defined in: packages/ai/src/activities/chat/agents/spawn.ts:88
Parameters#
ctx#
abortSignal?#
AbortSignal
agents#
NoInfer<TAgents>
messages#
( | UIMessage<unknown> | ModelMessage< | string | ContentPart<unknown, unknown, unknown, unknown, unknown>[] | null>)[]
Returns#
| SubagentRouterPick | Promise<SubagentRouterPick>
sandbox?#
optional sandbox?: "own" | "inherit";Defined in: packages/ai/src/activities/chat/agents/spawn.ts:100
strategy?#
optional strategy?: "exclusive" | "handoff";Defined in: packages/ai/src/activities/chat/agents/spawn.ts:93