@jupyterlite/ai 0.2.0 → 0.4.0

package/src/slash-commands.tsx

@@ -0,0 +1,55 @@
+/**
+ * TODO: reuse from Jupyter AI instead of copying?
+ * https://github.com/jupyterlab/jupyter-ai/blob/main/packages/jupyter-ai/src/slash-autocompletion.tsx
+ */
+
+import { Box, Typography } from '@mui/material';
+import { AutocompleteCommand } from '@jupyter/chat';
+
+import HideSource from '@mui/icons-material/HideSource';
+
+import React from 'react';
+
+const DEFAULT_SLASH_COMMAND_ICONS: Record<string, JSX.Element> = {
+  clear: <HideSource />
+};
+
+type SlashCommandOption = AutocompleteCommand & {
+  id: string;
+  description: string;
+};
+
+/**
+ * Renders an option shown in the slash command autocomplete.
+ */
+export function renderSlashCommandOption(
+  optionProps: React.HTMLAttributes<HTMLLIElement>,
+  option: SlashCommandOption
+): JSX.Element {
+  const icon =
+    option.id in DEFAULT_SLASH_COMMAND_ICONS
+      ? DEFAULT_SLASH_COMMAND_ICONS[option.id]
+      : DEFAULT_SLASH_COMMAND_ICONS.unknown;
+
+  return (
+    <li {...optionProps}>
+      <Box sx={{ lineHeight: 0, marginRight: 4, opacity: 0.618 }}>{icon}</Box>
+      <Box sx={{ flexGrow: 1 }}>
+        <Typography
+          component="span"
+          sx={{
+            fontSize: 'var(--jp-ui-font-size1)'
+          }}
+        >
+          {option.label}
+        </Typography>
+        <Typography
+          component="span"
+          sx={{ opacity: 0.618, fontSize: 'var(--jp-ui-font-size0)' }}
+        >
+          {' — ' + option.description}
+        </Typography>
+      </Box>
+    </li>
+  );
+}

package/src/tokens.ts

@@ -0,0 +1,112 @@
+import { BaseChatModel } from '@langchain/core/language_models/chat_models';
+import { ReadonlyPartialJSONObject, 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;
+}
+
+/**
+ * The provider interface.
+ */
+export interface IAIProvider {
+  /**
+   * The name of the provider.
+   */
+  name: string;
+  /**
+   * The chat model class to use.
+   */
+  chatModel?: IType<BaseChatModel>;
+  /**
+   * The completer class to use.
+   */
+  completer?: IType<IBaseCompleter>;
+  /**
+   * the settings schema for the provider.
+   */
+  settingsSchema?: any;
+  /**
+   * The instructions to be displayed in the settings, as helper to use the provider.
+   * A markdown renderer is used to render the instructions.
+   */
+  instructions?: string;
+  /**
+   * A function that extract the error message from the provider API error.
+   * Default to `(error) => error.message`.
+   */
+  errorMessage?: (error: any) => string;
+}
+
+/**
+ * The provider registry interface.
+ */
+export interface IAIProviderRegistry {
+  /**
+   * Get the list of provider names.
+   */
+  readonly providers: string[];
+  /**
+   * Add a new provider.
+   */
+  add(provider: IAIProvider): void;
+  /**
+   * Get the current provider name.
+   */
+  currentName: string;
+  /**
+   * Get the current completer of the completion provider.
+   */
+  currentCompleter: IBaseCompleter | null;
+  /**
+   * Get the current llm chat model.
+   */
+  currentChatModel: BaseChatModel | null;
+  /**
+   * Get the settings schema of a given provider.
+   */
+  getSettingsSchema(provider: string): JSONSchema7;
+  /**
+   * Get the instructions of a given provider.
+   */
+  getInstructions(provider: string): string | 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.
+   *
+   * @param name - the name of the provider to use.
+   * @param settings - the settings for the models.
+   */
+  setProvider(name: string, settings: ReadonlyPartialJSONObject): void;
+  /**
+   * A signal emitting when the provider or its settings has changed.
+   */
+  readonly providerChanged: ISignal<IAIProviderRegistry, void>;
+  /**
+   * Get the current chat error;
+   */
+  readonly chatError: string;
+  /**
+   * get the current completer error.
+   */
+  readonly completerError: string;
+}
+
+/**
+ * The provider registry token.
+ */
+export const IAIProviderRegistry = new Token<IAIProviderRegistry>(
+  '@jupyterlite/ai:provider-registry',
+  'Provider for chat and completion LLM provider'
+);

package/style/base.css

@@ -5,3 +5,7 @@
 */
 
 @import url('@jupyter/chat/style/index.css');
+
+.jp-AISettingsInstructions {
+  font-size: var(--jp-content-font-size1);
+}

package/style/icons/jupyternaut-lite.svg

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg fill="none" version="1.1" viewBox="0 0 38 38" xmlns="http://www.w3.org/2000/svg">
+ <g>
+  <circle cx="19" cy="19" r="19" fill="#f7dc1e"/>
+  <path d="m19.948 6.8365c0.6344-0.21603 1.0908-0.81693 1.0908-1.5244 0-0.88916-0.7208-1.61-1.61-1.61s-1.61 0.72081-1.61 1.61c0 0.70739 0.4562 1.3082 1.0905 1.5243v1.1674h-0.5394c-6.2858 0-11.399 5.1132-11.399 11.399 0 6.2859 5.1133 11.399 11.399 11.399h1.398c6.2859 0 11.399-5.1132 11.399-11.399 0-6.2253-5.0159-11.301-11.219-11.397v-1.1687zm-1.5781 22.163h1.398c5.3669 0 9.7303-4.9787 9.7303-8.3455 0-5.3669-4.3634-9.7303-9.7303-9.7303h-1.398c-5.3668 0-9.7302 4.3634-9.7302 9.7303 0 3.3668 4.3634 8.3455 9.7302 8.3455zm14.522-5.003c0.7341 0 0.7375-0.5123 0.7422-1.2408v-1e-4c0.0012-0.1847 0.0025-0.3833 0.0158-0.591 0.0573-0.8624 0.0739-1.7008 0.0573-2.4892l-0.0033-0.119c-0.0373-1.3318-0.0436-1.5579-1.3047-1.8058l-0.1479-0.0246 0.0015 0.0495c0.0076 0.2465 0.0151 0.493 0.0151 0.739 0 1.8018-0.2712 3.5478-0.773 5.189-0.1363 0.4459 0.3433 0.8629 0.7534 0.6411l0.6436-0.3481zm-27.612 0c-0.73409 0-0.73741-0.5123-0.74215-1.2407-0.0012-0.1848-0.00249-0.3834-0.01581-0.5912-0.0573-0.8624-0.07392-1.7007-0.05731-2.4892l0.00336-0.1189c0.03721-1.3319 0.04352-1.5579 1.3047-1.8058l0.14784-0.0247-0.00151 0.0495c-0.00756 0.2465-0.01511 0.493-0.01511 0.739 0 1.8019 0.27119 3.5478 0.773 5.189 0.13634 0.4459-0.34326 0.8629-0.7534 0.6411l-0.64361-0.3481zm14.242-12.005c-4.6297 0-8.4776 2.9361-9.4584 6.7577-0.13379 0.5212 0.5513 0.6935 0.877 0.2653 1.3829-1.818 3.1418-2.153 4.7068-2.4511 2.1143-0.4027 3.8746-0.7379 3.8746-4.5719z" clip-rule="evenodd" fill="#000" fill-rule="evenodd"/>
+ </g>
+</svg>

package/lib/llm-models/utils.d.ts

@@ -1,15 +0,0 @@
-import { BaseChatModel } from '@langchain/core/language_models/chat_models';
-import { IBaseCompleter } from './base-completer';
-import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
-/**
- * Get an LLM completer from the name.
- */
-export declare function getCompleter(name: string, settings: ReadonlyPartialJSONObject): IBaseCompleter | null;
-/**
- * Get an LLM chat model from the name.
- */
-export declare function getChatModel(name: string, settings: ReadonlyPartialJSONObject): BaseChatModel | null;
-/**
- * Get the error message from provider.
- */
-export declare function getErrorMessage(name: string, error: any): string;

package/lib/llm-models/utils.js

@@ -1,29 +0,0 @@
-import { ChatMistralAI } from '@langchain/mistralai';
-import { CodestralCompleter } from './codestral-completer';
-/**
- * Get an LLM completer from the name.
- */
-export function getCompleter(name, settings) {
-    if (name === 'MistralAI') {
-        return new CodestralCompleter({ settings });
-    }
-    return null;
-}
-/**
- * Get an LLM chat model from the name.
- */
-export function getChatModel(name, settings) {
-    if (name === 'MistralAI') {
-        return new ChatMistralAI({ ...settings });
-    }
-    return null;
-}
-/**
- * Get the error message from provider.
- */
-export function getErrorMessage(name, error) {
-    if (name === 'MistralAI') {
-        return error.message;
-    }
-    return 'Unknown provider';
-}

package/lib/token.d.ts

@@ -1,13 +0,0 @@
-import { BaseChatModel } from '@langchain/core/language_models/chat_models';
-import { Token } from '@lumino/coreutils';
-import { ISignal } from '@lumino/signaling';
-import { IBaseCompleter } from './llm-models';
-export interface IAIProvider {
-    name: string;
-    completer: IBaseCompleter | null;
-    chatModel: BaseChatModel | null;
-    modelChange: ISignal<IAIProvider, void>;
-    chatError: string;
-    completerError: string;
-}
-export declare const IAIProvider: Token<IAIProvider>;

package/lib/token.js

@@ -1,2 +0,0 @@
-import { Token } from '@lumino/coreutils';
-export const IAIProvider = new Token('@jupyterlite/ai:AIProvider', 'Provider for chat and completion LLM provider');

package/schema/ai-provider.json

@@ -1,21 +0,0 @@
-{
-  "title": "AI provider",
-  "description": "Provider settings",
-  "type": "object",
-  "properties": {
-    "provider": {
-      "type": "string",
-      "title": "The AI provider",
-      "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
-}

package/src/llm-models/utils.ts

@@ -1,41 +0,0 @@
-import { BaseChatModel } from '@langchain/core/language_models/chat_models';
-import { ChatMistralAI } from '@langchain/mistralai';
-import { IBaseCompleter } from './base-completer';
-import { CodestralCompleter } from './codestral-completer';
-import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
-
-/**
- * Get an LLM completer from the name.
- */
-export function getCompleter(
-  name: string,
-  settings: ReadonlyPartialJSONObject
-): IBaseCompleter | null {
-  if (name === 'MistralAI') {
-    return new CodestralCompleter({ settings });
-  }
-  return null;
-}
-
-/**
- * Get an LLM chat model from the name.
- */
-export function getChatModel(
-  name: string,
-  settings: ReadonlyPartialJSONObject
-): BaseChatModel | null {
-  if (name === 'MistralAI') {
-    return new ChatMistralAI({ ...settings });
-  }
-  return null;
-}
-
-/**
- * Get the error message from provider.
- */
-export function getErrorMessage(name: string, error: any): string {
-  if (name === 'MistralAI') {
-    return error.message;
-  }
-  return 'Unknown provider';
-}

package/src/token.ts

@@ -1,19 +0,0 @@
-import { BaseChatModel } from '@langchain/core/language_models/chat_models';
-import { Token } from '@lumino/coreutils';
-import { ISignal } from '@lumino/signaling';
-
-import { IBaseCompleter } from './llm-models';
-
-export interface IAIProvider {
-  name: string;
-  completer: IBaseCompleter | null;
-  chatModel: BaseChatModel | null;
-  modelChange: ISignal<IAIProvider, void>;
-  chatError: string;
-  completerError: string;
-}
-
-export const IAIProvider = new Token<IAIProvider>(
-  '@jupyterlite/ai:AIProvider',
-  'Provider for chat and completion LLM provider'
-);