Class BaseAgent`Abstract`

Abstract base class for all agents. Subclasses must implement executeTask and buildPrompt.

Hierarchy (View Summary)

BaseAgent

Implements

IAgent

Constructors

constructor

new BaseAgent(options: BaseAgentOptions): BaseAgent
Parameters
- options: BaseAgentOptions
Returns BaseAgent
- Defined in packages/nexus-agents/src/agents/base-agent.ts:122

Properties

`Readonly`id

id: string

Unique agent identifier

`Readonly`role

role: AgentRole

Agent role

`Readonly`capabilities

capabilities: readonly AgentCapability[]

Agent capabilities

`Protected` `Readonly`stateMachine

stateMachine: AgentStateMachine

`Protected` `Readonly`budgetTracker

budgetTracker: ITokenBudgetTracker

`Protected`adapter

adapter: IModelAdapter | undefined

`Protected` `Readonly`logger

logger: ILogger

`Protected`config

config: AgentConfig | undefined

`Protected`sharedState

sharedState: Record<string, unknown> = {}

`Protected`history

history: Message[] = []

`Protected` `Readonly`systemPrompt

systemPrompt: string | undefined

`Protected` `Readonly`temperature

temperature: number

`Protected` `Readonly`maxTokens

maxTokens: number

`Protected` `Readonly`eventBus

eventBus: IEventBus

`Protected` `Readonly`emitMessageEvents

emitMessageEvents: boolean

Accessors

state

get state(): AgentState
Current state

Returns AgentState
Implementation of IAgent.state
- Defined in packages/nexus-agents/src/agents/base-agent.ts:169

Methods

initialize

initialize(ctx: AgentContext): Promise<Result<void, AgentError>>
Initialize the agent with context.
Parameters
- ctx: AgentContext
  Agent context
Returns Promise<Result<void, AgentError>>
Result with void or AgentError
Implementation of IAgent.initialize
- Defined in packages/nexus-agents/src/agents/base-agent.ts:198

execute

execute(task: Task): Promise<Result<TaskResult, AgentError>>
Execute a task.
Parameters
- task: Task
  Task to execute
Returns Promise<Result<TaskResult, AgentError>>
Result with TaskResult or AgentError
Implementation of IAgent.execute
- Defined in packages/nexus-agents/src/agents/base-agent.ts:211

handleMessage

handleMessage(msg: AgentMessage): Promise<Result<AgentResponse, AgentError>>
Handle an inter-agent message.
Parameters
- msg: AgentMessage
  Message to handle
Returns Promise<Result<AgentResponse, AgentError>>
Result with AgentResponse or AgentError
Implementation of IAgent.handleMessage
- Defined in packages/nexus-agents/src/agents/base-agent.ts:243

cleanup

cleanup(): Promise<void>
Cleanup agent resources.

Returns Promise<void>
Implementation of IAgent.cleanup
- Defined in packages/nexus-agents/src/agents/base-agent.ts:258

hasCapability

hasCapability(capability: AgentCapability): boolean
Parameters
- capability: AgentCapability
Returns boolean
- Defined in packages/nexus-agents/src/agents/base-agent.ts:274

`Protected` `Abstract`executeTask

executeTask(task: Task): Promise<Result<TaskResult, AgentError>>
Parameters
- task: Task
Returns Promise<Result<TaskResult, AgentError>>
- Defined in packages/nexus-agents/src/agents/base-agent.ts:278

`Protected` `Abstract`buildPrompt

buildPrompt(task: Task): Message[]
Parameters
- task: Task
Returns Message[]
- Defined in packages/nexus-agents/src/agents/base-agent.ts:279

`Protected`transformError

transformError(error: unknown, taskId: string): AgentError
Parameters
- error: unknown
- taskId: string
Returns AgentError
- Defined in packages/nexus-agents/src/agents/base-agent.ts:281

`Protected`complete

complete(
request: CompletionRequest,
): Promise<Result<CompletionResponse, AgentError>>
Parameters
- request: CompletionRequest
Returns Promise<Result<CompletionResponse, AgentError>>
- Defined in packages/nexus-agents/src/agents/base-agent.ts:285

`Protected`addToHistory

addToHistory(message: Message): void
Parameters
- message: Message
Returns void
- Defined in packages/nexus-agents/src/agents/base-agent.ts:307

`Protected`getHistory

getHistory(): Message[]
Returns Message[]
- Defined in packages/nexus-agents/src/agents/base-agent.ts:310

`Protected`clearHistory

clearHistory(): void
Returns void
- Defined in packages/nexus-agents/src/agents/base-agent.ts:313

getPruningMetrics

getPruningMetrics(): Readonly<ContextPruningMetrics>
Returns Readonly<ContextPruningMetrics>
- Defined in packages/nexus-agents/src/agents/base-agent.ts:316

`Protected`addContextItem

addContextItem(
    content: string,
    priority?: 20 | 60 | 80 | 100 | 40,
    category?: "system" | "task" | "active",
): Promise<void>
Parameters
- content: string
- Optionalpriority: 20 | 60 | 80 | 100 | 40
- Optionalcategory: "system" | "task" | "active"
Returns Promise<void>
- Defined in packages/nexus-agents/src/agents/base-agent.ts:320

isContextPruningEnabled

isContextPruningEnabled(): boolean
Returns boolean
- Defined in packages/nexus-agents/src/agents/base-agent.ts:334

isMemoryEnabled

isMemoryEnabled(): boolean
Returns boolean
- Defined in packages/nexus-agents/src/agents/base-agent.ts:337

getMemoryState

getMemoryState(): Readonly<AgentMemoryState> | null
Returns Readonly<AgentMemoryState> | null
- Defined in packages/nexus-agents/src/agents/base-agent.ts:340

getRelevantMemories

getRelevantMemories(): readonly TypedMemoryEntry<MemoryType>[]
Returns readonly TypedMemoryEntry<MemoryType>[]
- Defined in packages/nexus-agents/src/agents/base-agent.ts:343

flushMemory

flushMemory(): Promise<Result<void, AgentMemoryError>>
Returns Promise<Result<void, AgentMemoryError>>
- Defined in packages/nexus-agents/src/agents/base-agent.ts:347

`Protected`recordLearning

recordLearning(learning: Omit<TaskLearning, "id" | "learnedAt">): void
Parameters
- learning: Omit<TaskLearning, "id" | "learnedAt">
Returns void
- Defined in packages/nexus-agents/src/agents/base-agent.ts:360

`Protected`recordPattern

recordPattern(
p: Omit<ExecutionPattern, "id" | "lastSeen" | "occurrences">,
): void
Parameters
- p: Omit<ExecutionPattern, "id" | "lastSeen" | "occurrences">
Returns void
- Defined in packages/nexus-agents/src/agents/base-agent.ts:363

`Protected`recordResolution

recordResolution(r: Omit<ErrorResolution, "resolvedAt">): void
Parameters
- r: Omit<ErrorResolution, "resolvedAt">
Returns void
- Defined in packages/nexus-agents/src/agents/base-agent.ts:366

`Protected`findResolutionForError

findResolutionForError(errorMessage: string): ErrorResolution | undefined
Parameters
- errorMessage: string
Returns ErrorResolution | undefined
- Defined in packages/nexus-agents/src/agents/base-agent.ts:369

`Protected`getTaskLearnings

getTaskLearnings(taskType: string): readonly TaskLearning[]
Parameters
- taskType: string
Returns readonly TaskLearning[]
- Defined in packages/nexus-agents/src/agents/base-agent.ts:372

`Protected`getTopExecutionPatterns

getTopExecutionPatterns(limit?: number): readonly ExecutionPattern[]
Parameters
- limit: number = 10
Returns readonly ExecutionPattern[]
- Defined in packages/nexus-agents/src/agents/base-agent.ts:375