@jupyterlite/ai 0.7.0 → 0.8.0

package/lib/base-completer.d.ts

@@ -1,10 +1,12 @@
 import { CompletionHandler, IInlineCompletionContext } from '@jupyterlab/completer';
+import { BaseLanguageModel } from '@langchain/core/language_models/base';
 import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
+import { IAIProviderRegistry } from './tokens';
 export interface IBaseCompleter {
     /**
      * The completion prompt.
      */
-    prompt: string;
+    readonly systemPrompt: string;
     /**
      * The function to fetch a new completion.
      */
@@ -14,6 +16,19 @@ export interface IBaseCompleter {
      */
     fetch(request: CompletionHandler.IRequest, context: IInlineCompletionContext): Promise<any>;
 }
+export declare abstract class BaseCompleter implements IBaseCompleter {
+    constructor(options: BaseCompleter.IOptions);
+    /**
+     * Get the system prompt for the completion.
+     */
+    get systemPrompt(): string;
+    /**
+     * 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.
  */
@@ -22,6 +37,13 @@ export declare namespace BaseCompleter {
      * The options for the constructor of a completer.
      */
     interface IOptions {
+        /**
+         * The provider registry.
+         */
+        providerRegistry: IAIProviderRegistry;
+        /**
+         * The settings of the provider.
+         */
         settings: ReadonlyPartialJSONObject;
     }
 }

package/lib/base-completer.js

@@ -1 +1,14 @@
-export {};
+import { DEFAULT_COMPLETION_SYSTEM_PROMPT } from './default-prompts';
+export class BaseCompleter {
+    constructor(options) {
+        this._providerRegistry = options.providerRegistry;
+    }
+    /**
+     * Get the system prompt for the completion.
+     */
+    get systemPrompt() {
+        return (this._providerRegistry.completerSystemPrompt ??
+            DEFAULT_COMPLETION_SYSTEM_PROMPT);
+    }
+    _providerRegistry;
+}

package/lib/chat-handler.d.ts

@@ -15,10 +15,9 @@ export declare class ChatHandler extends AbstractChatModel {
     get personaName(): string;
     set personaName(value: string);
     /**
-     * Getter and setter for the initial prompt.
+     * Get/set the system prompt for the chat.
      */
-    get prompt(): string;
-    set prompt(value: string);
+    get systemPrompt(): string;
     sendMessage(message: INewMessage): Promise<boolean>;
     getHistory(): Promise<IChatHistory>;
     dispose(): void;
@@ -27,7 +26,6 @@ export declare class ChatHandler extends AbstractChatModel {
     createChatContext(): IChatContext;
     private _providerRegistry;
     private _personaName;
-    private _prompt;
     private _errorMessage;
     private _history;
     private _defaultErrorMessage;
@@ -52,7 +50,7 @@ export declare namespace ChatHandler {
     class ClearCommandProvider implements IChatCommandProvider {
         id: string;
         private _slash_commands;
-        getChatCommands(inputModel: IInputModel): Promise<ChatCommand[]>;
-        handleChatCommand(command: ChatCommand, inputModel: IInputModel): Promise<void>;
+        listCommandCompletions(inputModel: IInputModel): Promise<ChatCommand[]>;
+        onSubmit(inputModel: IInputModel): Promise<void>;
     }
 }

package/lib/chat-handler.js

@@ -5,8 +5,8 @@
 import { AbstractChatContext, AbstractChatModel } from '@jupyter/chat';
 import { AIMessage, HumanMessage, mergeMessageRuns, SystemMessage } 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';
 /**
  * The base64 encoded SVG string of the jupyternaut lite icon.
  * Encode so it can be passed as avatar_url to jupyter-chat.
@@ -17,7 +17,7 @@ export const welcomeMessage = (providers) => `
 #### Ask JupyterLite AI
 
 
-The provider to use can be set in the settings editor, by selecting it from
+The provider to use can be set in the <button data-commandLinker-command="settingeditor:open" data-commandLinker-args='{"query": "AI provider"}' href="#">settings editor</button>, by selecting it from
 the <img src="${AI_AVATAR}" width="16" height="16"> _AI provider_ settings.
 
 The current providers that are available are _${providers.sort().join('_, _')}_.
@@ -28,14 +28,8 @@ export class ChatHandler extends AbstractChatModel {
     constructor(options) {
         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
-            });
         });
     }
     get provider() {
@@ -58,13 +52,10 @@ export class ChatHandler extends AbstractChatModel {
         this._personaName = value;
     }
     /**
-     * Getter and setter for the initial prompt.
+     * Get/set the system prompt for the chat.
      */
-    get prompt() {
-        return this._prompt;
-    }
-    set prompt(value) {
-        this._prompt = value;
+    get systemPrompt() {
+        return (this._providerRegistry.chatSystemPrompt ?? DEFAULT_CHAT_SYSTEM_PROMPT);
     }
     async sendMessage(message) {
         const body = message.body;
@@ -79,7 +70,7 @@ export class ChatHandler extends AbstractChatModel {
             id: message.id,
             body,
             sender: { username: 'User' },
-            time: Date.now(),
+            time: Private.getTimestampMs(),
             type: 'msg'
         };
         this.messageAdded(msg);
@@ -88,14 +79,14 @@ export class ChatHandler extends AbstractChatModel {
                 id: UUID.uuid4(),
                 body: `**${this._errorMessage ? this._errorMessage : this._defaultErrorMessage}**`,
                 sender: { username: 'ERROR' },
-                time: Date.now(),
+                time: Private.getTimestampMs(),
                 type: 'msg'
             };
             this.messageAdded(errorMsg);
             return false;
         }
         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') {
                 return new HumanMessage(msg.body);
@@ -109,7 +100,7 @@ export class ChatHandler extends AbstractChatModel {
             id: UUID.uuid4(),
             body: '',
             sender,
-            time: Date.now(),
+            time: Private.getTimestampMs(),
             type: 'msg'
         };
         let content = '';
@@ -129,7 +120,7 @@ export class ChatHandler extends AbstractChatModel {
                 id: UUID.uuid4(),
                 body: `**${error}**`,
                 sender: { username: 'ERROR' },
-                time: Date.now(),
+                time: Private.getTimestampMs(),
                 type: 'msg'
             };
             this.messageAdded(errorMsg);
@@ -157,7 +148,6 @@ export class ChatHandler extends AbstractChatModel {
     }
     _providerRegistry;
     _personaName = 'AI';
-    _prompt;
     _errorMessage = '';
     _history = { messages: [] };
     _defaultErrorMessage = 'AI provider not configured';
@@ -184,7 +174,7 @@ export class ChatHandler extends AbstractChatModel {
                 description: 'Clear the chat'
             }
         ];
-        async getChatCommands(inputModel) {
+        async listCommandCompletions(inputModel) {
             const match = inputModel.currentWord?.match(/^\/\w*/)?.[0];
             if (!match) {
                 return [];
@@ -192,10 +182,20 @@ export class ChatHandler extends AbstractChatModel {
             const commands = this._slash_commands.filter(cmd => cmd.name.startsWith(match));
             return commands;
         }
-        async handleChatCommand(command, inputModel) {
+        async onSubmit(inputModel) {
             // no handling needed because `replaceWith` is set in each command.
             return;
         }
     }
     ChatHandler.ClearCommandProvider = ClearCommandProvider;
 })(ChatHandler || (ChatHandler = {}));
+var Private;
+(function (Private) {
+    /**
+     * Return the current timestamp in milliseconds.
+     */
+    function getTimestampMs() {
+        return Date.now() / 1000;
+    }
+    Private.getTimestampMs = getTimestampMs;
+})(Private || (Private = {}));

package/lib/completion-provider.js

@@ -16,7 +16,7 @@ export class CompletionProvider {
      * Get the current completer name.
      */
     get name() {
-        return this._providerRegistry.currentName;
+        return this._providerRegistry.currentName('completer');
     }
     /**
      * Get the current completer.

package/lib/default-prompts.d.ts

@@ -0,0 +1,2 @@
+export declare const DEFAULT_CHAT_SYSTEM_PROMPT = "\nYou 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.\n";
+export declare const DEFAULT_COMPLETION_SYSTEM_PROMPT = "\nYou are an application built to provide helpful code completion suggestions.\nYou should only produce code. Keep comments to minimum, use the\nprogramming language comment syntax. Produce clean code.\nThe code is written in JupyterLab, a data analysis and code development\nenvironment which can execute code extended with additional syntax for\ninteractive 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\ngive code passed as input, no explanation whatsoever.\nDo not include the prompt in the output, only the string that should be appended to the current input.\nHere is the code to complete:\n";

package/lib/default-prompts.js

@@ -0,0 +1,31 @@
+/*
+ * 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:
+`;

package/lib/default-providers/Anthropic/completer.d.ts

@@ -1,17 +1,12 @@
 import { CompletionHandler, IInlineCompletionContext } from '@jupyterlab/completer';
-import { BaseCompleter, IBaseCompleter } from '../../base-completer';
-export declare class AnthropicCompleter implements IBaseCompleter {
+import { ChatAnthropic } from '@langchain/anthropic';
+import { BaseCompleter } from '../../base-completer';
+export declare class AnthropicCompleter extends BaseCompleter {
     constructor(options: BaseCompleter.IOptions);
-    /**
-     * Getter and setter for the initial prompt.
-     */
-    get prompt(): string;
-    set prompt(value: string);
     fetch(request: CompletionHandler.IRequest, context: IInlineCompletionContext): Promise<{
         items: {
             insertText: string;
         }[];
     }>;
-    private _completer;
-    private _prompt;
+    protected _completer: ChatAnthropic;
 }

package/lib/default-providers/Anthropic/completer.js

@@ -1,26 +1,18 @@
 import { ChatAnthropic } from '@langchain/anthropic';
 import { AIMessage, SystemMessage } from '@langchain/core/messages';
-import { COMPLETION_SYSTEM_PROMPT } from '../../provider';
-export class AnthropicCompleter {
+import { BaseCompleter } from '../../base-completer';
+export class AnthropicCompleter extends BaseCompleter {
     constructor(options) {
+        super(options);
         this._completer = new ChatAnthropic({ ...options.settings });
     }
-    /**
-     * Getter and setter for the initial prompt.
-     */
-    get prompt() {
-        return this._prompt;
-    }
-    set prompt(value) {
-        this._prompt = value;
-    }
     async fetch(request, context) {
         const { text, offset: cursorOffset } = request;
         const prompt = text.slice(0, cursorOffset);
         // Anthropic does not allow whitespace at the end of the AIMessage
         const trimmedPrompt = prompt.trim();
         const messages = [
-            new SystemMessage(this._prompt),
+            new SystemMessage(this.systemPrompt),
             new AIMessage(trimmedPrompt)
         ];
         try {
@@ -51,5 +43,4 @@ export class AnthropicCompleter {
         }
     }
     _completer;
-    _prompt = COMPLETION_SYSTEM_PROMPT;
 }

package/lib/default-providers/ChromeAI/completer.d.ts

@@ -1,17 +1,12 @@
 import { CompletionHandler, IInlineCompletionContext } from '@jupyterlab/completer';
-import { BaseCompleter, IBaseCompleter } from '../../base-completer';
-export declare class ChromeCompleter implements IBaseCompleter {
+import { ChromeAI } from '@langchain/community/experimental/llms/chrome_ai';
+import { BaseCompleter } from '../../base-completer';
+export declare class ChromeCompleter extends BaseCompleter {
     constructor(options: BaseCompleter.IOptions);
-    /**
-     * Getter and setter for the initial prompt.
-     */
-    get prompt(): string;
-    set prompt(value: string);
     fetch(request: CompletionHandler.IRequest, context: IInlineCompletionContext): Promise<{
         items: {
             insertText: string;
         }[];
     }>;
-    private _completer;
-    private _prompt;
+    protected _completer: ChromeAI;
 }

package/lib/default-providers/ChromeAI/completer.js

@@ -1,6 +1,6 @@
 import { ChromeAI } from '@langchain/community/experimental/llms/chrome_ai';
 import { HumanMessage, SystemMessage } from '@langchain/core/messages';
-import { COMPLETION_SYSTEM_PROMPT } from '../../provider';
+import { BaseCompleter } from '../../base-completer';
 /**
  * Regular expression to match the '```' string at the start of a string.
  * So the completions returned by the LLM can still be kept after removing the code block formatting.
@@ -20,25 +20,17 @@ const CODE_BLOCK_START_REGEX = /^```(?:[a-zA-Z]+)?\n?/;
  * Regular expression to match the '```' string at the end of a string.
  */
 const CODE_BLOCK_END_REGEX = /```$/;
-export class ChromeCompleter {
+export class ChromeCompleter extends BaseCompleter {
     constructor(options) {
+        super(options);
         this._completer = new ChromeAI({ ...options.settings });
     }
-    /**
-     * Getter and setter for the initial prompt.
-     */
-    get prompt() {
-        return this._prompt;
-    }
-    set prompt(value) {
-        this._prompt = value;
-    }
     async fetch(request, context) {
         const { text, offset: cursorOffset } = request;
         const prompt = text.slice(0, cursorOffset);
         const trimmedPrompt = prompt.trim();
         const messages = [
-            new SystemMessage(this._prompt),
+            new SystemMessage(this.systemPrompt),
             new HumanMessage(trimmedPrompt)
         ];
         try {
@@ -61,5 +53,4 @@ export class ChromeCompleter {
         }
     }
     _completer;
-    _prompt = COMPLETION_SYSTEM_PROMPT;
 }

package/lib/default-providers/ChromeAI/settings-schema.json

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

package/lib/default-providers/Gemini/completer.d.ts

@@ -0,0 +1,12 @@
+import { CompletionHandler, IInlineCompletionContext } from '@jupyterlab/completer';
+import { ChatGoogleGenerativeAI } from '@langchain/google-genai';
+import { BaseCompleter } from '../../base-completer';
+export declare class GeminiCompleter extends BaseCompleter {
+    constructor(options: BaseCompleter.IOptions);
+    fetch(request: CompletionHandler.IRequest, context: IInlineCompletionContext): Promise<{
+        items: {
+            insertText: string;
+        }[];
+    }>;
+    protected _completer: ChatGoogleGenerativeAI;
+}

package/lib/default-providers/Gemini/completer.js

@@ -0,0 +1,48 @@
+import { ChatGoogleGenerativeAI } from '@langchain/google-genai';
+import { AIMessage, SystemMessage } from '@langchain/core/messages';
+import { BaseCompleter } from '../../base-completer';
+export class GeminiCompleter extends BaseCompleter {
+    constructor(options) {
+        super(options);
+        this._completer = new ChatGoogleGenerativeAI({
+            model: 'gemini-pro',
+            ...options.settings
+        });
+    }
+    async fetch(request, context) {
+        const { text, offset: cursorOffset } = request;
+        const prompt = text.slice(0, cursorOffset);
+        const trimmedPrompt = prompt.trim();
+        const messages = [
+            new SystemMessage(this.systemPrompt),
+            new AIMessage(trimmedPrompt)
+        ];
+        try {
+            const response = await this._completer.invoke(messages);
+            const items = [];
+            // Gemini can return string or complex content, a list of string/images/other.
+            if (typeof response.content === 'string') {
+                items.push({
+                    insertText: response.content
+                });
+            }
+            else {
+                response.content.forEach(content => {
+                    if (content.type !== 'text') {
+                        return;
+                    }
+                    items.push({
+                        insertText: content.text,
+                        filterText: prompt.substring(trimmedPrompt.length)
+                    });
+                });
+            }
+            return { items };
+        }
+        catch (error) {
+            console.error('Error fetching completions', error);
+            return { items: [] };
+        }
+    }
+    _completer;
+}

package/lib/default-providers/Gemini/instructions.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "\n<i class=\"fas fa-exclamation-triangle\"></i> This extension is still very much experimental. It is not an official Google extension.\n\n1. Go to <https://aistudio.google.com> and create an API key.\n\n2. Open the JupyterLab settings and go to the **Ai providers** section to select the `Gemini`\n   provider and add your API key (required).\n3. Open the chat, or use the inline completer.\n";
+export default _default;

package/lib/default-providers/Gemini/instructions.js

@@ -0,0 +1,9 @@
+export default `
+<i class="fas fa-exclamation-triangle"></i> This extension is still very much experimental. It is not an official Google extension.
+
+1. Go to <https://aistudio.google.com> and create an API key.
+
+2. Open the JupyterLab settings and go to the **Ai providers** section to select the \`Gemini\`
+   provider and add your API key (required).
+3. Open the chat, or use the inline completer.
+`;

package/lib/default-providers/Gemini/settings-schema.json

@@ -0,0 +1,64 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "properties": {
+        "temperature": {
+            "type": "number",
+            "description": "Amount of randomness injected into the response. Ranges from 0 to 1. Use temp closer to 0 for analytical / multiple choice, and temp closer to 1 for creative and generative tasks."
+        },
+        "topK": {
+            "type": "number",
+            "description": "Only sample from the top K options for each subsequent token. Used to remove \"long tail\" low probability responses."
+        },
+        "topP": {
+            "type": "number",
+            "description": "Nucleus sampling parameter. Only the smallest set of most probable tokens with probabilities that add up to top_p or higher are kept for generation."
+        },
+        "maxOutputTokens": {
+            "type": "number",
+            "description": "The maximum number of tokens to generate in the response."
+        },
+        "stopSequences": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "A list of strings upon which to stop generating. You probably want something like [\"\\n\\nHuman:\"] for chat conversations."
+        },
+        "streaming": {
+            "type": "boolean",
+            "description": "Whether to stream the results or not"
+        },
+        "apiKey": {
+            "type": "string",
+            "description": "Google AI Studio API key"
+        },
+        "model": {
+            "type": "string",
+            "description": "Model name to use (e.g., gemini-pro, gemini-2.0-flash, etc.)",
+            "default": "gemini-pro"
+        },
+        "baseURL": {
+            "type": "string",
+            "description": "Base URL for the Google AI API"
+        },
+        "safetySettings": {
+            "type": "array",
+            "description": "Safety settings for content filtering",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "category": {
+                        "type": "string"
+                    },
+                    "threshold": {
+                        "type": "string"
+                    }
+                }
+            }
+        }
+    },
+    "additionalProperties": false,
+    "description": "Input to Google Generative AI Chat class.",
+    "definitions": {}
+}

package/lib/default-providers/MistralAI/completer.d.ts

@@ -1,14 +1,13 @@
 import { CompletionHandler, IInlineCompletionContext } from '@jupyterlab/completer';
-import { BaseCompleter, IBaseCompleter } from '../../base-completer';
-export declare class CodestralCompleter implements IBaseCompleter {
+import { MistralAI } from '@langchain/mistralai';
+import { BaseCompleter } from '../../base-completer';
+export declare class CodestralCompleter extends BaseCompleter {
     constructor(options: BaseCompleter.IOptions);
-    /**
-     * Getter and setter for the initial prompt.
-     */
-    get prompt(): string;
-    set prompt(value: string);
-    fetch(request: CompletionHandler.IRequest, context: IInlineCompletionContext): Promise<any>;
-    private _throttler;
-    private _completer;
-    private _prompt;
+    fetch(request: CompletionHandler.IRequest, context: IInlineCompletionContext): Promise<{
+        items: {
+            insertText: string;
+        }[];
+    }>;
+    private _controller;
+    protected _completer: MistralAI;
 }