@jupyterlite/ai 0.3.0 → 0.5.0

package/src/index.ts

@@ -1,11 +1,10 @@
 import {
   ActiveCellManager,
-  AutocompletionRegistry,
   buildChatSidebar,
   buildErrorWidget,
+  ChatCommandRegistry,
   IActiveCellManager,
-  IAutocompletionCommandsProps,
-  IAutocompletionRegistry
+  IChatCommandRegistry
 } from '@jupyter/chat';
 import {
   JupyterFrontEnd,
@@ -16,51 +15,40 @@ import { ICompletionProviderManager } from '@jupyterlab/completer';
 import { INotebookTracker } from '@jupyterlab/notebook';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import { IFormRendererRegistry } from '@jupyterlab/ui-components';
+import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
+import { ISecretsManager } from 'jupyter-secrets-manager';
 
 import { ChatHandler } from './chat-handler';
-import { getSettings } from './llm-models';
-import { AIProvider } from './provider';
-import { renderSlashCommandOption } from './slash-commands';
-import { IAIProvider } from './token';
-
-const autocompletionRegistryPlugin: JupyterFrontEndPlugin<IAutocompletionRegistry> =
-  {
-    id: '@jupyterlite/ai:autocompletion-registry',
-    description: 'Autocompletion registry',
-    autoStart: true,
-    provides: IAutocompletionRegistry,
-    activate: () => {
-      const autocompletionRegistry = new AutocompletionRegistry();
-      const options = ['/clear'];
-      const autocompletionCommands: IAutocompletionCommandsProps = {
-        opener: '/',
-        commands: options.map(option => {
-          return {
-            id: option.slice(1),
-            label: option,
-            description: 'Clear the chat window'
-          };
-        }),
-        props: {
-          renderOption: renderSlashCommandOption
-        }
-      };
-      autocompletionRegistry.add('jupyterlite-ai', autocompletionCommands);
-      return autocompletionRegistry;
-    }
-  };
+import { CompletionProvider } from './completion-provider';
+import { defaultProviderPlugins } from './default-providers';
+import { AIProviderRegistry } from './provider';
+import { aiSettingsRenderer } from './settings/panel';
+import { IAIProviderRegistry } from './tokens';
+
+const chatCommandRegistryPlugin: JupyterFrontEndPlugin<IChatCommandRegistry> = {
+  id: '@jupyterlite/ai:autocompletion-registry',
+  description: 'Autocompletion registry',
+  autoStart: true,
+  provides: IChatCommandRegistry,
+  activate: () => {
+    const registry = new ChatCommandRegistry();
+    registry.addProvider(new ChatHandler.ClearCommandProvider());
+    return registry;
+  }
+};
 
 const chatPlugin: JupyterFrontEndPlugin<void> = {
   id: '@jupyterlite/ai:chat',
   description: 'LLM chat extension',
   autoStart: true,
-  requires: [IAIProvider, IRenderMimeRegistry, IAutocompletionRegistry],
+  requires: [IAIProviderRegistry, IRenderMimeRegistry, IChatCommandRegistry],
   optional: [INotebookTracker, ISettingRegistry, IThemeManager],
   activate: async (
     app: JupyterFrontEnd,
-    aiProvider: IAIProvider,
+    providerRegistry: IAIProviderRegistry,
     rmRegistry: IRenderMimeRegistry,
-    autocompletionRegistry: IAutocompletionRegistry,
+    chatCommandRegistry: IChatCommandRegistry,
     notebookTracker: INotebookTracker | null,
     settingsRegistry: ISettingRegistry | null,
     themeManager: IThemeManager | null
@@ -74,8 +62,8 @@ const chatPlugin: JupyterFrontEndPlugin<void> = {
     }
 
     const chatHandler = new ChatHandler({
-      aiProvider: aiProvider,
-      activeCellManager: activeCellManager
+      providerRegistry,
+      activeCellManager
     });
 
     let sendWithShiftEnter = false;
@@ -116,7 +104,7 @@ const chatPlugin: JupyterFrontEndPlugin<void> = {
         model: chatHandler,
         themeManager,
         rmRegistry,
-        autocompletionRegistry
+        chatCommandRegistry
       });
       chatWidget.title.caption = 'Jupyterlite AI Chat';
     } catch (e) {
@@ -129,50 +117,54 @@ const chatPlugin: JupyterFrontEndPlugin<void> = {
   }
 };
 
-const aiProviderPlugin: JupyterFrontEndPlugin<IAIProvider> = {
-  id: '@jupyterlite/ai:ai-provider',
+const completerPlugin: JupyterFrontEndPlugin<void> = {
+  id: '@jupyterlite/ai:completer',
   autoStart: true,
-  requires: [ICompletionProviderManager, ISettingRegistry],
-  provides: IAIProvider,
+  requires: [IAIProviderRegistry, ICompletionProviderManager],
   activate: (
     app: JupyterFrontEnd,
-    manager: ICompletionProviderManager,
-    settingRegistry: ISettingRegistry
-  ): IAIProvider => {
-    const aiProvider = new AIProvider({
-      completionProviderManager: manager,
+    providerRegistry: IAIProviderRegistry,
+    manager: ICompletionProviderManager
+  ): void => {
+    const completer = new CompletionProvider({
+      providerRegistry,
       requestCompletion: () => app.commands.execute('inline-completer:invoke')
     });
+    manager.registerInlineProvider(completer);
+  }
+};
 
-    let currentProvider = 'None';
+const providerRegistryPlugin: JupyterFrontEndPlugin<IAIProviderRegistry> = {
+  id: '@jupyterlite/ai:provider-registry',
+  autoStart: true,
+  requires: [IFormRendererRegistry, ISettingRegistry],
+  optional: [IRenderMimeRegistry, ISecretsManager],
+  provides: IAIProviderRegistry,
+  activate: (
+    app: JupyterFrontEnd,
+    editorRegistry: IFormRendererRegistry,
+    settingRegistry: ISettingRegistry,
+    rmRegistry?: IRenderMimeRegistry,
+    secretsManager?: ISecretsManager
+  ): IAIProviderRegistry => {
+    const providerRegistry = new AIProviderRegistry();
+
+    editorRegistry.addRenderer(
+      '@jupyterlite/ai:provider-registry.AIprovider',
+      aiSettingsRenderer({ providerRegistry, rmRegistry, secretsManager })
+    );
     settingRegistry
-      .load(aiProviderPlugin.id)
+      .load(providerRegistryPlugin.id)
       .then(settings => {
         const updateProvider = () => {
-          const provider = settings.get('provider').composite as string;
-          if (provider !== currentProvider) {
-            // Update the settings panel.
-            currentProvider = provider;
-            const settingsProperties = settings.schema.properties;
-            if (settingsProperties) {
-              const schemaKeys = Object.keys(settingsProperties);
-              schemaKeys.forEach(key => {
-                if (key !== 'provider') {
-                  delete settings.schema.properties?.[key];
-                }
-              });
-              const properties = getSettings(provider);
-              if (properties === null) {
-                return;
-              }
-              Object.entries(properties).forEach(([name, value], index) => {
-                settingsProperties[name] = value as ISettingRegistry.IProperty;
-              });
-            }
-          }
-
           // Update the settings to the AI providers.
-          aiProvider.setModels(provider, settings.composite);
+          const providerSettings = (settings.get('AIprovider').composite ?? {
+            provider: 'None'
+          }) as ReadonlyPartialJSONObject;
+          providerRegistry.setProvider(
+            providerSettings.provider as string,
+            providerSettings
+          );
         };
 
         settings.changed.connect(() => updateProvider());
@@ -180,13 +172,19 @@ const aiProviderPlugin: JupyterFrontEndPlugin<IAIProvider> = {
       })
       .catch(reason => {
         console.error(
-          `Failed to load settings for ${aiProviderPlugin.id}`,
+          `Failed to load settings for ${providerRegistryPlugin.id}`,
           reason
         );
       });
 
-    return aiProvider;
+    return providerRegistry;
   }
 };
 
-export default [chatPlugin, autocompletionRegistryPlugin, aiProviderPlugin];
+export default [
+  providerRegistryPlugin,
+  chatCommandRegistryPlugin,
+  chatPlugin,
+  completerPlugin,
+  ...defaultProviderPlugins
+];

package/src/provider.ts

@@ -4,11 +4,13 @@ import { BaseChatModel } from '@langchain/core/language_models/chat_models';
 import { ISignal, Signal } from '@lumino/signaling';
 import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
 
-import { CompletionProvider } from './completion-provider';
-import { getChatModel, IBaseCompleter } from './llm-models';
-import { IAIProvider } from './token';
+import { IBaseCompleter } from './base-completer';
+import { IAIProvider, IAIProviderRegistry } from './tokens';
+import { JSONSchema7 } from 'json-schema';
 
-export const chatSystemPrompt = (options: AIProvider.IPromptOptions) => `
+export const chatSystemPrompt = (
+  options: AIProviderRegistry.IPromptOptions
+) => `
 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.
@@ -36,40 +38,79 @@ would write.
 Do not include the prompt in the output, only the string that should be appended to the current input.
 `;
 
-export class AIProvider implements IAIProvider {
-  constructor(options: AIProvider.IOptions) {
-    this._completionProvider = new CompletionProvider({
-      name: 'None',
-      settings: {},
-      requestCompletion: options.requestCompletion
-    });
-    options.completionProviderManager.registerInlineProvider(
-      this._completionProvider
-    );
+export class AIProviderRegistry implements IAIProviderRegistry {
+  /**
+   * Get the list of provider names.
+   */
+  get providers(): string[] {
+    return Array.from(this._providers.keys());
+  }
+
+  /**
+   * Add a new provider.
+   */
+  add(provider: IAIProvider): void {
+    if (this._providers.has(provider.name)) {
+      throw new Error(
+        `A AI provider named '${provider.name}' is already registered`
+      );
+    }
+    this._providers.set(provider.name, provider);
   }
 
-  get name(): string {
+  /**
+   * Get the current provider name.
+   */
+  get currentName(): string {
     return this._name;
   }
 
   /**
    * Get the current completer of the completion provider.
    */
-  get completer(): IBaseCompleter | null {
-    if (this._name === null) {
+  get currentCompleter(): IBaseCompleter | null {
+    if (this._name === 'None') {
       return null;
     }
-    return this._completionProvider.completer;
+    return this._completer;
   }
 
   /**
    * Get the current llm chat model.
    */
-  get chatModel(): BaseChatModel | null {
-    if (this._name === null) {
+  get currentChatModel(): BaseChatModel | null {
+    if (this._name === 'None') {
       return null;
     }
-    return this._llmChatModel;
+    return this._chatModel;
+  }
+
+  /**
+   * Get the settings schema of a given provider.
+   */
+  getSettingsSchema(provider: string): JSONSchema7 {
+    return (this._providers.get(provider)?.settingsSchema?.properties ||
+      {}) as JSONSchema7;
+  }
+
+  /**
+   * Get the instructions of a given provider.
+   */
+  getInstructions(provider: string): string | undefined {
+    return this._providers.get(provider)?.instructions;
+  }
+
+  /**
+   * Format an error message from the current provider.
+   */
+  formatErrorMessage(error: any): string {
+    if (this._currentProvider?.errorMessage) {
+      return this._currentProvider?.errorMessage(error);
+    }
+    if (error.message) {
+      return error.message;
+    }
+    return error;
   }
 
   /**
@@ -87,43 +128,59 @@ export class AIProvider implements IAIProvider {
   }
 
   /**
-   * Set the models (chat model and completer).
-   * Creates the models if the name has changed, otherwise only updates their config.
+   * 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 model to use.
+   * @param name - the name of the provider to use.
    * @param settings - the settings for the models.
    */
-  setModels(name: string, settings: ReadonlyPartialJSONObject) {
-    try {
-      this._completionProvider.setCompleter(name, settings);
-      this._completerError = '';
-    } catch (e: any) {
-      this._completerError = e.message;
+  setProvider(name: string, settings: ReadonlyPartialJSONObject): void {
+    this._currentProvider = this._providers.get(name) ?? null;
+
+    if (this._currentProvider?.completer !== undefined) {
+      try {
+        this._completer = new this._currentProvider.completer({ ...settings });
+        this._completerError = '';
+      } catch (e: any) {
+        this._completerError = e.message;
+      }
+    } else {
+      this._completer = null;
     }
-    try {
-      this._llmChatModel = getChatModel(name, settings);
-      this._chatError = '';
-    } catch (e: any) {
-      this._chatError = e.message;
-      this._llmChatModel = null;
+
+    if (this._currentProvider?.chatModel !== undefined) {
+      try {
+        this._chatModel = new this._currentProvider.chatModel({ ...settings });
+        this._chatError = '';
+      } catch (e: any) {
+        this._chatError = e.message;
+        this._chatModel = null;
+      }
+    } else {
+      this._chatModel = null;
     }
     this._name = name;
-    this._modelChange.emit();
+    this._providerChanged.emit();
   }
 
-  get modelChange(): ISignal<IAIProvider, void> {
-    return this._modelChange;
+  /**
+   * A signal emitting when the provider or its settings has changed.
+   */
+  get providerChanged(): ISignal<IAIProviderRegistry, void> {
+    return this._providerChanged;
   }
 
-  private _completionProvider: CompletionProvider;
-  private _llmChatModel: BaseChatModel | null = null;
+  private _currentProvider: IAIProvider | null = null;
+  private _completer: IBaseCompleter | null = null;
+  private _chatModel: BaseChatModel | null = null;
   private _name: string = 'None';
-  private _modelChange = new Signal<IAIProvider, void>(this);
+  private _providerChanged = new Signal<IAIProviderRegistry, void>(this);
   private _chatError: string = '';
   private _completerError: string = '';
+  private _providers = new Map<string, IAIProvider>();
 }
 
-export namespace AIProvider {
+export namespace AIProviderRegistry {
   /**
    * The options for the LLM provider.
    */