@theia/ai-core 1.54.0

package/src/common/agent-service.ts

@@ -0,0 +1,108 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+import { inject, injectable, named, optional, postConstruct } from '@theia/core/shared/inversify';
+import { ContributionProvider } from '@theia/core';
+import { Agent } from './agent';
+import { AISettingsService } from './settings-service';
+
+export const AgentService = Symbol('AgentService');
+
+/**
+ * Service to access the list of known Agents.
+ */
+export interface AgentService {
+    /**
+     * Retrieves a list of all available agents, i.e. agents which are not disabled
+     */
+    getAgents(): Agent[];
+    /**
+     * Retrieves a list of all agents, including disabled ones.
+     */
+    getAllAgents(): Agent[];
+    /**
+     * Enable the agent with the specified id.
+     * @param agentId the agent id.
+     */
+    enableAgent(agentId: string): void;
+    /**
+     * disable the agent with the specified id.
+     * @param agentId the agent id.
+     */
+    disableAgent(agentId: string): void;
+    /**
+     * query whether this agent is currently enabled or disabled.
+     * @param agentId the agent id.
+     * @return true if the agent is enabled, false otherwise.
+     */
+    isEnabled(agentId: string): boolean;
+}
+
+@injectable()
+export class AgentServiceImpl implements AgentService {
+
+    @inject(ContributionProvider) @named(Agent)
+    protected readonly agentsProvider: ContributionProvider<Agent>;
+
+    @inject(AISettingsService) @optional()
+    protected readonly aiSettingsService: AISettingsService | undefined;
+
+    protected disabledAgents = new Set<string>();
+
+    protected _agents: Agent[] = [];
+
+    @postConstruct()
+    protected init(): void {
+        this.aiSettingsService?.getSettings().then(settings => {
+            Object.entries(settings).forEach(([agentId, agentSettings]) => {
+                if (agentSettings.enable === false) {
+                    this.disabledAgents.add(agentId);
+                }
+            });
+        });
+    }
+
+    private get agents(): Agent[] {
+        // We can't collect the contributions at @postConstruct because this will lead to a circular dependency
+        // with agents reusing the chat agent service (e.g. orchestrator) which in turn injects the agent service
+        return [...this.agentsProvider.getContributions(), ...this._agents];
+    }
+
+    registerAgent(agent: Agent): void {
+        this._agents.push(agent);
+    }
+
+    getAgents(): Agent[] {
+        return this.agents.filter(agent => this.isEnabled(agent.id));
+    }
+
+    getAllAgents(): Agent[] {
+        return this.agents;
+    }
+
+    enableAgent(agentId: string): void {
+        this.disabledAgents.delete(agentId);
+        this.aiSettingsService?.updateAgentSettings(agentId, { enable: true });
+    }
+
+    disableAgent(agentId: string): void {
+        this.disabledAgents.add(agentId);
+        this.aiSettingsService?.updateAgentSettings(agentId, { enable: false });
+    }
+
+    isEnabled(agentId: string): boolean {
+        return !this.disabledAgents.has(agentId);
+    }
+}

package/src/common/agent.ts

@@ -0,0 +1,70 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { LanguageModelRequirement } from './language-model';
+import { PromptTemplate } from './prompt-service';
+
+export interface AgentSpecificVariables {
+    name: string;
+    description: string;
+    usedInPrompt: boolean;
+}
+
+export const Agent = Symbol('Agent');
+/**
+ * Agents represent the main functionality of the AI system. They are responsible for processing user input, collecting information from the environment,
+ * invoking and processing LLM responses, and providing the final response to the user while recording their actions in the AI history.
+ *
+ * Agents are meant to cover all use cases, from specialized scenarios to general purpose chat bots.
+ *
+ * Agents are encouraged to provide a detailed description of their functionality and their processed inputs.
+ * They can also declare their used prompt templates, which makes them configurable for the user.
+ */
+export interface Agent {
+    /**
+     * Used to identify an agent, e.g. when it is requesting language models, etc.
+     *
+     * @note This parameter might be removed in favor of `name`. Therefore, it is recommended to set `id` to the same value as `name` for now.
+     */
+    readonly id: string;
+
+    /**
+     * Human-readable name shown to users to identify the agent. Must be unique.
+     * Use short names without "Agent" or "Chat" (see `tags` for adding further properties).
+     */
+    readonly name: string;
+
+    /** A markdown description of its functionality and its privacy-relevant requirements, including function call handlers that access some data autonomously. */
+    readonly description: string;
+
+    /** The list of global variable identifiers this agent needs to clarify its context requirements. See #39. */
+    readonly variables: string[];
+
+    /** The prompt templates introduced and used by this agent. */
+    readonly promptTemplates: PromptTemplate[];
+
+    /** Required language models. This includes the purpose and optional language model selector arguments. See #47. */
+    readonly languageModelRequirements: LanguageModelRequirement[];
+
+    /** A list of tags to filter agents and to display capabilities in the UI */
+    readonly tags?: String[];
+
+    /** The list of local variable identifiers this agent needs to clarify its context requirements. */
+    readonly agentSpecificVariables: AgentSpecificVariables[];
+
+    /** The list of global function identifiers this agent needs to clarify its context requirements. */
+    readonly functions: string[];
+}

package/src/common/agents-variable-contribution.ts

@@ -0,0 +1,64 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { AIVariable, AIVariableContext, AIVariableContribution, AIVariableResolutionRequest, AIVariableResolver, AIVariableService, ResolvedAIVariable } from './variable-service';
+import { MaybePromise } from '@theia/core';
+import { AgentService } from './agent-service';
+
+export const AGENTS_VARIABLE: AIVariable = {
+    id: 'agents',
+    name: 'agents',
+    description: 'Returns the list of agents available in the system'
+};
+
+export interface ResolvedAgentsVariable extends ResolvedAIVariable {
+    agents: AgentDescriptor[];
+}
+
+export interface AgentDescriptor {
+    id: string;
+    name: string;
+    description: string;
+}
+
+@injectable()
+export class AgentsVariableContribution implements AIVariableContribution, AIVariableResolver {
+
+    @inject(AgentService)
+    protected readonly agentService: AgentService;
+
+    registerVariables(service: AIVariableService): void {
+        service.registerResolver(AGENTS_VARIABLE, this);
+    }
+
+    canResolve(request: AIVariableResolutionRequest, _context: AIVariableContext): MaybePromise<number> {
+        if (request.variable.name === AGENTS_VARIABLE.name) {
+            return 1;
+        }
+        return -1;
+    }
+
+    async resolve(request: AIVariableResolutionRequest, context: AIVariableContext): Promise<ResolvedAgentsVariable | undefined> {
+        if (request.variable.name === AGENTS_VARIABLE.name) {
+            const agents = this.agentService.getAgents().map(agent => ({
+                id: agent.id,
+                name: agent.name,
+                description: agent.description
+            }));
+            return { variable: AGENTS_VARIABLE, agents, value: JSON.stringify(agents) };
+        }
+    }
+}

package/src/common/communication-recording-service.ts

@@ -0,0 +1,44 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { Event } from '@theia/core';
+
+export type CommunicationHistory = CommunicationHistoryEntry[];
+
+export interface CommunicationHistoryEntry {
+    agentId: string;
+    sessionId: string;
+    timestamp: number;
+    requestId: string;
+    request?: string;
+    response?: string;
+    responseTime?: number;
+    messages?: unknown[];
+}
+
+export type CommunicationRequestEntry = Omit<CommunicationHistoryEntry, 'response' | 'responseTime'>;
+export type CommunicationResponseEntry = Omit<CommunicationHistoryEntry, 'request'>;
+
+export const CommunicationRecordingService = Symbol('CommunicationRecordingService');
+export interface CommunicationRecordingService {
+    recordRequest(requestEntry: CommunicationRequestEntry): void;
+    readonly onDidRecordRequest: Event<CommunicationRequestEntry>;
+
+    recordResponse(responseEntry: CommunicationResponseEntry): void;
+    readonly onDidRecordResponse: Event<CommunicationResponseEntry>;
+
+    getHistory(agentId: string): CommunicationHistory;
+}

package/src/common/index.ts

@@ -0,0 +1,30 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+export * from './agent-service';
+export * from './agent';
+export * from './agents-variable-contribution';
+export * from './communication-recording-service';
+export * from './tool-invocation-registry';
+export * from './language-model-delegate';
+export * from './language-model-util';
+export * from './language-model';
+export * from './prompt-service';
+export * from './prompt-service-util';
+export * from './protocol';
+export * from './today-variable-contribution';
+export * from './tomorrow-variable-contribution';
+export * from './variable-service';
+export * from './settings-service';

package/src/common/language-model-delegate.ts

@@ -0,0 +1,45 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { CancellationToken } from '@theia/core';
+import { LanguageModelMetaData, LanguageModelParsedResponse, LanguageModelRequest, LanguageModelStreamResponsePart, LanguageModelTextResponse } from './language-model';
+
+export const LanguageModelDelegateClient = Symbol('LanguageModelDelegateClient');
+export interface LanguageModelDelegateClient {
+    toolCall(requestId: string, toolId: string, args_string: string): Promise<unknown>;
+    send(id: string, token: LanguageModelStreamResponsePart | undefined): void;
+}
+export const LanguageModelRegistryFrontendDelegate = Symbol('LanguageModelRegistryFrontendDelegate');
+export interface LanguageModelRegistryFrontendDelegate {
+    getLanguageModelDescriptions(): Promise<LanguageModelMetaData[]>;
+}
+
+export interface LanguageModelStreamResponseDelegate {
+    streamId: string;
+}
+export const isLanguageModelStreamResponseDelegate = (obj: unknown): obj is LanguageModelStreamResponseDelegate =>
+    !!(obj && typeof obj === 'object' && 'streamId' in obj && typeof (obj as { streamId: unknown }).streamId === 'string');
+
+export type LanguageModelResponseDelegate = LanguageModelTextResponse | LanguageModelParsedResponse | LanguageModelStreamResponseDelegate;
+
+export const LanguageModelFrontendDelegate = Symbol('LanguageModelFrontendDelegate');
+export interface LanguageModelFrontendDelegate {
+    cancel(requestId: string): void;
+    request(modelId: string, request: LanguageModelRequest, requestId: string, cancellationToken?: CancellationToken): Promise<LanguageModelResponseDelegate>;
+}
+
+export const languageModelRegistryDelegatePath = '/services/languageModelRegistryDelegatePath';
+export const languageModelDelegatePath = '/services/languageModelDelegatePath';

package/src/common/language-model-util.ts

@@ -0,0 +1,67 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { isLanguageModelStreamResponse, isLanguageModelTextResponse, LanguageModelResponse, ToolRequest } from './language-model';
+
+export const getTextOfResponse = async (response: LanguageModelResponse): Promise<string> => {
+    if (isLanguageModelTextResponse(response)) {
+        return response.text;
+    } else if (isLanguageModelStreamResponse(response)) {
+        let result = '';
+        for await (const chunk of response.stream) {
+            result += chunk.content ?? '';
+        }
+        return result;
+    }
+    throw new Error(`Invalid response type ${response}`);
+};
+
+export const getJsonOfResponse = async (response: LanguageModelResponse): Promise<unknown> => {
+    const text = await getTextOfResponse(response);
+    if (text.startsWith('```json')) {
+        const regex = /```json\s*([\s\S]*?)\s*```/g;
+        let match;
+        // eslint-disable-next-line no-null/no-null
+        while ((match = regex.exec(text)) !== null) {
+            try {
+                return JSON.parse(match[1]);
+            } catch (error) {
+                console.error('Failed to parse JSON:', error);
+            }
+        }
+    } else if (text.startsWith('{') || text.startsWith('[')) {
+        return JSON.parse(text);
+    }
+    throw new Error('Invalid response format');
+};
+export const toolRequestToPromptText = (toolRequest: ToolRequest): string => {
+    const parameters = toolRequest.parameters;
+    let paramsText = '';
+    // parameters are supposed to be as a JSON schema. Thus, derive the parameters from its properties definition
+    if (parameters) {
+        const properties = parameters.properties;
+        paramsText = Object.keys(properties)
+            .map(key => {
+                const param = properties[key];
+                return `${key}: ${param.type}`;
+            })
+            .join(', ');
+    }
+    const descriptionText = toolRequest.description
+        ? `: ${toolRequest.description}`
+        : '';
+    return `You can call function: ${toolRequest.id}(${paramsText})${descriptionText}`;
+};

package/src/common/language-model.spec.ts

@@ -0,0 +1,86 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { isModelMatching, LanguageModel, LanguageModelSelector } from './language-model';
+import { expect } from 'chai';
+
+describe('isModelMatching', () => {
+    it('returns false with one of two parameter mismatches', () => {
+        expect(
+            isModelMatching(
+                <LanguageModelSelector>{
+                    name: 'XXX',
+                    family: 'YYY',
+                },
+                <LanguageModel>{
+                    name: 'gpt-4o',
+                    family: 'YYY',
+                }
+            )
+        ).eql(false);
+    });
+    it('returns false with two parameter mismatches', () => {
+        expect(
+            isModelMatching(
+                <LanguageModelSelector>{
+                    name: 'XXX',
+                    family: 'YYY',
+                },
+                <LanguageModel>{
+                    name: 'gpt-4o',
+                    family: 'ZZZ',
+                }
+            )
+        ).eql(false);
+    });
+    it('returns true with one parameter match', () => {
+        expect(
+            isModelMatching(
+                <LanguageModelSelector>{
+                    name: 'gpt-4o',
+                },
+                <LanguageModel>{
+                    name: 'gpt-4o',
+                }
+            )
+        ).eql(true);
+    });
+    it('returns true with two parameter matches', () => {
+        expect(
+            isModelMatching(
+                <LanguageModelSelector>{
+                    name: 'gpt-4o',
+                    family: 'YYY',
+                },
+                <LanguageModel>{
+                    name: 'gpt-4o',
+                    family: 'YYY',
+                }
+            )
+        ).eql(true);
+    });
+    it('returns true if there are no parameters in selector', () => {
+        expect(
+            isModelMatching(
+                <LanguageModelSelector>{},
+                <LanguageModel>{
+                    name: 'gpt-4o',
+                    family: 'YYY',
+                }
+            )
+        ).eql(true);
+    });
+});