@sinequa/assistant 3.7.0 → 3.7.1

package/fesm2020/sinequa-assistant-chat.mjs

@@ -66,7 +66,7 @@ class InstanceManagerService {
      */
     getInstance(key) {
         if (!this.checkInstance(key)) {
-            throw new Error(`No chat instance found for the given key : '${key}'`);
+            throw new Error(`No assistant instance found for the given key : '${key}'`);
         }
         return this._serviceInstances.get(key);
     }
@@ -225,10 +225,6 @@ const uiSettingsSchema = z.object({
     displaySystemPrompt: z.boolean(),
     displayUserPrompt: z.boolean()
 });
-// Define the Zod representation for the chatStarter object
-const chatStarterSchema = z.object({
-    text: z.string()
-});
 // Define the Zod representation for the defaultValues object
 const defaultValuesSchema = z.object({
     service_id: z.string(),
@@ -244,6 +240,15 @@ const defaultValuesSchema = z.object({
     systemPrompt: z.string(),
     userPrompt: z.string()
 });
+// Define the Zod representation for the chatStarter object
+const chatStarterSchema = z.object({
+    text: z.string()
+});
+// Define the Zod representation for the action object
+const actionSchema = z.object({
+    forcedWorkflow: z.string(),
+    forcedWorkflowProperties: z.record(z.unknown()).optional() // forcedWorkflowProperties must be an object (Map equivalent)
+});
 // Define the Zod representation for the modeSettings object
 const initializationSchema = z.object({
     event: z.enum(['Query', 'Prompt']),
@@ -257,7 +262,8 @@ const modeSettingsSchema = z.object({
     enabledUserInput: z.boolean(),
     displayUserPrompt: z.boolean(),
     sendUserPrompt: z.boolean(),
-    initialization: initializationSchema
+    initialization: initializationSchema,
+    actions: z.record(actionSchema).optional()
 }).refine(data => !(data.initialization.chatStarters?.length && (data.sendUserPrompt || data.displayUserPrompt || data.initialization.event === 'Query')), {
     message: "Incompatible configuration for using chatStarters ('sendUserPrompt' and 'displayUserPrompt' must be false, 'initialization.event' must not be 'Query')",
 });
@@ -2108,7 +2114,7 @@ class ChatComponent extends AbstractFacet {
         this._actions = [];
         this._resetChatAction = new Action({
             icon: 'fas fa-sync',
-            title: "Reset chat",
+            title: "Reset assistant",
             action: () => this.newChat()
         });
         this._sub = new Subscription();
@@ -2177,6 +2183,9 @@ class ChatComponent extends AbstractFacet {
         this._sub.unsubscribe();
         this._dataSubscription?.unsubscribe();
         this._reloadSubscription?.unsubscribe();
+        if (this.chatService instanceof WebSocketChatService) {
+            this.chatService.stopConnection();
+        }
     }
     get isAdmin() {
         return this.principalService.principal?.isAdministrator || false;
@@ -2203,6 +2212,17 @@ class ChatComponent extends AbstractFacet {
         this.instanceManagerService.storeInstance(this.instanceId, this.chatService);
     }
     get actions() { return this._actions; }
+    /**
+     * Handles the changes in the chat component.
+     * If the chat service is a WebSocketChatService, it handles the override of the message handlers if they exist.
+     * Initializes the chat with the provided chat messages if they exist, otherwise loads the default chat.
+     * If the chat is initialized, the initialization event is "Query", the query changes, and the queryChangeShouldTriggerReload function is provided,
+     * then the chat should be reloaded if the function returns true. Otherwise, the chat should be reloaded by default.
+     * It takes into account the ongoing streaming process and the ongoing stopping process to trigger that conditionally define the logic
+     * of the reload :
+     * - If the chat is streaming, then stop the generation and wait for the fetch to complete before reloading the chat.
+     * - If the chat is stopping the generation, then wait for the fetch to complete before reloading the chat.
+     */
     _handleChanges() {
         const changes = this.changes$.value;
         // If the chat service is a WebSocketChatService, handle the override of the message handlers if exists
@@ -2294,6 +2314,12 @@ class ChatComponent extends AbstractFacet {
             }
         }
     }
+    /**
+     * Triggers a reload after the query change.
+     * This method performs the necessary operations to reload the chat after a query change.
+     * It sets the system and user messages, resets the savedChatId, generates a new chatId,
+     * generates a new chat audit event, and handles the query mode.
+     */
     _triggerReloadAfterQueryChange() {
         const systemMsg = { role: 'system', content: this.config.defaultValues.systemPrompt, additionalProperties: { display: false } };
         const userMsg = { role: 'user', content: ChatService.formatPrompt(this.config.defaultValues.userPrompt, { principal: this.principalService.principal }), additionalProperties: { display: this.config.modeSettings.displayUserPrompt } };
@@ -2302,18 +2328,37 @@ class ChatComponent extends AbstractFacet {
         this.chatService.generateAuditEvent('new-chat', { 'configuration': JSON.stringify(this.chatService.chatConfig$.value) }); // Generate a new chat audit event
         this._handleQueryMode(systemMsg, userMsg);
     }
+    /**
+     * Adds a scroll listener to the message list element.
+     * The listener is triggered when any of the following events occur:
+     * - Loading state changes
+     * - Messages change
+     * - Streaming state changes
+     * - Scroll event occurs on the message list element
+     *
+     * When the listener is triggered, it updates the `isAtBottom` property.
+     */
     _addScrollListener() {
         this._sub.add(merge(this.loading$, this.messages$, this.chatService.streaming$, fromEvent(this.messageList.nativeElement, 'scroll')).subscribe(() => {
             this.isAtBottom = this._toggleScrollButtonVisibility();
             this.cdr.detectChanges();
         }));
     }
+    /**
+     * Get the model description based on the defaultValues service_id and model_id
+     */
     updateModelDescription() {
         this.modelDescription = this.chatService.getModel(this.config.defaultValues.service_id, this.config.defaultValues.model_id);
         this.cdr.detectChanges();
     }
+    /**
+     * Submits a question from the user.
+     * If the user is editing a previous message, removes all subsequent messages from the chat history.
+     * Triggers the fetch of the answer for the submitted question by calling _fetchAnswer().
+     * Clears the input value in the UI.
+     */
     submitQuestion() {
-        if (this.chatService.streaming$.value) {
+        if (!!this.chatService.streaming$.value || !!this.chatService.stoppingGeneration$.value) {
             return;
         }
         if (this.question.trim() && this.messages$.value && this.chatService.chatHistory) {
@@ -2337,6 +2382,13 @@ class ChatComponent extends AbstractFacet {
             this.questionInput.nativeElement.style.height = `auto`;
         }
     }
+    /**
+     * Triggers the fetch of the answer for the given question and updates the conversation.
+     * Generates an audit event for the user input.
+     *
+     * @param question - The question asked by the user.
+     * @param conversation - The current conversation messages.
+     */
     _fetchAnswer(question, conversation) {
         const userMsg = { role: 'user', content: question, additionalProperties: { display: true, isUserInput: true, additionalWorkflowProperties: this.config.additionalWorkflowProperties } };
         const messages = [...conversation, userMsg];
@@ -2348,7 +2400,7 @@ class ChatComponent extends AbstractFacet {
      * Depending on the connection's state :
      *  - If connected => given a list of messages, the chat endpoint is invoked for a continuation and updates the list of messages accordingly.
      *  - If any other state => a connection error message is displayed in the chat.
-     * @param messages
+     * @param messages The list of messages to invoke the chat endpoint with
      */
     fetch(messages) {
         this._updateConnectionStatus();
@@ -2472,12 +2524,18 @@ class ChatComponent extends AbstractFacet {
             this.scrollDown();
         }
     }
+    /**
+     * @returns true if the chat discussion is scrolled down to the bottom, false otherwise
+     */
     _toggleScrollButtonVisibility() {
         if (this.messageList?.nativeElement) {
             return Math.round(this.messageList?.nativeElement.scrollHeight - this.messageList?.nativeElement.scrollTop - 1) <= this.messageList?.nativeElement.clientHeight;
         }
         return true;
     }
+    /**
+     * Scroll down to the bottom of the chat discussion
+     */
     scrollDown() {
         setTimeout(() => {
             if (this.messageList?.nativeElement) {
@@ -2501,6 +2559,30 @@ class ChatComponent extends AbstractFacet {
         this.chatService.generateAuditEvent('new-chat', { 'configuration': JSON.stringify(this.chatService.chatConfig$.value) }); // Generate a new chat audit event
         this.loadDefaultChat(); // Start a new chat
     }
+    /**
+     * Attaches the specified document IDs to the assistant.
+     * If the chat is streaming or stopping the generation, the operation is not allowed.
+     * If no document IDs are provided, the operation is not allowed.
+     * If the action for attaching a document is not defined at the application customization level, an error is logged.
+     * @param ids - An array of document IDs to attach.
+     */
+    attachToChat(ids) {
+        if (!!this.chatService.streaming$.value || !!this.chatService.stoppingGeneration$.value) {
+            return;
+        }
+        if (!ids || ids?.length < 1) {
+            return;
+        }
+        const attachDocAction = this.config.modeSettings.actions?.["attachDocAction"];
+        if (!attachDocAction) {
+            console.error(`No action is defined for attaching a document to the assistant "${this.instanceId}"`);
+            return;
+        }
+        const userMsg = { role: 'user', content: '', additionalProperties: { display: false, isUserInput: false, type: "Action", forcedWorkflow: attachDocAction.forcedWorkflow, forcedWorkflowProperties: { ...(attachDocAction.forcedWorkflowProperties || {}), ids }, additionalWorkflowProperties: this.config.additionalWorkflowProperties } };
+        const messages = [...this.chatService.chatHistory, userMsg];
+        this.messages$.next(messages);
+        this.fetch(messages);
+    }
     /**
      * Start the default chat with the defaultValues settings
      * If the chat is meant to be initialized with event === "Query", the corresponding user query message will be added to the chat history
@@ -2560,7 +2642,7 @@ class ChatComponent extends AbstractFacet {
      */
     openChat(messages, savedChatId) {
         if (!messages || !Array.isArray(messages)) {
-            console.error('Error occurs while trying to load the chat discussion. Invalid messages received :', messages);
+            console.error('Error occurs while trying to load the discussion. Invalid messages received :', messages);
             return;
         }
         if (savedChatId) {
@@ -2593,14 +2675,26 @@ class ChatComponent extends AbstractFacet {
         this.question = '';
         this.terminateFetch();
     }
+    /**
+     * Fetch and Load the saved chat from the saved chat index.
+     * If the saved chat is found, the chat discussion will be loaded with the provided messages and chatId
+     */
     onLoadChat() {
         this.loading$.next(true);
         this._sub.add(this.chatService.loadSavedChat$
             .pipe(filter(savedChat => !!savedChat), switchMap(savedChat => this.chatService.getSavedChat(savedChat.id)), filter(savedChatHistory => !!savedChatHistory), tap(savedChatHistory => this.openChat(savedChatHistory.history, savedChatHistory.id))).subscribe());
     }
+    /**
+     * Stop the generation of the current assistant's answer.
+     * The fetch subscription will be terminated.
+     */
     stopGeneration() {
         this.chatService.stopGeneration().subscribe(() => this.terminateFetch());
     }
+    /**
+     * Terminate the fetch process by unsubscribing from the data subscription and updating the loading status to false.
+     * Additionally, focus on the chat input if the focusAfterResponse flag is set to true.
+     */
     terminateFetch() {
         this._dataSubscription?.unsubscribe();
         this._dataSubscription = undefined;
@@ -2680,6 +2774,10 @@ class ChatComponent extends AbstractFacet {
         // return the index of the message in the filtered history
         return filteredHistory[index - numberOfHiddenMessagesInMessages$BeforeIndex].additionalProperties.rank;
     }
+    /**
+     * Handles the key up event for 'Backspace' and 'Enter' keys.
+     * @param event - The keyboard event.
+     */
     onKeyUp(event) {
         switch (event.key) {
             case 'Backspace':
@@ -2696,6 +2794,11 @@ class ChatComponent extends AbstractFacet {
                 break;
         }
     }
+    /**
+     * Calculates and adjusts the height of the question input element based on its content.
+     * If the Enter key is pressed without the Shift key, it prevents the default behavior.
+     * @param event The keyboard event
+     */
     calculateHeight(event) {
         if (event?.key === 'Enter' && !event.shiftKey) {
             event?.preventDefault();