Theia API Documentation v1.77.0
    Preparing search index...

    The ChatAgentService provides access to the available chat agents.

    interface ChatAgentService {
        onDefaultAgentChanged: Event<ChatAgent | undefined>;
        onDidChangeAgents: Event<void>;
        getAgent(id: string, includeHidden?: boolean): ChatAgent | undefined;
        getAgents(includeHidden?: boolean): ChatAgent[];
        getAllAgents(): ChatAgent[];
        getDefaultAgent(): ChatAgent | undefined;
        getEffectiveDefaultAgent(): ChatAgent | undefined;
        getFallbackAgent(): ChatAgent | undefined;
        getPreferenceDefaultAgent(): ChatAgent | undefined;
        registerChatAgent(agent: ChatAgent): void;
        resolveAgent(parsedRequest: ParsedChatRequest): ChatAgent | undefined;
        unregisterChatAgent(agentId: string): void;
    }

    Implemented by

    Index
    onDefaultAgentChanged: Event<ChatAgent | undefined>

    Fired when the effective default agent changes (either through preference change or when the configured agent becomes available/unavailable).

    onDidChangeAgents: Event<void>

    Fired when an agent is registered or unregistered.

    • Returns the specified agent, if available

      Parameters

      • id: string

        the agent id

      • OptionalincludeHidden: boolean

        whether to include agents that are hidden from chat (showInChat set to false). Defaults to false, meaning hidden agents will not be returned.

      Returns ChatAgent | undefined