@jupyterlite/ai 0.6.2 → 0.8.0

package/src/settings/textarea.tsx

@@ -0,0 +1,33 @@
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import { IFormRenderer } from '@jupyterlab/ui-components';
+import { FieldProps } from '@rjsf/utils';
+import React, { useState } from 'react';
+
+const TEXTAREA_CLASS = 'jp-AISettingsTextArea';
+
+export const textArea: IFormRenderer = {
+  fieldRenderer: (props: FieldProps) => {
+    const settings: ISettingRegistry.ISettings = props.formContext.settings;
+    const schema = settings.schema.properties?.[props.name];
+    const [formData, setFormData] = useState<string>(props.formData);
+    settings.changed.connect(() => {
+      setFormData(settings.get(props.name).composite as string);
+    });
+    const onChange = (event: React.ChangeEvent<HTMLTextAreaElement>) => {
+      settings.set(props.name, event.target.value);
+    };
+
+    return (
+      <>
+        {schema?.title && (
+          <h3 className="jp-FormGroup-fieldLabel jp-FormGroup-contentItem">
+            {schema.title}
+          </h3>
+        )}
+        <textarea className={TEXTAREA_CLASS} onChange={onChange}>
+          {formData}
+        </textarea>
+      </>
+    );
+  }
+};

package/src/tokens.ts

@@ -4,15 +4,19 @@ import { ISignal } from '@lumino/signaling';
 import { JSONSchema7 } from 'json-schema';
 
 import { IBaseCompleter } from './base-completer';
+import { AIChatModel, AICompleter } from './types/ai-model';
 
 export const PLUGIN_IDS = {
   chat: '@jupyterlite/ai:chat',
   chatCommandRegistry: '@jupyterlite/ai:autocompletion-registry',
   completer: '@jupyterlite/ai:completer',
   providerRegistry: '@jupyterlite/ai:provider-registry',
-  settingsConnector: '@jupyterlite/ai:settings-connector'
+  settingsConnector: '@jupyterlite/ai:settings-connector',
+  systemPrompts: '@jupyterlite/ai:system-prompts'
 };
 
+export type ModelRole = 'chat' | 'completer';
+
 export interface IDict<T = any> {
   [key: string]: T;
 }
@@ -32,7 +36,7 @@ export interface IAIProvider {
   /**
    * The chat model class to use.
    */
-  chatModel?: IType<BaseChatModel>;
+  chat?: IType<BaseChatModel>;
   /**
    * The completer class to use.
    */
@@ -51,6 +55,20 @@ export interface IAIProvider {
    * Default to `(error) => error.message`.
    */
   errorMessage?: (error: any) => string;
+  /**
+   * Compatibility check function, to determine if the provider is compatible with the
+   * current environment.
+   */
+  compatibilityCheck?: () => Promise<string | null>;
+  /**
+   * Whether to expose or not the chat model.
+   *
+   * ### CAUTION
+   * This flag will expose the whole chat model API, which may contain private keys.
+   * Be sure to use it with a model that does not expose sensitive information in the
+   * API.
+   */
+  exposeChatModel?: boolean;
 }
 
 /**
@@ -68,15 +86,23 @@ export interface IAIProviderRegistry {
   /**
    * Get the current provider name.
    */
-  currentName: string;
+  currentName(role: ModelRole): string;
   /**
    * Get the current completer of the completion provider.
    */
-  currentCompleter: IBaseCompleter | null;
+  currentCompleter: AICompleter | null;
+  /**
+   * Getter/setter for the completer system prompt.
+   */
+  completerSystemPrompt: string;
   /**
    * Get the current llm chat model.
    */
-  currentChatModel: BaseChatModel | null;
+  currentChatModel: AIChatModel | null;
+  /**
+   * Getter/setter for the chat system prompt.
+   */
+  chatSystemPrompt: string;
   /**
    * Get the settings schema of a given provider.
    */
@@ -85,21 +111,34 @@ export interface IAIProviderRegistry {
    * Get the instructions of a given provider.
    */
   getInstructions(provider: string): string | undefined;
+  /**
+   * Get the compatibility check function of a given provider.
+   */
+  getCompatibilityCheck(
+    provider: string
+  ): (() => Promise<string | null>) | undefined;
   /**
    * Format an error message from the current provider.
    */
   formatErrorMessage(error: any): string;
   /**
-   * Set the providers (chat model and completer).
-   * Creates the providers if the name has changed, otherwise only updates their config.
+   * Set the completer provider.
+   * Creates the provider if the name has changed, otherwise only updates its config.
    *
-   * @param options - an object with the name and the settings of the provider to use.
+   * @param options - An object with the name and the settings of the provider to use.
    */
-  setProvider(options: ISetProviderOptions): void;
+  setCompleterProvider(settings: ReadonlyPartialJSONObject): void;
+  /**
+   * Set the chat provider.
+   * Creates the provider if the name has changed, otherwise only updates its config.
+   *
+   * @param options - An object with the name and the settings of the provider to use.
+   */
+  setChatProvider(settings: ReadonlyPartialJSONObject): void;
   /**
    * A signal emitting when the provider or its settings has changed.
    */
-  readonly providerChanged: ISignal<IAIProviderRegistry, void>;
+  readonly providerChanged: ISignal<IAIProviderRegistry, ModelRole>;
   /**
    * Get the current chat error;
    */
@@ -110,20 +149,6 @@ export interface IAIProviderRegistry {
   readonly completerError: string;
 }
 
-/**
- * The set provider options.
- */
-export interface ISetProviderOptions {
-  /**
-   * The name of the provider.
-   */
-  name: string;
-  /**
-   * The settings of the provider.
-   */
-  settings: ReadonlyPartialJSONObject;
-}
-
 /**
  * The provider registry token.
  */

package/src/types/ai-model.ts

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+import {
+  CompletionHandler,
+  IInlineCompletionContext
+} from '@jupyterlab/completer';
+import { IterableReadableStream } from '@langchain/core/utils/stream';
+
+/**
+ * The reduced AI chat model interface.
+ */
+export type AIChatModel = {
+  /**
+   * The stream function of the chat model.
+   */
+  stream: (input: any, options?: any) => Promise<IterableReadableStream<any>>;
+};
+
+/**
+ * The reduced AI completer interface.
+ */
+export type AICompleter = {
+  /**
+   * The fetch function of the completer.
+   */
+  fetch: (
+    request: CompletionHandler.IRequest,
+    context: IInlineCompletionContext
+  ) => Promise<any>;
+  /**
+   * The optional request completion function of the completer.
+   */
+  requestCompletion?: () => void;
+};

package/src/types/service-worker.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Type declarations for Service Worker APIs not included in standard TypeScript libs
+ */
+interface ExtendableMessageEvent extends MessageEvent {
+  waitUntil(f: Promise<any>): void;
+}

package/style/base.css

@@ -9,3 +9,37 @@
 .jp-AISettingsInstructions {
   font-size: var(--jp-content-font-size1);
 }
+
+.jp-AISettingsError {
+  color: var(--jp-error-color1);
+  font-size: var(--jp-content-font-size1);
+}
+
+.jp-AISettingsTextArea {
+  min-width: 400px;
+  min-height: 300px;
+}
+
+.jp-chat-welcome-message {
+  text-align: center;
+  max-width: 350px;
+  margin: 0 auto;
+}
+
+.jp-chat-welcome-message button[data-commandLinker-command] {
+  background: var(--jp-layout-color2);
+  border: 1px solid var(--jp-border-color1);
+  color: var(--jp-ui-font-color1);
+  border-radius: var(--jp-border-radius);
+  cursor: pointer;
+  font-size: inherit;
+  font-family: inherit;
+  padding: 2px 6px;
+  transition: all 0.2s ease;
+}
+
+.jp-chat-welcome-message button[data-commandLinker-command]:hover {
+  background: var(--jp-layout-color3);
+  border-color: var(--jp-brand-color1);
+  color: var(--jp-brand-color1);
+}

package/lib/settings/settings-connector.d.ts

@@ -1,31 +0,0 @@
-import { ISettingConnector, ISettingRegistry } from '@jupyterlab/settingregistry';
-import { DataConnector, IDataConnector } from '@jupyterlab/statedb';
-/**
- * A data connector for fetching settings.
- *
- * #### Notes
- * This connector adds a query parameter to the base services setting manager.
- */
-export declare class SettingConnector extends DataConnector<ISettingRegistry.IPlugin, string> implements ISettingConnector {
-    constructor(connector: IDataConnector<ISettingRegistry.IPlugin, string>);
-    set doNotSave(fields: string[]);
-    /**
-     * Fetch settings for a plugin.
-     * @param id - The plugin ID
-     *
-     * #### Notes
-     * The REST API requests are throttled at one request per plugin per 100ms.
-     */
-    fetch(id: string): Promise<ISettingRegistry.IPlugin | undefined>;
-    list(query: 'ids'): Promise<{
-        ids: string[];
-    }>;
-    list(query: 'active' | 'all'): Promise<{
-        ids: string[];
-        values: ISettingRegistry.IPlugin[];
-    }>;
-    save(id: string, raw: string): Promise<void>;
-    private _connector;
-    private _doNotSave;
-    private _throttlers;
-}

package/lib/settings/settings-connector.js

@@ -1,61 +0,0 @@
-import { PageConfig } from '@jupyterlab/coreutils';
-import { DataConnector } from '@jupyterlab/statedb';
-import { Throttler } from '@lumino/polling';
-import * as json5 from 'json5';
-import { SECRETS_REPLACEMENT } from '.';
-/**
- * A data connector for fetching settings.
- *
- * #### Notes
- * This connector adds a query parameter to the base services setting manager.
- */
-export class SettingConnector extends DataConnector {
-    constructor(connector) {
-        super();
-        this._doNotSave = [];
-        this._throttlers = Object.create(null);
-        this._connector = connector;
-    }
-    set doNotSave(fields) {
-        this._doNotSave = [...fields];
-    }
-    /**
-     * Fetch settings for a plugin.
-     * @param id - The plugin ID
-     *
-     * #### Notes
-     * The REST API requests are throttled at one request per plugin per 100ms.
-     */
-    fetch(id) {
-        const throttlers = this._throttlers;
-        if (!(id in throttlers)) {
-            throttlers[id] = new Throttler(() => this._connector.fetch(id), 100);
-        }
-        return throttlers[id].invoke();
-    }
-    async list(query = 'all') {
-        const { isDisabled } = PageConfig.Extension;
-        const { ids, values } = await this._connector.list(query === 'ids' ? 'ids' : undefined);
-        if (query === 'all') {
-            return { ids, values };
-        }
-        if (query === 'ids') {
-            return { ids };
-        }
-        return {
-            ids: ids.filter(id => !isDisabled(id)),
-            values: values.filter(({ id }) => !isDisabled(id))
-        };
-    }
-    async save(id, raw) {
-        const settings = json5.parse(raw);
-        // Replace secrets fields with the replacement string.
-        // Create the field if it does not exist in settings.
-        this._doNotSave.forEach(field => {
-            if (settings['AIprovider'] !== undefined) {
-                settings['AIprovider'][field] = SECRETS_REPLACEMENT;
-            }
-        });
-        await this._connector.save(id, json5.stringify(settings, null, 2));
-    }
-}

package/src/settings/settings-connector.ts

@@ -1,88 +0,0 @@
-import { PageConfig } from '@jupyterlab/coreutils';
-import {
-  ISettingConnector,
-  ISettingRegistry
-} from '@jupyterlab/settingregistry';
-import { DataConnector, IDataConnector } from '@jupyterlab/statedb';
-import { Throttler } from '@lumino/polling';
-import * as json5 from 'json5';
-
-import { SECRETS_REPLACEMENT } from '.';
-
-/**
- * A data connector for fetching settings.
- *
- * #### Notes
- * This connector adds a query parameter to the base services setting manager.
- */
-export class SettingConnector
-  extends DataConnector<ISettingRegistry.IPlugin, string>
-  implements ISettingConnector
-{
-  constructor(connector: IDataConnector<ISettingRegistry.IPlugin, string>) {
-    super();
-    this._connector = connector;
-  }
-
-  set doNotSave(fields: string[]) {
-    this._doNotSave = [...fields];
-  }
-
-  /**
-   * Fetch settings for a plugin.
-   * @param id - The plugin ID
-   *
-   * #### Notes
-   * The REST API requests are throttled at one request per plugin per 100ms.
-   */
-  fetch(id: string): Promise<ISettingRegistry.IPlugin | undefined> {
-    const throttlers = this._throttlers;
-    if (!(id in throttlers)) {
-      throttlers[id] = new Throttler(() => this._connector.fetch(id), 100);
-    }
-    return throttlers[id].invoke();
-  }
-
-  async list(query: 'ids'): Promise<{ ids: string[] }>;
-  async list(
-    query: 'active' | 'all'
-  ): Promise<{ ids: string[]; values: ISettingRegistry.IPlugin[] }>;
-  async list(
-    query: 'active' | 'all' | 'ids' = 'all'
-  ): Promise<{ ids: string[]; values?: ISettingRegistry.IPlugin[] }> {
-    const { isDisabled } = PageConfig.Extension;
-    const { ids, values } = await this._connector.list(
-      query === 'ids' ? 'ids' : undefined
-    );
-
-    if (query === 'all') {
-      return { ids, values };
-    }
-
-    if (query === 'ids') {
-      return { ids };
-    }
-
-    return {
-      ids: ids.filter(id => !isDisabled(id)),
-      values: values.filter(({ id }) => !isDisabled(id))
-    };
-  }
-
-  async save(id: string, raw: string): Promise<void> {
-    const settings = json5.parse(raw);
-
-    // Replace secrets fields with the replacement string.
-    // Create the field if it does not exist in settings.
-    this._doNotSave.forEach(field => {
-      if (settings['AIprovider'] !== undefined) {
-        settings['AIprovider'][field] = SECRETS_REPLACEMENT;
-      }
-    });
-    await this._connector.save(id, json5.stringify(settings, null, 2));
-  }
-
-  private _connector: IDataConnector<ISettingRegistry.IPlugin, string>;
-  private _doNotSave: string[] = [];
-  private _throttlers: { [key: string]: Throttler } = Object.create(null);
-}