Make instructions usable from the provider registry

Author: brichet

scripts/settings-generator.js

@@ -140,19 +140,19 @@ Object.entries(providers).forEach(([name, desc], index) => {
 });
 
 // Build the index.ts file
-const indexContent = [];
+const indexContent = ['import { IDict } from \'../../token\';', ''];
 Object.keys(providers).forEach(name => {
   indexContent.push(`import ${name} from './_generated/${name}.json';`);
 });
 
-indexContent.push('', 'const ProviderSettings: { [name: string]: any } = {');
+indexContent.push('', 'const ProviderSettings: IDict<any> = {');
 
 Object.keys(providers).forEach((name, index) => {
   indexContent.push(
     `  ${name}` + (index < Object.keys(providers).length - 1 ? ',' : '')
   );
 });
-indexContent.push('};', '', 'export default ProviderSettings;', '');
+indexContent.push('};', '', 'export { ProviderSettings };', '');
 fs.writeFile(
   path.join(schemasDir, 'index.ts'),
   indexContent.join('\n'),

src/llm-models/index.ts

@@ -8,7 +8,8 @@ import { CodestralCompleter } from './codestral-completer';
 import { ChromeCompleter } from './chrome-completer';
 import { OpenAICompleter } from './openai-completer';
 
-import ProviderSettings from '../settings/schemas';
+import { instructions } from '../settings/instructions';
+import { ProviderSettings } from '../settings/schemas';
 
 import { IAIProvider } from '../token';
 
@@ -28,12 +29,14 @@ const AIProviders: IAIProvider[] = [
     // @ts-expect-error: missing properties
     chatModel: ChromeAI,
     completer: ChromeCompleter,
+    instructions: instructions.ChromeAI,
     settings: ProviderSettings.ChromeAI
   },
   {
     name: 'MistralAI',
     chatModel: ChatMistralAI,
     completer: CodestralCompleter,
+    instructions: instructions.MistralAI,
     settings: ProviderSettings.MistralAI
   },
   {

src/provider.ts

@@ -78,13 +78,20 @@ export class AIProviderRegistry implements IAIProviderRegistry {
   }
 
   /**
-   * Get the settings schema.
+   * Get the settings schema of a given provider.
    */
-  settingsSchema(provider: string): JSONSchema7 {
+  getSettingsSchema(provider: string): JSONSchema7 {
     return (this._providers.get(provider)?.settings?.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 a provider.
    */

src/settings/instructions.ts

@@ -1,6 +1,4 @@
-export interface IDict<T = any> {
-  [key: string]: T;
-}
+import { IDict } from '../token';
 
 const chromeAiInstructions = `
 <i class="fas fa-exclamation-triangle"></i> Support for ChromeAI is still experimental and only available in Google Chrome.

src/settings/panel.tsx

@@ -8,9 +8,10 @@ import validator from '@rjsf/validator-ajv8';
 import { JSONSchema7 } from 'json-schema';
 import React from 'react';
 
-import { IDict, instructions } from './instructions';
+import { instructions } from './instructions';
 import baseSettings from './schemas/base.json';
-import ProviderSettings from './schemas';
+import { ProviderSettings } from './schemas';
+import { IDict } from '../token';
 
 const MD_MIME_TYPE = 'text/markdown';
 const STORAGE_NAME = '@jupyterlite/ai:settings';

src/token.ts

@@ -1,9 +1,14 @@
 import { BaseChatModel } from '@langchain/core/language_models/chat_models';
 import { Token } from '@lumino/coreutils';
 import { ISignal } from '@lumino/signaling';
+import { JSONSchema7 } from 'json-schema';
 
 import { IBaseCompleter } from './llm-models';
 
+export interface IDict<T = any> {
+  [key: string]: T;
+}
+
 export interface IType<T> {
   new (...args: any[]): T;
 }
@@ -24,6 +29,8 @@ export interface IAIProviderRegistry {
   name: string;
   completer: IBaseCompleter | null;
   chatModel: BaseChatModel | null;
+  getSettingsSchema(provider: string): JSONSchema7;
+  getInstructions(provider: string): string | undefined;
   formatErrorMessage(error: any): string;
   providerChanged: ISignal<IAIProviderRegistry, void>;
   chatError: string;