Do not expose providers api (#84)

* Do not explicitly expose the model in completer, it is useless

* Do not expose the models in the provider registry, only a wrapper containing required methods

* Add a flag allowing to expose the whole chat model instead of a wrapper

* Do not expose the providers list and current provider to avoid being able to modify the 'exposeChatModel' flag

* Docstring

* Update src/provider.ts

Co-authored-by: Duc Trung Le <leductrungxf@gmail.com>

---------

Co-authored-by: Duc Trung Le <leductrungxf@gmail.com>

Author: brichet

src/base-completer.ts

@@ -2,15 +2,9 @@ import {
   CompletionHandler,
   IInlineCompletionContext
 } from '@jupyterlab/completer';
-import { BaseLanguageModel } from '@langchain/core/language_models/base';
 import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
 
 export interface IBaseCompleter {
-  /**
-   * The LLM completer.
-   */
-  completer: BaseLanguageModel;
-
   /**
    * The completion prompt.
    */

src/chat-handler.ts

@@ -12,17 +12,18 @@ import {
   IInputModel,
   INewMessage
 } from '@jupyter/chat';
-import type { BaseChatModel } from '@langchain/core/language_models/chat_models';
 import {
   AIMessage,
   HumanMessage,
   mergeMessageRuns,
   SystemMessage
 } from '@langchain/core/messages';
 import { UUID } from '@lumino/coreutils';
+
+import { jupyternautLiteIcon } from './icons';
 import { chatSystemPrompt } from './provider';
+import { AIChatModel } from './types/ai-model';
 import { IAIProviderRegistry } from './tokens';
-import { jupyternautLiteIcon } from './icons';
 
 /**
  * The base64 encoded SVG string of the jupyternaut lite icon.
@@ -52,7 +53,7 @@ export class ChatHandler extends ChatModel {
     });
   }
 
-  get provider(): BaseChatModel | null {
+  get provider(): AIChatModel | null {
     return this._providerRegistry.currentChatModel;
   }
 
@@ -194,10 +195,16 @@ export class ChatHandler extends ChatModel {
 }
 
 export namespace ChatHandler {
+  /**
+   * The options used to create a chat handler.
+   */
   export interface IOptions extends ChatModel.IOptions {
     providerRegistry: IAIProviderRegistry;
   }
 
+  /**
+   * The chat command provider for the chat.
+   */
   export class ClearCommandProvider implements IChatCommandProvider {
     public id: string = '@jupyterlite/ai:clear-commands';
     private _slash_commands: ChatCommand[] = [

src/completion-provider.ts

@@ -4,8 +4,8 @@ import {
   IInlineCompletionProvider
 } from '@jupyterlab/completer';
 
-import { IBaseCompleter } from './base-completer';
 import { IAIProviderRegistry } from './tokens';
+import { AICompleter } from './types/ai-model';
 
 /**
  * The generic completion provider to register to the completion provider manager.
@@ -34,7 +34,7 @@ export class CompletionProvider implements IInlineCompletionProvider {
   /**
    * Get the current completer.
    */
-  get completer(): IBaseCompleter | null {
+  get completer(): AICompleter | null {
     return this._providerRegistry.currentCompleter;
   }
 

src/default-providers/Anthropic/completer.ts

@@ -3,7 +3,6 @@ import {
   IInlineCompletionContext
 } from '@jupyterlab/completer';
 import { ChatAnthropic } from '@langchain/anthropic';
-import { BaseChatModel } from '@langchain/core/language_models/chat_models';
 import { AIMessage, SystemMessage } from '@langchain/core/messages';
 
 import { BaseCompleter, IBaseCompleter } from '../../base-completer';
@@ -14,10 +13,6 @@ export class AnthropicCompleter implements IBaseCompleter {
     this._completer = new ChatAnthropic({ ...options.settings });
   }
 
-  get completer(): BaseChatModel {
-    return this._completer;
-  }
-
   /**
    * Getter and setter for the initial prompt.
    */

src/default-providers/ChromeAI/completer.ts

@@ -3,7 +3,6 @@ import {
   IInlineCompletionContext
 } from '@jupyterlab/completer';
 import { ChromeAI } from '@langchain/community/experimental/llms/chrome_ai';
-import { LLM } from '@langchain/core/language_models/llms';
 import { HumanMessage, SystemMessage } from '@langchain/core/messages';
 
 import { BaseCompleter, IBaseCompleter } from '../../base-completer';
@@ -45,10 +44,6 @@ export class ChromeCompleter implements IBaseCompleter {
     this._prompt = value;
   }
 
-  get completer(): LLM {
-    return this._completer;
-  }
-
   async fetch(
     request: CompletionHandler.IRequest,
     context: IInlineCompletionContext

src/default-providers/MistralAI/completer.ts

@@ -2,7 +2,6 @@ import {
   CompletionHandler,
   IInlineCompletionContext
 } from '@jupyterlab/completer';
-import { BaseChatModel } from '@langchain/core/language_models/chat_models';
 import {
   BaseMessage,
   HumanMessage,
@@ -47,10 +46,6 @@ export class CodestralCompleter implements IBaseCompleter {
     );
   }
 
-  get completer(): BaseChatModel {
-    return this._completer;
-  }
-
   /**
    * Getter and setter for the initial prompt.
    */

src/default-providers/Ollama/completer.ts

@@ -2,7 +2,6 @@ import {
   CompletionHandler,
   IInlineCompletionContext
 } from '@jupyterlab/completer';
-import { BaseChatModel } from '@langchain/core/language_models/chat_models';
 import { AIMessage, SystemMessage } from '@langchain/core/messages';
 import { ChatOllama } from '@langchain/ollama';
 
@@ -12,11 +11,6 @@ import { COMPLETION_SYSTEM_PROMPT } from '../../provider';
 export class OllamaCompleter implements IBaseCompleter {
   constructor(options: BaseCompleter.IOptions) {
     this._completer = new ChatOllama({ ...options.settings });
-    console.log('Settings', options.settings);
-  }
-
-  get completer(): BaseChatModel {
-    return this._completer;
   }
 
   /**

src/default-providers/OpenAI/completer.ts

@@ -2,7 +2,6 @@ import {
   CompletionHandler,
   IInlineCompletionContext
 } from '@jupyterlab/completer';
-import { BaseChatModel } from '@langchain/core/language_models/chat_models';
 import { AIMessage, SystemMessage } from '@langchain/core/messages';
 import { ChatOpenAI } from '@langchain/openai';
 
@@ -14,10 +13,6 @@ export class OpenAICompleter implements IBaseCompleter {
     this._completer = new ChatOpenAI({ ...options.settings });
   }
 
-  get completer(): BaseChatModel {
-    return this._completer;
-  }
-
   /**
    * Getter and setter for the initial prompt.
    */

src/default-providers/WebLLM/completer.ts

@@ -4,9 +4,9 @@ import {
 } from '@jupyterlab/completer';
 import { HumanMessage, SystemMessage } from '@langchain/core/messages';
 import { ChatWebLLM } from '@langchain/community/chat_models/webllm';
+
 import { BaseCompleter, IBaseCompleter } from '../../base-completer';
 import { COMPLETION_SYSTEM_PROMPT } from '../../provider';
-import { BaseChatModel } from '@langchain/core/language_models/chat_models';
 
 /**
  * Regular expression to match the '```' string at the start of a string.
@@ -69,10 +69,6 @@ export class WebLLMCompleter implements IBaseCompleter {
     }
   }
 
-  get completer(): BaseChatModel {
-    return this._completer;
-  }
-
   /**
    * Getter and setter for the initial prompt.
    */

src/default-providers/index.ts

@@ -98,7 +98,8 @@ const webLLMProviderPlugin: JupyterFrontEndPlugin<void> = {
       completer: WebLLMCompleter,
       settingsSchema: WebLLMSettings,
       instructions: WebLLMInstructions,
-      compatibilityCheck: webLLMCompatibilityCheck
+      compatibilityCheck: webLLMCompatibilityCheck,
+      exposeChatModel: true
     });
 
     registry.providerChanged.connect(async (sender, args) => {