@sinequa/assistant 3.5.3 → 3.6.0

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

@@ -19,6 +19,8 @@ export declare class ChatMessageComponent implements OnChanges, AfterViewInit {
     suggestedActions: SuggestedAction[] | undefined;
     assistantMessageIcon: string;
     userMessageIcon: string;
+    connectionErrorMessageIcon: string;
+    searchWarningMessageIcon: string;
     streaming: boolean;
     canEdit: boolean;
     canRegenerate: boolean;
@@ -77,5 +79,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"; "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"; "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>;
 }

package/chat/chat.component.d.ts

@@ -11,6 +11,7 @@ import { InstanceManagerService } from "./instance-manager.service";
 import { WebSocketChatService } from "./websocket-chat.service";
 import { LoginService } from "@sinequa/core/login";
 import { RestChatService } from "./rest-chat.service";
+import { HubConnection } from "@microsoft/signalr";
 import * as i0 from "@angular/core";
 export declare class ChatComponent extends AbstractFacet implements OnInit, OnChanges, OnDestroy {
     loginService: LoginService;
@@ -950,7 +951,17 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
     assistantMessageIcon: string;
     /** Icon to use for the user messages */
     userMessageIcon: string;
+    /** Icon to use for the connection error messages */
+    connectionErrorMessageIcon: string;
+    /** Icon to use for the search warning messages */
+    searchWarningMessageIcon: string;
+    /** Event emitter triggered once the signalR connection is established  */
+    connection: EventEmitter<HubConnection>;
     /** Event emitter triggered each time the assistant updates the current chat */
+    /** Event emitter triggered when the chat is loading new content */
+    loading$: EventEmitter<boolean>;
+    /** Emits the assistant configuration used when instantiating the component */
+    _config: EventEmitter<ChatConfig>;
     data: EventEmitter<ChatMessage[]>;
     /** Event emitter triggered when the user clicks to open the original document representing the context attachment*/
     openDocument: EventEmitter<{
@@ -958,11 +969,7 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
         id: string;
         title: string;
         text: string;
-        size: number; /**
-         * 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.
-         * @param index The index of the assistant's message to regenerate
-         */
+        size: number;
         $selected: boolean;
         matchlocations: string[];
         rank: number;
@@ -1060,19 +1067,12 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
                 $expanded?: boolean | undefined;
             }[];
         } | undefined;
-        $hasPassages?: boolean | undefined; /**
-         * Handle the click on a reference's 'open original document'.
-         * @param data
-         */
+        $hasPassages?: boolean | undefined;
     }>;
     /** Event emitter triggered when the user clicks to open the preview of a document representing the context attachment */
     openPreview: EventEmitter<ChatContextAttachment>;
     /** Event emitter triggered when the user clicks on a suggested action */
     suggestAction: EventEmitter<SuggestedAction>;
-    /** Event emitter triggered when the chat is loading new content */
-    loading$: EventEmitter<boolean>;
-    /** Emits the assistant configuration used when instantiating the component */
-    _config: EventEmitter<ChatConfig>;
     messageList?: ElementRef<HTMLUListElement>;
     questionInput?: ElementRef<HTMLTextAreaElement>;
     loadingTpl?: TemplateRef<any>;
@@ -1095,7 +1095,11 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
     isAtBottom: boolean;
     initializationError: boolean;
     enabledUserInput: boolean;
-    issueTypes: string[];
+    isConnected: boolean;
+    retrialAttempts: number | undefined;
+    private _isReconnectedListenerRegistered;
+    issueTypes?: string[];
+    defaultIssueTypes: string[];
     issueType: string;
     issueComment?: string;
     messageRelatedIssue?: ChatMessage;
@@ -1115,23 +1119,38 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
      */
     instantiateChatService(): void;
     get actions(): Action[];
-    private handleChanges;
+    private _handleChanges;
     private _triggerReloadAfterQueryChange;
-    private addScrollListener;
+    private _addScrollListener;
     updateModelDescription(): void;
     submitQuestion(): void;
-    private fetchAnswer;
+    private _fetchAnswer;
     /**
-     * Given a list of messages, the chat endpoint is invoked for a continuation and updates the list of messages accordingly.
+     * 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
      */
     fetch(messages: ChatMessage[]): void;
+    /**
+     * Retry to fetch the messages if the connection issues.
+     *  - If reconnecting => keep display the connection error message even when clicking on the "retry" button and increasing the number of retrial attempts, until the connection is re-established
+     *  - If disconnected => On click on the "retry" button, start the connection process while displaying the connection error message :
+     *      * If successful => given a list of messages, the chat endpoint is invoked for a continuation and updates the list of messages accordingly.
+     *      * If failed => increase the number of retrial attempts
+     */
+    retryFetch(): void;
+    /**
+     * Check if the signalR connection is connected.
+     * For the REST protocol, the connection is always considered connected (for the moment).
+     */
+    private _updateConnectionStatus;
     /**
      * Update the UI with the new messages
      * @param messages
      */
     updateData(messages: ChatMessage[]): void;
-    private toggleScrollButtonVisibility;
+    private _toggleScrollButtonVisibility;
     scrollDown(): void;
     /**
      * Start a new chat with the defaultValues settings
@@ -1186,7 +1205,7 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
      */
     regenerateMessage(index: number): void;
     onKeyUp(event: KeyboardEvent): void;
-    calculateHeight(): void;
+    calculateHeight(event?: KeyboardEvent): void;
     /**
      * Send a "like" event on clicking on the thumb-up icon of an assistant's message
      * @param rank The rank of the message to like
@@ -1235,5 +1254,5 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
      */
     showDebug(message: ChatMessage): void;
     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"; }, { "data": "data"; "openDocument": "openDocument"; "openPreview": "openPreview"; "suggestAction": "suggestAction"; "loading$": "loading"; "_config": "config"; }, ["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"; "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>;
 }

package/chat/styles/assistant.scss

@@ -25,6 +25,10 @@ $ast-primary-bg: var(--ast-primary-bg, #f2f8fe);
 $ast-primary-color: var(--ast-primary-color, #005DA7);
 $ast-secondary-bg: var(--ast-secondary-bg, #FFF8F1);
 $ast-secondary-color: var(--ast-secondary-color, #FF732E);
+$ast-error-bg: var(--ast-error-bg, rgba(249, 58, 55, 0.2));
+$ast-error-color: var(--ast-error-color, rgba(249, 58, 55, 0.7));
+$ast-warning-bg: var(--ast-warning-bg, #fff1b8);
+$ast-warning-color: var(--ast-warning-color, #fed86f);
 $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);
@@ -52,6 +56,14 @@ $ast-muted-color: var(--ast-muted-color, rgba(33, 37, 41, 0.75));
     background-color: $ast-secondary-bg;
 }
 
+.ast-error {
+  background-color: $ast-error-bg;
+
+  &:hover {
+    color: $ast-error-color;
+}
+}
+
 .ast-btn {
     border: 0;
     text-align: left;
@@ -78,4 +90,4 @@ $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;
-}
+}

package/chat/types.d.ts

@@ -121,26 +121,31 @@ export interface SavedChatHistory extends SavedChat {
     history: ChatMessage[];
 }
 export declare const connectionSettingsSchema: z.ZodEffects<z.ZodObject<{
+    connectionErrorMessage: z.ZodString;
     restEndpoint: z.ZodOptional<z.ZodString>;
     websocketEndpoint: z.ZodOptional<z.ZodString>;
     signalRTransport: z.ZodEnum<["WebSockets", "ServerSentEvents", "LongPolling", "None"]>;
     signalRLogLevel: z.ZodEnum<["Critical", "Debug", "Error", "Information", "None", "Trace", "Warning"]>;
 }, "strip", z.ZodTypeAny, {
+    connectionErrorMessage: string;
     signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
     signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
     restEndpoint?: string | undefined;
     websocketEndpoint?: string | undefined;
 }, {
+    connectionErrorMessage: string;
     signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
     signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
     restEndpoint?: string | undefined;
     websocketEndpoint?: string | undefined;
 }>, {
+    connectionErrorMessage: string;
     signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
     signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
     restEndpoint?: string | undefined;
     websocketEndpoint?: string | undefined;
 }, {
+    connectionErrorMessage: string;
     signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
     signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
     restEndpoint?: string | undefined;
@@ -317,26 +322,31 @@ export interface SavedChatSettings extends z.infer<typeof savedChatSettingsSchem
 }
 export declare const chatConfigSchema: z.ZodObject<{
     connectionSettings: z.ZodEffects<z.ZodObject<{
+        connectionErrorMessage: z.ZodString;
         restEndpoint: z.ZodOptional<z.ZodString>;
         websocketEndpoint: z.ZodOptional<z.ZodString>;
         signalRTransport: z.ZodEnum<["WebSockets", "ServerSentEvents", "LongPolling", "None"]>;
         signalRLogLevel: z.ZodEnum<["Critical", "Debug", "Error", "Information", "None", "Trace", "Warning"]>;
     }, "strip", z.ZodTypeAny, {
+        connectionErrorMessage: string;
         signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
     }, {
+        connectionErrorMessage: string;
         signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
     }>, {
+        connectionErrorMessage: string;
         signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
     }, {
+        connectionErrorMessage: string;
         signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
@@ -474,23 +484,37 @@ export declare const chatConfigSchema: z.ZodObject<{
         enabled: boolean;
     }>;
     globalSettings: z.ZodObject<{
+        searchWarningMessage: z.ZodString;
         disclaimer: z.ZodOptional<z.ZodString>;
+        genericChatErrorMessage: z.ZodOptional<z.ZodString>;
         displayUserQuotaConsumption: z.ZodOptional<z.ZodBoolean>;
         displayChatTokensConsumption: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
+        searchWarningMessage: string;
         disclaimer?: string | undefined;
+        genericChatErrorMessage?: string | undefined;
         displayUserQuotaConsumption?: boolean | undefined;
         displayChatTokensConsumption?: boolean | undefined;
     }, {
+        searchWarningMessage: string;
         disclaimer?: string | undefined;
+        genericChatErrorMessage?: string | undefined;
         displayUserQuotaConsumption?: boolean | undefined;
         displayChatTokensConsumption?: boolean | undefined;
     }>;
+    auditSettings: z.ZodOptional<z.ZodObject<{
+        issueTypes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        issueTypes?: string[] | undefined;
+    }, {
+        issueTypes?: string[] | undefined;
+    }>>;
     additionalServiceSettings: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
     additionalWorkflowProperties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
 }, "strip", z.ZodTypeAny, {
     additionalWorkflowProperties: {};
     connectionSettings: {
+        connectionErrorMessage: string;
         signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
@@ -536,14 +560,20 @@ export declare const chatConfigSchema: z.ZodObject<{
         enabled: boolean;
     };
     globalSettings: {
+        searchWarningMessage: string;
         disclaimer?: string | undefined;
+        genericChatErrorMessage?: string | undefined;
         displayUserQuotaConsumption?: boolean | undefined;
         displayChatTokensConsumption?: boolean | undefined;
     };
     additionalServiceSettings: {};
+    auditSettings?: {
+        issueTypes?: string[] | undefined;
+    } | undefined;
 }, {
     additionalWorkflowProperties: {};
     connectionSettings: {
+        connectionErrorMessage: string;
         signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
@@ -589,11 +619,16 @@ export declare const chatConfigSchema: z.ZodObject<{
         enabled: boolean;
     };
     globalSettings: {
+        searchWarningMessage: string;
         disclaimer?: string | undefined;
+        genericChatErrorMessage?: string | undefined;
         displayUserQuotaConsumption?: boolean | undefined;
         displayChatTokensConsumption?: boolean | undefined;
     };
     additionalServiceSettings: {};
+    auditSettings?: {
+        issueTypes?: string[] | undefined;
+    } | undefined;
 }>;
 export interface ChatConfig extends z.infer<typeof chatConfigSchema> {
 }
@@ -610,6 +645,7 @@ export interface ChatPayload {
     };
     instanceId?: string;
     savedChatId?: string;
+    genericChatErrorMessage?: string;
 }
 export declare type ActionMessage = {
     guid: string;

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

@@ -4,12 +4,10 @@ import { Query } from "@sinequa/core/app-utils";
 import { HubConnection } from "@microsoft/signalr";
 import { ChatMessage, ChatResponse, GllmFunction, GllmModelDescription, MessageHandler, SavedChatHistory, SavedChat } from "./types";
 import { ChatService } from "./chat.service";
-import { Observable, Subject } from "rxjs";
+import { Observable } from "rxjs";
 import * as i0 from "@angular/core";
 export declare class WebSocketChatService extends ChatService {
     connection: HubConnection | undefined;
-    connectionBuilt$: Subject<void>;
-    connectionStarted$: Subject<void>;
     private _messageHandlers;
     private _actionMap;
     private _progress;