System prompt configurable (#96)

* Add an abstract base completer class

* Add a plugin to set the system prompts

* lint

* Add settings icon

* Remove the system prompt settings of chrome AI

Author: brichet

schema/chat.json

@@ -1,5 +1,5 @@
 {
-  "title": "Chat configuration",
+  "title": "Chat Configuration",
   "description": "Configuration for the chat panel",
   "jupyter.lab.setting-icon": "jupyter-chat::chat",
   "jupyter.lab.setting-icon-label": "Jupyter Chat",

schema/system-prompts.json

@@ -0,0 +1,22 @@
+{
+  "title": "AI system prompts",
+  "description": "System prompts",
+  "jupyter.lab.setting-icon": "@jupyterlite/ai:jupyternaut-lite",
+  "jupyter.lab.setting-icon-label": "JupyterLite AI Chat",
+  "type": "object",
+  "properties": {
+    "chatSystemPrompt": {
+      "type": "string",
+      "title": "Chat message system prompt",
+      "description": "The system prompt for the chat messages",
+      "default": "You are Jupyternaut, a conversational assistant living in JupyterLab to help users.\nYou are not a language model, but rather an application built on a foundation model from $provider_name$.\nYou are talkative and you provide lots of specific details from the foundation model's context.\nYou may use Markdown to format your response.\nIf your response includes code, they must be enclosed in Markdown fenced code blocks (with triple backticks before and after).\nIf your response includes mathematical notation, they must be expressed in LaTeX markup and enclosed in LaTeX delimiters.\nAll dollar quantities (of USD) must be formatted in LaTeX, with the `$` symbol escaped by a single backslash `\\`.\n- Example prompt: `If I have \\\\$100 and spend \\\\$20, how much money do I have left?`\n- **Correct** response: `You have \\(\\$80\\) remaining.`\n- **Incorrect** response: `You have $80 remaining.`\nIf you do not know the answer to a question, answer truthfully by responding that you do not know.\nThe following is a friendly conversation between you and a human."
+    },
+    "completionSystemPrompt": {
+      "type": "string",
+      "title": "Completion system prompt",
+      "description": "The system prompt for the completion",
+      "default": "You are an application built to provide helpful code completion suggestions.\nYou should only produce code. Keep comments to minimum, use the programming language comment syntax. Produce clean code.\nThe code is written in JupyterLab, a data analysis and code development environment which can execute code extended with additional syntax for interactive features, such as magics.\nOnly give raw strings back, do not format the response using backticks.\nThe output should be a single string, and should only contain the code that will complete the give code passed as input, no explanation whatsoever. Do not include the prompt in the output, only the string that should be appended to the current input. Here is the code to complete:"
+    }
+  },
+  "additionalProperties": false
+}

scripts/settings-checker.js

@@ -49,7 +49,8 @@ const providers = {
   },
   ChromeAI: {
     path: 'node_modules/@langchain/community/experimental/llms/chrome_ai.d.ts',
-    type: 'ChromeAIInputs'
+    type: 'ChromeAIInputs',
+    excludedProps: ['systemPrompt']
   },
   MistralAI: {
     path: 'node_modules/@langchain/mistralai/dist/chat_models.d.ts',

src/base-completer.ts

@@ -2,13 +2,17 @@ import {
   CompletionHandler,
   IInlineCompletionContext
 } from '@jupyterlab/completer';
+import { BaseLanguageModel } from '@langchain/core/language_models/base';
 import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
 
+import { DEFAULT_COMPLETION_SYSTEM_PROMPT } from './default-prompts';
+import { IAIProviderRegistry } from './tokens';
+
 export interface IBaseCompleter {
   /**
    * The completion prompt.
    */
-  prompt: string;
+  readonly systemPrompt: string;
 
   /**
    * The function to fetch a new completion.
@@ -24,6 +28,33 @@ export interface IBaseCompleter {
   ): Promise<any>;
 }
 
+export abstract class BaseCompleter implements IBaseCompleter {
+  constructor(options: BaseCompleter.IOptions) {
+    this._providerRegistry = options.providerRegistry;
+  }
+
+  /**
+   * Get the system prompt for the completion.
+   */
+  get systemPrompt(): string {
+    return (
+      this._providerRegistry.completerSystemPrompt ??
+      DEFAULT_COMPLETION_SYSTEM_PROMPT
+    );
+  }
+
+  /**
+   * The fetch request for the LLM completer.
+   */
+  abstract fetch(
+    request: CompletionHandler.IRequest,
+    context: IInlineCompletionContext
+  ): Promise<any>;
+
+  protected _providerRegistry: IAIProviderRegistry;
+  protected abstract _completer: BaseLanguageModel<any, any>;
+}
+
 /**
  * The namespace for the base completer.
  */
@@ -32,6 +63,13 @@ export namespace BaseCompleter {
    * The options for the constructor of a completer.
    */
   export interface IOptions {
+    /**
+     * The provider registry.
+     */
+    providerRegistry: IAIProviderRegistry;
+    /**
+     * The settings of the provider.
+     */
     settings: ReadonlyPartialJSONObject;
   }
 }

src/chat-handler.ts

@@ -23,8 +23,8 @@ import {
 } from '@langchain/core/messages';
 import { UUID } from '@lumino/coreutils';
 
+import { DEFAULT_CHAT_SYSTEM_PROMPT } from './default-prompts';
 import { jupyternautLiteIcon } from './icons';
-import { chatSystemPrompt } from './provider';
 import { IAIProviderRegistry } from './tokens';
 import { AIChatModel } from './types/ai-model';
 
@@ -56,15 +56,9 @@ export class ChatHandler extends AbstractChatModel {
   constructor(options: ChatHandler.IOptions) {
     super(options);
     this._providerRegistry = options.providerRegistry;
-    this._prompt = chatSystemPrompt({
-      provider_name: this._providerRegistry.currentName
-    });
 
     this._providerRegistry.providerChanged.connect(() => {
       this._errorMessage = this._providerRegistry.chatError;
-      this._prompt = chatSystemPrompt({
-        provider_name: this._providerRegistry.currentName
-      });
     });
   }
 
@@ -90,13 +84,12 @@ export class ChatHandler extends AbstractChatModel {
   }
 
   /**
-   * Getter and setter for the initial prompt.
+   * Get/set the system prompt for the chat.
    */
-  get prompt(): string {
-    return this._prompt;
-  }
-  set prompt(value: string) {
-    this._prompt = value;
+  get systemPrompt(): string {
+    return (
+      this._providerRegistry.chatSystemPrompt ?? DEFAULT_CHAT_SYSTEM_PROMPT
+    );
   }
 
   async sendMessage(message: INewMessage): Promise<boolean> {
@@ -131,7 +124,7 @@ export class ChatHandler extends AbstractChatModel {
 
     this._history.messages.push(msg);
 
-    const messages = mergeMessageRuns([new SystemMessage(this._prompt)]);
+    const messages = mergeMessageRuns([new SystemMessage(this.systemPrompt)]);
     messages.push(
       ...this._history.messages.map(msg => {
         if (msg.sender.username === 'User') {
@@ -206,7 +199,6 @@ export class ChatHandler extends AbstractChatModel {
 
   private _providerRegistry: IAIProviderRegistry;
   private _personaName = 'AI';
-  private _prompt: string;
   private _errorMessage: string = '';
   private _history: IChatHistory = { messages: [] };
   private _defaultErrorMessage = 'AI provider not configured';

src/default-prompts.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+export const DEFAULT_CHAT_SYSTEM_PROMPT = `
+You are Jupyternaut, a conversational assistant living in JupyterLab to help users.
+You are not a language model, but rather an application built on a foundation model from $provider_name$.
+You are talkative and you provide lots of specific details from the foundation model's context.
+You may use Markdown to format your response.
+If your response includes code, they must be enclosed in Markdown fenced code blocks (with triple backticks before and after).
+If your response includes mathematical notation, they must be expressed in LaTeX markup and enclosed in LaTeX delimiters.
+All dollar quantities (of USD) must be formatted in LaTeX, with the \`$\` symbol escaped by a single backslash \`\\\`.
+- Example prompt: \`If I have \\\\$100 and spend \\\\$20, how much money do I have left?\`
+- **Correct** response: \`You have \\(\\$80\\) remaining.\`
+- **Incorrect** response: \`You have $80 remaining.\`
+If you do not know the answer to a question, answer truthfully by responding that you do not know.
+The following is a friendly conversation between you and a human.
+`;
+
+export const DEFAULT_COMPLETION_SYSTEM_PROMPT = `
+You are an application built to provide helpful code completion suggestions.
+You should only produce code. Keep comments to minimum, use the
+programming language comment syntax. Produce clean code.
+The code is written in JupyterLab, a data analysis and code development
+environment which can execute code extended with additional syntax for
+interactive features, such as magics.
+Only give raw strings back, do not format the response using backticks.
+The output should be a single string, and should only contain the code that will complete the
+give code passed as input, no explanation whatsoever.
+Do not include the prompt in the output, only the string that should be appended to the current input.
+Here is the code to complete:
+`;

src/default-providers/Anthropic/completer.ts

@@ -5,24 +5,14 @@ import {
 import { ChatAnthropic } from '@langchain/anthropic';
 import { AIMessage, SystemMessage } from '@langchain/core/messages';
 
-import { BaseCompleter, IBaseCompleter } from '../../base-completer';
-import { COMPLETION_SYSTEM_PROMPT } from '../../provider';
+import { BaseCompleter } from '../../base-completer';
 
-export class AnthropicCompleter implements IBaseCompleter {
+export class AnthropicCompleter extends BaseCompleter {
   constructor(options: BaseCompleter.IOptions) {
+    super(options);
     this._completer = new ChatAnthropic({ ...options.settings });
   }
 
-  /**
-   * Getter and setter for the initial prompt.
-   */
-  get prompt(): string {
-    return this._prompt;
-  }
-  set prompt(value: string) {
-    this._prompt = value;
-  }
-
   async fetch(
     request: CompletionHandler.IRequest,
     context: IInlineCompletionContext
@@ -34,7 +24,7 @@ export class AnthropicCompleter implements IBaseCompleter {
     const trimmedPrompt = prompt.trim();
 
     const messages = [
-      new SystemMessage(this._prompt),
+      new SystemMessage(this.systemPrompt),
       new AIMessage(trimmedPrompt)
     ];
 
@@ -65,6 +55,5 @@ export class AnthropicCompleter implements IBaseCompleter {
     }
   }
 
-  private _completer: ChatAnthropic;
-  private _prompt: string = COMPLETION_SYSTEM_PROMPT;
+  protected _completer: ChatAnthropic;
 }

src/default-providers/ChromeAI/completer.ts

@@ -5,8 +5,7 @@ import {
 import { ChromeAI } from '@langchain/community/experimental/llms/chrome_ai';
 import { HumanMessage, SystemMessage } from '@langchain/core/messages';
 
-import { BaseCompleter, IBaseCompleter } from '../../base-completer';
-import { COMPLETION_SYSTEM_PROMPT } from '../../provider';
+import { BaseCompleter } from '../../base-completer';
 
 /**
  * Regular expression to match the '```' string at the start of a string.
@@ -29,21 +28,12 @@ const CODE_BLOCK_START_REGEX = /^```(?:[a-zA-Z]+)?\n?/;
  */
 const CODE_BLOCK_END_REGEX = /```$/;
 
-export class ChromeCompleter implements IBaseCompleter {
+export class ChromeCompleter extends BaseCompleter {
   constructor(options: BaseCompleter.IOptions) {
+    super(options);
     this._completer = new ChromeAI({ ...options.settings });
   }
 
-  /**
-   * Getter and setter for the initial prompt.
-   */
-  get prompt(): string {
-    return this._prompt;
-  }
-  set prompt(value: string) {
-    this._prompt = value;
-  }
-
   async fetch(
     request: CompletionHandler.IRequest,
     context: IInlineCompletionContext
@@ -54,7 +44,7 @@ export class ChromeCompleter implements IBaseCompleter {
     const trimmedPrompt = prompt.trim();
 
     const messages = [
-      new SystemMessage(this._prompt),
+      new SystemMessage(this.systemPrompt),
       new HumanMessage(trimmedPrompt)
     ];
 
@@ -79,6 +69,5 @@ export class ChromeCompleter implements IBaseCompleter {
     }
   }
 
-  private _completer: ChromeAI;
-  private _prompt: string = COMPLETION_SYSTEM_PROMPT;
+  protected _completer: ChromeAI;
 }

src/default-providers/ChromeAI/settings-schema.json

@@ -11,9 +11,6 @@
     },
     "temperature": {
       "type": "number"
-    },
-    "systemPrompt": {
-      "type": "string"
     }
   },
   "additionalProperties": false,

src/default-providers/MistralAI/completer.ts

@@ -10,16 +10,16 @@ import {
 import { ChatMistralAI } from '@langchain/mistralai';
 import { Throttler } from '@lumino/polling';
 
-import { BaseCompleter, IBaseCompleter } from '../../base-completer';
-import { COMPLETION_SYSTEM_PROMPT } from '../../provider';
+import { BaseCompleter } from '../../base-completer';
 
 /**
  * The Mistral API has a rate limit of 1 request per second
  */
 const INTERVAL = 1000;
 
-export class CodestralCompleter implements IBaseCompleter {
+export class CodestralCompleter extends BaseCompleter {
   constructor(options: BaseCompleter.IOptions) {
+    super(options);
     this._completer = new ChatMistralAI({ ...options.settings });
     this._throttler = new Throttler(
       async (messages: BaseMessage[]) => {
@@ -46,16 +46,6 @@ export class CodestralCompleter implements IBaseCompleter {
     );
   }
 
-  /**
-   * Getter and setter for the initial prompt.
-   */
-  get prompt(): string {
-    return this._prompt;
-  }
-  set prompt(value: string) {
-    this._prompt = value;
-  }
-
   async fetch(
     request: CompletionHandler.IRequest,
     context: IInlineCompletionContext
@@ -64,7 +54,7 @@ export class CodestralCompleter implements IBaseCompleter {
     const prompt = text.slice(0, cursorOffset);
 
     const messages: BaseMessage[] = [
-      new SystemMessage(this._prompt),
+      new SystemMessage(this.systemPrompt),
       new HumanMessage(prompt)
     ];
 
@@ -77,6 +67,5 @@ export class CodestralCompleter implements IBaseCompleter {
   }
 
   private _throttler: Throttler;
-  private _completer: ChatMistralAI;
-  private _prompt: string = COMPLETION_SYSTEM_PROMPT;
+  protected _completer: ChatMistralAI;
 }