Dynamic settings for providers (#14)

* Create provider settings at build time and update the settings list dynamically

* lint

* Bump jupyterlab dependency to 4.4.0-alpha.0

* update requirements in README and add optional dependencies to Jupyter front end applications

* lint

Author: brichet

.gitignore

@@ -11,6 +11,9 @@ jupyterlite_ai/labextension
 # Version file is handled by hatchling
 jupyterlite_ai/_version.py
 
+# Settings schema are built
+src/_provider-settings
+
 # Created by https://www.gitignore.io/api/python
 # Edit at https://www.gitignore.io/?templates=python
 

README.md

@@ -5,7 +5,7 @@
 
 AI code completions and chat for JupyterLab, Notebook 7 and JupyterLite, powered by MistralAI ✨
 
-[a screencast showing the Codestral extension in JupyterLite](https://github.com/jupyterlite/ai/assets/591645/855c4e3e-3a63-4868-8052-5c9909922c21)
+[a screencast showing the Jupyterlite AI extension in JupyterLite](https://github.com/jupyterlite/ai/assets/591645/855c4e3e-3a63-4868-8052-5c9909922c21)
 
 ## Requirements
 
@@ -14,7 +14,7 @@ AI code completions and chat for JupyterLab, Notebook 7 and JupyterLite, powered
 > To enable more AI providers in JupyterLab and Jupyter Notebook, we recommend using the [Jupyter AI](https://github.com/jupyterlab/jupyter-ai) extension directly.
 > At the moment Jupyter AI is not compatible with JupyterLite, but might be to some extent in the future.
 
-- JupyterLab >= 4.1.0 or Notebook >= 7.1.0
+- JupyterLab >= 4.4.0a0 or Notebook >= 7.4.0a0
 
 > [!WARNING]
 > This extension is still very much experimental. It is not an official MistralAI extension.
@@ -37,13 +37,20 @@ To install the extension, execute:
 pip install jupyterlite-ai
 ```
 
+To install requirements (jupyterlab, jupyterlite and notebook), there is an optional dependencies argument:
+
+```bash
+pip install jupyterlite-ai[jupyter]
+```
+
 # Usage
 
 1. Go to https://console.mistral.ai/api-keys/ and create an API key.
 
 ![Screenshot showing how to create an API key](./img/1-api-key.png)
 
-2. Open the JupyterLab settings and go to the Codestral section to enter the API key
+2. Open the JupyterLab settings and go to the **Ai providers** section to select the provider
+   (`mistral` is only supported one currently) and the API key (required).
 
 ![Screenshot showing how to add the API key to the settings](./img/2-jupyterlab-settings.png)
 

package.json

@@ -27,8 +27,9 @@
         "url": "https://github.com/jupyterlite/ai.git"
     },
     "scripts": {
-        "build": "jlpm build:lib && jlpm build:labextension:dev",
-        "build:prod": "jlpm clean && jlpm build:lib:prod && jlpm build:labextension",
+        "build": "node ./scripts/settings-generator.js && jlpm build:lib && jlpm build:labextension:dev",
+        "build:dev": "jlpm build:lib && jlpm build:labextension:dev",
+        "build:prod": "node ./scripts/settings-generator.js && jlpm clean && jlpm build:lib:prod && jlpm build:labextension",
         "build:labextension": "jupyter labextension build .",
         "build:labextension:dev": "jupyter labextension build --development True .",
         "build:lib": "tsc --sourceMap",
@@ -53,13 +54,13 @@
         "watch:labextension": "jupyter labextension watch ."
     },
     "dependencies": {
-        "@jupyter/chat": "^0.5.0",
-        "@jupyterlab/application": "^4.2.0",
-        "@jupyterlab/apputils": "^4.3.0",
-        "@jupyterlab/completer": "^4.2.0",
-        "@jupyterlab/notebook": "^4.2.0",
-        "@jupyterlab/rendermime": "^4.2.0",
-        "@jupyterlab/settingregistry": "^4.2.0",
+        "@jupyter/chat": "^0.7.1",
+        "@jupyterlab/application": "^4.4.0-alpha.0",
+        "@jupyterlab/apputils": "^4.5.0-alpha.0",
+        "@jupyterlab/completer": "^4.4.0-alpha.0",
+        "@jupyterlab/notebook": "^4.4.0-alpha.0",
+        "@jupyterlab/rendermime": "^4.4.0-alpha.0",
+        "@jupyterlab/settingregistry": "^4.4.0-alpha.0",
         "@langchain/core": "^0.3.13",
         "@langchain/mistralai": "^0.1.1",
         "@lumino/coreutils": "^2.1.2",
@@ -87,7 +88,8 @@
         "stylelint-config-standard": "^34.0.0",
         "stylelint-csstree-validator": "^3.0.0",
         "stylelint-prettier": "^4.0.0",
-        "typescript": "~5.0.2",
+        "ts-json-schema-generator": "^2.3.0",
+        "typescript": "~5.1.6",
         "yjs": "^13.5.0"
     },
     "sideEffects": [

pyproject.toml

@@ -26,6 +26,13 @@ dependencies = [
 ]
 dynamic = ["version", "description", "authors", "urls", "keywords"]
 
+[project.optional-dependencies]
+jupyter = [
+    "jupyterlab>=4.4.0a0",
+    "jupyterlite>=0.6.0a0",
+    "notebook>=7.4.0a0"
+]
+
 [tool.hatch.version]
 source = "nodejs"
 

schema/ai-provider.json

@@ -9,13 +9,7 @@
       "description": "The AI provider to use for chat and completion",
       "default": "None",
       "enum": ["None", "MistralAI"]
-    },
-    "apiKey": {
-      "type": "string",
-      "title": "The Codestral API key",
-      "description": "The API key to use for Codestral",
-      "default": ""
     }
   },
-  "additionalProperties": false
+  "additionalProperties": true
 }

scripts/settings-generator.js

@@ -0,0 +1,95 @@
+const fs = require('fs');
+const tsj = require('ts-json-schema-generator');
+const path = require('path');
+
+console.log('Building settings schema\n');
+
+const outputDir = 'src/_provider-settings';
+if (!fs.existsSync(outputDir)) {
+  fs.mkdirSync(outputDir);
+}
+
+// Build the langchain BaseLanguageModelParams object
+const configBase = {
+  path: 'node_modules/@langchain/core/dist/language_models/base.d.ts',
+  tsconfig: './tsconfig.json',
+  type: 'BaseLanguageModelParams'
+};
+
+const schemaBase = tsj
+  .createGenerator(configBase)
+  .createSchema(configBase.type);
+
+const providers = {
+  mistralAI: {
+    path: 'node_modules/@langchain/mistralai/dist/chat_models.d.ts',
+    type: 'ChatMistralAIInput'
+  }
+};
+
+Object.entries(providers).forEach(([name, desc], index) => {
+  const config = {
+    path: desc.path,
+    tsconfig: './tsconfig.json',
+    type: desc.type
+  };
+
+  const outputPath = path.join(outputDir, `${name}.json`);
+
+  const schema = tsj.createGenerator(config).createSchema(config.type);
+
+  if (!schema.definitions) {
+    return;
+  }
+
+  // Remove the properties from extended class.
+  const providerKeys = Object.keys(schema.definitions[desc.type]['properties']);
+  Object.keys(
+    schemaBase.definitions?.['BaseLanguageModelParams']['properties']
+  ).forEach(key => {
+    if (providerKeys.includes(key)) {
+      delete schema.definitions?.[desc.type]['properties'][key];
+    }
+  });
+
+  // Remove the useless definitions.
+  let change = true;
+  while (change) {
+    change = false;
+    const temporarySchemaString = JSON.stringify(schema);
+
+    Object.keys(schema.definitions).forEach(key => {
+      const index = temporarySchemaString.indexOf(`#/definitions/${key}`);
+      if (index === -1) {
+        delete schema.definitions?.[key];
+        change = true;
+      }
+    });
+  }
+
+  // Transform the default values.
+  Object.values(schema.definitions[desc.type]['properties']).forEach(value => {
+    const defaultValue = value.default;
+    if (!defaultValue) {
+      return;
+    }
+    if (value.type === 'number') {
+      value.default = Number(/{(.*)}/.exec(value.default)?.[1] ?? 0);
+    } else if (value.type === 'boolean') {
+      value.default = /{(.*)}/.exec(value.default)?.[1] === 'true';
+    } else if (value.type === 'string') {
+      value.default = /{\"(.*)\"}/.exec(value.default)?.[1] ?? '';
+    }
+  });
+
+  // Write JSON file.
+  const schemaString = JSON.stringify(schema, null, 2);
+  fs.writeFile(outputPath, schemaString, err => {
+    if (err) {
+      throw err;
+    }
+  });
+});
+
+console.log('Settings schema built\n');
+console.log('=====================\n');

src/index.ts

@@ -15,6 +15,7 @@ import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 
 import { ChatHandler } from './chat-handler';
+import { getSettings } from './llm-models';
 import { AIProvider } from './provider';
 import { IAIProvider } from './token';
 
@@ -79,7 +80,7 @@ const chatPlugin: JupyterFrontEndPlugin<void> = {
         themeManager,
         rmRegistry
       });
-      chatWidget.title.caption = 'Codestral Chat';
+      chatWidget.title.caption = 'Jupyterlite AI Chat';
     } catch (e) {
       chatWidget = buildErrorWidget(themeManager);
     }
@@ -105,11 +106,34 @@ const aiProviderPlugin: JupyterFrontEndPlugin<IAIProvider> = {
       requestCompletion: () => app.commands.execute('inline-completer:invoke')
     });
 
+    let currentProvider = 'None';
     settingRegistry
       .load(aiProviderPlugin.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);
         };
 

src/llm-models/utils.ts

@@ -1,9 +1,13 @@
 import { BaseChatModel } from '@langchain/core/language_models/chat_models';
 import { ChatMistralAI } from '@langchain/mistralai';
+import { JSONObject } from '@lumino/coreutils';
+
 import { IBaseCompleter } from './base-completer';
 import { CodestralCompleter } from './codestral-completer';
 import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
 
+import mistralAI from '../_provider-settings/mistralAI.json';
+
 /**
  * Get an LLM completer from the name.
  */
@@ -39,3 +43,13 @@ export function getErrorMessage(name: string, error: any): string {
   }
   return 'Unknown provider';
 }
+
+/*
+ * Get an LLM completer from the name.
+ */
+export function getSettings(name: string): JSONObject | null {
+  if (name === 'MistralAI') {
+    return mistralAI.definitions.ChatMistralAIInput.properties;
+  }
+  return null;
+}

tsconfig.json

@@ -19,5 +19,5 @@
     "strictNullChecks": true,
     "target": "ES2018"
   },
-  "include": ["src/*", "src/**/*"]
+  "include": ["src/*", "src/**/*", "src/_provider-settings/*.json"]
 }