@jupyterlite/ai 0.6.2 → 0.8.0

package/lib/provider.js

@@ -1,116 +1,130 @@
+import { Notification } from '@jupyterlab/apputils';
+import { Debouncer } from '@lumino/polling';
 import { Signal } from '@lumino/signaling';
 import { getSecretId, SECRETS_REPLACEMENT } from './settings';
 import { PLUGIN_IDS } from './tokens';
 const SECRETS_NAMESPACE = PLUGIN_IDS.providerRegistry;
-export const chatSystemPrompt = (options) => `
-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 ${options.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 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 correspond to what a human users
-would write.
-Do not include the prompt in the output, only the string that should be appended to the current input.
-`;
+const NOTIFICATION_DELAY = 2000;
 export class AIProviderRegistry {
     /**
      * The constructor of the provider registry.
      */
     constructor(options) {
-        this._currentProvider = null;
-        this._completer = null;
-        this._chatModel = null;
-        this._name = 'None';
-        this._providerChanged = new Signal(this);
-        this._chatError = '';
-        this._completerError = '';
-        this._providers = new Map();
-        this._deferredProvider = null;
         this._secretsManager = options.secretsManager || null;
         Private.setToken(options.token);
+        this._notifications = {
+            chat: new Debouncer(this._emitErrorNotification, NOTIFICATION_DELAY),
+            completer: new Debouncer(this._emitErrorNotification, NOTIFICATION_DELAY)
+        };
     }
     /**
      * Get the list of provider names.
      */
     get providers() {
-        return Array.from(this._providers.keys());
+        return Array.from(Private.providers.keys());
     }
     /**
      * Add a new provider.
      */
     add(provider) {
-        var _a;
-        if (this._providers.has(provider.name)) {
+        if (Private.providers.has(provider.name)) {
             throw new Error(`A AI provider named '${provider.name}' is already registered`);
         }
-        this._providers.set(provider.name, provider);
-        // Set the provider if the loading has been deferred.
-        if (provider.name === ((_a = this._deferredProvider) === null || _a === void 0 ? void 0 : _a.name)) {
-            this.setProvider(this._deferredProvider);
+        Private.providers.set(provider.name, provider);
+        // Set the providers if the loading has been deferred.
+        if (provider.name === this._deferredProvider.completer?.name) {
+            this.setCompleterProvider(this._deferredProvider.completer);
+        }
+        if (provider.name === this._deferredProvider.chat?.name) {
+            this.setChatProvider(this._deferredProvider.chat);
         }
     }
     /**
      * Get the current provider name.
      */
-    get currentName() {
-        return this._name;
+    currentName(role) {
+        return Private.getName(role);
     }
     /**
-     * Get the current completer of the completion provider.
+     * Get the current AICompleter.
      */
     get currentCompleter() {
-        if (this._name === 'None') {
+        if (Private.getName('completer') === 'None') {
+            return null;
+        }
+        const completer = Private.getCompleter();
+        if (completer === null) {
             return null;
         }
-        return this._completer;
+        return {
+            fetch: (request, context) => completer.fetch(request, context)
+        };
     }
     /**
-     * Get the current llm chat model.
+     * Getter/setter for the completer system prompt.
+     */
+    get completerSystemPrompt() {
+        return this._completerPrompt.replaceAll('$provider_name$', this.currentName('completer'));
+    }
+    set completerSystemPrompt(value) {
+        this._completerPrompt = value;
+    }
+    /**
+     * Get the current AIChatModel.
      */
     get currentChatModel() {
-        if (this._name === 'None') {
+        if (Private.getName('chat') === 'None') {
+            return null;
+        }
+        const currentProvider = Private.providers.get(Private.getName('chat')) ?? null;
+        const chatModel = Private.getChatModel();
+        if (chatModel === null) {
             return null;
         }
-        return this._chatModel;
+        if (currentProvider?.exposeChatModel ?? false) {
+            // Expose the full chat model if expected.
+            return chatModel;
+        }
+        // Otherwise, we create a reduced AIChatModel interface.
+        return {
+            stream: (input, options) => chatModel.stream(input, options)
+        };
+    }
+    /**
+     * Getter/setter for the chat system prompt.
+     */
+    get chatSystemPrompt() {
+        return this._chatPrompt.replaceAll('$provider_name$', this.currentName('chat'));
+    }
+    set chatSystemPrompt(value) {
+        this._chatPrompt = value;
     }
     /**
      * Get the settings schema of a given provider.
      */
     getSettingsSchema(provider) {
-        var _a, _b;
-        return (((_b = (_a = this._providers.get(provider)) === null || _a === void 0 ? void 0 : _a.settingsSchema) === null || _b === void 0 ? void 0 : _b.properties) ||
+        return (Private.providers.get(provider)?.settingsSchema?.properties ||
             {});
     }
     /**
      * Get the instructions of a given provider.
      */
     getInstructions(provider) {
-        var _a;
-        return (_a = this._providers.get(provider)) === null || _a === void 0 ? void 0 : _a.instructions;
+        return Private.providers.get(provider)?.instructions;
+    }
+    /**
+     * Get the compatibility check function of a given provider.
+     */
+    getCompatibilityCheck(provider) {
+        return Private.providers.get(provider)?.compatibilityCheck;
     }
     /**
      * Format an error message from the current provider.
      */
     formatErrorMessage(error) {
-        var _a, _b;
-        if ((_a = this._currentProvider) === null || _a === void 0 ? void 0 : _a.errorMessage) {
-            return (_b = this._currentProvider) === null || _b === void 0 ? void 0 : _b.errorMessage(error);
+        const currentProvider = Private.providers.get(Private.getName('chat')) ?? null;
+        if (currentProvider?.errorMessage) {
+            return currentProvider?.errorMessage(error);
         }
         if (error.message) {
             return error.message;
@@ -118,79 +132,149 @@ export class AIProviderRegistry {
         return error;
     }
     /**
-     * Get the current chat error;
+     * Get/set the current chat error;
      */
     get chatError() {
         return this._chatError;
     }
+    set chatError(error) {
+        this._chatError = error;
+        if (error !== '') {
+            this._notifications.chat.invoke(`Chat: ${error}`);
+        }
+    }
     /**
-     * get the current completer error.
+     * Get/set the current completer error.
      */
     get completerError() {
         return this._completerError;
     }
+    set completerError(error) {
+        this._completerError = error;
+        if (error !== '') {
+            this._notifications.completer.invoke(`Completer: ${error}`);
+        }
+    }
     /**
-     * Set the providers (chat model and completer).
-     * Creates the providers if the name has changed, otherwise only updates their config.
+     * A function to emit a notification error.
+     */
+    _emitErrorNotification(error) {
+        Notification.emit(error, 'error', {
+            autoClose: NOTIFICATION_DELAY
+        });
+    }
+    /**
+     * Set the completer provider.
+     * Creates the provider if the name has changed, otherwise only updates its config.
      *
      * @param options - An object with the name and the settings of the provider to use.
      */
-    async setProvider(options) {
-        var _a, _b, _c, _d;
-        const { name, settings } = options;
-        this._currentProvider = (_a = this._providers.get(name)) !== null && _a !== void 0 ? _a : null;
-        if (this._currentProvider === null) {
+    async setCompleterProvider(settings) {
+        this.completerError = '';
+        if (!Object.keys(settings).includes('provider')) {
+            Private.setName('completer', 'None');
+            Private.setCompleter(null);
+            this.completerError =
+                'The provider is missing from the completer settings';
+            return;
+        }
+        const provider = settings['provider'];
+        const currentProvider = Private.providers.get(provider) ?? null;
+        if (currentProvider === null) {
             // The current provider may not be loaded when the settings are first loaded.
             // Let's defer the provider loading.
-            this._deferredProvider = options;
+            this._deferredProvider.completer = settings;
+            Private.setName('completer', provider);
+            Private.setCompleter(null);
+            return;
         }
         else {
-            this._deferredProvider = null;
+            this._deferredProvider.completer = null;
         }
-        // Build a new settings object containing the secrets.
-        const fullSettings = {};
-        for (const key of Object.keys(settings)) {
-            if (settings[key] === SECRETS_REPLACEMENT) {
-                const id = getSecretId(name, key);
-                const secrets = await ((_b = this._secretsManager) === null || _b === void 0 ? void 0 : _b.get(Private.getToken(), SECRETS_NAMESPACE, id));
-                if (secrets !== undefined) {
-                    fullSettings[key] = secrets.value;
-                }
-                continue;
+        const compatibilityCheck = this.getCompatibilityCheck(provider);
+        if (compatibilityCheck !== undefined) {
+            const error = await compatibilityCheck();
+            if (error !== null) {
+                this.completerError = error.trim();
+                Private.setName('completer', 'None');
+                this._providerChanged.emit('completer');
+                return;
             }
-            fullSettings[key] = settings[key];
         }
-        if (((_c = this._currentProvider) === null || _c === void 0 ? void 0 : _c.completer) !== undefined) {
+        // Get the settings including the secrets.
+        const fullSettings = await this._buildFullSettings(provider, settings);
+        if (currentProvider?.completer !== undefined) {
             try {
-                this._completer = new this._currentProvider.completer({
+                Private.setCompleter(new currentProvider.completer({
+                    providerRegistry: this,
                     settings: fullSettings
-                });
-                this._completerError = '';
+                }));
             }
             catch (e) {
-                this._completerError = e.message;
+                this.completerError = e.message;
             }
         }
         else {
-            this._completer = null;
+            Private.setCompleter(null);
+        }
+        Private.setName('completer', provider);
+        this._providerChanged.emit('completer');
+    }
+    /**
+     * Set the chat provider.
+     * Creates the provider if the name has changed, otherwise only updates its config.
+     *
+     * @param options - An object with the name and the settings of the provider to use.
+     */
+    async setChatProvider(settings) {
+        this.chatError = '';
+        if (!Object.keys(settings).includes('provider')) {
+            Private.setName('chat', 'None');
+            Private.setChatModel(null);
+            this.chatError = 'The provider is missing from the chat settings';
+            return;
+        }
+        const provider = settings['provider'];
+        const currentProvider = Private.providers.get(provider) ?? null;
+        if (currentProvider === null) {
+            // The current provider may not be loaded when the settings are first loaded.
+            // Let's defer the provider loading.
+            this._deferredProvider.chat = settings;
+            Private.setName('chat', provider);
+            Private.setChatModel(null);
+            return;
+        }
+        else {
+            this._deferredProvider.chat = null;
         }
-        if (((_d = this._currentProvider) === null || _d === void 0 ? void 0 : _d.chatModel) !== undefined) {
+        const compatibilityCheck = this.getCompatibilityCheck(provider);
+        if (compatibilityCheck !== undefined) {
+            const error = await compatibilityCheck();
+            if (error !== null) {
+                this.chatError = error.trim();
+                Private.setName('chat', 'None');
+                this._providerChanged.emit('chat');
+                return;
+            }
+        }
+        // Get the settings including the secrets.
+        const fullSettings = await this._buildFullSettings(provider, settings);
+        if (currentProvider?.chat !== undefined) {
             try {
-                this._chatModel = new this._currentProvider.chatModel({
+                Private.setChatModel(new currentProvider.chat({
                     ...fullSettings
-                });
-                this._chatError = '';
+                }));
             }
             catch (e) {
-                this._chatError = e.message;
-                this._chatModel = null;
+                this.chatError = e.message;
+                Private.setChatModel(null);
             }
         }
         else {
-            this._chatModel = null;
+            Private.setChatModel(null);
         }
-        this._name = name;
-        this._providerChanged.emit();
+        Private.setName('chat', provider);
+        this._providerChanged.emit('chat');
     }
     /**
      * A signal emitting when the provider or its settings has changed.
@@ -198,6 +282,36 @@ export class AIProviderRegistry {
     get providerChanged() {
         return this._providerChanged;
     }
+    /**
+     * Build a new settings object containing the secrets.
+     */
+    async _buildFullSettings(name, settings) {
+        // Build a new settings object containing the secrets.
+        const fullSettings = {};
+        for (const key of Object.keys(settings)) {
+            if (settings[key] === SECRETS_REPLACEMENT) {
+                const id = getSecretId(name, key);
+                const secrets = await this._secretsManager?.get(Private.getToken(), SECRETS_NAMESPACE, id);
+                if (secrets !== undefined) {
+                    fullSettings[key] = secrets.value;
+                }
+                continue;
+            }
+            fullSettings[key] = settings[key];
+        }
+        return fullSettings;
+    }
+    _secretsManager;
+    _providerChanged = new Signal(this);
+    _chatError = '';
+    _completerError = '';
+    _notifications;
+    _deferredProvider = {
+        chat: null,
+        completer: null
+    };
+    _chatPrompt = '';
+    _completerPrompt = '';
 }
 (function (AIProviderRegistry) {
     /**
@@ -239,21 +353,60 @@ export class AIProviderRegistry {
 var Private;
 (function (Private) {
     /**
-     * The token to use with the secrets manager.
+     * The token to use with the secrets manager, setter and getter.
      */
     let secretsToken;
-    /**
-     * Set of the token.
-     */
     function setToken(value) {
         secretsToken = value;
     }
     Private.setToken = setToken;
-    /**
-     * get the token.
-     */
     function getToken() {
         return secretsToken;
     }
     Private.getToken = getToken;
+    /**
+     * The providers map, in private namespace to prevent updating the 'exposeChatModel'
+     * flag.
+     */
+    Private.providers = new Map();
+    /**
+     * The name of the current provider, setter and getter.
+     * It is in a private namespace to prevent updating it without updating the models.
+     */
+    const names = {
+        chat: 'None',
+        completer: 'None'
+    };
+    function setName(role, value) {
+        names[role] = value;
+    }
+    Private.setName = setName;
+    function getName(role) {
+        return names[role];
+    }
+    Private.getName = getName;
+    /**
+     * The chat model setter and getter.
+     */
+    let chatModel = null;
+    function setChatModel(model) {
+        chatModel = model;
+    }
+    Private.setChatModel = setChatModel;
+    function getChatModel() {
+        return chatModel;
+    }
+    Private.getChatModel = getChatModel;
+    /**
+     * The completer setter and getter.
+     */
+    let completer = null;
+    function setCompleter(model) {
+        completer = model;
+    }
+    Private.setCompleter = setCompleter;
+    function getCompleter() {
+        return completer;
+    }
+    Private.getCompleter = getCompleter;
 })(Private || (Private = {}));

package/lib/settings/index.d.ts

@@ -1,3 +1,3 @@
 export * from './panel';
-export * from './settings-connector';
+export * from './textarea';
 export * from './utils';

package/lib/settings/index.js

@@ -1,3 +1,3 @@
 export * from './panel';
-export * from './settings-connector';
+export * from './textarea';
 export * from './utils';