Class Agent

Standard Agent implementation that uses an LLM

Hierarchy (View Summary)

BaseAgent
- Agent

Index

Constructors

Properties

description name parentAgent? subAgents

Accessors

Methods

addSubAgent findAgent findSubAgent run runStreaming

Constructors

constructor

new Agent(config: AgentConfig): Agent
Constructor for Agent
Parameters
- config: AgentConfig
Returns Agent
Overrides BaseAgent.constructor
- Defined in agents/specialized/Agent.ts:152

Properties

description

description: string

Description about the agent's capability The LLM uses this to determine whether to delegate control to the agent

name

name: string

The agent's name Agent name must be a unique identifier within the agent tree

`Optional`parentAgent

parentAgent?: BaseAgent

The parent agent of this agent Note that an agent can ONLY be added as sub-agent once

subAgents

subAgents: BaseAgent[]

The sub-agents of this agent

Accessors

rootAgent

get rootAgent(): BaseAgent
Gets the root agent of the agent tree

Returns BaseAgent
Inherited from BaseAgent.rootAgent
- Defined in agents/base/BaseAgent.ts:56

Methods

addSubAgent

addSubAgent(agent: BaseAgent): BaseAgent
Adds a sub-agent to this agent
Parameters
- agent: BaseAgent
Returns BaseAgent
Inherited from BaseAgent.addSubAgent
- Defined in agents/base/BaseAgent.ts:63

findAgent

findAgent(name: string): undefined | BaseAgent
Finds an agent in the agent tree by name
Parameters
- name: string
Returns undefined | BaseAgent
Inherited from BaseAgent.findAgent
- Defined in agents/base/BaseAgent.ts:92

findSubAgent

findSubAgent(name: string): undefined | BaseAgent
Finds a sub-agent by name
Parameters
- name: string
Returns undefined | BaseAgent
Inherited from BaseAgent.findSubAgent
- Defined in agents/base/BaseAgent.ts:85

run

run(
options: { config?: RunConfig; messages: Message[]; sessionId?: string },
): Promise<LLMResponse>
Runs the agent with the given messages and configuration
Parameters
- options: { config?: RunConfig; messages: Message[]; sessionId?: string }
Returns Promise<LLMResponse>
Overrides BaseAgent.run
- Defined in agents/specialized/Agent.ts:383

runStreaming

runStreaming(
options: { config?: RunConfig; messages: Message[]; sessionId?: string },
): AsyncGenerator<LLMResponse>
Runs the agent with streaming support
Parameters
- options: { config?: RunConfig; messages: Message[]; sessionId?: string }
Returns AsyncGenerator<LLMResponse>
Overrides BaseAgent.runStreaming
- Defined in agents/specialized/Agent.ts:516