@jupyterlite/ai 0.8.0 → 0.9.0-a0

package/src/base-completer.ts

@@ -1,75 +0,0 @@
-import {
-  CompletionHandler,
-  IInlineCompletionContext
-} from '@jupyterlab/completer';
-import { BaseLanguageModel } from '@langchain/core/language_models/base';
-import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
-
-import { DEFAULT_COMPLETION_SYSTEM_PROMPT } from './default-prompts';
-import { IAIProviderRegistry } from './tokens';
-
-export interface IBaseCompleter {
-  /**
-   * The completion prompt.
-   */
-  readonly systemPrompt: string;
-
-  /**
-   * The function to fetch a new completion.
-   */
-  requestCompletion?: () => void;
-
-  /**
-   * The fetch request for the LLM completer.
-   */
-  fetch(
-    request: CompletionHandler.IRequest,
-    context: IInlineCompletionContext
-  ): Promise<any>;
-}
-
-export abstract class BaseCompleter implements IBaseCompleter {
-  constructor(options: BaseCompleter.IOptions) {
-    this._providerRegistry = options.providerRegistry;
-  }
-
-  /**
-   * Get the system prompt for the completion.
-   */
-  get systemPrompt(): string {
-    return (
-      this._providerRegistry.completerSystemPrompt ??
-      DEFAULT_COMPLETION_SYSTEM_PROMPT
-    );
-  }
-
-  /**
-   * The fetch request for the LLM completer.
-   */
-  abstract fetch(
-    request: CompletionHandler.IRequest,
-    context: IInlineCompletionContext
-  ): Promise<any>;
-
-  protected _providerRegistry: IAIProviderRegistry;
-  protected abstract _completer: BaseLanguageModel<any, any>;
-}
-
-/**
- * The namespace for the base completer.
- */
-export namespace BaseCompleter {
-  /**
-   * The options for the constructor of a completer.
-   */
-  export interface IOptions {
-    /**
-     * The provider registry.
-     */
-    providerRegistry: IAIProviderRegistry;
-    /**
-     * The settings of the provider.
-     */
-    settings: ReadonlyPartialJSONObject;
-  }
-}

package/src/chat-handler.ts

@@ -1,262 +0,0 @@
-/*
- * Copyright (c) Jupyter Development Team.
- * Distributed under the terms of the Modified BSD License.
- */
-
-import {
-  ChatCommand,
-  AbstractChatContext,
-  AbstractChatModel,
-  IChatCommandProvider,
-  IChatContext,
-  IChatHistory,
-  IChatMessage,
-  IChatModel,
-  IInputModel,
-  INewMessage
-} from '@jupyter/chat';
-import {
-  AIMessage,
-  HumanMessage,
-  mergeMessageRuns,
-  SystemMessage
-} from '@langchain/core/messages';
-import { UUID } from '@lumino/coreutils';
-
-import { DEFAULT_CHAT_SYSTEM_PROMPT } from './default-prompts';
-import { jupyternautLiteIcon } from './icons';
-import { IAIProviderRegistry } from './tokens';
-import { AIChatModel } from './types/ai-model';
-
-/**
- * The base64 encoded SVG string of the jupyternaut lite icon.
- * Encode so it can be passed as avatar_url to jupyter-chat.
- */
-const AI_AVATAR_BASE64 = btoa(jupyternautLiteIcon.svgstr);
-const AI_AVATAR = `data:image/svg+xml;base64,${AI_AVATAR_BASE64}`;
-
-export const welcomeMessage = (providers: string[]) => `
-#### Ask JupyterLite AI
-
-
-The provider to use can be set in the <button data-commandLinker-command="settingeditor:open" data-commandLinker-args='{"query": "AI provider"}' href="#">settings editor</button>, by selecting it from
-the <img src="${AI_AVATAR}" width="16" height="16"> _AI provider_ settings.
-
-The current providers that are available are _${providers.sort().join('_, _')}_.
-
-To clear the chat, you can use the \`/clear\` command from the chat input.
-`;
-
-export type ConnectionMessage = {
-  type: 'connection';
-  client_id: string;
-};
-
-export class ChatHandler extends AbstractChatModel {
-  constructor(options: ChatHandler.IOptions) {
-    super(options);
-    this._providerRegistry = options.providerRegistry;
-
-    this._providerRegistry.providerChanged.connect(() => {
-      this._errorMessage = this._providerRegistry.chatError;
-    });
-  }
-
-  get provider(): AIChatModel | null {
-    return this._providerRegistry.currentChatModel;
-  }
-
-  /**
-   * Getter and setter for the persona name.
-   */
-  get personaName(): string {
-    return this._personaName;
-  }
-  set personaName(value: string) {
-    this.messages.forEach(message => {
-      if (message.sender.username === this._personaName) {
-        const updated: IChatMessage = { ...message };
-        updated.sender.username = value;
-        this.messageAdded(updated);
-      }
-    });
-    this._personaName = value;
-  }
-
-  /**
-   * Get/set the system prompt for the chat.
-   */
-  get systemPrompt(): string {
-    return (
-      this._providerRegistry.chatSystemPrompt ?? DEFAULT_CHAT_SYSTEM_PROMPT
-    );
-  }
-
-  async sendMessage(message: INewMessage): Promise<boolean> {
-    const body = message.body;
-    if (body.startsWith('/clear')) {
-      // TODO: do we need a clear method?
-      this.messagesDeleted(0, this.messages.length);
-      this._history.messages = [];
-      return false;
-    }
-    message.id = UUID.uuid4();
-    const msg: IChatMessage = {
-      id: message.id,
-      body,
-      sender: { username: 'User' },
-      time: Private.getTimestampMs(),
-      type: 'msg'
-    };
-    this.messageAdded(msg);
-
-    if (this._providerRegistry.currentChatModel === null) {
-      const errorMsg: IChatMessage = {
-        id: UUID.uuid4(),
-        body: `**${this._errorMessage ? this._errorMessage : this._defaultErrorMessage}**`,
-        sender: { username: 'ERROR' },
-        time: Private.getTimestampMs(),
-        type: 'msg'
-      };
-      this.messageAdded(errorMsg);
-      return false;
-    }
-
-    this._history.messages.push(msg);
-
-    const messages = mergeMessageRuns([new SystemMessage(this.systemPrompt)]);
-    messages.push(
-      ...this._history.messages.map(msg => {
-        if (msg.sender.username === 'User') {
-          return new HumanMessage(msg.body);
-        }
-        return new AIMessage(msg.body);
-      })
-    );
-
-    const sender = { username: this._personaName, avatar_url: AI_AVATAR };
-    this.updateWriters([{ user: sender }]);
-
-    // create an empty message to be filled by the AI provider
-    const botMsg: IChatMessage = {
-      id: UUID.uuid4(),
-      body: '',
-      sender,
-      time: Private.getTimestampMs(),
-      type: 'msg'
-    };
-
-    let content = '';
-
-    this._controller = new AbortController();
-    try {
-      for await (const chunk of await this._providerRegistry.currentChatModel.stream(
-        messages,
-        { signal: this._controller.signal }
-      )) {
-        content += chunk.content ?? chunk;
-        botMsg.body = content;
-        this.messageAdded(botMsg);
-      }
-      this._history.messages.push(botMsg);
-      return true;
-    } catch (reason) {
-      const error = this._providerRegistry.formatErrorMessage(reason);
-      const errorMsg: IChatMessage = {
-        id: UUID.uuid4(),
-        body: `**${error}**`,
-        sender: { username: 'ERROR' },
-        time: Private.getTimestampMs(),
-        type: 'msg'
-      };
-      this.messageAdded(errorMsg);
-      return false;
-    } finally {
-      this.updateWriters([]);
-      this._controller = null;
-    }
-  }
-
-  async getHistory(): Promise<IChatHistory> {
-    return this._history;
-  }
-
-  dispose(): void {
-    super.dispose();
-  }
-
-  messageAdded(message: IChatMessage): void {
-    super.messageAdded(message);
-  }
-
-  stopStreaming(): void {
-    this._controller?.abort();
-  }
-
-  createChatContext(): IChatContext {
-    return new ChatHandler.ChatContext({ model: this });
-  }
-
-  private _providerRegistry: IAIProviderRegistry;
-  private _personaName = 'AI';
-  private _errorMessage: string = '';
-  private _history: IChatHistory = { messages: [] };
-  private _defaultErrorMessage = 'AI provider not configured';
-  private _controller: AbortController | null = null;
-}
-
-export namespace ChatHandler {
-  /**
-   * The options used to create a chat handler.
-   */
-  export interface IOptions extends IChatModel.IOptions {
-    providerRegistry: IAIProviderRegistry;
-  }
-
-  /**
-   * The minimal chat context.
-   */
-  export class ChatContext extends AbstractChatContext {
-    users = [];
-  }
-
-  /**
-   *  The chat command provider for the chat.
-   */
-  export class ClearCommandProvider implements IChatCommandProvider {
-    public id: string = '@jupyterlite/ai:clear-commands';
-    private _slash_commands: ChatCommand[] = [
-      {
-        name: '/clear',
-        providerId: this.id,
-        replaceWith: '/clear',
-        description: 'Clear the chat'
-      }
-    ];
-    async listCommandCompletions(inputModel: IInputModel) {
-      const match = inputModel.currentWord?.match(/^\/\w*/)?.[0];
-      if (!match) {
-        return [];
-      }
-
-      const commands = this._slash_commands.filter(cmd =>
-        cmd.name.startsWith(match)
-      );
-      return commands;
-    }
-
-    async onSubmit(inputModel: IInputModel): Promise<void> {
-      // no handling needed because `replaceWith` is set in each command.
-      return;
-    }
-  }
-}
-
-namespace Private {
-  /**
-   * Return the current timestamp in milliseconds.
-   */
-  export function getTimestampMs(): number {
-    return Date.now() / 1000;
-  }
-}

package/src/completion-provider.ts

@@ -1,64 +0,0 @@
-import {
-  CompletionHandler,
-  IInlineCompletionContext,
-  IInlineCompletionProvider
-} from '@jupyterlab/completer';
-
-import { IAIProviderRegistry } from './tokens';
-import { AICompleter } from './types/ai-model';
-
-/**
- * The generic completion provider to register to the completion provider manager.
- */
-export class CompletionProvider implements IInlineCompletionProvider {
-  readonly identifier = '@jupyterlite/ai';
-
-  constructor(options: CompletionProvider.IOptions) {
-    this._providerRegistry = options.providerRegistry;
-    this._requestCompletion = options.requestCompletion;
-
-    this._providerRegistry.providerChanged.connect(() => {
-      if (this.completer) {
-        this.completer.requestCompletion = this._requestCompletion;
-      }
-    });
-  }
-
-  /**
-   * Get the current completer name.
-   */
-  get name(): string {
-    return this._providerRegistry.currentName('completer');
-  }
-
-  /**
-   * Get the current completer.
-   */
-  get completer(): AICompleter | null {
-    return this._providerRegistry.currentCompleter;
-  }
-
-  async fetch(
-    request: CompletionHandler.IRequest,
-    context: IInlineCompletionContext
-  ) {
-    return this.completer?.fetch(request, context);
-  }
-
-  private _providerRegistry: IAIProviderRegistry;
-  private _requestCompletion: () => void;
-}
-
-export namespace CompletionProvider {
-  export interface IOptions {
-    /**
-     * The registry where the completion provider belongs.
-     */
-    providerRegistry: IAIProviderRegistry;
-    /**
-     * The request completion commands, can be useful if a provider needs to request
-     * the completion by itself.
-     */
-    requestCompletion: () => void;
-  }
-}

package/src/default-prompts.ts

@@ -1,33 +0,0 @@
-/*
- * Copyright (c) Jupyter Development Team.
- * Distributed under the terms of the Modified BSD License.
- */
-
-export const DEFAULT_CHAT_SYSTEM_PROMPT = `
-You are Jupyternaut, a conversational assistant living in JupyterLab to help users.
-You are not a language model, but rather an application built on a foundation model from $provider_name$.
-You are talkative and you provide lots of specific details from the foundation model's context.
-You may use Markdown to format your response.
-If your response includes code, they must be enclosed in Markdown fenced code blocks (with triple backticks before and after).
-If your response includes mathematical notation, they must be expressed in LaTeX markup and enclosed in LaTeX delimiters.
-All dollar quantities (of USD) must be formatted in LaTeX, with the \`$\` symbol escaped by a single backslash \`\\\`.
-- Example prompt: \`If I have \\\\$100 and spend \\\\$20, how much money do I have left?\`
-- **Correct** response: \`You have \\(\\$80\\) remaining.\`
-- **Incorrect** response: \`You have $80 remaining.\`
-If you do not know the answer to a question, answer truthfully by responding that you do not know.
-The following is a friendly conversation between you and a human.
-`;
-
-export const DEFAULT_COMPLETION_SYSTEM_PROMPT = `
-You are an application built to provide helpful code completion suggestions.
-You should only produce code. Keep comments to minimum, use the
-programming language comment syntax. Produce clean code.
-The code is written in JupyterLab, a data analysis and code development
-environment which can execute code extended with additional syntax for
-interactive features, such as magics.
-Only give raw strings back, do not format the response using backticks.
-The output should be a single string, and should only contain the code that will complete the
-give code passed as input, no explanation whatsoever.
-Do not include the prompt in the output, only the string that should be appended to the current input.
-Here is the code to complete:
-`;

package/src/default-providers/Anthropic/completer.ts

@@ -1,59 +0,0 @@
-import {
-  CompletionHandler,
-  IInlineCompletionContext
-} from '@jupyterlab/completer';
-import { ChatAnthropic } from '@langchain/anthropic';
-import { AIMessage, SystemMessage } from '@langchain/core/messages';
-
-import { BaseCompleter } from '../../base-completer';
-
-export class AnthropicCompleter extends BaseCompleter {
-  constructor(options: BaseCompleter.IOptions) {
-    super(options);
-    this._completer = new ChatAnthropic({ ...options.settings });
-  }
-
-  async fetch(
-    request: CompletionHandler.IRequest,
-    context: IInlineCompletionContext
-  ) {
-    const { text, offset: cursorOffset } = request;
-    const prompt = text.slice(0, cursorOffset);
-
-    // Anthropic does not allow whitespace at the end of the AIMessage
-    const trimmedPrompt = prompt.trim();
-
-    const messages = [
-      new SystemMessage(this.systemPrompt),
-      new AIMessage(trimmedPrompt)
-    ];
-
-    try {
-      const response = await this._completer.invoke(messages);
-      const items = [];
-
-      // Anthropic can return string or complex content, a list of string/images/other.
-      if (typeof response.content === 'string') {
-        items.push({
-          insertText: response.content
-        });
-      } else {
-        response.content.forEach(content => {
-          if (content.type !== 'text') {
-            return;
-          }
-          items.push({
-            insertText: content.text,
-            filterText: prompt.substring(trimmedPrompt.length)
-          });
-        });
-      }
-      return { items };
-    } catch (error) {
-      console.error('Error fetching completions', error);
-      return { items: [] };
-    }
-  }
-
-  protected _completer: ChatAnthropic;
-}

package/src/default-providers/ChromeAI/completer.ts

@@ -1,73 +0,0 @@
-import {
-  CompletionHandler,
-  IInlineCompletionContext
-} from '@jupyterlab/completer';
-import { ChromeAI } from '@langchain/community/experimental/llms/chrome_ai';
-import { HumanMessage, SystemMessage } from '@langchain/core/messages';
-
-import { BaseCompleter } from '../../base-completer';
-
-/**
- * Regular expression to match the '```' string at the start of a string.
- * So the completions returned by the LLM can still be kept after removing the code block formatting.
- *
- * For example, if the response contains the following content after typing `import pandas`:
- *
- * ```python
- * as pd
- * ```
- *
- * The formatting string after removing the code block delimiters will be:
- *
- * as pd
- */
-const CODE_BLOCK_START_REGEX = /^```(?:[a-zA-Z]+)?\n?/;
-
-/**
- * Regular expression to match the '```' string at the end of a string.
- */
-const CODE_BLOCK_END_REGEX = /```$/;
-
-export class ChromeCompleter extends BaseCompleter {
-  constructor(options: BaseCompleter.IOptions) {
-    super(options);
-    this._completer = new ChromeAI({ ...options.settings });
-  }
-
-  async fetch(
-    request: CompletionHandler.IRequest,
-    context: IInlineCompletionContext
-  ) {
-    const { text, offset: cursorOffset } = request;
-    const prompt = text.slice(0, cursorOffset);
-
-    const trimmedPrompt = prompt.trim();
-
-    const messages = [
-      new SystemMessage(this.systemPrompt),
-      new HumanMessage(trimmedPrompt)
-    ];
-
-    try {
-      let response = await this._completer.invoke(messages);
-
-      // ChromeAI sometimes returns a string starting with '```',
-      // so process the response to remove the code block delimiters
-      if (CODE_BLOCK_START_REGEX.test(response)) {
-        response = response
-          .replace(CODE_BLOCK_START_REGEX, '')
-          .replace(CODE_BLOCK_END_REGEX, '');
-      }
-
-      const items = [{ insertText: response }];
-      return {
-        items
-      };
-    } catch (error) {
-      console.error('Error fetching completion:', error);
-      return { items: [] };
-    }
-  }
-
-  protected _completer: ChromeAI;
-}

package/src/default-providers/ChromeAI/instructions.ts

@@ -1,45 +0,0 @@
-export default `
-<i class="fas fa-exclamation-triangle"></i> Support for ChromeAI is still experimental and only available in Google Chrome.
-
-You can test ChromeAI is enabled in your browser by going to the following URL: <https://chromeai.org/>
-
-Enable the proper flags in Google Chrome.
-
-- chrome://flags/#prompt-api-for-gemini-nano
-  - Select: \`Enabled\`
-- chrome://flags/#optimization-guide-on-device-model
-  - Select: \`Enabled BypassPrefRequirement\`
-- chrome://components
-  - Click \`Check for Update\` on Optimization Guide On Device Model to download the model
-- [Optional] chrome://flags/#text-safety-classifier
-
-<img src="https://github.com/user-attachments/assets/d48f46cc-52ee-4ce5-9eaf-c763cdbee04c" alt="A screenshot showing how to enable the ChromeAI flag in Google Chrome" width="500px">
-
-Then restart Chrome for these changes to take effect.
-
-<i class="fas fa-exclamation-triangle"></i> On first use, Chrome will download the on-device model, which can be as large as 22GB (according to their docs and at the time of writing).
-During the download, ChromeAI may not be available via the extension.
-
-<i class="fa fa-info-circle" aria-hidden="true"></i> For more information about Chrome Built-in AI: <https://developer.chrome.com/docs/ai/get-started>
-`;
-
-/**
- * Check if the browser supports ChromeAI and the model is available.
- */
-export async function compatibilityCheck(): Promise<string | null> {
-  // Check if the browser supports the ChromeAI model
-  if (
-    typeof window === 'undefined' ||
-    !('LanguageModel' in window) ||
-    window.LanguageModel === undefined ||
-    (window.LanguageModel as any).availability === undefined
-  ) {
-    return 'Your browser does not support ChromeAI. Please use an updated chrome based browser like Google Chrome, and follow the instructions in settings to enable it.';
-  }
-  const languageModel = window.LanguageModel as any;
-  if (!(await languageModel.availability())) {
-    return 'The ChromeAI model is not available in your browser. Please ensure you have enabled the necessary flags in Google Chrome as described in the instructions in settings.';
-  }
-  // If the model is available, return null to indicate compatibility
-  return null;
-}

package/src/default-providers/Gemini/completer.ts

@@ -1,61 +0,0 @@
-import {
-  CompletionHandler,
-  IInlineCompletionContext
-} from '@jupyterlab/completer';
-import { ChatGoogleGenerativeAI } from '@langchain/google-genai';
-import { AIMessage, SystemMessage } from '@langchain/core/messages';
-
-import { BaseCompleter } from '../../base-completer';
-
-export class GeminiCompleter extends BaseCompleter {
-  constructor(options: BaseCompleter.IOptions) {
-    super(options);
-    this._completer = new ChatGoogleGenerativeAI({
-      model: 'gemini-pro',
-      ...options.settings
-    });
-  }
-
-  async fetch(
-    request: CompletionHandler.IRequest,
-    context: IInlineCompletionContext
-  ) {
-    const { text, offset: cursorOffset } = request;
-    const prompt = text.slice(0, cursorOffset);
-
-    const trimmedPrompt = prompt.trim();
-
-    const messages = [
-      new SystemMessage(this.systemPrompt),
-      new AIMessage(trimmedPrompt)
-    ];
-
-    try {
-      const response = await this._completer.invoke(messages);
-      const items = [];
-
-      // Gemini can return string or complex content, a list of string/images/other.
-      if (typeof response.content === 'string') {
-        items.push({
-          insertText: response.content
-        });
-      } else {
-        response.content.forEach(content => {
-          if (content.type !== 'text') {
-            return;
-          }
-          items.push({
-            insertText: content.text,
-            filterText: prompt.substring(trimmedPrompt.length)
-          });
-        });
-      }
-      return { items };
-    } catch (error) {
-      console.error('Error fetching completions', error);
-      return { items: [] };
-    }
-  }
-
-  protected _completer: ChatGoogleGenerativeAI;
-}

package/src/default-providers/Gemini/instructions.ts

@@ -1,9 +0,0 @@
-export default `
-<i class="fas fa-exclamation-triangle"></i> This extension is still very much experimental. It is not an official Google extension.
-
-1. Go to <https://aistudio.google.com> and create an API key.
-
-2. Open the JupyterLab settings and go to the **Ai providers** section to select the \`Gemini\`
-   provider and add your API key (required).
-3. Open the chat, or use the inline completer.
-`;