Interface AgentService

Service to access the list of known Agents.

interface AgentService {
    onDidChangeAgents: Event<void>;
    disableAgent(agentId): void;
    enableAgent(agentId): void;
    getAgents(): Agent[];
    getAllAgents(): Agent[];
    isEnabled(agentId): boolean;
    registerAgent(agent): void;
    unregisterAgent(agentId): void;
}

Implemented by

AgentServiceImpl

Index

Properties

onDidChangeAgents

Methods

disableAgent enableAgent getAgents getAllAgents isEnabled registerAgent unregisterAgent

Properties

onDidChangeAgents

onDidChangeAgents: Event<void>

Emitted when the list of agents changes. This can be used to update the UI when agents are added or removed.

Methods

disableAgent

disableAgent(agentId): void
disable the agent with the specified id.
Parameters
- agentId: string
  the agent id.
Returns void
- Defined in packages/ai-core/src/common/agent-service.ts:45

enableAgent

enableAgent(agentId): void
Enable the agent with the specified id.
Parameters
- agentId: string
  the agent id.
Returns void
- Defined in packages/ai-core/src/common/agent-service.ts:40

getAgents

getAgents(): Agent[]
Retrieves a list of all available agents, i.e. agents which are not disabled

Returns Agent[]
- Defined in packages/ai-core/src/common/agent-service.ts:31

getAllAgents

getAllAgents(): Agent[]
Retrieves a list of all agents, including disabled ones.

Returns Agent[]
- Defined in packages/ai-core/src/common/agent-service.ts:35

isEnabled

isEnabled(agentId): boolean
query whether this agent is currently enabled or disabled.
Parameters
- agentId: string
  the agent id.
Returns boolean
true if the agent is enabled, false otherwise.
- Defined in packages/ai-core/src/common/agent-service.ts:51

registerAgent

registerAgent(agent): void
Allows to register an agent programmatically.
Parameters
- agent: Agent
  the agent to register
Returns void
- Defined in packages/ai-core/src/common/agent-service.ts:57

unregisterAgent

unregisterAgent(agentId): void
Allows to unregister an agent programmatically.
Parameters
- agentId: string
  the agent id to unregister
Returns void
- Defined in packages/ai-core/src/common/agent-service.ts:63