Class Orchestrator

Agents exports - Agent framework, Orchestrator, Experts Split from index.ts for file size compliance (Issue #285)

Hierarchy (View Summary)

BaseAgent
- Orchestrator

Constructors

constructor

new Orchestrator(
    options?: Partial<BaseAgentOptions> & OrchestratorExtendedOptions & {
        techLeadOptions?: OrchestratorOptions;
    },
): Orchestrator
Parameters
- options: Partial<BaseAgentOptions> & OrchestratorExtendedOptions & {
  techLeadOptions?: OrchestratorOptions;
  } = {}
Returns Orchestrator
Overrides BaseAgent.constructor
- Defined in packages/nexus-agents/src/agents/tech-lead.ts:198

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
Inherited from BaseAgent.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
Inherited from BaseAgent.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
Inherited from BaseAgent.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
Inherited from BaseAgent.handleMessage
- Defined in packages/nexus-agents/src/agents/base-agent.ts:243

cleanup

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

Returns Promise<void>
Inherited from BaseAgent.cleanup
- Defined in packages/nexus-agents/src/agents/base-agent.ts:258

hasCapability

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

`Protected`transformError

transformError(error: unknown, taskId: string): AgentError
Parameters
- error: unknown
- taskId: string
Returns AgentError
Inherited from BaseAgent.transformError
- 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>>
Inherited from BaseAgent.complete
- Defined in packages/nexus-agents/src/agents/base-agent.ts:285

`Protected`addToHistory

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

`Protected`getHistory

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

`Protected`clearHistory

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

getPruningMetrics

getPruningMetrics(): Readonly<ContextPruningMetrics>
Returns Readonly<ContextPruningMetrics>
Inherited from BaseAgent.getPruningMetrics
- 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>
Inherited from BaseAgent.addContextItem
- Defined in packages/nexus-agents/src/agents/base-agent.ts:320

isContextPruningEnabled

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

isMemoryEnabled

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

getMemoryState

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

getRelevantMemories

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

flushMemory

flushMemory(): Promise<Result<void, AgentMemoryError>>
Returns Promise<Result<void, AgentMemoryError>>
Inherited from BaseAgent.flushMemory
- 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
Inherited from BaseAgent.recordLearning
- 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
Inherited from BaseAgent.recordPattern
- 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
Inherited from BaseAgent.recordResolution
- Defined in packages/nexus-agents/src/agents/base-agent.ts:366

`Protected`findResolutionForError

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

`Protected`getTaskLearnings

getTaskLearnings(taskType: string): readonly TaskLearning[]
Parameters
- taskType: string
Returns readonly TaskLearning[]
Inherited from BaseAgent.getTaskLearnings
- 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[]
Inherited from BaseAgent.getTopExecutionPatterns
- Defined in packages/nexus-agents/src/agents/base-agent.ts:375

setExpertAgents

setExpertAgents(agents: Map<string, IAgent>): void
Set expert agents for collaboration (Issue #488). Call this to provide agents that can participate in collaborative synthesis.
Parameters
- agents: Map<string, IAgent>
Returns void
- Defined in packages/nexus-agents/src/agents/tech-lead.ts:231

`Protected`executeTask

executeTask(task: Task): Promise<Result<TaskResult, AgentError>>
Execute a task by analyzing, decomposing (if needed), and coordinating.
Parameters
- task: Task
Returns Promise<Result<TaskResult, AgentError>>
Overrides BaseAgent.executeTask
- Defined in packages/nexus-agents/src/agents/tech-lead.ts:240

`Protected`buildPrompt

buildPrompt(task: Task): Message[]
Build prompt messages for task execution.
Parameters
- task: Task
Returns Message[]
Overrides BaseAgent.buildPrompt
- Defined in packages/nexus-agents/src/agents/tech-lead.ts:282

analyzeTask

analyzeTask(task: Task): Promise<Result<TaskAnalysis, AgentError>>
Analyze a task to understand its complexity and requirements.
Parameters
- task: Task
Returns Promise<Result<TaskAnalysis, AgentError>>
- Defined in packages/nexus-agents/src/agents/tech-lead.ts:287

decomposeTask

decomposeTask(
task: Task,
analysis: TaskAnalysis,
): Promise<Result<SubTask[], AgentError>>
Decompose a task into subtasks.
Parameters
- task: Task
- analysis: TaskAnalysis
Returns Promise<Result<SubTask[], AgentError>>
- Defined in packages/nexus-agents/src/agents/tech-lead.ts:318

selectExperts

selectExperts(subtasks: SubTask[]): ExpertAssignment[]
Select appropriate expert agents for each subtask.
Parameters
- subtasks: SubTask[]
Returns ExpertAssignment[]
- Defined in packages/nexus-agents/src/agents/tech-lead.ts:357

synthesizeResults

synthesizeResults(
results: TaskResult[],
originalTask?: Task,
): Promise<Result<SynthesizedResult, AgentError>>
Synthesize results from multiple experts into a cohesive output.

Uses collaboration protocols for complex multi-expert synthesis (Issue #488) when enough experts and task complexity warrant it.
Parameters
- results: TaskResult[]
  Results to synthesize
- OptionaloriginalTask: Task
  Optional original task for context in collaborative synthesis
Returns Promise<Result<SynthesizedResult, AgentError>>
- Defined in packages/nexus-agents/src/agents/tech-lead.ts:370

getCollaborationHelper

getCollaborationHelper(): OrchestratorCollaborationHelper
Get the collaboration helper for external use.

Returns OrchestratorCollaborationHelper
- Defined in packages/nexus-agents/src/agents/tech-lead.ts:468

getOptions

getOptions(): Readonly<Required<OrchestratorOptions>>
Get the Orchestrator options.

Returns Readonly<Required<OrchestratorOptions>>
- Defined in packages/nexus-agents/src/agents/tech-lead.ts:473

Class Orchestrator

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Orchestrator

Properties

Readonlyid

Readonlyrole

Readonlycapabilities

Protected ReadonlystateMachine

Protected ReadonlybudgetTracker

Protectedadapter

Protected Readonlylogger

Protectedconfig

ProtectedsharedState

Protectedhistory

Protected ReadonlysystemPrompt

Protected Readonlytemperature

Protected ReadonlymaxTokens

Protected ReadonlyeventBus

Protected ReadonlyemitMessageEvents

Accessors

state

Returns AgentState

Methods

initialize

Parameters

Returns Promise<Result<void, AgentError>>

execute

Parameters

Returns Promise<Result<TaskResult, AgentError>>

handleMessage

Parameters

Returns Promise<Result<AgentResponse, AgentError>>

cleanup

Returns Promise<void>

hasCapability

Parameters

Returns boolean

ProtectedtransformError

Parameters

Returns AgentError

Protectedcomplete

Parameters

Returns Promise<Result<CompletionResponse, AgentError>>

ProtectedaddToHistory

Parameters

Returns void

ProtectedgetHistory

Returns Message[]

ProtectedclearHistory

Returns void

getPruningMetrics

Returns Readonly<ContextPruningMetrics>

ProtectedaddContextItem

Parameters

Returns Promise<void>

isContextPruningEnabled

Returns boolean

isMemoryEnabled

Returns boolean

getMemoryState

Returns Readonly<AgentMemoryState> | null

getRelevantMemories

Returns readonly TypedMemoryEntry<MemoryType>[]

flushMemory

Returns Promise<Result<void, AgentMemoryError>>

ProtectedrecordLearning

Parameters

Returns void

ProtectedrecordPattern

Parameters

Returns void

ProtectedrecordResolution

`Readonly`id

`Readonly`role

`Readonly`capabilities

`Protected` `Readonly`stateMachine

`Protected` `Readonly`budgetTracker

`Protected`adapter

`Protected` `Readonly`logger

`Protected`config

`Protected`sharedState

`Protected`history

`Protected` `Readonly`systemPrompt

`Protected` `Readonly`temperature

`Protected` `Readonly`maxTokens

`Protected` `Readonly`eventBus

`Protected` `Readonly`emitMessageEvents

`Protected`transformError

`Protected`complete

`Protected`addToHistory

`Protected`getHistory

`Protected`clearHistory

`Protected`addContextItem

`Protected`recordLearning

`Protected`recordPattern

`Protected`recordResolution

`Protected`findResolutionForError

`Protected`getTaskLearnings

`Protected`getTopExecutionPatterns

`Protected`executeTask

`Protected`buildPrompt