@jupyterlite/ai 0.6.2 → 0.8.0

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

@@ -42,10 +42,7 @@
                                                     "description": "The type of the content part."
                                                 }
                                             },
-                                            "required": [
-                                                "text",
-                                                "type"
-                                            ],
+                                            "required": ["text", "type"],
                                             "additionalProperties": false,
                                             "description": "Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation)."
                                         }
@@ -63,10 +60,7 @@
                                 "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
                             }
                         },
-                        "required": [
-                            "content",
-                            "role"
-                        ],
+                        "required": ["content", "role"],
                         "additionalProperties": false,
                         "description": "Developer-provided instructions that the model should follow, regardless of messages sent by the user. With o1 models and newer, `developer` messages replace the previous `system` messages."
                     },
@@ -93,10 +87,7 @@
                                                     "description": "The type of the content part."
                                                 }
                                             },
-                                            "required": [
-                                                "text",
-                                                "type"
-                                            ],
+                                            "required": ["text", "type"],
                                             "additionalProperties": false,
                                             "description": "Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation)."
                                         }
@@ -114,10 +105,7 @@
                                 "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
                             }
                         },
-                        "required": [
-                            "content",
-                            "role"
-                        ],
+                        "required": ["content", "role"],
                         "additionalProperties": false,
                         "description": "Developer-provided instructions that the model should follow, regardless of messages sent by the user. With o1 models and newer, use `developer` messages for this purpose instead."
                     },
@@ -146,10 +134,7 @@
                                                             "description": "The type of the content part."
                                                         }
                                                     },
-                                                    "required": [
-                                                        "text",
-                                                        "type"
-                                                    ],
+                                                    "required": ["text", "type"],
                                                     "additionalProperties": false,
                                                     "description": "Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation)."
                                                 },
@@ -165,17 +150,11 @@
                                                                 },
                                                                 "detail": {
                                                                     "type": "string",
-                                                                    "enum": [
-                                                                        "auto",
-                                                                        "low",
-                                                                        "high"
-                                                                    ],
+                                                                    "enum": ["auto", "low", "high"],
                                                                     "description": "Specifies the detail level of the image. Learn more in the [Vision guide](https://platform.openai.com/docs/guides/vision#low-or-high-fidelity-image-understanding)."
                                                                 }
                                                             },
-                                                            "required": [
-                                                                "url"
-                                                            ],
+                                                            "required": ["url"],
                                                             "additionalProperties": false
                                                         },
                                                         "type": {
@@ -184,10 +163,7 @@
                                                             "description": "The type of the content part."
                                                         }
                                                     },
-                                                    "required": [
-                                                        "image_url",
-                                                        "type"
-                                                    ],
+                                                    "required": ["image_url", "type"],
                                                     "additionalProperties": false,
                                                     "description": "Learn about [image inputs](https://platform.openai.com/docs/guides/vision)."
                                                 },
@@ -203,17 +179,11 @@
                                                                 },
                                                                 "format": {
                                                                     "type": "string",
-                                                                    "enum": [
-                                                                        "wav",
-                                                                        "mp3"
-                                                                    ],
+                                                                    "enum": ["wav", "mp3"],
                                                                     "description": "The format of the encoded audio data. Currently supports \"wav\" and \"mp3\"."
                                                                 }
                                                             },
-                                                            "required": [
-                                                                "data",
-                                                                "format"
-                                                            ],
+                                                            "required": ["data", "format"],
                                                             "additionalProperties": false
                                                         },
                                                         "type": {
@@ -222,12 +192,40 @@
                                                             "description": "The type of the content part. Always `input_audio`."
                                                         }
                                                     },
-                                                    "required": [
-                                                        "input_audio",
-                                                        "type"
-                                                    ],
+                                                    "required": ["input_audio", "type"],
                                                     "additionalProperties": false,
                                                     "description": "Learn about [audio inputs](https://platform.openai.com/docs/guides/audio)."
+                                                },
+                                                {
+                                                    "type": "object",
+                                                    "properties": {
+                                                        "file": {
+                                                            "type": "object",
+                                                            "properties": {
+                                                                "file_data": {
+                                                                    "type": "string",
+                                                                    "description": "The base64 encoded file data, used when passing the file to the model as a string."
+                                                                },
+                                                                "file_id": {
+                                                                    "type": "string",
+                                                                    "description": "The ID of an uploaded file to use as input."
+                                                                },
+                                                                "filename": {
+                                                                    "type": "string",
+                                                                    "description": "The name of the file, used when passing the file to the model as a string."
+                                                                }
+                                                            },
+                                                            "additionalProperties": false
+                                                        },
+                                                        "type": {
+                                                            "type": "string",
+                                                            "const": "file",
+                                                            "description": "The type of the content part. Always `file`."
+                                                        }
+                                                    },
+                                                    "required": ["file", "type"],
+                                                    "additionalProperties": false,
+                                                    "description": "Learn about [file inputs](https://platform.openai.com/docs/guides/text) for text generation."
                                                 }
                                             ],
                                             "description": "Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation)."
@@ -246,10 +244,7 @@
                                 "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
                             }
                         },
-                        "required": [
-                            "content",
-                            "role"
-                        ],
+                        "required": ["content", "role"],
                         "additionalProperties": false,
                         "description": "Messages sent by an end user, containing prompts or additional context information."
                     },
@@ -271,9 +266,7 @@
                                                 "description": "Unique identifier for a previous audio response from the model."
                                             }
                                         },
-                                        "required": [
-                                            "id"
-                                        ],
+                                        "required": ["id"],
                                         "additionalProperties": false,
                                         "description": "Data about a previous audio response from the model. [Learn more](https://platform.openai.com/docs/guides/audio)."
                                     },
@@ -305,10 +298,7 @@
                                                             "description": "The type of the content part."
                                                         }
                                                     },
-                                                    "required": [
-                                                        "text",
-                                                        "type"
-                                                    ],
+                                                    "required": ["text", "type"],
                                                     "additionalProperties": false,
                                                     "description": "Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation)."
                                                 },
@@ -325,10 +315,7 @@
                                                             "description": "The type of the content part."
                                                         }
                                                     },
-                                                    "required": [
-                                                        "refusal",
-                                                        "type"
-                                                    ],
+                                                    "required": ["refusal", "type"],
                                                     "additionalProperties": false
                                                 }
                                             ]
@@ -354,10 +341,7 @@
                                                 "description": "The name of the function to call."
                                             }
                                         },
-                                        "required": [
-                                            "arguments",
-                                            "name"
-                                        ],
+                                        "required": ["arguments", "name"],
                                         "additionalProperties": false,
                                         "deprecated": "Deprecated and replaced by `tool_calls`. The name and arguments of a\nfunction that should be called, as generated by the model."
                                     },
@@ -372,10 +356,7 @@
                                 "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
                             },
                             "refusal": {
-                                "type": [
-                                    "string",
-                                    "null"
-                                ],
+                                "type": ["string", "null"],
                                 "description": "The refusal message by the assistant."
                             },
                             "tool_calls": {
@@ -399,10 +380,7 @@
                                                     "description": "The name of the function to call."
                                                 }
                                             },
-                                            "required": [
-                                                "arguments",
-                                                "name"
-                                            ],
+                                            "required": ["arguments", "name"],
                                             "additionalProperties": false,
                                             "description": "The function that the model called."
                                         },
@@ -412,19 +390,13 @@
                                             "description": "The type of the tool. Currently, only `function` is supported."
                                         }
                                     },
-                                    "required": [
-                                        "id",
-                                        "function",
-                                        "type"
-                                    ],
+                                    "required": ["id", "function", "type"],
                                     "additionalProperties": false
                                 },
                                 "description": "The tool calls generated by the model, such as function calls."
                             }
                         },
-                        "required": [
-                            "role"
-                        ],
+                        "required": ["role"],
                         "additionalProperties": false,
                         "description": "Messages sent by the model in response to user messages."
                     },
@@ -451,10 +423,7 @@
                                                     "description": "The type of the content part."
                                                 }
                                             },
-                                            "required": [
-                                                "text",
-                                                "type"
-                                            ],
+                                            "required": ["text", "type"],
                                             "additionalProperties": false,
                                             "description": "Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation)."
                                         }
@@ -472,21 +441,14 @@
                                 "description": "Tool call that this message is responding to."
                             }
                         },
-                        "required": [
-                            "content",
-                            "role",
-                            "tool_call_id"
-                        ],
+                        "required": ["content", "role", "tool_call_id"],
                         "additionalProperties": false
                     },
                     {
                         "type": "object",
                         "properties": {
                             "content": {
-                                "type": [
-                                    "string",
-                                    "null"
-                                ],
+                                "type": ["string", "null"],
                                 "description": "The contents of the function message."
                             },
                             "name": {
@@ -499,11 +461,7 @@
                                 "description": "The role of the messages author, in this case `function`."
                             }
                         },
-                        "required": [
-                            "content",
-                            "name",
-                            "role"
-                        ],
+                        "required": ["content", "name", "role"],
                         "additionalProperties": false,
                         "deprecated": true
                     }
@@ -524,10 +482,7 @@
             "type": "array",
             "items": {
                 "type": "string",
-                "enum": [
-                    "text",
-                    "audio"
-                ]
+                "enum": ["text", "audio"]
             },
             "description": "Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default:\n\n`[\"text\"]`\n\nThe `gpt-4o-audio-preview` model can also be used to [generate audio](https://platform.openai.com/docs/guides/audio). To request that this model generate both text and audio responses, you can use:\n\n`[\"text\", \"audio\"]`"
         },
@@ -536,43 +491,48 @@
             "properties": {
                 "format": {
                     "type": "string",
-                    "enum": [
-                        "wav",
-                        "mp3",
-                        "flac",
-                        "opus",
-                        "pcm16"
-                    ],
+                    "enum": ["wav", "aac", "mp3", "flac", "opus", "pcm16"],
                     "description": "Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`, or `pcm16`."
                 },
                 "voice": {
-                    "type": "string",
-                    "enum": [
-                        "alloy",
-                        "ash",
-                        "ballad",
-                        "coral",
-                        "echo",
-                        "sage",
-                        "shimmer",
-                        "verse"
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "string",
+                            "enum": [
+                                "alloy",
+                                "ash",
+                                "ballad",
+                                "coral",
+                                "echo",
+                                "fable",
+                                "onyx",
+                                "nova",
+                                "sage",
+                                "shimmer",
+                                "verse"
+                            ]
+                        }
                     ],
-                    "description": "The voice the model uses to respond. Supported voices are `ash`, `ballad`, `coral`, `sage`, and `verse` (also supported but not recommended are `alloy`, `echo`, and `shimmer`; these voices are less expressive)."
+                    "description": "The voice the model uses to respond. Supported voices are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, and `shimmer`."
                 }
             },
-            "required": [
-                "format",
-                "voice"
-            ],
+            "required": ["format", "voice"],
             "additionalProperties": false,
             "description": "Parameters for audio output. Required when audio output is requested with `modalities: [\"audio\"]`. [Learn more](https://platform.openai.com/docs/guides/audio)."
         },
         "reasoningEffort": {
-            "type": "string",
-            "enum": [
-                "low",
-                "medium",
-                "high"
+            "anyOf": [
+                {
+                    "type": ["string", "null"],
+                    "enum": ["low", "medium", "high", null],
+                    "description": "**o-series models only**\n\nConstrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `low`, `medium`, and `high`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response."
+                },
+                {
+                    "type": "null"
+                }
             ],
             "description": "Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response."
         },

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

@@ -0,0 +1,21 @@
+import { CompletionHandler, IInlineCompletionContext } from '@jupyterlab/completer';
+import { ChatWebLLM } from '@langchain/community/chat_models/webllm';
+import { BaseCompleter } from '../../base-completer';
+export declare class WebLLMCompleter extends BaseCompleter {
+    constructor(options: BaseCompleter.IOptions);
+    /**
+     * Initialize the WebLLM model
+     */
+    private _initializeModel;
+    get provider(): ChatWebLLM;
+    fetch(request: CompletionHandler.IRequest, context: IInlineCompletionContext): Promise<{
+        items: {
+            insertText: string;
+        }[];
+    }>;
+    protected _completer: ChatWebLLM;
+    private _isInitialized;
+    private _isInitializing;
+    private _initError;
+    private _abortController;
+}

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

@@ -0,0 +1,127 @@
+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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,32 @@
+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

@@ -0,0 +1,19 @@
+{
+    "$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": {}
+}