@sinequa/assistant 3.6.2 → 3.7.1

package/chat/chat-message/chat-message.component.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter, OnChanges, SimpleChanges, ChangeDetectorRef, AfterViewInit, ElementRef } from "@angular/core";
 import { PrincipalWebService } from "@sinequa/core/web-services";
 import { SearchService } from "@sinequa/components/search";
-import { ChatContextAttachment, ChatMessage, SuggestedAction } from "../types";
+import { ChatContextAttachment, ChatMessage, ChatStarter, SuggestedAction } from "../types";
 import { Processor } from "unified";
 import { Node } from "unist";
 import { UIService } from "@sinequa/components/utils";
@@ -17,6 +17,7 @@ export declare class ChatMessageComponent implements OnChanges, AfterViewInit {
     message: ChatMessage;
     conversation: ChatMessage[];
     suggestedActions: SuggestedAction[] | undefined;
+    chatStarters: ChatStarter[] | undefined;
     assistantMessageIcon: string;
     userMessageIcon: string;
     connectionErrorMessageIcon: string;
@@ -37,6 +38,7 @@ export declare class ChatMessageComponent implements OnChanges, AfterViewInit {
         partId?: number | undefined;
     }>;
     suggestAction: EventEmitter<SuggestedAction>;
+    chatStarterClicked: EventEmitter<ChatStarter>;
     edit: EventEmitter<ChatMessage>;
     copy: EventEmitter<ChatMessage>;
     regenerate: EventEmitter<ChatMessage>;
@@ -79,5 +81,5 @@ export declare class ChatMessageComponent implements OnChanges, AfterViewInit {
     openOriginalAttachment(attachment: ChatContextAttachment, partId?: number): void;
     hideTooltip(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ChatMessageComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ChatMessageComponent, "sq-chat-message", never, { "message": "message"; "conversation": "conversation"; "suggestedActions": "suggestedActions"; "assistantMessageIcon": "assistantMessageIcon"; "userMessageIcon": "userMessageIcon"; "connectionErrorMessageIcon": "connectionErrorMessageIcon"; "searchWarningMessageIcon": "searchWarningMessageIcon"; "streaming": "streaming"; "canEdit": "canEdit"; "canRegenerate": "canRegenerate"; "canCopy": "canCopy"; "canDebug": "canDebug"; "canLike": "canLike"; "canDislike": "canDislike"; }, { "openDocument": "openDocument"; "openPreview": "openPreview"; "suggestAction": "suggestAction"; "edit": "edit"; "copy": "copy"; "regenerate": "regenerate"; "like": "like"; "dislike": "dislike"; "debug": "debug"; }, never, never, true>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ChatMessageComponent, "sq-chat-message", never, { "message": "message"; "conversation": "conversation"; "suggestedActions": "suggestedActions"; "chatStarters": "chatStarters"; "assistantMessageIcon": "assistantMessageIcon"; "userMessageIcon": "userMessageIcon"; "connectionErrorMessageIcon": "connectionErrorMessageIcon"; "searchWarningMessageIcon": "searchWarningMessageIcon"; "streaming": "streaming"; "canEdit": "canEdit"; "canRegenerate": "canRegenerate"; "canCopy": "canCopy"; "canDebug": "canDebug"; "canLike": "canLike"; "canDislike": "canDislike"; }, { "openDocument": "openDocument"; "openPreview": "openPreview"; "suggestAction": "suggestAction"; "chatStarterClicked": "chatStarterClicked"; "edit": "edit"; "copy": "copy"; "regenerate": "regenerate"; "like": "like"; "dislike": "dislike"; "debug": "debug"; }, never, never, true>;
 }

package/chat/chat.component.d.ts

@@ -4,9 +4,9 @@ import { AbstractFacet } from "@sinequa/components/facet";
 import { SearchService } from "@sinequa/components/search";
 import { AppService, Query } from "@sinequa/core/app-utils";
 import { PrincipalWebService } from "@sinequa/core/web-services";
-import { BehaviorSubject, Subscription } from "rxjs";
+import { BehaviorSubject } from "rxjs";
 import { ChatService } from "./chat.service";
-import { ChatContextAttachment, ChatConfig, ChatMessage, GllmModelDescription, MessageHandler, RawMessage, SuggestedAction, InitChat, DebugMessage } from "./types";
+import { ChatContextAttachment, ChatConfig, ChatMessage, GllmModelDescription, MessageHandler, RawMessage, SuggestedAction, InitChat, DebugMessage, ChatStarter } from "./types";
 import { InstanceManagerService } from "./instance-manager.service";
 import { WebSocketChatService } from "./websocket-chat.service";
 import { LoginService } from "@sinequa/core/login";
@@ -945,6 +945,8 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
     messageHandlers: Map<string, MessageHandler<any>>;
     /** When the assistant answer a user question, automatically scroll down to the bottom of the discussion */
     automaticScrollToLastResponse: boolean;
+    /** When the assistant answer a user question, automatically focus to the chat input */
+    focusAfterResponse: boolean;
     /** A chat discussion that the component should get initialized with it */
     chat?: InitChat;
     /** Icon to use for the assistant messages */
@@ -1073,10 +1075,14 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
     openPreview: EventEmitter<ChatContextAttachment>;
     /** Event emitter triggered when the user clicks on a suggested action */
     suggestAction: EventEmitter<SuggestedAction>;
+    /** Event emitter triggered when the user clicks on a chat starter */
+    chatStarter: EventEmitter<ChatStarter>;
+    /** ViewChild decorators to access the template elements */
     messageList?: ElementRef<HTMLUListElement>;
     questionInput?: ElementRef<HTMLTextAreaElement>;
+    /** ContentChild decorators allowing the override of the default templates from the parent component */
     loadingTpl?: TemplateRef<any>;
-    reportIssueTpl?: TemplateRef<any>;
+    reportTpl?: TemplateRef<any>;
     tokenConsumptionTpl?: TemplateRef<any>;
     debugMessagesTpl?: TemplateRef<any>;
     chatService: ChatService;
@@ -1084,11 +1090,13 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
     messages$: BehaviorSubject<ChatMessage[] | undefined>;
     question: string;
     _actions: Action[];
-    sub: Subscription;
-    dataSubscription: Subscription | undefined;
+    private _resetChatAction;
+    private _sub;
+    private _dataSubscription;
     /** Variables that depend on the type of model in use */
     modelDescription?: GllmModelDescription;
     messageToEdit?: number;
+    remappedMessageToEdit?: number;
     changes$: BehaviorSubject<SimpleChanges | undefined>;
     currentMessageIndex: number | undefined;
     firstChangesHandled: boolean;
@@ -1101,35 +1109,81 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
     issueTypes?: string[];
     defaultIssueTypes: string[];
     issueType: string;
-    issueComment?: string;
-    messageRelatedIssue?: ChatMessage;
-    issueRank?: number;
-    showReportIssue: boolean;
+    reportComment?: string;
+    messageToReport?: ChatMessage;
+    reportRank?: number;
+    reportType: 'like' | 'dislike';
+    showReport: boolean;
     debugMessages: DebugMessage[] | undefined;
     showDebugMessages: boolean;
     private _previousQuery;
+    private _reloadSubscription;
     constructor();
     ngOnInit(): void;
     ngOnChanges(changes: SimpleChanges): void;
     ngOnDestroy(): void;
     get isAdmin(): boolean;
+    get visibleMessagesCount(): number;
     /**
      * Instantiate the chat service based on the provided @input protocol
      * This chat service instance will then be stored in the instanceManagerService with provided @input instanceId as a key
      */
     instantiateChatService(): void;
     get actions(): Action[];
+    /**
+     * 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.
+     */
     private _handleChanges;
+    /**
+     * 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.
+     */
     private _triggerReloadAfterQueryChange;
+    /**
+     * 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.
+     */
     private _addScrollListener;
+    /**
+     * Get the model description based on the defaultValues service_id and model_id
+     */
     updateModelDescription(): void;
+    /**
+     * 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(): void;
+    /**
+     * 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.
+     */
     private _fetchAnswer;
     /**
      * 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: ChatMessage[]): void;
     /**
@@ -1150,7 +1204,13 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
      * @param messages
      */
     updateData(messages: ChatMessage[]): void;
+    /**
+     * @returns true if the chat discussion is scrolled down to the bottom, false otherwise
+     */
     private _toggleScrollButtonVisibility;
+    /**
+     * Scroll down to the bottom of the chat discussion
+     */
     scrollDown(): void;
     /**
      * Start a new chat with the defaultValues settings
@@ -1158,6 +1218,14 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
      * If the savedChat feature is enabled, the list of saved chats will be refreshed
      */
     newChat(): void;
+    /**
+     * 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: string[]): void;
     /**
      * 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
@@ -1183,7 +1251,20 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
      * The fetch subscription will be terminated
      */
     resetChat(): void;
+    /**
+     * 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(): void;
+    /**
+     * Stop the generation of the current assistant's answer.
+     * The fetch subscription will be terminated.
+     */
+    stopGeneration(): void;
+    /**
+     * 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(): void;
     /**
      * Copy a previous user message of the chat history to the chat user input.
@@ -1204,28 +1285,46 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
      * @param index The index of the assistant's message to regenerate
      */
     regenerateMessage(index: number): void;
+    /**
+     * Remaps the index in the chat history.
+     * The chat history is a list of messages where some messages can be hidden (display set to false).
+     * The index provided as input is the index of the message in the chat history displayed in the UI.
+     * This function should be removed once the backend is updated to add the ids of the messages in the chat history
+     * @param index - The index to be remapped.
+     */
+    private _remapIndexInChatHistory;
+    /**
+     * Handles the key up event for 'Backspace' and 'Enter' keys.
+     * @param event - The keyboard event.
+     */
     onKeyUp(event: KeyboardEvent): void;
+    /**
+     * 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?: KeyboardEvent): void;
     /**
      * Send a "like" event on clicking on the thumb-up icon of an assistant's message
+     * @param message The assistant message to like
      * @param rank The rank of the message to like
      */
-    onLike(rank: number): void;
+    onLike(message: ChatMessage, rank: number): void;
     /**
      * Send a "dislike" event on clicking on the thumb-down icon of an assistant's message.
      * It also opens the issue reporting dialog.
      * @param message The assistant message to dislike
-     * @param rank The rank of the message to dislike
+     * @param index The rank of the message to dislike
      */
     onDislike(message: ChatMessage, rank: number): void;
     /**
      * Report an issue related to the assistant's message.
      */
-    sendIssue(): void;
+    sendReport(): void;
     /**
-     * Close the issue reporting dialog.
+     * Close the reporting dialog.
      */
-    ignoreIssue(): void;
+    ignoreReport(): void;
     /**
      * Handle the click on a reference's 'open preview'.
      * @param data
@@ -1248,11 +1347,31 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
      * @param index Rank of the message in the chatHistory related to the suggested action.
      */
     suggestActionClick(action: SuggestedAction, index: number): void;
+    /**
+     * Handle the click on a chat starter.
+     * @param starter the chat starter.
+     */
+    chatStarterClick(starter: ChatStarter): void;
+    /**
+     * It looks for the debug messages available in the current group of "assistant" messages.
+     * By design, the debug messages are only available in the first visible message among the group "assistant" messages.
+     * @param index The rank of the message
+     * @returns The debug messages available in the current group of "assistant" messages
+     */
+    getDebugMessages(index: number): DebugMessage[];
     /**
      * Handle the click on the 'show log info' button of a message.
-     * @param message The message of the ChatHistory to show its debug messages
+     * @param index The rank of the message
+     */
+    showDebug(index: number): void;
+    /**
+     * Verify whether the current message is an assistant message and that all following messages are assistant ones
+     * Used to keep the "View progress" opened even though the assistant is sending additional messages after the current one
+     * @param messages the list of current messages
+     * @param index the index of the current message
+     * @returns if this messages and the following ones (if any) are the last ones
      */
-    showDebug(message: ChatMessage): void;
+    isAssistantLastMessages(messages: ChatMessage[], index: number): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<ChatComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ChatComponent, "sq-chat-v3", never, { "instanceId": "instanceId"; "query": "query"; "queryChangeShouldTriggerReload": "queryChangeShouldTriggerReload"; "protocol": "protocol"; "messageHandlers": "messageHandlers"; "automaticScrollToLastResponse": "automaticScrollToLastResponse"; "chat": "chat"; "assistantMessageIcon": "assistantMessageIcon"; "userMessageIcon": "userMessageIcon"; "connectionErrorMessageIcon": "connectionErrorMessageIcon"; "searchWarningMessageIcon": "searchWarningMessageIcon"; }, { "connection": "connection"; "loading$": "loading"; "_config": "config"; "data": "data"; "openDocument": "openDocument"; "openPreview": "openPreview"; "suggestAction": "suggestAction"; }, ["loadingTpl", "reportIssueTpl", "tokenConsumptionTpl", "debugMessagesTpl"], never, true>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ChatComponent, "sq-chat-v3", never, { "instanceId": "instanceId"; "query": "query"; "queryChangeShouldTriggerReload": "queryChangeShouldTriggerReload"; "protocol": "protocol"; "messageHandlers": "messageHandlers"; "automaticScrollToLastResponse": "automaticScrollToLastResponse"; "focusAfterResponse": "focusAfterResponse"; "chat": "chat"; "assistantMessageIcon": "assistantMessageIcon"; "userMessageIcon": "userMessageIcon"; "connectionErrorMessageIcon": "connectionErrorMessageIcon"; "searchWarningMessageIcon": "searchWarningMessageIcon"; }, { "connection": "connection"; "loading$": "loading"; "_config": "config"; "data": "data"; "openDocument": "openDocument"; "openPreview": "openPreview"; "suggestAction": "suggestAction"; "chatStarter": "chatStarter"; }, ["loadingTpl", "reportTpl", "tokenConsumptionTpl", "debugMessagesTpl"], never, true>;
 }

package/chat/chat.service.d.ts

@@ -17,7 +17,11 @@ export declare abstract class ChatService {
     initConfig$: BehaviorSubject<boolean>;
     /** Global configuration of the chat. */
     chatConfig$: BehaviorSubject<ChatConfig | undefined>;
-    /** Streaming status of the chat endpoint. */
+    /**
+     * Emit true if the fetch of an assistant's response is ongoing (it includes Streaming status of the chat endpoint AND saving the discussion if save Chat is enabled).
+     * This is used to prevent multiple fetches at the same time.
+     * Typically, there is no problem chaining fetches, but when forcing a reload after query changes cases, it can't be allowed because it breaks the whole business logic.
+    */
     streaming$: BehaviorSubject<boolean>;
     /** Store the messages history of the current chat. */
     chatHistory: ChatMessage[] | undefined;
@@ -37,6 +41,8 @@ export declare abstract class ChatService {
     chatUsageMetrics$: BehaviorSubject<ChatUsageMetrics | undefined>;
     /** Emit the calculated chat's token consumption based on the chat usage metrics. */
     chatTokenConsumption$: BehaviorSubject<TokenConsumption | undefined>;
+    /** Emit true if "CancelTasks" is ongoing. */
+    stoppingGeneration$: BehaviorSubject<boolean>;
     /** Instance ID of the chat service defining the assistant instance. */
     private _chatInstanceId;
     /** ID of the current **saved chat** discussion which is used to update/get/delete it. */
@@ -126,6 +132,10 @@ export declare abstract class ChatService {
      * Return the list of functions available on the server AND matching enabled functions in the chat config
      */
     abstract listFunctions(): Observable<GllmFunction[] | undefined>;
+    /**
+     * Stops the assistant answer generation and cancels all the ongoing and pending related tasks
+     */
+    abstract stopGeneration(): Observable<any>;
     /**
      * A handler for quota updates each time the chat is invoked.
      * It emits the updated quota to the quota$ subject, emits accordingly the updated user's tokens consumption and notifies the user if the max quota is reached.
@@ -183,6 +193,18 @@ export declare abstract class ChatService {
      * @param id Actions (savedChat delete/rename/...) may occur on a specific chat different than the current one stored in this service, so the chat id can be provided
      */
     generateAuditEvent(type: string, details: Record<string, any>, id?: string): void;
+    /**
+     * Traverse the array from the end and track the first 'assistant' message among the last group of "assistant" messages where display is true
+     * @param array The array of ChatMessage to traverse
+     * @returns The index of the first visible assistant message among the last group of "assistant" messages in the array
+     */
+    firstVisibleAssistantMessageIndex(array: ChatMessage[] | undefined): number;
+    /**
+     * Traverse the array from the end and pick the last 'assistant' message among the last group of "assistant" messages where display is true
+     * @param array The array of ChatMessage to traverse
+     * @returns The index of the last visible assistant message among the last group of "assistant" messages in the array
+     */
+    lastVisibleAssistantMessageIndex(array: ChatMessage[] | undefined): number;
     /**
      * Format a date string in UTC to a local date string
      * @param value Date string in UTC to format

package/chat/rest-chat.service.d.ts

@@ -21,6 +21,7 @@ export declare class RestChatService extends ChatService {
     listModels(): Observable<GllmModelDescription[] | undefined>;
     listFunctions(): Observable<GllmFunction[] | undefined>;
     fetch(messages: ChatMessage[], query: Query): Observable<ChatResponse>;
+    stopGeneration(): Observable<any>;
     listSavedChat(): void;
     addSavedChat(messages: ChatMessage[]): Observable<SavedChat>;
     getSavedChat(id: string): Observable<SavedChatHistory | undefined>;

package/chat/saved-chats/saved-chats.component.d.ts

@@ -27,8 +27,8 @@ export declare class SavedChatsComponent implements OnInit, OnDestroy {
     instantiateChatService(): void;
     onListSavedChat(): void;
     onLoad(savedChat: SavedChat): void;
-    onRename(savedChat: SavedChat): void;
-    onDelete(savedChat: SavedChat): void;
+    onRename(event: Event, savedChat: SavedChat): void;
+    onDelete(event: Event, savedChat: SavedChat): void;
     private _groupSavedChatsByDate;
     private _getTimeKey;
     static ɵfac: i0.ɵɵFactoryDeclaration<SavedChatsComponent, never>;

package/chat/styles/assistant.scss

@@ -33,6 +33,8 @@ $ast-saved-chat-hover-background: var(--ast-saved-chat-hover-background, #FFF8F1
 $ast-input-bg: var(--ast-input-bg, #F8F8F8);
 $ast-input-color: var(--ast-input-color, #B0B0B0);
 $ast-muted-color: var(--ast-muted-color, rgba(33, 37, 41, 0.75));
+$ast-action-buttons-color: var(--ast-action-buttons-color, #212529);
+$ast-action-buttons-hover-color: var(--ast-action-buttons-hover-color, var(--ast-primary-color, #005DA7));
 
 /****************************************************
     classes
@@ -58,6 +60,7 @@ $ast-muted-color: var(--ast-muted-color, rgba(33, 37, 41, 0.75));
 
 .ast-error {
   background-color: $ast-error-bg;
+  color: var(--ast-action-buttons-color, inherit);
 
   &:hover {
     color: $ast-error-color;
@@ -90,4 +93,6 @@ $ast-muted-color: var(--ast-muted-color, rgba(33, 37, 41, 0.75));
     --ast-reference-passages-color: white;
     --ast-reference-expanded-hover-bg: #262421;
     --ast-message-reference-color: black;
+    --ast-action-buttons-color: white;
+    --ast-action-buttons-hover-color: #6dbee6;
 }