@jupyterlite/ai 0.5.0 → 0.6.1

package/lib/chat-handler.d.ts

@@ -22,12 +22,14 @@ export declare class ChatHandler extends ChatModel {
     getHistory(): Promise<IChatHistory>;
     dispose(): void;
     messageAdded(message: IChatMessage): void;
+    stopStreaming(): void;
     private _providerRegistry;
     private _personaName;
     private _prompt;
     private _errorMessage;
     private _history;
     private _defaultErrorMessage;
+    private _controller;
 }
 export declare namespace ChatHandler {
     interface IOptions extends ChatModel.IOptions {

package/lib/chat-handler.js

@@ -20,6 +20,7 @@ export class ChatHandler extends ChatModel {
         this._errorMessage = '';
         this._history = { messages: [] };
         this._defaultErrorMessage = 'AI provider not configured';
+        this._controller = null;
         this._providerRegistry = options.providerRegistry;
         this._prompt = chatSystemPrompt({
             provider_name: this._providerRegistry.currentName
@@ -107,8 +108,9 @@ export class ChatHandler extends ChatModel {
             type: 'msg'
         };
         let content = '';
+        this._controller = new AbortController();
         try {
-            for await (const chunk of await this._providerRegistry.currentChatModel.stream(messages)) {
+            for await (const chunk of await this._providerRegistry.currentChatModel.stream(messages, { signal: this._controller.signal })) {
                 content += (_a = chunk.content) !== null && _a !== void 0 ? _a : chunk;
                 botMsg.body = content;
                 this.messageAdded(botMsg);
@@ -130,6 +132,7 @@ export class ChatHandler extends ChatModel {
         }
         finally {
             this.updateWriters([]);
+            this._controller = null;
         }
     }
     async getHistory() {
@@ -141,6 +144,10 @@ export class ChatHandler extends ChatModel {
     messageAdded(message) {
         super.messageAdded(message);
     }
+    stopStreaming() {
+        var _a;
+        (_a = this._controller) === null || _a === void 0 ? void 0 : _a.abort();
+    }
 }
 (function (ChatHandler) {
     class ClearCommandProvider {

package/lib/completion-provider.d.ts

@@ -21,7 +21,14 @@ export declare class CompletionProvider implements IInlineCompletionProvider {
 }
 export declare namespace CompletionProvider {
     interface IOptions {
+        /**
+         * The registry where the completion provider belongs.
+         */
         providerRegistry: IAIProviderRegistry;
+        /**
+         * The request completion commands, can be useful if a provider needs to request
+         * the completion by itself.
+         */
         requestCompletion: () => void;
     }
 }

package/lib/components/stop-button.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="react" />
+import { InputToolbarRegistry } from '@jupyter/chat';
+/**
+ * Properties of the stop button.
+ */
+export interface IStopButtonProps extends InputToolbarRegistry.IToolbarItemProps {
+    /**
+     * The function to stop streaming.
+     */
+    stopStreaming: () => void;
+}
+/**
+ * The stop button.
+ */
+export declare function StopButton(props: IStopButtonProps): JSX.Element;
+/**
+ * factory returning the toolbar item.
+ */
+export declare function stopItem(stopStreaming: () => void): InputToolbarRegistry.IToolbarItem;

package/lib/components/stop-button.js

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import StopIcon from '@mui/icons-material/Stop';
+import React from 'react';
+import { TooltippedButton } from '@jupyter/chat';
+/**
+ * The stop button.
+ */
+export function StopButton(props) {
+    const tooltip = 'Stop streaming';
+    return (React.createElement(TooltippedButton, { onClick: props.stopStreaming, tooltip: tooltip, buttonProps: {
+            size: 'small',
+            variant: 'contained',
+            title: tooltip
+        } },
+        React.createElement(StopIcon, null)));
+}
+/**
+ * factory returning the toolbar item.
+ */
+export function stopItem(stopStreaming) {
+    return {
+        element: (props) => {
+            const stopProps = { ...props, stopStreaming };
+            return StopButton(stopProps);
+        },
+        position: 50,
+        hidden: true /* hidden by default */
+    };
+}

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 import { IChatCommandRegistry } from '@jupyter/chat';
 import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+import { ISettingConnector } from '@jupyterlab/settingregistry';
 import { IAIProviderRegistry } from './tokens';
-declare const _default: (JupyterFrontEndPlugin<void> | JupyterFrontEndPlugin<IChatCommandRegistry> | JupyterFrontEndPlugin<IAIProviderRegistry>)[];
+declare const _default: (JupyterFrontEndPlugin<void> | JupyterFrontEndPlugin<IChatCommandRegistry> | JupyterFrontEndPlugin<IAIProviderRegistry> | JupyterFrontEndPlugin<ISettingConnector>)[];
 export default _default;

package/lib/index.js

@@ -1,19 +1,20 @@
-import { ActiveCellManager, buildChatSidebar, buildErrorWidget, ChatCommandRegistry, IChatCommandRegistry } from '@jupyter/chat';
+import { ActiveCellManager, buildChatSidebar, buildErrorWidget, ChatCommandRegistry, IChatCommandRegistry, InputToolbarRegistry } from '@jupyter/chat';
 import { IThemeManager } from '@jupyterlab/apputils';
 import { ICompletionProviderManager } from '@jupyterlab/completer';
 import { INotebookTracker } from '@jupyterlab/notebook';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
-import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import { ISettingConnector, ISettingRegistry } from '@jupyterlab/settingregistry';
 import { IFormRendererRegistry } from '@jupyterlab/ui-components';
-import { ISecretsManager } from 'jupyter-secrets-manager';
+import { ISecretsManager, SecretsManager } from 'jupyter-secrets-manager';
 import { ChatHandler } from './chat-handler';
 import { CompletionProvider } from './completion-provider';
 import { defaultProviderPlugins } from './default-providers';
 import { AIProviderRegistry } from './provider';
-import { aiSettingsRenderer } from './settings/panel';
-import { IAIProviderRegistry } from './tokens';
+import { aiSettingsRenderer, SettingConnector } from './settings';
+import { IAIProviderRegistry, PLUGIN_IDS } from './tokens';
+import { stopItem } from './components/stop-button';
 const chatCommandRegistryPlugin = {
-    id: '@jupyterlite/ai:autocompletion-registry',
+    id: PLUGIN_IDS.chatCommandRegistry,
     description: 'Autocompletion registry',
     autoStart: true,
     provides: IChatCommandRegistry,
@@ -24,7 +25,7 @@ const chatCommandRegistryPlugin = {
     }
 };
 const chatPlugin = {
-    id: '@jupyterlite/ai:chat',
+    id: PLUGIN_IDS.chat,
     description: 'LLM chat extension',
     autoStart: true,
     requires: [IAIProviderRegistry, IRenderMimeRegistry, IChatCommandRegistry],
@@ -66,12 +67,26 @@ const chatPlugin = {
             console.error(`Something went wrong when reading the settings.\n${reason}`);
         });
         let chatWidget = null;
+        const inputToolbarRegistry = InputToolbarRegistry.defaultToolbarRegistry();
+        const stopButton = stopItem(() => chatHandler.stopStreaming());
+        inputToolbarRegistry.addItem('stop', stopButton);
+        chatHandler.writersChanged.connect((_, users) => {
+            if (users.filter(user => user.username === chatHandler.personaName).length) {
+                inputToolbarRegistry.hide('send');
+                inputToolbarRegistry.show('stop');
+            }
+            else {
+                inputToolbarRegistry.hide('stop');
+                inputToolbarRegistry.show('send');
+            }
+        });
         try {
             chatWidget = buildChatSidebar({
                 model: chatHandler,
                 themeManager,
                 rmRegistry,
-                chatCommandRegistry
+                chatCommandRegistry,
+                inputToolbarRegistry
             });
             chatWidget.title.caption = 'Jupyterlite AI Chat';
         }
@@ -83,7 +98,7 @@ const chatPlugin = {
     }
 };
 const completerPlugin = {
-    id: '@jupyterlite/ai:completer',
+    id: PLUGIN_IDS.completer,
     autoStart: true,
     requires: [IAIProviderRegistry, ICompletionProviderManager],
     activate: (app, providerRegistry, manager) => {
@@ -94,15 +109,24 @@ const completerPlugin = {
         manager.registerInlineProvider(completer);
     }
 };
-const providerRegistryPlugin = {
-    id: '@jupyterlite/ai:provider-registry',
+const providerRegistryPlugin = SecretsManager.sign(PLUGIN_IDS.providerRegistry, token => ({
+    id: PLUGIN_IDS.providerRegistry,
     autoStart: true,
     requires: [IFormRendererRegistry, ISettingRegistry],
-    optional: [IRenderMimeRegistry, ISecretsManager],
+    optional: [IRenderMimeRegistry, ISecretsManager, ISettingConnector],
     provides: IAIProviderRegistry,
-    activate: (app, editorRegistry, settingRegistry, rmRegistry, secretsManager) => {
-        const providerRegistry = new AIProviderRegistry();
-        editorRegistry.addRenderer('@jupyterlite/ai:provider-registry.AIprovider', aiSettingsRenderer({ providerRegistry, rmRegistry, secretsManager }));
+    activate: (app, editorRegistry, settingRegistry, rmRegistry, secretsManager, settingConnector) => {
+        const providerRegistry = new AIProviderRegistry({
+            token,
+            secretsManager
+        });
+        editorRegistry.addRenderer(`${PLUGIN_IDS.providerRegistry}.AIprovider`, aiSettingsRenderer({
+            providerRegistry,
+            secretsToken: token,
+            rmRegistry,
+            secretsManager,
+            settingConnector
+        }));
         settingRegistry
             .load(providerRegistryPlugin.id)
             .then(settings => {
@@ -112,7 +136,10 @@ const providerRegistryPlugin = {
                 const providerSettings = ((_a = settings.get('AIprovider').composite) !== null && _a !== void 0 ? _a : {
                     provider: 'None'
                 });
-                providerRegistry.setProvider(providerSettings.provider, providerSettings);
+                providerRegistry.setProvider({
+                    name: providerSettings.provider,
+                    settings: providerSettings
+                });
             };
             settings.changed.connect(() => updateProvider());
             updateProvider();
@@ -122,11 +149,24 @@ const providerRegistryPlugin = {
         });
         return providerRegistry;
     }
+}));
+/**
+ * Provides the settings connector as a separate plugin to allow for alternative
+ * implementations that may want to fetch settings from a different source or
+ * endpoint.
+ */
+const settingsConnector = {
+    id: PLUGIN_IDS.settingsConnector,
+    description: 'Provides a settings connector which does not save passwords.',
+    autoStart: true,
+    provides: ISettingConnector,
+    activate: (app) => new SettingConnector(app.serviceManager.settings)
 };
 export default [
     providerRegistryPlugin,
     chatCommandRegistryPlugin,
     chatPlugin,
     completerPlugin,
+    settingsConnector,
     ...defaultProviderPlugins
 ];

package/lib/provider.d.ts

@@ -1,14 +1,18 @@
-import { ICompletionProviderManager } from '@jupyterlab/completer';
 import { BaseLanguageModel } from '@langchain/core/language_models/base';
 import { BaseChatModel } from '@langchain/core/language_models/chat_models';
 import { ISignal } from '@lumino/signaling';
 import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
-import { IBaseCompleter } from './base-completer';
-import { IAIProvider, IAIProviderRegistry } from './tokens';
 import { JSONSchema7 } from 'json-schema';
+import { ISecretsManager } from 'jupyter-secrets-manager';
+import { IBaseCompleter } from './base-completer';
+import { IAIProvider, IAIProviderRegistry, ISetProviderOptions } from './tokens';
 export declare const chatSystemPrompt: (options: AIProviderRegistry.IPromptOptions) => string;
 export declare const 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 correspond to what a human users\nwould write.\nDo not include the prompt in the output, only the string that should be appended to the current input.\n";
 export declare class AIProviderRegistry implements IAIProviderRegistry {
+    /**
+     * The constructor of the provider registry.
+     */
+    constructor(options: AIProviderRegistry.IOptions);
     /**
      * Get the list of provider names.
      */
@@ -53,14 +57,14 @@ export declare class AIProviderRegistry implements IAIProviderRegistry {
      * Set the providers (chat model and completer).
      * Creates the providers if the name has changed, otherwise only updates their config.
      *
-     * @param name - the name of the provider to use.
-     * @param settings - the settings for the models.
+     * @param options - An object with the name and the settings of the provider to use.
      */
-    setProvider(name: string, settings: ReadonlyPartialJSONObject): void;
+    setProvider(options: ISetProviderOptions): Promise<void>;
     /**
      * A signal emitting when the provider or its settings has changed.
      */
     get providerChanged(): ISignal<IAIProviderRegistry, void>;
+    private _secretsManager;
     private _currentProvider;
     private _completer;
     private _chatModel;
@@ -69,6 +73,7 @@ export declare class AIProviderRegistry implements IAIProviderRegistry {
     private _chatError;
     private _completerError;
     private _providers;
+    private _deferredProvider;
 }
 export declare namespace AIProviderRegistry {
     /**
@@ -76,13 +81,13 @@ export declare namespace AIProviderRegistry {
      */
     interface IOptions {
         /**
-         * The completion provider manager in which register the LLM completer.
+         * The secrets manager used in the application.
          */
-        completionProviderManager: ICompletionProviderManager;
+        secretsManager?: ISecretsManager;
         /**
-         * The application commands registry.
+         * The token used to request the secrets manager.
          */
-        requestCompletion: () => void;
+        token: symbol;
     }
     /**
      * The options for the Chat system prompt.

package/lib/provider.js

@@ -1,4 +1,7 @@
 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}.
@@ -26,7 +29,10 @@ would write.
 Do not include the prompt in the output, only the string that should be appended to the current input.
 `;
 export class AIProviderRegistry {
-    constructor() {
+    /**
+     * The constructor of the provider registry.
+     */
+    constructor(options) {
         this._currentProvider = null;
         this._completer = null;
         this._chatModel = null;
@@ -35,6 +41,9 @@ export class AIProviderRegistry {
         this._chatError = '';
         this._completerError = '';
         this._providers = new Map();
+        this._deferredProvider = null;
+        this._secretsManager = options.secretsManager || null;
+        Private.setToken(options.token);
     }
     /**
      * Get the list of provider names.
@@ -46,10 +55,15 @@ export class AIProviderRegistry {
      * Add a new provider.
      */
     add(provider) {
+        var _a;
         if (this._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);
+        }
     }
     /**
      * Get the current provider name.
@@ -119,15 +133,36 @@ export class AIProviderRegistry {
      * Set the providers (chat model and completer).
      * Creates the providers if the name has changed, otherwise only updates their config.
      *
-     * @param name - the name of the provider to use.
-     * @param settings - the settings for the models.
+     * @param options - An object with the name and the settings of the provider to use.
      */
-    setProvider(name, settings) {
-        var _a, _b, _c;
+    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 (((_b = this._currentProvider) === null || _b === void 0 ? void 0 : _b.completer) !== undefined) {
+        if (this._currentProvider === null) {
+            // The current provider may not be loaded when the settings are first loaded.
+            // Let's defer the provider loading.
+            this._deferredProvider = options;
+        }
+        else {
+            this._deferredProvider = 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));
+                fullSettings[key] = (secrets === null || secrets === void 0 ? void 0 : secrets.value) || settings[key];
+                continue;
+            }
+            fullSettings[key] = settings[key];
+        }
+        if (((_c = this._currentProvider) === null || _c === void 0 ? void 0 : _c.completer) !== undefined) {
             try {
-                this._completer = new this._currentProvider.completer({ ...settings });
+                this._completer = new this._currentProvider.completer({
+                    ...fullSettings
+                });
                 this._completerError = '';
             }
             catch (e) {
@@ -137,9 +172,11 @@ export class AIProviderRegistry {
         else {
             this._completer = null;
         }
-        if (((_c = this._currentProvider) === null || _c === void 0 ? void 0 : _c.chatModel) !== undefined) {
+        if (((_d = this._currentProvider) === null || _d === void 0 ? void 0 : _d.chatModel) !== undefined) {
             try {
-                this._chatModel = new this._currentProvider.chatModel({ ...settings });
+                this._chatModel = new this._currentProvider.chatModel({
+                    ...fullSettings
+                });
                 this._chatError = '';
             }
             catch (e) {
@@ -197,3 +234,24 @@ export class AIProviderRegistry {
     }
     AIProviderRegistry.updateConfig = updateConfig;
 })(AIProviderRegistry || (AIProviderRegistry = {}));
+var Private;
+(function (Private) {
+    /**
+     * The token to use with the secrets manager.
+     */
+    let secretsToken;
+    /**
+     * Set of the token.
+     */
+    function setToken(value) {
+        secretsToken = value;
+    }
+    Private.setToken = setToken;
+    /**
+     * get the token.
+     */
+    function getToken() {
+        return secretsToken;
+    }
+    Private.getToken = getToken;
+})(Private || (Private = {}));

package/lib/settings/index.d.ts

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

package/lib/settings/index.js

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

package/lib/settings/panel.d.ts

@@ -1,4 +1,5 @@
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
+import { ISettingConnector } from '@jupyterlab/settingregistry';
 import { IFormRenderer } from '@jupyterlab/ui-components';
 import type { FieldProps } from '@rjsf/utils';
 import { JSONSchema7 } from 'json-schema';
@@ -7,8 +8,10 @@ import React from 'react';
 import { IAIProviderRegistry, IDict } from '../tokens';
 export declare const aiSettingsRenderer: (options: {
     providerRegistry: IAIProviderRegistry;
+    secretsToken?: symbol;
     rmRegistry?: IRenderMimeRegistry;
     secretsManager?: ISecretsManager;
+    settingConnector?: ISettingConnector;
 }) => IFormRenderer;
 export interface ISettingsFormStates {
     schema: JSONSchema7;
@@ -17,6 +20,7 @@ export interface ISettingsFormStates {
 export declare class AiSettings extends React.Component<FieldProps, ISettingsFormStates> {
     constructor(props: FieldProps);
     componentDidUpdate(): Promise<void>;
+    componentWillUnmount(): void;
     /**
      * Get the current provider from the local storage.
      */
@@ -34,11 +38,6 @@ export declare class AiSettings extends React.Component<FieldProps, ISettingsFor
      */
     saveSettings(value: IDict<any>): void;
     private updateUseSecretsManager;
-    /**
-     * Update the UI schema of the form.
-     * Currently use to hide API keys.
-     */
-    private _updateUiSchema;
     /**
      * Build the schema for a given provider.
      */
@@ -73,8 +72,10 @@ export declare class AiSettings extends React.Component<FieldProps, ISettingsFor
     private _provider;
     private _providerSchema;
     private _useSecretsManager;
+    private _hideSecretFields;
     private _rmRegistry;
     private _secretsManager;
+    private _settingConnector;
     private _currentSettings;
     private _uiSchema;
     private _settings;