@jupyterlite/ai 0.8.0 → 0.9.0-a0

package/lib/providers/models.d.ts

@@ -0,0 +1,37 @@
+import type { LanguageModel } from 'ai';
+import type { IChatProviderRegistry, ICompletionProviderRegistry } from '../tokens';
+/**
+ * Configuration options for creating language models.
+ */
+export interface IModelOptions {
+    /**
+     * The provider name (e.g., 'openai', 'anthropic', 'huggingface')
+     */
+    provider: string;
+    /**
+     * The specific model name. If not provided, uses provider's default model
+     */
+    model?: string;
+    /**
+     * API key for authentication with the provider
+     */
+    apiKey?: string;
+    /**
+     * Additional HTTP headers to send with requests
+     */
+    headers?: Record<string, string>;
+    /**
+     * Custom base URL for the provider's API endpoint
+     */
+    baseURL?: string;
+}
+/**
+ * Create a completion model using the provider registry.
+ * Built-in providers are automatically registered during extension initialization.
+ */
+export declare function createCompletionModel(options: IModelOptions, registry?: ICompletionProviderRegistry): LanguageModel;
+/**
+ * Create a chat model using the provider registry.
+ * Built-in providers are automatically registered during extension initialization.
+ */
+export declare function createModel(options: IModelOptions, registry?: IChatProviderRegistry): any;

package/lib/providers/models.js

@@ -0,0 +1,28 @@
+/**
+ * Create a completion model using the provider registry.
+ * Built-in providers are automatically registered during extension initialization.
+ */
+export function createCompletionModel(options, registry) {
+    if (!registry) {
+        throw new Error('Completion provider registry not available');
+    }
+    const model = registry.createCompletionModel(options.provider, options);
+    if (!model) {
+        throw new Error(`Provider ${options.provider} not found or failed to create model`);
+    }
+    return model;
+}
+/**
+ * Create a chat model using the provider registry.
+ * Built-in providers are automatically registered during extension initialization.
+ */
+export function createModel(options, registry) {
+    if (!registry) {
+        throw new Error('Chat provider registry not available');
+    }
+    const model = registry.createChatModel(options.provider, options);
+    if (!model) {
+        throw new Error(`Provider ${options.provider} not found or failed to create model`);
+    }
+    return model;
+}

package/lib/providers/provider-registry.d.ts

@@ -0,0 +1,94 @@
+import { ISignal } from '@lumino/signaling';
+import type { LanguageModel } from 'ai';
+import type { IModelOptions } from './models';
+import { IChatProviderInfo, IChatProviderRegistry, ICompletionProviderInfo, ICompletionProviderRegistry } from '../tokens';
+/**
+ * Implementation of the chat provider registry
+ */
+export declare class ChatProviderRegistry implements IChatProviderRegistry {
+    /**
+     * Get a copy of all registered providers
+     */
+    get providers(): Record<string, IChatProviderInfo>;
+    /**
+     * Signal emitted when providers are added or removed
+     */
+    get providersChanged(): ISignal<IChatProviderRegistry, void>;
+    /**
+     * Register a new chat provider
+     * @param info Provider information including factory
+     */
+    registerProvider(info: IChatProviderInfo): void;
+    /**
+     * Unregister a chat provider by ID
+     * @param id Provider ID to remove
+     * @returns true if provider was found and removed, false otherwise
+     */
+    unregisterProvider(id: string): boolean;
+    /**
+     * Get provider information by ID
+     * @param id Provider ID
+     * @returns Provider info or null if not found
+     */
+    getProviderInfo(id: string): IChatProviderInfo | null;
+    /**
+     * Create a chat model instance using the specified provider
+     * @param id Provider ID
+     * @param options Model configuration options
+     * @returns Chat model instance or null if creation fails
+     */
+    createChatModel(id: string, options: IModelOptions): any | null;
+    /**
+     * Get list of all available provider IDs
+     * @returns Array of provider IDs
+     */
+    getAvailableProviders(): string[];
+    private _providers;
+    private _factories;
+    private _providersChanged;
+}
+/**
+ * Implementation of the completion provider registry
+ */
+export declare class CompletionProviderRegistry implements ICompletionProviderRegistry {
+    /**
+     * Get a copy of all registered providers
+     */
+    get providers(): Record<string, ICompletionProviderInfo>;
+    /**
+     * Signal emitted when providers are added or removed
+     */
+    get providersChanged(): ISignal<ICompletionProviderRegistry, void>;
+    /**
+     * Register a new completion provider
+     * @param info Provider information including factory
+     */
+    registerProvider(info: ICompletionProviderInfo): void;
+    /**
+     * Unregister a completion provider by ID
+     * @param id Provider ID to remove
+     * @returns true if provider was found and removed, false otherwise
+     */
+    unregisterProvider(id: string): boolean;
+    /**
+     * Get provider information by ID
+     * @param id Provider ID
+     * @returns Provider info or null if not found
+     */
+    getProviderInfo(id: string): ICompletionProviderInfo | null;
+    /**
+     * Create a completion model instance using the specified provider
+     * @param id Provider ID
+     * @param options Model configuration options
+     * @returns Language model instance or null if creation fails
+     */
+    createCompletionModel(id: string, options: IModelOptions): LanguageModel | null;
+    /**
+     * Get list of all available provider IDs
+     * @returns Array of provider IDs
+     */
+    getAvailableProviders(): string[];
+    private _providers;
+    private _factories;
+    private _providersChanged;
+}

package/lib/providers/provider-registry.js

@@ -0,0 +1,155 @@
+import { Signal } from '@lumino/signaling';
+/**
+ * Implementation of the chat provider registry
+ */
+export class ChatProviderRegistry {
+    /**
+     * Get a copy of all registered providers
+     */
+    get providers() {
+        return { ...this._providers };
+    }
+    /**
+     * Signal emitted when providers are added or removed
+     */
+    get providersChanged() {
+        return this._providersChanged;
+    }
+    /**
+     * Register a new chat provider
+     * @param info Provider information including factory
+     */
+    registerProvider(info) {
+        this._providers[info.id] = { ...info };
+        this._factories[info.id] = info.factory;
+        this._providersChanged.emit();
+    }
+    /**
+     * Unregister a chat provider by ID
+     * @param id Provider ID to remove
+     * @returns true if provider was found and removed, false otherwise
+     */
+    unregisterProvider(id) {
+        if (id in this._providers) {
+            delete this._providers[id];
+            delete this._factories[id];
+            this._providersChanged.emit();
+            return true;
+        }
+        return false;
+    }
+    /**
+     * Get provider information by ID
+     * @param id Provider ID
+     * @returns Provider info or null if not found
+     */
+    getProviderInfo(id) {
+        return this._providers[id] || null;
+    }
+    /**
+     * Create a chat model instance using the specified provider
+     * @param id Provider ID
+     * @param options Model configuration options
+     * @returns Chat model instance or null if creation fails
+     */
+    createChatModel(id, options) {
+        const factory = this._factories[id];
+        if (!factory) {
+            return null;
+        }
+        try {
+            return factory(options);
+        }
+        catch (error) {
+            console.error(`Failed to create chat model for provider ${id}:`, error);
+            return null;
+        }
+    }
+    /**
+     * Get list of all available provider IDs
+     * @returns Array of provider IDs
+     */
+    getAvailableProviders() {
+        return Object.keys(this._providers);
+    }
+    _providers = {};
+    _factories = {};
+    _providersChanged = new Signal(this);
+}
+/**
+ * Implementation of the completion provider registry
+ */
+export class CompletionProviderRegistry {
+    /**
+     * Get a copy of all registered providers
+     */
+    get providers() {
+        return { ...this._providers };
+    }
+    /**
+     * Signal emitted when providers are added or removed
+     */
+    get providersChanged() {
+        return this._providersChanged;
+    }
+    /**
+     * Register a new completion provider
+     * @param info Provider information including factory
+     */
+    registerProvider(info) {
+        this._providers[info.id] = { ...info };
+        this._factories[info.id] = info.factory;
+        this._providersChanged.emit();
+    }
+    /**
+     * Unregister a completion provider by ID
+     * @param id Provider ID to remove
+     * @returns true if provider was found and removed, false otherwise
+     */
+    unregisterProvider(id) {
+        if (id in this._providers) {
+            delete this._providers[id];
+            delete this._factories[id];
+            this._providersChanged.emit();
+            return true;
+        }
+        return false;
+    }
+    /**
+     * Get provider information by ID
+     * @param id Provider ID
+     * @returns Provider info or null if not found
+     */
+    getProviderInfo(id) {
+        return this._providers[id] || null;
+    }
+    /**
+     * Create a completion model instance using the specified provider
+     * @param id Provider ID
+     * @param options Model configuration options
+     * @returns Language model instance or null if creation fails
+     */
+    createCompletionModel(id, options) {
+        const factory = this._factories[id];
+        if (!factory) {
+            return null;
+        }
+        try {
+            return factory(options);
+        }
+        catch (error) {
+            console.error(`Failed to create completion model for provider ${id}:`, error);
+            return null;
+        }
+    }
+    /**
+     * Get list of all available provider IDs
+     * @returns Array of provider IDs
+     */
+    getAvailableProviders() {
+        return Object.keys(this._providers);
+    }
+    _providers = {};
+    _factories = {};
+    _providersChanged = new Signal(this);
+}

package/lib/tokens.d.ts

@@ -1,145 +1,216 @@
-import { BaseChatModel } from '@langchain/core/language_models/chat_models';
-import { ReadonlyPartialJSONObject, Token } from '@lumino/coreutils';
+import { Token } from '@lumino/coreutils';
 import { ISignal } from '@lumino/signaling';
-import { JSONSchema7 } from 'json-schema';
-import { IBaseCompleter } from './base-completer';
-import { AIChatModel, AICompleter } from './types/ai-model';
-export declare const PLUGIN_IDS: {
-    chat: string;
-    chatCommandRegistry: string;
-    completer: string;
-    providerRegistry: string;
-    settingsConnector: string;
-    systemPrompts: string;
-};
-export type ModelRole = 'chat' | 'completer';
-export interface IDict<T = any> {
-    [key: string]: T;
-}
-export interface IType<T> {
-    new (...args: any[]): T;
+import { FunctionTool } from '@openai/agents';
+import { LanguageModel } from 'ai';
+import type { AISettingsModel } from './models/settings-model';
+import type { IModelOptions } from './providers/models';
+/**
+ * Type definition for a tool
+ */
+export type ITool = FunctionTool<any, any, any>;
+/**
+ * Interface for token usage statistics from AI model interactions
+ */
+export interface ITokenUsage {
+    /**
+     * Number of input tokens consumed (prompt tokens)
+     */
+    inputTokens: number;
+    /**
+     * Number of output tokens generated (completion tokens)
+     */
+    outputTokens: number;
 }
 /**
- * The provider interface.
+ * Interface for a named tool (tool with a name identifier)
  */
-export interface IAIProvider {
+export interface INamedTool {
     /**
-     * The name of the provider.
+     * The unique name of the tool
      */
     name: string;
     /**
-     * The chat model class to use.
+     * The tool instance
      */
-    chat?: IType<BaseChatModel>;
+    tool: ITool;
+}
+/**
+ * The tool registry interface for managing AI tools
+ */
+export interface IToolRegistry {
     /**
-     * The completer class to use.
+     * The registered tools as a record (name -> tool mapping).
      */
-    completer?: IType<IBaseCompleter>;
+    readonly tools: Record<string, ITool>;
     /**
-     * the settings schema for the provider.
+     * The registered named tools array.
      */
-    settingsSchema?: any;
+    readonly namedTools: INamedTool[];
     /**
-     * The instructions to be displayed in the settings, as helper to use the provider.
-     * A markdown renderer is used to render the instructions.
+     * A signal triggered when the tools have changed.
      */
-    instructions?: string;
+    readonly toolsChanged: ISignal<IToolRegistry, void>;
     /**
-     * A function that extract the error message from the provider API error.
-     * Default to `(error) => error.message`.
+     * Add a new tool to the registry.
      */
-    errorMessage?: (error: any) => string;
+    add(name: string, tool: ITool): void;
     /**
-     * Compatibility check function, to determine if the provider is compatible with the
-     * current environment.
+     * Get a tool for a given name.
+     * Return null if the name is not provided or if there is no registered tool with the
+     * given name.
      */
-    compatibilityCheck?: () => Promise<string | null>;
+    get(name: string | null): ITool | 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.
+     * Remove a tool from the registry by name.
      */
-    exposeChatModel?: boolean;
+    remove(name: string): boolean;
 }
 /**
- * The provider registry interface.
+ * The tool registry token.
+ */
+export declare const IToolRegistry: Token<IToolRegistry>;
+/**
+ * Token for the chat provider registry.
  */
-export interface IAIProviderRegistry {
+export declare const IChatProviderRegistry: Token<IChatProviderRegistry>;
+/**
+ * Token for the completion provider registry.
+ */
+export declare const ICompletionProviderRegistry: Token<ICompletionProviderRegistry>;
+/**
+ * Interface for a provider factory function that creates chat models
+ */
+export interface IChatProviderFactory {
+    (options: IModelOptions): any;
+}
+/**
+ * Interface for a provider factory function that creates completion models
+ */
+export interface ICompletionProviderFactory {
+    (options: IModelOptions): LanguageModel;
+}
+/**
+ * Base information about a registered provider
+ */
+export interface IBaseProviderInfo {
     /**
-     * Get the list of provider names.
+     * Unique identifier for the provider
      */
-    readonly providers: string[];
+    id: string;
     /**
-     * Add a new provider.
+     * Display name for the provider
      */
-    add(provider: IAIProvider): void;
+    name: string;
     /**
-     * Get the current provider name.
+     * Whether this provider requires an API key
      */
-    currentName(role: ModelRole): string;
+    requiresApiKey: boolean;
     /**
-     * Get the current completer of the completion provider.
+     * Default model names for this provider
      */
-    currentCompleter: AICompleter | null;
+    defaultModels: string[];
     /**
-     * Getter/setter for the completer system prompt.
+     * Whether this provider supports custom base URLs
      */
-    completerSystemPrompt: string;
+    supportsBaseURL?: boolean;
     /**
-     * Get the current llm chat model.
+     * Whether this provider supports custom headers
      */
-    currentChatModel: AIChatModel | null;
+    supportsHeaders?: boolean;
     /**
-     * Getter/setter for the chat system prompt.
+     * Whether this provider supports tool calling
      */
-    chatSystemPrompt: string;
+    supportsToolCalling?: boolean;
     /**
-     * Get the settings schema of a given provider.
+     * Additional provider-specific configuration schema
      */
-    getSettingsSchema(provider: string): JSONSchema7;
+    customSettings?: Record<string, any>;
+}
+/**
+ * Information about a chat provider
+ */
+export interface IChatProviderInfo extends IBaseProviderInfo {
+    /**
+     * Factory function for creating chat models
+     */
+    factory: IChatProviderFactory;
+}
+/**
+ * Information about a completion provider
+ */
+export interface ICompletionProviderInfo extends IBaseProviderInfo {
+    /**
+     * Factory function for creating completion models
+     */
+    factory: ICompletionProviderFactory;
+}
+/**
+ * Registry for chat AI providers
+ */
+export interface IChatProviderRegistry {
+    /**
+     * The registered providers as a record (id -> info mapping).
+     */
+    readonly providers: Record<string, IChatProviderInfo>;
     /**
-     * Get the instructions of a given provider.
+     * A signal triggered when providers have changed.
      */
-    getInstructions(provider: string): string | undefined;
+    readonly providersChanged: ISignal<IChatProviderRegistry, void>;
+    /**
+     * Register a new chat provider.
+     */
+    registerProvider(info: IChatProviderInfo): void;
+    /**
+     * Unregister a chat provider.
+     */
+    unregisterProvider(id: string): boolean;
+    /**
+     * Get provider info by id.
+     */
+    getProviderInfo(id: string): IChatProviderInfo | null;
+    /**
+     * Create a chat model instance for the given provider.
+     */
+    createChatModel(id: string, options: IModelOptions): any | null;
+    /**
+     * Get all available provider IDs.
+     */
+    getAvailableProviders(): string[];
+}
+/**
+ * Registry for completion providers
+ */
+export interface ICompletionProviderRegistry {
     /**
-     * Get the compatibility check function of a given provider.
+     * The registered providers as a record (id -> info mapping).
      */
-    getCompatibilityCheck(provider: string): (() => Promise<string | null>) | undefined;
+    readonly providers: Record<string, ICompletionProviderInfo>;
     /**
-     * Format an error message from the current provider.
+     * A signal triggered when providers have changed.
      */
-    formatErrorMessage(error: any): string;
+    readonly providersChanged: ISignal<ICompletionProviderRegistry, void>;
     /**
-     * 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.
+     * Register a new completion provider.
      */
-    setCompleterProvider(settings: ReadonlyPartialJSONObject): void;
+    registerProvider(info: ICompletionProviderInfo): 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.
+     * Unregister a completion provider.
      */
-    setChatProvider(settings: ReadonlyPartialJSONObject): void;
+    unregisterProvider(id: string): boolean;
     /**
-     * A signal emitting when the provider or its settings has changed.
+     * Get provider info by id.
      */
-    readonly providerChanged: ISignal<IAIProviderRegistry, ModelRole>;
+    getProviderInfo(id: string): ICompletionProviderInfo | null;
     /**
-     * Get the current chat error;
+     * Create a completion model instance for the given provider.
      */
-    readonly chatError: string;
+    createCompletionModel(id: string, options: IModelOptions): LanguageModel | null;
     /**
-     * get the current completer error.
+     * Get all available provider IDs.
      */
-    readonly completerError: string;
+    getAvailableProviders(): string[];
 }
 /**
- * The provider registry token.
+ * Token for the AI settings model.
  */
-export declare const IAIProviderRegistry: Token<IAIProviderRegistry>;
+export declare const IAISettingsModel: Token<AISettingsModel>;

package/lib/tokens.js

@@ -1,13 +1,17 @@
 import { Token } from '@lumino/coreutils';
-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',
-    systemPrompts: '@jupyterlite/ai:system-prompts'
-};
-/**
- * The provider registry token.
- */
-export const IAIProviderRegistry = new Token('@jupyterlite/ai:provider-registry', 'Provider for chat and completion LLM provider');
+/**
+ * The tool registry token.
+ */
+export const IToolRegistry = new Token('@jupyterlite/ai:tool-registry', 'Tool registry for AI agent functionality');
+/**
+ * Token for the chat provider registry.
+ */
+export const IChatProviderRegistry = new Token('@jupyterlite/ai:chat-provider-registry', 'Registry for chat AI providers');
+/**
+ * Token for the completion provider registry.
+ */
+export const ICompletionProviderRegistry = new Token('@jupyterlite/ai:completion-provider-registry', 'Registry for completion providers');
+/**
+ * Token for the AI settings model.
+ */
+export const IAISettingsModel = new Token('@jupyterlite/ai:IAISettingsModel');

package/lib/tools/commands.d.ts

@@ -0,0 +1,11 @@
+import { CommandRegistry } from '@lumino/commands';
+import { ITool } from '../tokens';
+import { AISettingsModel } from '../models/settings-model';
+/**
+ * Create a tool to discover all available commands and their metadata
+ */
+export declare function createDiscoverCommandsTool(commands: CommandRegistry): ITool;
+/**
+ * Create a tool to execute a specific JupyterLab command
+ */
+export declare function createExecuteCommandTool(commands: CommandRegistry, settingsModel: AISettingsModel): ITool;