@sinequa/assistant 3.9.2 → 3.9.4

package/chat/chat.component.d.ts

@@ -4,22 +4,20 @@ import { BehaviorSubject } from "rxjs";
 import { AppGlobalConfig, Article, Query } from "@sinequa/atomic";
 import { ChatService } from "./chat.service";
 import { InstanceManagerService } from "./instance-manager.service";
-import { RestChatService } from "./rest-chat.service";
 import { NotificationsService } from "./services/notification.service";
 import { PrincipalService } from "./services/principal.service";
 import { SearchService } from "./services/search.service";
 import { ChatConfig, ChatContextAttachment, ChatMessage, DebugMessage, GllmModelDescription, InitChat, MessageHandler, RawMessage, SuggestedAction } from "./types";
-import { WebSocketChatService } from "./websocket-chat.service";
 import * as i0 from "@angular/core";
 export declare class ChatComponent implements OnInit, OnChanges, OnDestroy {
-    websocketService: WebSocketChatService;
-    restService: RestChatService;
+    chatService: ChatService;
     instanceManagerService: InstanceManagerService;
     searchService: SearchService;
     principalService: PrincipalService;
     cdr: ChangeDetectorRef;
     notificationsService: NotificationsService;
     private readonly transloco;
+    private readonly assistantUtils;
     /** Define the key based on it, the chat service instance will be stored */
     instanceId: string;
     /** Define the query to use to fetch answers */
@@ -31,8 +29,6 @@ export declare class ChatComponent implements OnInit, OnChanges, OnDestroy {
      * @returns true if the chat should be reloaded, false otherwise
      */
     queryChangeShouldTriggerReload: (prevQuery: Query, newQuery: Query) => boolean;
-    /** Define the protocol to be used for this chat instance*/
-    protocol: 'REST' | 'WEBSOCKET';
     /** Map of listeners overriding default registered ones*/
     messageHandlers: Map<string, MessageHandler<any>>;
     /** When the assistant answer a user question, automatically scroll down to the bottom of the discussion */
@@ -73,7 +69,6 @@ export declare class ChatComponent implements OnInit, OnChanges, OnDestroy {
     tokenConsumptionTpl?: TemplateRef<any>;
     debugMessagesTpl?: TemplateRef<any>;
     appConfig: AppGlobalConfig;
-    chatService: ChatService;
     config: ChatConfig;
     messages$: BehaviorSubject<ChatMessage[] | undefined>;
     isAdminOrDeletedAdmin: boolean;
@@ -82,8 +77,8 @@ export declare class ChatComponent implements OnInit, OnChanges, OnDestroy {
     private _dataSubscription;
     /** Variables that depend on the type of model in use */
     modelDescription?: GllmModelDescription;
-    messageToEdit?: number;
-    remappedMessageToEdit?: number;
+    indexMessageToEdit?: number;
+    rankMessageToEdit?: number;
     changes$: BehaviorSubject<SimpleChanges | undefined>;
     currentMessageIndex: number | undefined;
     firstChangesHandled: boolean;
@@ -103,7 +98,6 @@ export declare class ChatComponent implements OnInit, OnChanges, OnDestroy {
     showReport: boolean;
     debugMessages: DebugMessage[] | undefined;
     showDebugMessages: boolean;
-    lastFetchDuration?: number;
     private _previousQuery;
     private _reloadSubscription;
     ngOnInit(): void;
@@ -111,8 +105,7 @@ export declare class ChatComponent implements OnInit, OnChanges, OnDestroy {
     ngOnDestroy(): void;
     get isAdmin(): boolean;
     /**
-     * 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
+     * This chat service instance is stored in the instanceManagerService with provided @input instanceId as a key
      */
     instantiateChatService(): void;
     /**
@@ -244,9 +237,9 @@ export declare class ChatComponent implements OnInit, OnChanges, OnDestroy {
      * If the last message is from the user, a request to the assistant is made to get an answer
      * If the last message is from the assistant, the conversation is loaded right away
      * @param messages The list of messages of the chat
-     * @param savedChatId  The id of the saved chat. If provided (ie. an existing discussion in the saved chat index), update the savedChatId in the chat service for the upcoming saved chat operations
+     * @param chatId  The id of the discussion. If provided (ie. an existing discussion in the saved chat index), update the chatId in the chat service for the upcoming saved chat operations
      */
-    openChat(messages: RawMessage[], savedChatId?: string): void;
+    openChat(messages: RawMessage[], chatId?: string): void;
     /**
      * Reset the chat by clearing the chat history and the UI accordingly
      * The user input will be cleared
@@ -274,29 +267,26 @@ export declare class ChatComponent implements OnInit, OnChanges, OnDestroy {
      * Once the edited message is submitted, all subsequent messages starting from @param index will be removed from the history and the UI will be updated accordingly.
      * The assistant will regenerate a new answer based on the updated chat history.
      * ⚠️ If the assistant is streaming or stopping the generation, the operation is not allowed.
+     * @param message The user's message to edit
      * @param index The index of the user's message to edit
+     * @returns void
      */
-    editMessage(index: number): void;
+    editMessage(message: ChatMessage, index: number): void;
     /**
      * Copy a previous assistant message of the chat history to the clipboard.
-     * @param index The index of the assistant's message to edit
+     * @param message The message to copy
+     * @param index The index of the message to copy
+     * @returns void
      */
-    copyMessage(index: number): void;
+    copyMessage(message: ChatMessage, index: number): void;
     /**
      * Starting from the provided index, remove all subsequent messages from the chat history and the UI accordingly.
      * The assistant will regenerate a new answer based on the updated chat history.
      * ⚠️ If the assistant is streaming or stopping the generation, the operation is not allowed.
+     * @param message The assistant's message to regenerate
      * @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;
+    regenerateMessage(message: ChatMessage, index: number): void;
     /**
      * Handles the key up event for 'Backspace' and 'Enter' keys.
      * @param event - The keyboard event.
@@ -311,16 +301,16 @@ export declare class ChatComponent implements OnInit, OnChanges, OnDestroy {
     /**
      * 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
+     * @param index The index of the message to like
      */
-    onLike(message: ChatMessage, rank: number): void;
+    onLike(message: ChatMessage, index: 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 index The rank of the message to dislike
      */
-    onDislike(message: ChatMessage, rank: number): void;
+    onDislike(message: ChatMessage, index: number): void;
     private _updateChatHistory;
     /**
      * Report an issue related to the assistant's message.
@@ -333,20 +323,25 @@ export declare class ChatComponent implements OnInit, OnChanges, OnDestroy {
     /**
      * Handle the click on a reference's 'open preview'.
      * @param data
-     * @param index rank of the message
+     * @param message the message containing the reference
+     * @param index index of the message containing the reference
+     * @returns void
      */
     openAttachmentPreview(data: {
         reference: ChatContextAttachment;
         partId?: number;
-    }, rank: number): void;
+    }, message: ChatMessage, index: number): void;
     /**
      * Handle the click on a reference's 'open original document'.
      * @param data
+     * @param message the message containing the reference
+     * @param index index of the message containing the reference
+     * @returns void
      */
     openOriginalAttachment(data: {
         reference: ChatContextAttachment;
         partId?: number;
-    }, rank: number): void;
+    }, message: ChatMessage, index: number): void;
     /**
      * Handle the click on a suggested action.
      * @param action Suggested action.
@@ -355,16 +350,18 @@ export declare class ChatComponent implements OnInit, OnChanges, OnDestroy {
     suggestActionClick(action: SuggestedAction, index: number): 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
+     * By design, the debug messages are only available in the first visible message among the group of "assistant" messages.
+     * @param message The message containing the debug information
+     * @param index The index of the message
      * @returns The debug messages available in the current group of "assistant" messages
      */
-    getDebugMessages(index: number): DebugMessage[];
+    getDebugMessages(message: ChatMessage, index: number): DebugMessage[];
     /**
      * Handle the click on the 'show log info' button of a message.
-     * @param index The rank of the message
+     * @param message The message containing the debug information
+     * @param index The index of the message
      */
-    showDebug(index: number): void;
+    showDebug(message: ChatMessage, 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
@@ -384,5 +381,5 @@ export declare class ChatComponent implements OnInit, OnChanges, OnDestroy {
      */
     isEmptyAssistantMessage(message: ChatMessage | undefined): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<ChatComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ChatComponent, "sq-chat-v3", never, { "instanceId": { "alias": "instanceId"; "required": false; }; "query": { "alias": "query"; "required": false; }; "queryChangeShouldTriggerReload": { "alias": "queryChangeShouldTriggerReload"; "required": false; }; "protocol": { "alias": "protocol"; "required": false; }; "messageHandlers": { "alias": "messageHandlers"; "required": false; }; "automaticScrollToLastResponse": { "alias": "automaticScrollToLastResponse"; "required": false; }; "focusAfterResponse": { "alias": "focusAfterResponse"; "required": false; }; "chat": { "alias": "chat"; "required": false; }; "assistantMessageIcon": { "alias": "assistantMessageIcon"; "required": false; }; "userMessageIcon": { "alias": "userMessageIcon"; "required": false; }; "connectionErrorMessageIcon": { "alias": "connectionErrorMessageIcon"; "required": false; }; "searchWarningMessageIcon": { "alias": "searchWarningMessageIcon"; "required": false; }; "additionalWorkflowProperties": { "alias": "additionalWorkflowProperties"; "required": false; }; "appConfig": { "alias": "appConfig"; "required": false; }; }, { "connection": "connection"; "loading$": "loading"; "_config": "config"; "data": "data"; "openDocument": "openDocument"; "openPreview": "openPreview"; "suggestAction": "suggestAction"; }, ["loadingTpl", "reportTpl", "tokenConsumptionTpl", "debugMessagesTpl"], never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ChatComponent, "sq-chat-v3", never, { "instanceId": { "alias": "instanceId"; "required": false; }; "query": { "alias": "query"; "required": false; }; "queryChangeShouldTriggerReload": { "alias": "queryChangeShouldTriggerReload"; "required": false; }; "messageHandlers": { "alias": "messageHandlers"; "required": false; }; "automaticScrollToLastResponse": { "alias": "automaticScrollToLastResponse"; "required": false; }; "focusAfterResponse": { "alias": "focusAfterResponse"; "required": false; }; "chat": { "alias": "chat"; "required": false; }; "assistantMessageIcon": { "alias": "assistantMessageIcon"; "required": false; }; "userMessageIcon": { "alias": "userMessageIcon"; "required": false; }; "connectionErrorMessageIcon": { "alias": "connectionErrorMessageIcon"; "required": false; }; "searchWarningMessageIcon": { "alias": "searchWarningMessageIcon"; "required": false; }; "additionalWorkflowProperties": { "alias": "additionalWorkflowProperties"; "required": false; }; "appConfig": { "alias": "appConfig"; "required": false; }; }, { "connection": "connection"; "loading$": "loading"; "_config": "config"; "data": "data"; "openDocument": "openDocument"; "openPreview": "openPreview"; "suggestAction": "suggestAction"; }, ["loadingTpl", "reportTpl", "tokenConsumptionTpl", "debugMessagesTpl"], never, true, never>;
 }

package/chat/chat.service.d.ts

@@ -1,17 +1,22 @@
 import { TranslocoService } from "@jsverse/transloco";
 import { BehaviorSubject, Observable } from "rxjs";
+import { HubConnection } from "@microsoft/signalr";
 import { Query } from "@sinequa/atomic";
 import { AppService } from "./services/app.service";
-import { DialogService } from "./services/dialog.service";
 import { NotificationsService } from "./services/notification.service";
 import { PrincipalService } from "./services/principal.service";
 import { UserSettingsWebService } from "./services/user-settings.service";
-import { ChatConfig, ChatMessage, ChatResponse, ChatUsageMetrics, DeleteSavedChatResponse, GllmFunction, GllmModelDescription, Quota, SavedChat, SavedChatHistory, SavedChatResponse, TokenConsumption, UserTokenConsumption } from "./types";
+import { ChatConfig, ChatMessage, ChatResponse, ChatUsageMetrics, DebugMessage, DeleteSavedChatResponse, GllmFunction, GllmModelDescription, KvObject, ListObject, MessageHandler, Quota, SavedChat, SavedChatHistory, SavedChatResponse, TokenConsumption, UserTokenConsumption } from "./types";
+import { ConnectionOptions } from "./services/signalR.web.service";
+import { AssistantUtils } from "./utils/utils.service";
 import * as i0 from "@angular/core";
-export declare abstract class ChatService {
-    readonly localID: string | null;
-    /** Name of the assistant plugin OR websocket endpoint. */
-    REQUEST_URL: string;
+export declare class ChatService {
+    /** Name of the assistant websocket endpoint. */
+    WS_REQUEST_URL: string;
+    /** Name of the assistant REST endpoint. */
+    REST_REQUEST_URL: string;
+    /** SignalR connection instance */
+    connection: HubConnection | undefined;
     /** Emit true once the initialization of the assistant process is done. */
     initProcess$: BehaviorSubject<boolean>;
     /** Emit true once the initialization of the assistant config is done. */
@@ -50,26 +55,136 @@ export declare abstract class ChatService {
     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. */
-    private _savedChatId;
-    /** Generated GUID for the current non-saved chat discussion used to identify audit events.
-     * If the chat is saved, the savedChatId is initialized with the value of this chatId.
-     */
+    /** Generated GUID for the current chat discussion used to save/get/delete it and identify audit events. */
     private _chatId;
     userSettingsService: UserSettingsWebService;
     notificationsService: NotificationsService;
     appService: AppService;
-    modalService: DialogService;
     principalService: PrincipalService;
+    assistantUtils: AssistantUtils;
+    private savedChatsService;
+    private signalRConnectionService;
+    private assistantConfigurationService;
+    private assistantMetadataService;
+    private assistantTokensTrackingService;
+    private debugMessageService;
+    private assistantWsFramesService;
     protected readonly transloco: TranslocoService;
     /**
-     * Initialize the chat process
+     * Initialize the assistant process.
+     * It includes building and starting a connection, executing parallel requests for models and functions, and handling errors during the process.
+     * ⚠️ This method MUST be called ONLY if the user is loggedIn and once when the assistant is initialized.
+     *
+     * @returns An Observable<boolean> indicating the success of the initialization process.
+     */
+    init(): Observable<boolean>;
+    /**
+     * Define the endpoint to use for the websocket requests
+     * It can be overridden by the app config
      */
-    abstract init(): Observable<boolean>;
+    getWSRequestsUrl(): void;
     /**
-     * Initialize the REQUEST_URL
+     * Define the endpoint to use for the http requests
+     * It can be overridden by the app config
+     */
+    getRESTRequestsUrl(): void;
+    /**
+     * Initializes the SavedChatsService with the necessary configuration.
+     *
+     * This method sets up the `SavedChatsService` by providing it with a configuration object
+     * (`SavedChatsOperationConfig`) that includes various callbacks and properties required
+     * for its operation. The initialization will only proceed if both `assistantConfig$` and
+     * `REST_REQUEST_URL` are available.
+     *
+     * The configuration object includes:
+     * - Application name retrieval.
+     * - Instance ID retrieval.
+     * - REST API URL retrieval.
+     * - Debug flag retrieval.
+     * - Chat ID for new saves.
+     * - Saved chats enablement check.
+     * - Methods for setting a saved chat ID, updating the saved chats list, and generating audit events.
+     *
+     * If the required dependencies are not ready, an error is logged to the console.
+     *
+     * @private
+     */
+    private _initSavedChatsService;
+    /**
+     * Initializes the SignalR connection service with the necessary configuration.
+     *
+     * This method ensures that the SignalR connection service is properly set up
+     * by providing it with the required configuration values, such as the WebSocket
+     * request URL and assistant configuration. It also manages the SignalR hub connection
+     * instance.
+     *
+     * Preconditions:
+     * - `assistantConfig$.value` must be available.
+     * - `WS_REQUEST_URL` must be defined.
+     *
+     * If these preconditions are not met, an error is logged to the console.
+     *
+     * @private
+     */
+    private _initSignalRConnectionService;
+    /**
+     * Initializes the Assistant Configuration Service with the necessary operation context.
+     * This method sets up the configuration context by providing various utility functions
+     * and state management mechanisms required for the assistant's configuration operations.
+     *
+     * The operation context includes:
+     * - Methods to retrieve chat instance and chat IDs.
+     * - Methods to get and set assistant configuration values.
+     * - Methods to set WebSocket and REST request URLs.
+     * - Methods to update the initialization configuration status.
+     * - A method to generate audit events for tracking operations.
+     *
+     * @private
+     */
+    private _initAssistantConfigurationService;
+    /**
+     * Initializes the AssistantMetadataService with the necessary operation context.
+     *
+     * This method checks if the `assistantConfig$` value and `REST_REQUEST_URL` are available.
+     * If both are ready, it creates an `AssistantMetadataOperationContext` object and
+     * initializes the `assistantMetadataService` with it. The operation context provides
+     * methods to retrieve the REST URL, assistant configuration, and to set models and functions.
+     *
+     * If the required values are not ready, an error is logged to the console.
+     *
+     * @private
+     */
+    private _initAssistantMetadataService;
+    /**
+     * Initializes the Assistant Tokens Tracking Service with the necessary operation context.
+     * This method sets up the service by providing it with functions to manage quotas,
+     * token consumption, usage metrics, and audit events, as well as access to assistant configuration
+     * and model retrieval.
+     *
+     * The initialization will only proceed if the assistant configuration is available.
+     * If the configuration is not ready, an error message is logged to the console.
+     *
+     * @private
      */
-    abstract getRequestsUrl(): void;
+    private _initAssistantTokensTrackingService;
+    /**
+     * Initializes the Assistant WebSocket Frames Service with the necessary operation context.
+     * This method sets up the required dependencies and configuration for the service to function properly.
+     * It ensures that the assistant configuration and connection are available before initializing the service.
+     *
+     * The operation context provides various utility functions and state management methods, including:
+     * - Accessing the assistant configuration, chat instance ID, saved chat ID, and chat history.
+     * - Managing streaming and stopping generation statuses.
+     * - Updating quota and chat usage metrics.
+     * - Generating audit events.
+     * - Managing saved chats (adding, updating, and listing).
+     *
+     * If the required dependencies (`assistantConfig$` and `connection`) are not ready, an error is logged.
+     *
+     * @private
+     */
+    private _initAssistantWsFramesService;
+    private _initDebugMessageService;
     get assistants(): any;
     /**
      * Get the instance ID of the chat service
@@ -82,23 +197,12 @@ export declare abstract class ChatService {
      */
     setChatInstanceId(instanceId: string): void;
     /**
-     * Get the ID of the current chat discussion which is used to save/get/delete it
-     * @returns The ID of the current chat discussion
-     */
-    get savedChatId(): string | undefined;
-    /**
-     * Persist the ID of the current chat discussion which is used to save/get/delete it
-     * @param savedChatId The ID of the current chat discussion which is used to save/get/delete it
-     */
-    setSavedChatId(savedChatId: string | undefined): void;
-    /**
-     * Get the ID of the current chat discussion which is used to identify audit events
+     * Get the ID of the current chat discussion which is used to save/get/delete the discussion and identify audit events
      * @returns The ID of the current chat discussion
      */
     get chatId(): string;
     /**
-     * Generate an GUID for the current chat discussion which is used to identify audit events
-     * If the discussion is saved, the savedChatId is initialized with the value of this chatId
+     * Generate an GUID for the current chat discussion which is used to save/get/delete it and identify audit events
      * @param chatId if provided, it will be considered as the ID of the current chat discussion which is used to identify audit events
      */
     generateChatId(chatId?: string): void;
@@ -125,23 +229,23 @@ export declare abstract class ChatService {
     /**
      * Overrides the logged in user
      */
-    abstract overrideUser(): void;
+    overrideUser(): void;
     /**
      * Calls the Fetch API to retrieve a new message given all previous messages
      */
-    abstract fetch(messages: ChatMessage[], query: Query): Observable<ChatResponse>;
+    fetch(messages: ChatMessage[], query: Query): Observable<ChatResponse>;
     /**
      * Return the list of models available on the server
      */
-    abstract listModels(): Observable<GllmModelDescription[] | undefined>;
+    listModels(): Observable<GllmModelDescription[] | undefined>;
     /**
      * Return the list of functions available on the server AND matching enabled functions in the chat config
      */
-    abstract listFunctions(): Observable<GllmFunction[] | undefined>;
+    listFunctions(): Observable<GllmFunction[] | undefined>;
     /**
      * Stops the assistant answer generation and cancels all the ongoing and pending related tasks
      */
-    abstract stopGeneration(): Observable<any>;
+    stopGeneration(): Observable<boolean>;
     /**
      * 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.
@@ -166,18 +270,24 @@ export declare abstract class ChatService {
     /**
      * Fetch the list saved chats belonging to a specific instance of the assistant
      */
-    abstract listSavedChat(): void;
+    listSavedChat(): void;
     /**
      * Return the saved chat with the given id, if exists. Otherwise, return undefined
      * @param id The id of the saved chat
      */
-    abstract getSavedChat(id: string): Observable<SavedChatHistory | undefined>;
+    getSavedChat(id: string): Observable<SavedChatHistory | undefined>;
+    /**
+     * Check if a saved chat with the given id already exists
+     * @param id The id of the saved chat
+     * @returns True if the saved chat exists, false otherwise
+     */
+    isExistingSavedChat(id: string): Observable<boolean>;
     /**
      * Save a chat with the given messages
      * @param messages The messages to add to the saved chat index
      * @returns The saved chat
      */
-    abstract addSavedChat(messages: ChatMessage[]): Observable<SavedChatResponse>;
+    addSavedChat(id: string, messages: ChatMessage[]): Observable<SavedChatResponse>;
     /**
      * Update a saved chat with the given id.
      * @param id The id of the saved chat
@@ -185,13 +295,54 @@ export declare abstract class ChatService {
      * @param messages The messages to update the saved chat history, if provided
      * @returns True if the saved chat has been successfully updated
      */
-    abstract updateSavedChat(id: string, name?: string, messages?: ChatMessage[]): Observable<SavedChatResponse>;
+    updateSavedChat(id: string, name?: string, messages?: ChatMessage[]): Observable<SavedChatResponse>;
     /**
      * Bulk delete of saved chats matching the given ids
      * @param ids List of ids of the saved chats to delete
      * @returns The number of deleted chats
      */
-    abstract deleteSavedChat(ids: string[]): Observable<DeleteSavedChatResponse>;
+    deleteSavedChat(ids: string[]): Observable<DeleteSavedChatResponse>;
+    getDebugMessage(message: DebugMessage): Observable<KvObject | ListObject | undefined>;
+    /**
+     * Initialize out-of-the-box handlers
+     * It is a placeholder for non-streaming scenarios, where you invoke a specific hub method, and the server responds with frame message(s)
+     */
+    initMessageHandlers(): void;
+    /**
+     * Override and register the entire _messageHandlers map by merging the provided map with the default one
+     * @param _messageHandlers
+     */
+    overrideMessageHandlers<T>(_messageHandlers: Map<string, MessageHandler<T>>): void;
+    /**
+     * Add a listener for a specific event.
+     * If a listener for this same event already exists, it will be overridden.
+     * If the listener has "isGlobalHandler" set to true, it will be registered to the hub connection.
+     * @param eventName Name of the event to register a listener for
+     * @param eventHandler The handler to be called when the event is received
+     */
+    addMessageHandler<T>(eventName: string, eventHandler: MessageHandler<T>): void;
+    /**
+     * Remove a listener for a specific event from the _messageHandlers map and unsubscribe from receiving messages for this event from the SignalR hub.
+     * @param eventName Name of the event to remove the listener for
+     */
+    removeMessageHandler(eventName: string): void;
+    /**
+     * Build a connection to the signalR websocket and register default listeners to the methods defined in the server hub class
+     * @param options The options for the connection. It overrides the default options
+     * @param logLevel Define the log level displayed in the console
+     * @returns Promise that resolves when the connection is built
+     */
+    buildConnection(options?: ConnectionOptions): Promise<void>;
+    /**
+     * Start the connection
+     * @returns Promise that resolves when the connection is started
+     */
+    startConnection(): Promise<void>;
+    /**
+     * Stop the connection
+     * @returns Promise that resolves when the connection is stopped
+     */
+    stopConnection(): Promise<void>;
     /**
      * Generate an audit event with the given type and details. The generated audit event is sent afterwards via the AuditWebService
      * @param type Audit event type
@@ -199,51 +350,6 @@ 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): Promise<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
-     * @returns A formatted local date string
-     */
-    protected formatDateTime(value: string): string;
-    /**
-   * Takes a text prompt that may contain placeholders for variables
-   * and replaces these placeholders if it finds a match in the given
-   * context object.
-   *
-   * @example
-   * const p = "Hello, [[user.name]]! You have [[user.notifications.length]] new notifications.";
-   * const context = {
-   *     user: {
-   *         name: "Alice",
-   *         notifications: ["Message from Bob", "Reminder for meeting"]
-   *     }
-   * };
-   * const formattedPrompt = formatPrompt(p, context);
-   * console.log(formattedPrompt); // Output: "Hello, Alice! You have 2 new notifications."
-   */
-    static formatPrompt(prompt: string, context: any): string;
-    /**
-     * Determines a time-based key for a given date to be used for translations or formatting.
-     * The key represents a relative time period such as "today", "yesterday", "this week", etc.
-     * If the date does not fall into any predefined relative time period, it returns the year as a string.
-     *
-     * @param date - The date for which the time key is to be determined.
-     * @returns A string representing the time key, which can be used for translation or display purposes.
-     */
-    getTimeKey(date: Date): string;
-    getCurrentLocaleName(): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<ChatService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ChatService>;
 }

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

@@ -0,0 +1,19 @@
+import { AfterViewInit } from "@angular/core";
+import { KvObject, ListObject } from "../../types";
+import { UIService } from "../../services/ui.service";
+import { DebugMessageService } from "../debug-message.service";
+import * as i0 from "@angular/core";
+export declare class DebugMessageDetailsComponent implements AfterViewInit {
+    ui: UIService;
+    debugMessageService: DebugMessageService;
+    data: (KvObject | ListObject)[] | undefined;
+    level: number;
+    parentColor: string;
+    constructor(ui: UIService, debugMessageService: DebugMessageService);
+    ngAfterViewInit(): void;
+    isObject(value: any): boolean;
+    getRowClass(item: KvObject | ListObject): string;
+    copyToClipboard(code: any): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DebugMessageDetailsComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DebugMessageDetailsComponent, "sq-debug-message-details", never, { "data": { "alias": "data"; "required": false; }; "level": { "alias": "level"; "required": false; }; "parentColor": { "alias": "parentColor"; "required": false; }; }, {}, never, never, true, never>;
+}

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

@@ -1,17 +1,14 @@
-import { AfterViewInit } from "@angular/core";
+import { ChangeDetectorRef } from "@angular/core";
 import { DebugMessage } from "../types";
-import { UIService } from "../services/ui.service";
+import { DebugMessageService } from "./debug-message.service";
 import * as i0 from "@angular/core";
-export declare class DebugMessageComponent implements AfterViewInit {
-    ui: UIService;
+export declare class DebugMessageComponent {
+    debugMessageService: DebugMessageService;
+    cdr: ChangeDetectorRef;
     data: DebugMessage[] | undefined;
-    level: number;
-    parentColor: string;
-    constructor(ui: UIService);
-    ngAfterViewInit(): void;
-    isObject(value: any): boolean;
-    getRowClass(item: DebugMessage, index: number): string;
-    copyToClipboard(code: any): void;
+    constructor(debugMessageService: DebugMessageService, cdr: ChangeDetectorRef);
+    getRowClass(index: number): string;
+    toggleExpand(item: DebugMessage): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<DebugMessageComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<DebugMessageComponent, "sq-debug-message", never, { "data": { "alias": "data"; "required": false; }; "level": { "alias": "level"; "required": false; }; "parentColor": { "alias": "parentColor"; "required": false; }; }, {}, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DebugMessageComponent, "sq-debug-message", never, { "data": { "alias": "data"; "required": false; }; }, {}, never, never, true, never>;
 }

package/chat/debug-message/debug-message.service.d.ts

@@ -0,0 +1,15 @@
+import { Observable } from 'rxjs';
+import { DebugMessage, ListObject } from '../types';
+import * as i0 from "@angular/core";
+export interface DebugMessageOperationConfig {
+    getRestUrl: () => string;
+}
+export declare class DebugMessageService {
+    private operationConfig;
+    constructor();
+    init(config: DebugMessageOperationConfig): void;
+    private ensureInitialized;
+    getDebugMessage(message: DebugMessage): Observable<ListObject | undefined>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DebugMessageService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DebugMessageService>;
+}

package/chat/documents-upload/document-list/document-list.component.d.ts

@@ -21,6 +21,7 @@ export declare class DocumentListComponent implements OnInit, OnDestroy {
     documentsUploadService: DocumentsUploadService;
     notificationsService: NotificationsService;
     private readonly transloco;
+    private readonly assistantUtils;
     ngOnInit(): void;
     ngOnDestroy(): void;
     instantiateChatService(): void;

package/chat/public-api.d.ts

@@ -5,8 +5,6 @@ export * from './saved-chats/saved-chats.component';
 export * from './initials-avatar/initials-avatar.component';
 export * from './format-icon/format-icon.component';
 export * from './types';
-export * from './websocket-chat.service';
-export * from './rest-chat.service';
 export * from './instance-manager.service';
 export * from './prompt.component';
 export * from './documents-upload/document-upload/document-upload.component';