@jupyterlite/ai 0.8.1 → 0.9.0-a0

package/lib/chat-model.d.ts

@@ -0,0 +1,195 @@
+import { AbstractChatModel, IActiveCellManager, IChatContext, INewMessage, IUser } from '@jupyter/chat';
+import { IDocumentManager } from '@jupyterlab/docmanager';
+import { AgentManager } from './agent';
+import { AISettingsModel } from './models/settings-model';
+/**
+ * AI Chat Model implementation that provides chat functionality with OpenAI agents,
+ * tool integration, and MCP server support.
+ * Extends the base AbstractChatModel to provide AI-powered conversations.
+ */
+export declare class AIChatModel extends AbstractChatModel {
+    /**
+     * Constructs a new AIChatModel instance.
+     * @param options Configuration options for the chat model
+     */
+    constructor(options: AIChatModel.IOptions);
+    /**
+     * Gets the current user information.
+     */
+    get user(): IUser;
+    get tokenUsageChanged(): import("@lumino/signaling").ISignal<AgentManager, import("./tokens").ITokenUsage>;
+    /**
+     * Creates a chat context for the current conversation.
+     */
+    createChatContext(): AIChatModel.IAIChatContext;
+    /**
+     * Stops the current streaming response by aborting the request.
+     */
+    stopStreaming: () => void;
+    /**
+     * Clears all messages from the chat and resets conversation state.
+     */
+    clearMessages: () => void;
+    /**
+     * Sends a message to the AI and generates a response.
+     * @param message The user message to send
+     */
+    sendMessage(message: INewMessage): Promise<void>;
+    /**
+     * Approves a tool call and updates the UI accordingly.
+     * @param interruptionId The interruption ID to approve
+     * @param messageId Optional message ID for UI updates
+     */
+    approveToolCall(interruptionId: string, messageId?: string): Promise<void>;
+    /**
+     * Rejects a tool call and updates the UI accordingly.
+     * @param interruptionId The interruption ID to reject
+     * @param messageId Optional message ID for UI updates
+     */
+    rejectToolCall(interruptionId: string, messageId?: string): Promise<void>;
+    /**
+     * Approves all tools in a group.
+     * @param groupId The group ID containing the tool calls
+     * @param interruptionIds Array of interruption IDs to approve
+     * @param messageId Optional message ID for UI updates
+     */
+    approveGroupedToolCalls(groupId: string, interruptionIds: string[], messageId?: string): Promise<void>;
+    /**
+     * Rejects all tools in a group.
+     * @param groupId The group ID containing the tool calls
+     * @param interruptionIds Array of interruption IDs to reject
+     * @param messageId Optional message ID for UI updates
+     */
+    rejectGroupedToolCalls(groupId: string, interruptionIds: string[], messageId?: string): Promise<void>;
+    /**
+     * Gets the AI user information for system messages.
+     */
+    private _getAIUser;
+    /**
+     * Handles settings changes and updates chat configuration accordingly.
+     */
+    private _onSettingsChanged;
+    /**
+     * Handles events emitted by the agent manager.
+     * @param event The event data containing type and payload
+     */
+    private _onAgentEvent;
+    /**
+     * Handles the start of a new message from the AI agent.
+     * @param event Event containing the message start data
+     */
+    private _handleMessageStart;
+    /**
+     * Handles streaming message chunks from the AI agent.
+     * @param event Event containing the message chunk data
+     */
+    private _handleMessageChunk;
+    /**
+     * Handles the completion of a message from the AI agent.
+     * @param event Event containing the message completion data
+     */
+    private _handleMessageComplete;
+    /**
+     * Handles the start of a tool call execution.
+     * @param event Event containing the tool call start data
+     */
+    private _handleToolCallStartEvent;
+    /**
+     * Handles the completion of a tool call execution.
+     * @param event Event containing the tool call completion data
+     */
+    private _handleToolCallCompleteEvent;
+    /**
+     * Handles tool approval requests from the AI agent.
+     * @param event Event containing the tool approval request data
+     */
+    private _handleToolApprovalRequired;
+    /**
+     * Handles grouped tool approval requests from the AI agent.
+     * @param event Event containing the grouped tool approval request data
+     */
+    private _handleGroupedApprovalRequired;
+    /**
+     * Handles error events from the AI agent.
+     * @param event Event containing the error information
+     */
+    private _handleErrorEvent;
+    /**
+     * Processes file attachments and returns their content as formatted strings.
+     * @param attachments Array of file attachments to process
+     * @returns Array of formatted attachment contents
+     */
+    private _processAttachments;
+    /**
+     * Reads the content of a file attachment.
+     * @param attachment The file attachment to read
+     * @returns File content as string or null if unable to read
+     */
+    private _readFileAttachment;
+    /**
+     * Updates the status display of a grouped approval message.
+     * @param messageId The message ID to update
+     * @param status The status text to display
+     * @param isSuccess Whether the action was successful
+     */
+    private _updateGroupedApprovalStatus;
+    /**
+     * Updates the status display of a tool call box.
+     * @param messageId The message ID to update
+     * @param status The status text to display
+     * @param isSuccess Whether the action was successful
+     */
+    private _updateToolCallBoxStatus;
+    private _settingsModel;
+    private _user;
+    private _pendingToolCalls;
+    private _agentManager;
+    private _currentStreamingMessage;
+}
+/**
+ * Namespace containing types and interfaces for AIChatModel.
+ */
+export declare namespace AIChatModel {
+    /**
+     * Configuration options for constructing an AIChatModel instance.
+     */
+    interface IOptions {
+        /**
+         * The user information for the chat
+         */
+        user: IUser;
+        /**
+         * Settings model for AI configuration
+         */
+        settingsModel: AISettingsModel;
+        /**
+         * Optional agent manager for handling AI agent lifecycle
+         */
+        agentManager: AgentManager;
+        /**
+         * Optional active cell manager for Jupyter integration
+         */
+        activeCellManager?: IActiveCellManager;
+        /**
+         * Optional document manager for file operations
+         */
+        documentManager?: IDocumentManager;
+    }
+    /**
+     * The chat context for toolbar buttons.
+     */
+    interface IAIChatContext extends IChatContext {
+        /**
+         * The stop streaming callback.
+         */
+        stopStreaming: () => void;
+        /**
+         * The clear messages callback.
+         */
+        clearMessages: () => void;
+        /**
+         * The agent manager of the chat.
+         */
+        agentManager: AgentManager;
+    }
+}