@theia/ai-chat 1.55.0-next.4 → 1.55.0-next.67

package/src/common/chat-agent-service.ts

@@ -41,6 +41,18 @@ export interface ChatAgentService {
      * Returns all agents, including disabled ones.
      */
     getAllAgents(): ChatAgent[];
+
+    /**
+     * Allows to register a chat agent programmatically.
+     * @param agent the agent to register
+     */
+    registerChatAgent(agent: ChatAgent): void;
+
+    /**
+     * Allows to unregister a chat agent programmatically.
+     * @param agentId the agent id to unregister
+     */
+    unregisterChatAgent(agentId: string): void;
 }
 @injectable()
 export class ChatAgentServiceImpl implements ChatAgentService {
@@ -65,6 +77,9 @@ export class ChatAgentServiceImpl implements ChatAgentService {
     registerChatAgent(agent: ChatAgent): void {
         this._agents.push(agent);
     }
+    unregisterChatAgent(agentId: string): void {
+        this._agents = this._agents.filter(a => a.id !== agentId);
+    }
 
     getAgent(id: string): ChatAgent | undefined {
         if (!this._agentIsEnabled(id)) {

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

@@ -23,7 +23,7 @@ import {
     AIVariableResolver,
     AIVariableService,
     ResolvedAIVariable
-} from '../../../ai-core/src/common/variable-service';
+} from '@theia/ai-core';
 import { ChatAgentService } from './chat-agent-service';
 
 export const CHAT_AGENTS_VARIABLE: AIVariable = {

package/src/common/chat-agents.ts

@@ -52,6 +52,7 @@ import {
 } from './chat-model';
 import { findFirstMatch, parseContents } from './parse-contents';
 import { DefaultResponseContentFactory, ResponseContentMatcher, ResponseContentMatcherProvider } from './response-content-matcher';
+import { ChatHistoryEntry } from './chat-history-entry';
 
 /**
  * A conversation consists of a sequence of ChatMessages.
@@ -137,7 +138,8 @@ export abstract class AbstractChatAgent {
         protected defaultLanguageModelPurpose: string,
         public iconClass: string = 'codicon codicon-copilot',
         public locations: ChatAgentLocation[] = ChatAgentLocation.ALL,
-        public tags: String[] = ['Chat']) {
+        public tags: String[] = ['Chat'],
+        public defaultLogging: boolean = true) {
     }
 
     @postConstruct()
@@ -151,17 +153,19 @@ export abstract class AbstractChatAgent {
             if (!languageModel) {
                 throw new Error('Couldn\'t find a matching language model. Please check your setup!');
             }
-            const messages = await this.getMessages(request.session);
-            this.recordingService.recordRequest({
-                agentId: this.id,
-                sessionId: request.session.id,
-                timestamp: Date.now(),
-                requestId: request.id,
-                request: request.request.text,
-                messages
-            });
 
             const systemMessageDescription = await this.getSystemMessageDescription();
+            const messages = await this.getMessages(request.session);
+            if (this.defaultLogging) {
+                this.recordingService.recordRequest(
+                    ChatHistoryEntry.fromRequest(
+                        this.id, request, {
+                        messages,
+                        systemMessage: systemMessageDescription?.text
+                    })
+                );
+            }
+
             const tools: Map<string, ToolRequest> = new Map();
             if (systemMessageDescription) {
                 const systemMsg: ChatMessage = {
@@ -192,13 +196,9 @@ export abstract class AbstractChatAgent {
             );
             await this.addContentsToResponse(languageModelResponse, request);
             request.response.complete();
-            this.recordingService.recordResponse({
-                agentId: this.id,
-                sessionId: request.session.id,
-                timestamp: Date.now(),
-                requestId: request.response.requestId,
-                response: request.response.response.asString()
-            });
+            if (this.defaultLogging) {
+                this.recordingService.recordResponse(ChatHistoryEntry.fromResponse(this.id, request));
+            }
         } catch (e) {
             this.handleError(request, e);
         }
@@ -274,13 +274,22 @@ export abstract class AbstractChatAgent {
         tools: ToolRequest[] | undefined,
         token: CancellationToken
     ): Promise<LanguageModelResponse> {
+        const settings = this.getLlmSettings();
         const languageModelResponse = languageModel.request({
             messages,
             tools,
+            settings,
         }, token);
         return languageModelResponse;
     }
 
+    /**
+     * @returns the settings, such as `temperature`, to be used in all language model requests. Returns `undefined` by default.
+     */
+    protected getLlmSettings(): { [key: string]: unknown; } | undefined {
+        return undefined;
+    }
+
     protected abstract addContentsToResponse(languageModelResponse: LanguageModelResponse, request: ChatRequestModelImpl): Promise<void>;
 }
 
@@ -307,25 +316,17 @@ export abstract class AbstractStreamParsingChatAgent extends AbstractChatAgent {
             const contents = this.parseContents(languageModelResponse.text);
             request.response.response.addContents(contents);
             request.response.complete();
-            this.recordingService.recordResponse({
-                agentId: this.id,
-                sessionId: request.session.id,
-                timestamp: Date.now(),
-                requestId: request.response.requestId,
-                response: request.response.response.asString()
-            });
+            if (this.defaultLogging) {
+                this.recordingService.recordResponse(ChatHistoryEntry.fromResponse(this.id, request));
+            }
             return;
         }
         if (isLanguageModelStreamResponse(languageModelResponse)) {
             await this.addStreamResponse(languageModelResponse, request);
             request.response.complete();
-            this.recordingService.recordResponse({
-                agentId: this.id,
-                sessionId: request.session.id,
-                timestamp: Date.now(),
-                requestId: request.response.requestId,
-                response: request.response.response.asString()
-            });
+            if (this.defaultLogging) {
+                this.recordingService.recordResponse(ChatHistoryEntry.fromResponse(this.id, request));
+            }
             return;
         }
         this.logger.error(

package/src/common/chat-history-entry.ts

@@ -0,0 +1,47 @@
+// *****************************************************************************
+// 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 { CommunicationRequestEntryParam, CommunicationResponseEntryParam } from '@theia/ai-core/lib/common/communication-recording-service';
+import { ChatRequestModel } from './chat-model';
+
+export namespace ChatHistoryEntry {
+    export function fromRequest(
+        agentId: string,
+        request: ChatRequestModel,
+        args: Partial<CommunicationRequestEntryParam> = {}
+    ): CommunicationRequestEntryParam {
+        return {
+            agentId: agentId,
+            sessionId: request.session.id,
+            requestId: request.id,
+            request: request.request.text,
+            ...args,
+        };
+    }
+    export function fromResponse(
+        agentId: string,
+        request: ChatRequestModel,
+        args: Partial<CommunicationResponseEntryParam> = {}
+    ): CommunicationResponseEntryParam {
+        return {
+            agentId: agentId,
+            sessionId: request.session.id,
+            requestId: request.id,
+            response: request.response.response.asString(),
+            ...args,
+        };
+    }
+}

package/src/common/chat-model.ts

@@ -73,6 +73,7 @@ export interface ChatRequestModel {
     readonly response: ChatResponseModel;
     readonly message: ParsedChatRequest;
     readonly agentId?: string;
+    readonly data?: { [key: string]: unknown };
 }
 
 export interface ChatProgressMessage {
@@ -342,14 +343,29 @@ export class ChatRequestModelImpl implements ChatRequestModel {
     protected _request: ChatRequest;
     protected _response: ChatResponseModelImpl;
     protected _agentId?: string;
+    protected _data: { [key: string]: unknown };
 
-    constructor(session: ChatModel, public readonly message: ParsedChatRequest, agentId?: string) {
+    constructor(session: ChatModel, public readonly message: ParsedChatRequest, agentId?: string,
+        data: { [key: string]: unknown } = {}) {
         // TODO accept serialized data as a parameter to restore a previously saved ChatRequestModel
         this._request = message.request;
         this._id = generateUuid();
         this._session = session;
         this._response = new ChatResponseModelImpl(this._id, agentId);
         this._agentId = agentId;
+        this._data = data;
+    }
+
+    get data(): { [key: string]: unknown } | undefined {
+        return this._data;
+    }
+
+    addData(key: string, value: unknown): void {
+        this._data[key] = value;
+    }
+
+    getDataByKey(key: string): unknown {
+        return this._data[key];
     }
 
     get id(): string {

package/src/common/custom-chat-agent.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 { AgentSpecificVariables, PromptTemplate } from '@theia/ai-core';
+import { AbstractStreamParsingChatAgent, ChatAgent, SystemMessageDescription } from './chat-agents';
+import { injectable } from '@theia/core/shared/inversify';
+
+@injectable()
+export class CustomChatAgent
+    extends AbstractStreamParsingChatAgent
+    implements ChatAgent {
+    name: string;
+    description: string;
+    readonly variables: string[] = [];
+    readonly functions: string[] = [];
+    readonly promptTemplates: PromptTemplate[] = [];
+    readonly agentSpecificVariables: AgentSpecificVariables[] = [];
+
+    constructor(
+    ) {
+        super('CustomChatAgent', [{ purpose: 'chat' }], 'chat');
+    }
+    protected override async getSystemMessageDescription(): Promise<SystemMessageDescription | undefined> {
+        const resolvedPrompt = await this.promptService.getPrompt(`${this.name}_prompt`);
+        return resolvedPrompt ? SystemMessageDescription.fromResolvedPromptTemplate(resolvedPrompt) : undefined;
+    }
+
+    set prompt(prompt: string) {
+        this.promptTemplates.push({ id: `${this.name}_prompt`, template: prompt });
+    }
+}

package/src/common/index.ts

@@ -13,12 +13,13 @@
 //
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
-export * from './chat-agent-service';
 export * from './chat-agents';
+export * from './chat-agent-service';
 export * from './chat-model';
-export * from './parsed-chat-request';
 export * from './chat-request-parser';
 export * from './chat-service';
 export * from './command-chat-agents';
-export * from './universal-chat-agent';
+export * from './custom-chat-agent';
+export * from './parsed-chat-request';
 export * from './orchestrator-chat-agent';
+export * from './universal-chat-agent';

package/src/common/o1-chat-agent.ts

@@ -0,0 +1,51 @@
+// *****************************************************************************
+// 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 {
+    ChatAgent,
+    AbstractStreamParsingChatAgent,
+    SystemMessageDescription
+} from './chat-agents';
+
+import { injectable } from '@theia/core/shared/inversify';
+import { AgentSpecificVariables, PromptTemplate } from '@theia/ai-core';
+
+@injectable()
+export class O1ChatAgent extends AbstractStreamParsingChatAgent implements ChatAgent {
+
+    public name = 'O1-Preview';
+    public description = 'An agent for interacting with ChatGPT o1-preview';
+    public promptTemplates: PromptTemplate[] = [];
+    readonly agentSpecificVariables: AgentSpecificVariables[] = [];
+    readonly variables: string[] = [];
+    readonly functions: string[] = [];
+
+    constructor() {
+        super(
+            'o1-preview',
+            [{
+                purpose: 'chat',
+                identifier: 'openai/o1-preview',
+            }],
+            'chat'
+        );
+    }
+
+    protected async getSystemMessageDescription(): Promise<SystemMessageDescription | undefined> {
+        // O1 currently does not support system prompts
+        return undefined;
+    }
+}

package/src/common/orchestrator-chat-agent.ts

@@ -14,7 +14,7 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { AgentSpecificVariables, getJsonOfResponse, LanguageModelResponse } from '@theia/ai-core';
+import { AgentSpecificVariables, getJsonOfText, getTextOfResponse, LanguageModelResponse } from '@theia/ai-core';
 import {
     PromptTemplate
 } from '@theia/ai-core/lib/common';
@@ -22,6 +22,8 @@ import { inject, injectable } from '@theia/core/shared/inversify';
 import { ChatAgentService } from './chat-agent-service';
 import { AbstractStreamParsingChatAgent, ChatAgent, SystemMessageDescription } from './chat-agents';
 import { ChatRequestModelImpl, InformationalChatResponseContentImpl } from './chat-model';
+import { generateUuid } from '@theia/core';
+import { ChatHistoryEntry } from './chat-history-entry';
 
 export const orchestratorTemplate: PromptTemplate = {
     id: 'orchestrator-system',
@@ -59,6 +61,7 @@ You must only use the \`id\` attribute of the agent, never the name.
 `};
 
 export const OrchestratorChatAgentId = 'Orchestrator';
+const OrchestratorRequestIdKey = 'orchestatorRequestIdKey';
 
 @injectable()
 export class OrchestratorChatAgent extends AbstractStreamParsingChatAgent implements ChatAgent {
@@ -74,7 +77,7 @@ export class OrchestratorChatAgent extends AbstractStreamParsingChatAgent implem
         super(OrchestratorChatAgentId, [{
             purpose: 'agent-selection',
             identifier: 'openai/gpt-4o',
-        }], 'agent-selection', 'codicon codicon-symbol-boolean');
+        }], 'agent-selection', 'codicon codicon-symbol-boolean', undefined, undefined, false);
         this.name = OrchestratorChatAgentId;
         this.description = 'This agent analyzes the user request against the description of all available chat agents and selects the best fitting agent to answer the request \
         (by using AI).The user\'s request will be directly delegated to the selected agent without further confirmation.';
@@ -88,8 +91,20 @@ export class OrchestratorChatAgent extends AbstractStreamParsingChatAgent implem
     @inject(ChatAgentService)
     protected chatAgentService: ChatAgentService;
 
-    override invoke(request: ChatRequestModelImpl): Promise<void> {
+    override async invoke(request: ChatRequestModelImpl): Promise<void> {
         request.response.addProgressMessage({ content: 'Determining the most appropriate agent', status: 'inProgress' });
+        // We generate a dedicated ID for recording the orchestrator request/response, as we will forward the original request to another agent
+        const orchestratorRequestId = generateUuid();
+        request.addData(OrchestratorRequestIdKey, orchestratorRequestId);
+        const messages = await this.getMessages(request.session);
+        const systemMessage = (await this.getSystemMessageDescription())?.text;
+        this.recordingService.recordRequest(
+            ChatHistoryEntry.fromRequest(this.id, request, {
+                requestId: orchestratorRequestId,
+                messages,
+                systemMessage
+            })
+        );
         return super.invoke(request);
     }
 
@@ -100,8 +115,19 @@ export class OrchestratorChatAgent extends AbstractStreamParsingChatAgent implem
 
     protected override async addContentsToResponse(response: LanguageModelResponse, request: ChatRequestModelImpl): Promise<void> {
         let agentIds: string[] = [];
+        const responseText = await getTextOfResponse(response);
+        // We use the previously generated, dedicated ID to log the orchestrator response before we forward the original request
+        const orchestratorRequestId = request.getDataByKey(OrchestratorRequestIdKey);
+        if (typeof orchestratorRequestId === 'string') {
+            this.recordingService.recordResponse({
+                agentId: this.id,
+                sessionId: request.session.id,
+                requestId: orchestratorRequestId,
+                response: responseText,
+            });
+        }
         try {
-            const jsonResponse = await getJsonOfResponse(response);
+            const jsonResponse = await getJsonOfText(responseText);
             if (Array.isArray(jsonResponse)) {
                 agentIds = jsonResponse.filter((id: string) => id !== this.id);
             }