@jupyterlite/ai 0.8.1 → 0.9.0-a0

package/lib/default-providers/WebLLM/completer.js

@@ -1,127 +0,0 @@
-import { HumanMessage, SystemMessage } from '@langchain/core/messages';
-import { ChatWebLLM } from '@langchain/community/chat_models/webllm';
-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 WebLLMCompleter extends BaseCompleter {
-    constructor(options) {
-        super(options);
-        const model = options.settings.model;
-        // provide model separately since ChatWebLLM expects it
-        this._completer = new ChatWebLLM({
-            ...options.settings,
-            model
-        });
-        // Initialize the model and track its status
-        this._isInitialized = false;
-        this._isInitializing = false;
-        this._initError = null;
-        void this._initializeModel();
-    }
-    /**
-     * Initialize the WebLLM model
-     */
-    async _initializeModel() {
-        if (this._isInitialized || this._isInitializing) {
-            return;
-        }
-        this._isInitializing = true;
-        try {
-            await this._completer.initialize((progress) => {
-                console.log('WebLLM initialization progress:', progress);
-            });
-            this._isInitialized = true;
-            this._isInitializing = false;
-            console.log('WebLLM model successfully initialized');
-        }
-        catch (error) {
-            this._initError =
-                error instanceof Error ? error : new Error(String(error));
-            this._isInitializing = false;
-            console.error('Failed to initialize WebLLM model:', error);
-        }
-    }
-    get provider() {
-        return this._completer;
-    }
-    async fetch(request, context) {
-        // Abort any pending request
-        if (this._abortController) {
-            this._abortController.abort();
-        }
-        // Create a new abort controller for this request
-        this._abortController = new AbortController();
-        const signal = this._abortController.signal;
-        if (!this._isInitialized) {
-            if (this._initError) {
-                console.error('WebLLM model failed to initialize:', this._initError);
-                return { items: [] };
-            }
-            if (!this._isInitializing) {
-                // Try to initialize again if it's not currently initializing
-                await this._initializeModel();
-            }
-            else {
-                console.log('WebLLM model is still initializing, please try again later');
-                return { items: [] };
-            }
-            // Return empty if still not initialized
-            if (!this._isInitialized) {
-                return { items: [] };
-            }
-        }
-        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 {
-            console.log('Trigger invoke');
-            const response = await this._completer.invoke(messages, { signal });
-            let content = response.content;
-            console.log('Response content:', content);
-            if (CODE_BLOCK_START_REGEX.test(content)) {
-                content = content
-                    .replace(CODE_BLOCK_START_REGEX, '')
-                    .replace(CODE_BLOCK_END_REGEX, '');
-            }
-            const items = [{ insertText: content }];
-            return {
-                items
-            };
-        }
-        catch (error) {
-            if (error instanceof Error) {
-                console.error('Error fetching completion from WebLLM:', error.message);
-            }
-            else {
-                console.error('Unknown error fetching completion from WebLLM:', error);
-            }
-            return { items: [] };
-        }
-    }
-    _completer;
-    _isInitialized = false;
-    _isInitializing = false;
-    _initError = null;
-    _abortController = null;
-}

package/lib/default-providers/WebLLM/instructions.d.ts

@@ -1,6 +0,0 @@
-declare const _default: "\nWebLLM enables running LLMs directly in your browser, making it possible to use AI features without sending data to external servers.\n\n<i class=\"fas fa-info-circle\"></i> WebLLM runs models entirely in your browser, so initial model download may be large (100MB-2GB depending on the model).\n\n<i class=\"fas fa-exclamation-triangle\"></i> <strong>Requirements:</strong> WebLLM requires a browser with WebGPU support (Chrome 113+, Edge 113+, or Safari 17+). It will not work on older browsers or browsers without WebGPU enabled.\n\n1. Enter a model in the JupyterLab settings under the **Ai providers** section. Select the `WebLLM` provider and type the model you want to use.\n2. When you first use WebLLM, your browser will download the model. A progress notification will appear:\n3. Once loaded, use the chat\n4. Example of available models:\n  - Llama-3.2-1B-Instruct-q4f32_1-MLC\n  - Mistral-7B-Instruct-v0.3-q4f32_1-MLC\n  - Qwen3-0.6B-q4f32_1-MLC\n5. See the full list of models: https://github.com/mlc-ai/web-llm/blob/632d34725629b480b5b2772379ef5c150b1286f0/src/config.ts#L303-L309\n\n<i class=\"fas fa-exclamation-triangle\"></i> Model performance depends on your device's hardware capabilities. More powerful devices will run models faster. Some larger models may not work well on devices with limited GPU memory or may experience slow response times.\n";
-export default _default;
-/**
- * Check if the browser supports WebLLM.
- */
-export declare function compatibilityCheck(): Promise<string | null>;

package/lib/default-providers/WebLLM/instructions.js

@@ -1,32 +0,0 @@
-export default `
-WebLLM enables running LLMs directly in your browser, making it possible to use AI features without sending data to external servers.
-
-<i class="fas fa-info-circle"></i> WebLLM runs models entirely in your browser, so initial model download may be large (100MB-2GB depending on the model).
-
-<i class="fas fa-exclamation-triangle"></i> <strong>Requirements:</strong> WebLLM requires a browser with WebGPU support (Chrome 113+, Edge 113+, or Safari 17+). It will not work on older browsers or browsers without WebGPU enabled.
-
-1. Enter a model in the JupyterLab settings under the **Ai providers** section. Select the \`WebLLM\` provider and type the model you want to use.
-2. When you first use WebLLM, your browser will download the model. A progress notification will appear:
-3. Once loaded, use the chat
-4. Example of available models:
-  - Llama-3.2-1B-Instruct-q4f32_1-MLC
-  - Mistral-7B-Instruct-v0.3-q4f32_1-MLC
-  - Qwen3-0.6B-q4f32_1-MLC
-5. See the full list of models: https://github.com/mlc-ai/web-llm/blob/632d34725629b480b5b2772379ef5c150b1286f0/src/config.ts#L303-L309
-
-<i class="fas fa-exclamation-triangle"></i> Model performance depends on your device's hardware capabilities. More powerful devices will run models faster. Some larger models may not work well on devices with limited GPU memory or may experience slow response times.
-`;
-/**
- * Check if the browser supports WebLLM.
- */
-export async function compatibilityCheck() {
-    // Check if the browser supports the ChromeAI model
-    if (typeof navigator === 'undefined' || !('gpu' in navigator)) {
-        return 'Your browser does not support WebLLM, it does not support required WebGPU.';
-    }
-    if ((await navigator.gpu.requestAdapter()) === null) {
-        return 'You may need to enable WebGPU, `await navigator.gpu.requestAdapter()` is null.';
-    }
-    // If the model is available, return null to indicate compatibility
-    return null;
-}

package/lib/default-providers/WebLLM/settings-schema.json

@@ -1,19 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "type": "object",
-    "properties": {
-        "disableStreaming": {
-            "type": "boolean",
-            "description": "Whether to disable streaming.\n\nIf streaming is bypassed, then `stream()` will defer to `invoke()`.\n\n- If true, will always bypass streaming case.\n- If false (default), will always use streaming case if available."
-        },
-        "temperature": {
-            "type": "number"
-        },
-        "model": {
-            "type": "string"
-        }
-    },
-    "required": ["model"],
-    "additionalProperties": false,
-    "definitions": {}
-}

package/lib/default-providers/index.d.ts

@@ -1,2 +0,0 @@
-import { JupyterFrontEndPlugin } from '@jupyterlab/application';
-export declare const defaultProviderPlugins: JupyterFrontEndPlugin<void>[];

package/lib/default-providers/index.js

@@ -1,179 +0,0 @@
-import { Notification } from '@jupyterlab/apputils';
-import { ChatAnthropic } from '@langchain/anthropic';
-import { ChatWebLLM } from '@langchain/community/chat_models/webllm';
-import { ChromeAI } from '@langchain/community/experimental/llms/chrome_ai';
-import { ChatGoogleGenerativeAI } from '@langchain/google-genai';
-import { ChatMistralAI } from '@langchain/mistralai';
-import { ChatOllama } from '@langchain/ollama';
-import { ChatOpenAI } from '@langchain/openai';
-// Import completers
-import { AnthropicCompleter } from './Anthropic/completer';
-import { ChromeCompleter } from './ChromeAI/completer';
-import { GeminiCompleter } from './Gemini/completer';
-import { CodestralCompleter } from './MistralAI/completer';
-import { OllamaCompleter } from './Ollama/completer';
-import { OpenAICompleter } from './OpenAI/completer';
-import { WebLLMCompleter } from './WebLLM/completer';
-// Import Settings
-import AnthropicSettings from './Anthropic/settings-schema.json';
-import ChromeAISettings from './ChromeAI/settings-schema.json';
-import GeminiSettings from './Gemini/settings-schema.json';
-import MistralAISettings from './MistralAI/settings-schema.json';
-import OllamaAISettings from './Ollama/settings-schema.json';
-import OpenAISettings from './OpenAI/settings-schema.json';
-import WebLLMSettings from './WebLLM/settings-schema.json';
-// Import instructions
-import ChromeAIInstructions, { compatibilityCheck as chromeAICompatibilityCheck } from './ChromeAI/instructions';
-import GeminiInstructions from './Gemini/instructions';
-import MistralAIInstructions from './MistralAI/instructions';
-import OllamaInstructions from './Ollama/instructions';
-import WebLLMInstructions, { compatibilityCheck as webLLMCompatibilityCheck } from './WebLLM/instructions';
-import { prebuiltAppConfig } from '@mlc-ai/web-llm';
-import { IAIProviderRegistry } from '../tokens';
-// Build the AIProvider list
-const AIProviders = [
-    {
-        name: 'Anthropic',
-        chat: ChatAnthropic,
-        completer: AnthropicCompleter,
-        settingsSchema: AnthropicSettings,
-        errorMessage: (error) => error.error.error.message
-    },
-    {
-        name: 'ChromeAI',
-        // TODO: fix
-        // @ts-expect-error: missing properties
-        chat: ChromeAI,
-        completer: ChromeCompleter,
-        instructions: ChromeAIInstructions,
-        settingsSchema: ChromeAISettings,
-        compatibilityCheck: chromeAICompatibilityCheck
-    },
-    {
-        name: 'MistralAI',
-        chat: ChatMistralAI,
-        completer: CodestralCompleter,
-        instructions: MistralAIInstructions,
-        settingsSchema: MistralAISettings
-    },
-    {
-        name: 'Ollama',
-        chat: ChatOllama,
-        completer: OllamaCompleter,
-        instructions: OllamaInstructions,
-        settingsSchema: OllamaAISettings
-    },
-    {
-        name: 'Gemini',
-        chat: ChatGoogleGenerativeAI,
-        completer: GeminiCompleter,
-        instructions: GeminiInstructions,
-        settingsSchema: GeminiSettings
-    },
-    {
-        name: 'OpenAI',
-        chat: ChatOpenAI,
-        completer: OpenAICompleter,
-        settingsSchema: OpenAISettings
-    }
-];
-/**
- * Register the WebLLM provider in a separate plugin since it creates notifications
- * when the model is changed in the settings.
- */
-const webLLMProviderPlugin = {
-    id: '@jupyterlite/ai:webllm',
-    description: 'Register the WebLLM provider',
-    autoStart: true,
-    requires: [IAIProviderRegistry],
-    activate: (app, registry) => {
-        registry.add({
-            name: 'WebLLM',
-            chat: ChatWebLLM,
-            completer: WebLLMCompleter,
-            settingsSchema: WebLLMSettings,
-            instructions: WebLLMInstructions,
-            compatibilityCheck: webLLMCompatibilityCheck,
-            exposeChatModel: true
-        });
-        registry.providerChanged.connect(async (sender, role) => {
-            const { currentChatModel } = registry;
-            // TODO: implement a proper way to handle models that may need to be initialized before being used.
-            // Mostly applies to WebLLM and ChromeAI as they may need to download the model in the browser first.
-            if (registry.currentName(role) === 'WebLLM') {
-                // Leaving this check here, but it should never happen, this check is done in
-                // the provider registry, and the current name is set to 'None' if there is a
-                // compatibility error.
-                const compatibilityError = await webLLMCompatibilityCheck();
-                if (compatibilityError) {
-                    return;
-                }
-                const model = currentChatModel;
-                if (model === null || !model.model) {
-                    return;
-                }
-                // Find if the model is part of the prebuiltAppConfig
-                const modelRecord = prebuiltAppConfig.model_list.find(modelRecord => modelRecord.model_id === model.model);
-                if (!modelRecord) {
-                    Notification.dismiss();
-                    Notification.emit(`Model ${model.model} not found in the prebuiltAppConfig`, 'error', {
-                        autoClose: 2000
-                    });
-                    return;
-                }
-                // create a notification
-                const notification = Notification.emit('Loading model...', 'in-progress', {
-                    autoClose: false,
-                    progress: 0
-                });
-                try {
-                    void model.initialize(report => {
-                        const { progress, text } = report;
-                        if (progress === 1) {
-                            Notification.update({
-                                id: notification,
-                                progress: 1,
-                                message: `Model ${model.model} loaded successfully`,
-                                type: 'success',
-                                autoClose: 2000
-                            });
-                            return;
-                        }
-                        Notification.update({
-                            id: notification,
-                            progress: progress / 1,
-                            message: text,
-                            type: 'in-progress'
-                        });
-                    });
-                }
-                catch (err) {
-                    Notification.update({
-                        id: notification,
-                        progress: 1,
-                        message: `Error loading model ${model.model}`,
-                        type: 'error',
-                        autoClose: 2000
-                    });
-                }
-            }
-        });
-    }
-};
-/**
- * Register all default AI providers.
- */
-const aiProviderPlugins = AIProviders.map(provider => {
-    return {
-        id: `@jupyterlite/ai:${provider.name}`,
-        autoStart: true,
-        requires: [IAIProviderRegistry],
-        activate: (app, registry) => {
-            registry.add(provider);
-        }
-    };
-});
-export const defaultProviderPlugins = [
-    webLLMProviderPlugin,
-    ...aiProviderPlugins
-];

package/lib/provider.d.ts

@@ -1,144 +0,0 @@
-import { BaseLanguageModel } from '@langchain/core/language_models/base';
-import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
-import { ISignal } from '@lumino/signaling';
-import { JSONSchema7 } from 'json-schema';
-import { ISecretsManager } from 'jupyter-secrets-manager';
-import { IAIProvider, IAIProviderRegistry, ModelRole } from './tokens';
-import { AIChatModel, AICompleter } from './types/ai-model';
-export declare class AIProviderRegistry implements IAIProviderRegistry {
-    /**
-     * The constructor of the provider registry.
-     */
-    constructor(options: AIProviderRegistry.IOptions);
-    /**
-     * Get the list of provider names.
-     */
-    get providers(): string[];
-    /**
-     * Add a new provider.
-     */
-    add(provider: IAIProvider): void;
-    /**
-     * Get the current provider name.
-     */
-    currentName(role: ModelRole): string;
-    /**
-     * Get the current AICompleter.
-     */
-    get currentCompleter(): AICompleter | null;
-    /**
-     * Getter/setter for the completer system prompt.
-     */
-    get completerSystemPrompt(): string;
-    set completerSystemPrompt(value: string);
-    /**
-     * Get the current AIChatModel.
-     */
-    get currentChatModel(): AIChatModel | null;
-    /**
-     * Getter/setter for the chat system prompt.
-     */
-    get chatSystemPrompt(): string;
-    set chatSystemPrompt(value: string);
-    /**
-     * Get the settings schema of a given provider.
-     */
-    getSettingsSchema(provider: string): JSONSchema7;
-    /**
-     * 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;
-    /**
-     * Get/set the current chat error;
-     */
-    get chatError(): string;
-    private set chatError(value);
-    /**
-     * Get/set the current completer error.
-     */
-    get completerError(): string;
-    private set completerError(value);
-    /**
-     * A function to emit a notification error.
-     */
-    private _emitErrorNotification;
-    /**
-     * 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.
-     */
-    setCompleterProvider(settings: ReadonlyPartialJSONObject): Promise<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): Promise<void>;
-    /**
-     * A signal emitting when the provider or its settings has changed.
-     */
-    get providerChanged(): ISignal<IAIProviderRegistry, ModelRole>;
-    /**
-     * Build a new settings object containing the secrets.
-     */
-    private _buildFullSettings;
-    private _secretsManager;
-    private _providerChanged;
-    private _chatError;
-    private _completerError;
-    private _notifications;
-    private _deferredProvider;
-    private _chatPrompt;
-    private _completerPrompt;
-}
-export declare namespace AIProviderRegistry {
-    /**
-     * The options for the LLM provider.
-     */
-    interface IOptions {
-        /**
-         * The secrets manager used in the application.
-         */
-        secretsManager?: ISecretsManager;
-        /**
-         * The token used to request the secrets manager.
-         */
-        token: symbol;
-    }
-    /**
-     * The options for the Chat system prompt.
-     */
-    interface IPromptOptions {
-        /**
-         * The provider name.
-         */
-        provider_name: string;
-    }
-    /**
-     * This function indicates whether a key is writable in an object.
-     * https://stackoverflow.com/questions/54724875/can-we-check-whether-property-is-readonly-in-typescript
-     *
-     * @param obj - An object extending the BaseLanguageModel interface.
-     * @param key - A string as a key of the object.
-     * @returns a boolean whether the key is writable or not.
-     */
-    function isWritable<T extends BaseLanguageModel>(obj: T, key: keyof T): boolean;
-    /**
-     * Update the config of a language model.
-     * It only updates the writable attributes of the model.
-     *
-     * @param model - the model to update.
-     * @param settings - the configuration s a JSON object.
-     */
-    function updateConfig<T extends BaseLanguageModel>(model: T, settings: ReadonlyPartialJSONObject): void;
-}