Interface ChatAgentService

The ChatAgentService provides access to the available chat agents.

interface ChatAgentService {
    getAgent(id): undefined | ChatAgent;
    getAgents(): ChatAgent[];
    getAllAgents(): ChatAgent[];
    registerChatAgent(agent): void;
    unregisterChatAgent(agentId): void;
}

Implemented by

ChatAgentServiceImpl

Index

Methods

getAgent getAgents getAllAgents registerChatAgent unregisterChatAgent

Methods

getAgent

getAgent(id): undefined | ChatAgent
Returns the specified agent, if available
Parameters
- id: string
Returns undefined | ChatAgent
- Defined in packages/ai-chat/src/common/chat-agent-service.ts:39

getAgents

getAgents(): ChatAgent[]
Returns all available agents.

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

getAllAgents

getAllAgents(): ChatAgent[]
Returns all agents, including disabled ones.

Returns ChatAgent[]
- Defined in packages/ai-chat/src/common/chat-agent-service.ts:43

registerChatAgent

registerChatAgent(agent): void
Allows to register a chat agent programmatically.
Parameters
- agent: ChatAgent
  the agent to register
Returns void
- Defined in packages/ai-chat/src/common/chat-agent-service.ts:49

unregisterChatAgent

unregisterChatAgent(agentId): void
Allows to unregister a chat agent programmatically.
Parameters
- agentId: string
  the agent id to unregister
Returns void
- Defined in packages/ai-chat/src/common/chat-agent-service.ts:55