@theia/ai-core 1.46.0-next.241

package/src/common/prompt-service.ts

@@ -0,0 +1,334 @@
+// *****************************************************************************
+// 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 { URI, Event } from '@theia/core';
+import { inject, injectable, optional } from '@theia/core/shared/inversify';
+import { AIVariableService } from './variable-service';
+import { ToolInvocationRegistry } from './tool-invocation-registry';
+import { toolRequestToPromptText } from './language-model-util';
+import { ToolRequest } from './language-model';
+import { matchFunctionsRegEx, matchVariablesRegEx } from './prompt-service-util';
+import { AISettingsService } from './settings-service';
+
+export interface PromptTemplate {
+    id: string;
+    template: string;
+    /**
+     * (Optional) The ID of the main template for which this template is a variant.
+     * If present, this indicates that the current template represents an alternative version of the specified main template.
+     */
+    variantOf?: string;
+}
+
+export interface PromptMap { [id: string]: PromptTemplate }
+
+export interface ResolvedPromptTemplate {
+    id: string;
+    /** The resolved prompt text with variables and function requests being replaced. */
+    text: string;
+    /** All functions referenced in the prompt template. */
+    functionDescriptions?: Map<string, ToolRequest>;
+}
+
+export const PromptService = Symbol('PromptService');
+export interface PromptService {
+    /**
+     * Retrieve the raw {@link PromptTemplate} object (unresolved variables, functions and including comments).
+     * @param id the id of the {@link PromptTemplate}
+     */
+    getRawPrompt(id: string): PromptTemplate | undefined;
+    /**
+     * Retrieve the unresolved {@link PromptTemplate} object (unresolved variables, functions, excluding comments)
+     * @param id the id of the {@link PromptTemplate}
+     */
+    getUnresolvedPrompt(id: string): PromptTemplate | undefined;
+    /**
+     * Retrieve the default raw {@link PromptTemplate} object.
+     * @param id the id of the {@link PromptTemplate}
+     */
+    getDefaultRawPrompt(id: string): PromptTemplate | undefined;
+    /**
+     * Allows to directly replace placeholders in the prompt. The supported format is 'Hi {{name}}!'.
+     * The placeholder is then searched inside the args object and replaced.
+     * Function references are also supported via format '~{functionId}'.
+     * @param id the id of the prompt
+     * @param args the object with placeholders, mapping the placeholder key to the value
+     */
+    getPrompt(id: string, args?: { [key: string]: unknown }): Promise<ResolvedPromptTemplate | undefined>;
+    /**
+     * Adds a {@link PromptTemplate} to the list of prompts.
+     * @param promptTemplate the prompt template to store
+     */
+    storePromptTemplate(promptTemplate: PromptTemplate): void;
+    /**
+     * Removes a prompt from the list of prompts.
+     * @param id the id of the prompt
+     */
+    removePrompt(id: string): void;
+    /**
+     * Return all known prompts as a {@link PromptMap map}.
+     */
+    getAllPrompts(): PromptMap;
+    /**
+     * Retrieve all variant IDs of a given {@link PromptTemplate}.
+     * @param id the id of the main {@link PromptTemplate}
+     * @returns an array of string IDs representing the variants of the given template
+     */
+    getVariantIds(id: string): string[];
+    /**
+     * Retrieve the currently selected variant ID for a given main prompt ID.
+     * If a variant is selected for the main prompt, it will be returned.
+     * Otherwise, the main prompt ID will be returned.
+     * @param id the id of the main prompt
+     * @returns the variant ID if one is selected, or the main prompt ID otherwise
+     */
+    getVariantId(id: string): Promise<string>;
+}
+
+export interface CustomAgentDescription {
+    id: string;
+    name: string;
+    description: string;
+    prompt: string;
+    defaultLLM: string;
+}
+export namespace CustomAgentDescription {
+    export function is(entry: unknown): entry is CustomAgentDescription {
+        // eslint-disable-next-line no-null/no-null
+        return typeof entry === 'object' && entry !== null
+            && 'id' in entry && typeof entry.id === 'string'
+            && 'name' in entry && typeof entry.name === 'string'
+            && 'description' in entry && typeof entry.description === 'string'
+            && 'prompt' in entry
+            && typeof entry.prompt === 'string'
+            && 'defaultLLM' in entry
+            && typeof entry.defaultLLM === 'string';
+    }
+    export function equals(a: CustomAgentDescription, b: CustomAgentDescription): boolean {
+        return a.id === b.id && a.name === b.name && a.description === b.description && a.prompt === b.prompt && a.defaultLLM === b.defaultLLM;
+    }
+}
+
+export const PromptCustomizationService = Symbol('PromptCustomizationService');
+export interface PromptCustomizationService {
+    /**
+     * Whether there is a customization for a {@link PromptTemplate} object
+     * @param id the id of the {@link PromptTemplate} to check
+     */
+    isPromptTemplateCustomized(id: string): boolean;
+
+    /**
+     * Returns the customization of {@link PromptTemplate} object or undefined if there is none
+     * @param id the id of the {@link PromptTemplate} to check
+     */
+    getCustomizedPromptTemplate(id: string): string | undefined
+
+    getCustomPromptTemplateIDs(): string[];
+    /**
+     * Edit the template. If the content is specified, is will be
+     * used to customize the template. Otherwise, the behavior depends
+     * on the implementation. Implementation may for example decide to
+     * open an editor, or request more information from the user, ...
+     * @param id the template id.
+     * @param content optional default content to initialize the template
+     */
+    editTemplate(id: string, defaultContent?: string): void;
+
+    /**
+     * Reset the template to its default value.
+     * @param id the template id.
+     */
+    resetTemplate(id: string): void;
+
+    /**
+     * Return the template id for a given template file.
+     * @param uri the uri of the template file
+     */
+    getTemplateIDFromURI(uri: URI): string | undefined;
+
+    /**
+     * Event which is fired when the prompt template is changed.
+     */
+    readonly onDidChangePrompt: Event<string>;
+
+    /**
+     * Return all custom agents.
+     * @returns all custom agents
+     */
+    getCustomAgents(): Promise<CustomAgentDescription[]>;
+
+    /**
+     * Event which is fired when custom agents are modified.
+     */
+    readonly onDidChangeCustomAgents: Event<void>;
+
+    /**
+     * Open the custom agent yaml file.
+     */
+    openCustomAgentYaml(): void;
+}
+
+@injectable()
+export class PromptServiceImpl implements PromptService {
+    @inject(AISettingsService) @optional()
+    protected readonly settingsService: AISettingsService | undefined;
+
+    @inject(PromptCustomizationService) @optional()
+    protected readonly customizationService: PromptCustomizationService | undefined;
+
+    @inject(AIVariableService) @optional()
+    protected readonly variableService: AIVariableService | undefined;
+
+    @inject(ToolInvocationRegistry) @optional()
+    protected readonly toolInvocationRegistry: ToolInvocationRegistry | undefined;
+
+    protected _prompts: PromptMap = {};
+
+    getRawPrompt(id: string): PromptTemplate | undefined {
+        if (this.customizationService !== undefined && this.customizationService.isPromptTemplateCustomized(id)) {
+            const template = this.customizationService.getCustomizedPromptTemplate(id);
+            if (template !== undefined) {
+                return { id, template };
+            }
+        }
+        return this.getDefaultRawPrompt(id);
+    }
+    getDefaultRawPrompt(id: string): PromptTemplate | undefined {
+        return this._prompts[id];
+    }
+
+    getUnresolvedPrompt(id: string): PromptTemplate | undefined {
+        const rawPrompt = this.getRawPrompt(id);
+        if (!rawPrompt) {
+            return undefined;
+        }
+        return {
+            id: rawPrompt.id,
+            template: this.stripComments(rawPrompt.template)
+        };
+    }
+
+    protected stripComments(template: string): string {
+        const commentRegex = /^\s*{{!--[\s\S]*?--}}\s*\n?/;
+        return commentRegex.test(template) ? template.replace(commentRegex, '').trimStart() : template;
+    }
+
+    async getVariantId(id: string): Promise<string> {
+        if (this.settingsService !== undefined) {
+            const agentSettingsMap = await this.settingsService.getSettings();
+
+            for (const agentSettings of Object.values(agentSettingsMap)) {
+                if (agentSettings.selectedVariants && agentSettings.selectedVariants[id]) {
+                    return agentSettings.selectedVariants[id];
+                }
+            }
+        }
+        return id;
+    }
+
+    async getPrompt(id: string, args?: { [key: string]: unknown }): Promise<ResolvedPromptTemplate | undefined> {
+        const variantId = await this.getVariantId(id);
+        const prompt = this.getUnresolvedPrompt(variantId);
+        if (prompt === undefined) {
+            return undefined;
+        }
+
+        const matches = matchVariablesRegEx(prompt.template);
+        const variableAndArgReplacements = await Promise.all(matches.map(async match => {
+            const completeText = match[0];
+            const variableAndArg = match[1];
+            let variableName = variableAndArg;
+            let argument: string | undefined;
+            const parts = variableAndArg.split(':', 2);
+            if (parts.length > 1) {
+                variableName = parts[0];
+                argument = parts[1];
+            }
+            return {
+                placeholder: completeText,
+                value: String(args?.[variableAndArg] ?? (await this.variableService?.resolveVariable({
+                    variable: variableName,
+                    arg: argument
+                }, {}))?.value ?? completeText)
+            };
+        }));
+
+        const functionMatches = matchFunctionsRegEx(prompt.template);
+        const functions = new Map<string, ToolRequest>();
+        const functionReplacements = functionMatches.map(match => {
+            const completeText = match[0];
+            const functionId = match[1];
+            const toolRequest = this.toolInvocationRegistry?.getFunction(functionId);
+            if (toolRequest) {
+                functions.set(toolRequest.id, toolRequest);
+            }
+            return {
+                placeholder: completeText,
+                value: toolRequest ? toolRequestToPromptText(toolRequest) : completeText
+            };
+        });
+
+        let resolvedTemplate = prompt.template;
+        const replacements = [...variableAndArgReplacements, ...functionReplacements];
+        replacements.forEach(replacement => resolvedTemplate = resolvedTemplate.replace(replacement.placeholder, replacement.value));
+        return {
+            id,
+            text: resolvedTemplate,
+            functionDescriptions: functions.size > 0 ? functions : undefined
+        };
+    }
+    getAllPrompts(): PromptMap {
+        if (this.customizationService !== undefined) {
+            const myCustomization = this.customizationService;
+            const result: PromptMap = {};
+            Object.keys(this._prompts).forEach(id => {
+                if (myCustomization.isPromptTemplateCustomized(id)) {
+                    const template = myCustomization.getCustomizedPromptTemplate(id);
+                    if (template !== undefined) {
+                        result[id] = { id, template };
+                    } else {
+                        result[id] = { ...this._prompts[id] };
+                    }
+                } else {
+                    result[id] = { ...this._prompts[id] };
+                }
+            });
+            return result;
+        } else {
+            return { ...this._prompts };
+        }
+    }
+    removePrompt(id: string): void {
+        delete this._prompts[id];
+    }
+    getVariantIds(id: string): string[] {
+        const allCustomPromptTemplateIds = this.customizationService?.getCustomPromptTemplateIDs() || [];
+        const knownPromptIds = Object.keys(this._prompts);
+
+        // We filter out known IDs from the custom prompt template IDs, these are no variants, but customizations. Then we retain IDs that start with the main ID
+        const customVariantIds = allCustomPromptTemplateIds.filter(customId =>
+            !knownPromptIds.includes(customId) && customId.startsWith(id)
+        );
+        const variantIds = Object.values(this._prompts)
+            .filter(prompt => prompt.variantOf === id)
+            .map(variant => variant.id);
+
+        return [...variantIds, ...customVariantIds];
+    }
+    storePromptTemplate(promptTemplate: PromptTemplate): void {
+        this._prompts[promptTemplate.id] = promptTemplate;
+    }
+}

package/src/common/protocol.ts

@@ -0,0 +1,23 @@
+// *****************************************************************************
+// 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 { LanguageModelMetaData } from './language-model';
+
+export const LanguageModelRegistryClient = Symbol('LanguageModelRegistryClient');
+export interface LanguageModelRegistryClient {
+    languageModelAdded(metadata: LanguageModelMetaData): void;
+    languageModelRemoved(id: string): void;
+}

package/src/common/settings-service.ts

@@ -0,0 +1,38 @@
+// *****************************************************************************
+// 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';
+import { LanguageModelRequirement } from './language-model';
+
+export const AISettingsService = Symbol('AISettingsService');
+/**
+ * Service to store and retrieve settings on a per-agent basis.
+ */
+export interface AISettingsService {
+    updateAgentSettings(agent: string, agentSettings: Partial<AgentSettings>): Promise<void>;
+    getAgentSettings(agent: string): Promise<AgentSettings | undefined>;
+    getSettings(): Promise<AISettings>;
+    onDidChange: Event<void>;
+}
+export type AISettings = Record<string, AgentSettings>;
+export interface AgentSettings {
+    languageModelRequirements?: LanguageModelRequirement[];
+    enable?: boolean;
+    /**
+     * A mapping of main template IDs to their selected variant IDs.
+     * If a main template is not present in this mapping, it means the main template is used.
+     */
+    selectedVariants?: Record<string, string>;
+}

package/src/common/today-variable-contribution.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 { MaybePromise } from '@theia/core';
+import { injectable } from '@theia/core/shared/inversify';
+import { AIVariable, ResolvedAIVariable, AIVariableContribution, AIVariableResolver, AIVariableService, AIVariableResolutionRequest, AIVariableContext } from './variable-service';
+
+export namespace TodayVariableArgs {
+    export const IN_UNIX_SECONDS = 'inUnixSeconds';
+    export const IN_ISO_8601 = 'inIso8601';
+}
+
+export const TODAY_VARIABLE: AIVariable = {
+    id: 'today-provider',
+    description: 'Does something for today',
+    name: 'today',
+    args: [
+        { name: TodayVariableArgs.IN_ISO_8601, description: 'Returns the current date in ISO 8601 format' },
+        { name: TodayVariableArgs.IN_UNIX_SECONDS, description: 'Returns the current date in unix seconds format' }
+    ]
+};
+
+export interface ResolvedTodayVariable extends ResolvedAIVariable {
+    date: Date;
+}
+
+@injectable()
+export class TodayVariableContribution implements AIVariableContribution, AIVariableResolver {
+    registerVariables(service: AIVariableService): void {
+        service.registerResolver(TODAY_VARIABLE, this);
+    }
+
+    canResolve(request: AIVariableResolutionRequest, context: AIVariableContext): MaybePromise<number> {
+        return 1;
+    }
+
+    async resolve(request: AIVariableResolutionRequest, context: AIVariableContext): Promise<ResolvedAIVariable | undefined> {
+        if (request.variable.name === TODAY_VARIABLE.name) {
+            return this.resolveTodayVariable(request);
+        }
+        return undefined;
+    }
+
+    private resolveTodayVariable(request: AIVariableResolutionRequest): ResolvedTodayVariable {
+        const date = new Date();
+        if (request.arg === TodayVariableArgs.IN_ISO_8601) {
+            return { variable: request.variable, value: date.toISOString(), date };
+        }
+        if (request.arg === TodayVariableArgs.IN_UNIX_SECONDS) {
+            return { variable: request.variable, value: Math.round(date.getTime() / 1000).toString(), date };
+        }
+        return { variable: request.variable, value: date.toDateString(), date };
+    }
+}
+

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

@@ -0,0 +1,66 @@
+// *****************************************************************************
+// 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 { MaybePromise } from '@theia/core';
+import { injectable } from '@theia/core/shared/inversify';
+import { AIVariable, AIVariableContext, AIVariableContribution, AIVariableResolutionRequest, AIVariableResolver, AIVariableService, ResolvedAIVariable } from './variable-service';
+
+export namespace TomorrowVariableArgs {
+    export const IN_UNIX_SECONDS = 'inUnixSeconds';
+    export const IN_ISO_8601 = 'inIso8601';
+}
+
+export const TOMORROW_VARIABLE: AIVariable = {
+    id: 'tomorrow-provider',
+    description: 'Does something for tomorrow',
+    name: 'tomorrow',
+    args: [
+        { name: TomorrowVariableArgs.IN_ISO_8601, description: 'Returns the current date in ISO 8601 format' },
+        { name: TomorrowVariableArgs.IN_UNIX_SECONDS, description: 'Returns the current date in unix seconds format' }
+    ]
+};
+
+export interface ResolvedTomorrowVariable extends ResolvedAIVariable {
+    date: Date;
+}
+
+@injectable()
+export class TomorrowVariableContribution implements AIVariableContribution, AIVariableResolver {
+    registerVariables(service: AIVariableService): void {
+        service.registerResolver(TOMORROW_VARIABLE, this);
+    }
+
+    canResolve(request: AIVariableResolutionRequest, context: AIVariableContext): MaybePromise<number> {
+        return 1;
+    }
+
+    async resolve(request: AIVariableResolutionRequest, context: AIVariableContext): Promise<ResolvedAIVariable | undefined> {
+        if (request.variable.name === TOMORROW_VARIABLE.name) {
+            return this.resolveTomorrowVariable(request);
+        }
+        return undefined;
+    }
+
+    private resolveTomorrowVariable(request: AIVariableResolutionRequest): ResolvedTomorrowVariable {
+        const date = new Date(+new Date() + 86400000);
+        if (request.arg === TomorrowVariableArgs.IN_ISO_8601) {
+            return { variable: request.variable, value: date.toISOString(), date };
+        }
+        if (request.arg === TomorrowVariableArgs.IN_UNIX_SECONDS) {
+            return { variable: request.variable, value: Math.round(date.getTime() / 1000).toString(), date };
+        }
+        return { variable: request.variable, value: date.toDateString(), date };
+    }
+}

package/src/common/tool-invocation-registry.ts

@@ -0,0 +1,79 @@
+// *****************************************************************************
+// 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, postConstruct } from '@theia/core/shared/inversify';
+import { ToolRequest } from './language-model';
+import { ContributionProvider } from '@theia/core';
+
+export const ToolInvocationRegistry = Symbol('ToolInvocationRegistry');
+
+/**
+ * Registry for all the function calls available to Agents.
+ */
+export interface ToolInvocationRegistry {
+    registerTool(tool: ToolRequest): void;
+
+    getFunction(toolId: string): ToolRequest | undefined;
+
+    getFunctions(...toolIds: string[]): ToolRequest[];
+}
+
+export const ToolProvider = Symbol('ToolProvider');
+export interface ToolProvider {
+    getTool(): ToolRequest;
+}
+
+@injectable()
+export class ToolInvocationRegistryImpl implements ToolInvocationRegistry {
+
+    private tools: Map<string, ToolRequest> = new Map<string, ToolRequest>();
+
+    @inject(ContributionProvider)
+    @named(ToolProvider)
+    private providers: ContributionProvider<ToolProvider>;
+
+    @postConstruct()
+    init(): void {
+        this.providers.getContributions().forEach(provider => {
+            this.registerTool(provider.getTool());
+        });
+    }
+
+    registerTool(tool: ToolRequest): void {
+        if (this.tools.has(tool.id)) {
+            console.warn(`Function with id ${tool.id} is already registered.`);
+        } else {
+            this.tools.set(tool.id, tool);
+        }
+    }
+
+    getFunction(toolId: string): ToolRequest | undefined {
+        return this.tools.get(toolId);
+    }
+
+    getFunctions(...toolIds: string[]): ToolRequest[] {
+        const tools: ToolRequest[] = toolIds.map(toolId => {
+            const tool = this.tools.get(toolId);
+            if (tool) {
+                return tool;
+            } else {
+                throw new Error(`Function with id ${toolId} does not exist.`);
+            }
+        });
+        return tools;
+    }
+}
+