Completer plugin (#49)

* Make the inline completer a plugin, that depends on AIProvider

* Rename some attributes/functions in AIProvider

Author: brichet

src/chat-handler.ts

@@ -40,7 +40,7 @@ export class ChatHandler extends ChatModel {
     this._aiProvider = options.aiProvider;
     this._prompt = chatSystemPrompt({ provider_name: this._aiProvider.name });
 
-    this._aiProvider.modelChange.connect(() => {
+    this._aiProvider.providerChanged.connect(() => {
       this._errorMessage = this._aiProvider.chatError;
       this._prompt = chatSystemPrompt({ provider_name: this._aiProvider.name });
     });

src/completion-provider.ts

@@ -3,10 +3,9 @@ import {
   IInlineCompletionContext,
   IInlineCompletionProvider
 } from '@jupyterlab/completer';
-import { BaseLanguageModel } from '@langchain/core/language_models/base';
-import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
 
-import { getCompleter, IBaseCompleter, BaseCompleter } from './llm-models';
+import { IBaseCompleter } from './llm-models';
+import { IAIProvider } from './token';
 
 /**
  * The generic completion provider to register to the completion provider manager.
@@ -15,67 +14,44 @@ export class CompletionProvider implements IInlineCompletionProvider {
   readonly identifier = '@jupyterlite/ai';
 
   constructor(options: CompletionProvider.IOptions) {
-    const { name, settings } = options;
+    this._aiProvider = options.aiProvider;
     this._requestCompletion = options.requestCompletion;
-    this.setCompleter(name, settings);
-  }
 
-  /**
-   * Set the completer.
-   *
-   * @param name - the name of the completer.
-   * @param settings - The settings associated to the completer.
-   */
-  setCompleter(name: string, settings: ReadonlyPartialJSONObject) {
-    try {
-      this._completer = getCompleter(name, settings);
-      if (this._completer) {
-        this._completer.requestCompletion = this._requestCompletion;
+    this._aiProvider.providerChanged.connect(() => {
+      if (this.completer) {
+        this.completer.requestCompletion = this._requestCompletion;
       }
-      this._name = this._completer === null ? 'None' : name;
-    } catch (e: any) {
-      this._completer = null;
-      this._name = 'None';
-      throw e;
-    }
+    });
   }
 
   /**
    * Get the current completer name.
    */
   get name(): string {
-    return this._name;
+    return this._aiProvider.name;
   }
 
   /**
    * Get the current completer.
    */
   get completer(): IBaseCompleter | null {
-    return this._completer;
-  }
-
-  /**
-   * Get the LLM completer.
-   */
-  get llmCompleter(): BaseLanguageModel | null {
-    return this._completer?.provider || null;
+    return this._aiProvider.completer;
   }
 
   async fetch(
     request: CompletionHandler.IRequest,
     context: IInlineCompletionContext
   ) {
-    return this._completer?.fetch(request, context);
+    return this.completer?.fetch(request, context);
   }
 
-  private _name: string = 'None';
+  private _aiProvider: IAIProvider;
   private _requestCompletion: () => void;
-  private _completer: IBaseCompleter | null = null;
 }
 
 export namespace CompletionProvider {
-  export interface IOptions extends BaseCompleter.IOptions {
-    name: string;
+  export interface IOptions {
+    aiProvider: IAIProvider;
     requestCompletion: () => void;
   }
 }

src/index.ts

@@ -22,6 +22,7 @@ import { getSettings } from './llm-models';
 import { AIProvider } from './provider';
 import { renderSlashCommandOption } from './slash-commands';
 import { IAIProvider } from './token';
+import { CompletionProvider } from './completion-provider';
 
 const autocompletionRegistryPlugin: JupyterFrontEndPlugin<IAutocompletionRegistry> =
   {
@@ -129,20 +130,33 @@ const chatPlugin: JupyterFrontEndPlugin<void> = {
   }
 };
 
+const completerPlugin: JupyterFrontEndPlugin<void> = {
+  id: '@jupyterlite/ai:completer',
+  autoStart: true,
+  requires: [IAIProvider, ICompletionProviderManager],
+  activate: (
+    app: JupyterFrontEnd,
+    aiProvider: IAIProvider,
+    manager: ICompletionProviderManager
+  ): void => {
+    const completer = new CompletionProvider({
+      aiProvider,
+      requestCompletion: () => app.commands.execute('inline-completer:invoke')
+    });
+    manager.registerInlineProvider(completer);
+  }
+};
+
 const aiProviderPlugin: JupyterFrontEndPlugin<IAIProvider> = {
   id: '@jupyterlite/ai:ai-provider',
   autoStart: true,
-  requires: [ICompletionProviderManager, ISettingRegistry],
+  requires: [ISettingRegistry],
   provides: IAIProvider,
   activate: (
     app: JupyterFrontEnd,
-    manager: ICompletionProviderManager,
     settingRegistry: ISettingRegistry
   ): IAIProvider => {
-    const aiProvider = new AIProvider({
-      completionProviderManager: manager,
-      requestCompletion: () => app.commands.execute('inline-completer:invoke')
-    });
+    const aiProvider = new AIProvider();
 
     let currentProvider = 'None';
     settingRegistry
@@ -172,7 +186,7 @@ const aiProviderPlugin: JupyterFrontEndPlugin<IAIProvider> = {
           }
 
           // Update the settings to the AI providers.
-          aiProvider.setModels(provider, settings.composite);
+          aiProvider.setProvider(provider, settings.composite);
         };
 
         settings.changed.connect(() => updateProvider());
@@ -189,4 +203,9 @@ const aiProviderPlugin: JupyterFrontEndPlugin<IAIProvider> = {
   }
 };
 
-export default [chatPlugin, autocompletionRegistryPlugin, aiProviderPlugin];
+export default [
+  aiProviderPlugin,
+  autocompletionRegistryPlugin,
+  chatPlugin,
+  completerPlugin
+];

src/provider.ts

@@ -4,8 +4,7 @@ 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 { getChatModel, getCompleter, IBaseCompleter } from './llm-models';
 import { IAIProvider } from './token';
 
 export const chatSystemPrompt = (options: AIProvider.IPromptOptions) => `
@@ -37,17 +36,9 @@ Do not include the prompt in the output, only the string that should be appended
 `;
 
 export class AIProvider implements IAIProvider {
-  constructor(options: AIProvider.IOptions) {
-    this._completionProvider = new CompletionProvider({
-      name: 'None',
-      settings: {},
-      requestCompletion: options.requestCompletion
-    });
-    options.completionProviderManager.registerInlineProvider(
-      this._completionProvider
-    );
-  }
-
+  /**
+   * Get the provider name.
+   */
   get name(): string {
     return this._name;
   }
@@ -59,7 +50,7 @@ export class AIProvider implements IAIProvider {
     if (this._name === null) {
       return null;
     }
-    return this._completionProvider.completer;
+    return this._completer;
   }
 
   /**
@@ -87,15 +78,15 @@ 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 provider (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) {
+  setProvider(name: string, settings: ReadonlyPartialJSONObject) {
     try {
-      this._completionProvider.setCompleter(name, settings);
+      this._completer = getCompleter(name, settings);
       this._completerError = '';
     } catch (e: any) {
       this._completerError = e.message;
@@ -108,17 +99,17 @@ export class AIProvider implements IAIProvider {
       this._llmChatModel = null;
     }
     this._name = name;
-    this._modelChange.emit();
+    this._providerChanged.emit();
   }
 
-  get modelChange(): ISignal<IAIProvider, void> {
-    return this._modelChange;
+  get providerChanged(): ISignal<IAIProvider, void> {
+    return this._providerChanged;
   }
 
-  private _completionProvider: CompletionProvider;
+  private _completer: IBaseCompleter | null = null;
   private _llmChatModel: BaseChatModel | null = null;
   private _name: string = 'None';
-  private _modelChange = new Signal<IAIProvider, void>(this);
+  private _providerChanged = new Signal<IAIProvider, void>(this);
   private _chatError: string = '';
   private _completerError: string = '';
 }

src/token.ts

@@ -8,7 +8,7 @@ export interface IAIProvider {
   name: string;
   completer: IBaseCompleter | null;
   chatModel: BaseChatModel | null;
-  modelChange: ISignal<IAIProvider, void>;
+  providerChanged: ISignal<IAIProvider, void>;
   chatError: string;
   completerError: string;
 }