DefinedAgent

Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:50

A named child agent. run is a chat() call (or any stream of AG-UI chunks). TTools and TSchema stay on the object so useChat({ subagents }) can type that child's parts.

Extends#

• SubagentInfo

Type Parameters#

TName#

TName extends string = string

TTools#

TTools extends ReadonlyArray<SubagentTool> = ReadonlyArray<SubagentTool>

TSchema#

TSchema extends SchemaInput | undefined = SchemaInput | undefined

TInterrupts#

TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> = ReadonlyArray<InterruptDefinition<any, any, any, any>>

Properties#

description#

description: string;

Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:59

Required here: the router and the synthetic tool both read it.

Overrides#

AGUISubagentInfo.description

interrupts?#

optional interrupts?: TInterrupts;

Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:64

name#

name: TName;

Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:57

Unique name or identifier of the subagent.

Overrides#

AGUISubagentInfo.name

outputSchema?#

optional outputSchema?: TSchema;

Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:65

run#

run: (ctx) => 
  | AsyncIterable<AGUIEvent, any, any>
| Promise<AsyncIterable<AGUIEvent, any, any>>;

Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:60

Parameters#

ctx#

SubagentRunContext

Returns#

| AsyncIterable<AGUIEvent, any, any> | Promise<AsyncIterable<AGUIEvent, any, any>>

subagents?#

optional subagents?: unknown;

Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:66

tools?#

optional tools?: TTools;

Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:63