@sinequa/assistant 3.1.1 → 3.2.1

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

@@ -5,6 +5,8 @@ import { ChatContextAttachment, ChatMessage } from "../types";
 import { Processor } from "unified";
 import { Node } from "unist";
 import { UIService } from "@sinequa/components/utils";
+import "prismjs-components-importer/esm";
+import 'prismjs/plugins/autoloader/prism-autoloader';
 import * as i0 from "@angular/core";
 export declare class ChatMessageComponent implements OnChanges, AfterViewInit {
     searchService: SearchService;
@@ -143,6 +145,7 @@ export declare class ChatMessageComponent implements OnChanges, AfterViewInit {
      */
     referencePlugin: (tree: Node) => Node<import("unist").Data>;
     placeholderPlugin: (tree: Node) => Node<import("unist").Data>;
+    getLinkText(node: any): string;
     /**
      * Reformat [ids: 12.2, 42.5] to [12.2][42.5]
      */

package/chat/chat-settings-v3/chat-settings-v3.component.d.ts

@@ -9,12 +9,16 @@ import * as i0 from "@angular/core";
 export declare class ChatSettingsV3Component implements OnInit, OnDestroy {
     /** Define the key based on it, the appropriate chatService instance will be returned from instanceManagerService */
     instanceId: string;
-    _update: EventEmitter<any>;
-    _cancel: EventEmitter<any>;
+    _update: EventEmitter<ChatConfig>;
+    _cancel: EventEmitter<ChatConfig>;
     chatService: ChatService;
     config: ChatConfig;
     subscription: Subscription;
     selectedModel: GllmModelDescription | undefined;
+    functions: {
+        name: string;
+        enabled: boolean;
+    }[];
     isAdmin: boolean;
     loginService: LoginService;
     instanceManagerService: InstanceManagerService;
@@ -26,8 +30,9 @@ export declare class ChatSettingsV3Component implements OnInit, OnDestroy {
     get hasModel(): boolean;
     instantiateChatService(): void;
     onChatModelChange(selectedModel: GllmModelDescription): void;
+    getFunctionDescription(name: string): string;
     toggleFunctionsSelection(name: string): void;
-    private updateFunctionsCheckboxes;
+    private initFunctionsList;
     /**
      * Save the new chat config in the chat service and the user preferences
      */

package/chat/chat.component.d.ts

@@ -16,150 +16,6 @@ export interface InitChat {
     messages: RawMessage[];
 }
 export declare class ChatComponent extends AbstractFacet implements OnInit, OnChanges, OnDestroy {
-    /** Define the key based on it, the chat service instance will be stored */
-    instanceId: string;
-    /** Define the query to use to fetch answers */
-    query?: Query;
-    /** 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 */
-    automaticScrollToLastResponse: boolean;
-    chat?: InitChat;
-    enableChat: boolean;
-    showCredits: boolean;
-    customAssistantIcon: string;
-    data: EventEmitter<ChatMessage[]>;
-    referenceClicked: EventEmitter<{
-        filename: string;
-        id: string;
-        title: string;
-        text: string;
-        size: number;
-        $selected: boolean;
-        matchlocations: string[];
-        rank: number;
-        databasealias: string;
-        matchingpartnames: string[];
-        matchlocationsperpartname: {
-            matchlocations: {
-                data: string;
-                partname: string;
-            }[];
-        }[];
-        documentlanguages: string[];
-        documentweight: string;
-        modified: string;
-        indexationtime: string;
-        version: string;
-        treepath: string[];
-        fileext: string;
-        flags: string[];
-        collection: string[];
-        docformat: string;
-        url1: string;
-        authors: string[];
-        rfmEnabled: boolean;
-        termspresence: {
-            term: string;
-            presence: "found" | "missing";
-        }[];
-        $isDuplicate: boolean;
-        $duplicateCount: number;
-        globalrelevance?: number | undefined;
-        displayTitle?: string | undefined;
-        doctype?: string | undefined;
-        url2?: string | undefined;
-        relevantExtracts?: string | undefined;
-        extracts?: {
-            score: number;
-            highlighted: string;
-            locations: string;
-            originalLocations: string;
-            partname?: string | undefined;
-        }[] | undefined;
-        accesslists?: {
-            accessListIndices: number[];
-            authorizedLists: {
-                id: string;
-                domain: string;
-            }[];
-            deniedLists: {
-                id: string;
-                domain: string;
-            }[];
-        } | undefined;
-        thumbnailUrl?: string | undefined;
-        originalUrl?: string | undefined;
-        pdfUrl?: string | undefined;
-        rfm?: {
-            click?: {
-                image: import("@sinequa/core/web-services").RFMDisplay;
-                status: import("@sinequa/core/web-services").RFMDisplay;
-                eventCount: number;
-                average: number;
-                imageAction: import("@sinequa/core/web-services").RFMDisplay;
-                availableActions: import("@sinequa/core/web-services").RFMDisplay;
-            } | undefined;
-            like?: {
-                image: import("@sinequa/core/web-services").RFMDisplay;
-                status: import("@sinequa/core/web-services").RFMDisplay;
-                eventCount: number;
-                average: number;
-                imageAction: import("@sinequa/core/web-services").RFMDisplay;
-                availableActions: import("@sinequa/core/web-services").RFMDisplay;
-            } | undefined;
-            important?: {
-                image: import("@sinequa/core/web-services").RFMDisplay;
-                status: import("@sinequa/core/web-services").RFMDisplay;
-                eventCount: number;
-                average: number;
-                imageAction: import("@sinequa/core/web-services").RFMDisplay;
-                availableActions: import("@sinequa/core/web-services").RFMDisplay;
-            } | undefined;
-        } | undefined;
-        groupcount?: number | undefined;
-        nearhash?: string | undefined;
-        exacthash?: string | undefined;
-        containerid?: string | undefined;
-        $page?: number | undefined;
-        matchingpassages?: {
-            passages: {
-                location: number[];
-                id: number;
-                score: number;
-                rlocation: number[];
-                highlightedText: string;
-                $expanded?: boolean | undefined;
-            }[];
-        } | undefined;
-        $hasPassages?: boolean | undefined;
-    }>;
-    openPreview: EventEmitter<ChatContextAttachment>;
-    loading$: EventEmitter<boolean>;
-    error: EventEmitter<any>;
-    _config: EventEmitter<ChatConfig>;
-    messageList?: ElementRef<HTMLUListElement>;
-    questionInput?: ElementRef<HTMLInputElement>;
-    loadingTpl?: TemplateRef<any>;
-    chatService: ChatService;
-    config: ChatConfig;
-    messages$: BehaviorSubject<ChatMessage[] | undefined>;
-    question: string;
-    _actions: Action[];
-    sub: Subscription;
-    dataSubscription: Subscription | undefined;
-    /** Variables that depend on the type of model in use */
-    modelDescription?: GllmModelDescription;
-    assistantIcon: string;
-    privacyUrl: string;
-    messageToEdit?: number;
-    changes$: BehaviorSubject<SimpleChanges | undefined>;
-    currentMessageIndex: number | undefined;
-    handleFirstChanges: boolean;
-    isAtBottom: boolean;
-    initializationError: boolean;
     loginService: LoginService;
     websocketService: WebSocketChatService;
     restService: RestChatService;
@@ -1073,6 +929,156 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
     }>;
     principalService: PrincipalWebService;
     cdr: ChangeDetectorRef;
+    /** Define the key based on it, the chat service instance will be stored */
+    instanceId: string;
+    /** Define the query to use to fetch answers */
+    query: Query;
+    /** Function that determines whether the chat should be reloaded after the query changes
+     * If not provided, the chat will be reloaded by default
+     * @param prevQuery The previous query
+     * @param newQuery The new query
+     * @returns true if the chat should be reloaded, false otherwise
+     */
+    queryChangeShouldTriggerReload: (prevQuery: any, newQuery: any) => 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 */
+    automaticScrollToLastResponse: boolean;
+    chat?: InitChat;
+    customAssistantIcon: string;
+    data: EventEmitter<ChatMessage[]>;
+    referenceClicked: EventEmitter<{
+        filename: string;
+        id: string;
+        title: string;
+        text: string;
+        size: number;
+        $selected: boolean;
+        matchlocations: string[];
+        rank: number;
+        databasealias: string;
+        matchingpartnames: string[];
+        matchlocationsperpartname: {
+            matchlocations: {
+                data: string;
+                partname: string;
+            }[];
+        }[];
+        documentlanguages: string[];
+        documentweight: string;
+        modified: string;
+        indexationtime: string;
+        version: string;
+        treepath: string[];
+        fileext: string;
+        flags: string[];
+        collection: string[];
+        docformat: string;
+        url1: string;
+        authors: string[];
+        rfmEnabled: boolean;
+        termspresence: {
+            term: string;
+            presence: "found" | "missing";
+        }[];
+        $isDuplicate: boolean;
+        $duplicateCount: number;
+        globalrelevance?: number | undefined;
+        displayTitle?: string | undefined;
+        doctype?: string | undefined;
+        url2?: string | undefined;
+        relevantExtracts?: string | undefined;
+        extracts?: {
+            score: number;
+            highlighted: string;
+            locations: string;
+            originalLocations: string;
+            partname?: string | undefined;
+        }[] | undefined;
+        accesslists?: {
+            accessListIndices: number[];
+            authorizedLists: {
+                id: string;
+                domain: string;
+            }[];
+            deniedLists: {
+                id: string;
+                domain: string;
+            }[];
+        } | undefined;
+        thumbnailUrl?: string | undefined;
+        originalUrl?: string | undefined;
+        pdfUrl?: string | undefined;
+        rfm?: {
+            click?: {
+                image: import("@sinequa/core/web-services").RFMDisplay;
+                status: import("@sinequa/core/web-services").RFMDisplay;
+                eventCount: number;
+                average: number;
+                imageAction: import("@sinequa/core/web-services").RFMDisplay;
+                availableActions: import("@sinequa/core/web-services").RFMDisplay;
+            } | undefined;
+            like?: {
+                image: import("@sinequa/core/web-services").RFMDisplay;
+                status: import("@sinequa/core/web-services").RFMDisplay;
+                eventCount: number;
+                average: number;
+                imageAction: import("@sinequa/core/web-services").RFMDisplay;
+                availableActions: import("@sinequa/core/web-services").RFMDisplay;
+            } | undefined;
+            important?: {
+                image: import("@sinequa/core/web-services").RFMDisplay;
+                status: import("@sinequa/core/web-services").RFMDisplay;
+                eventCount: number;
+                average: number;
+                imageAction: import("@sinequa/core/web-services").RFMDisplay;
+                availableActions: import("@sinequa/core/web-services").RFMDisplay;
+            } | undefined;
+        } | undefined;
+        groupcount?: number | undefined;
+        nearhash?: string | undefined;
+        exacthash?: string | undefined;
+        containerid?: string | undefined;
+        $page?: number | undefined;
+        matchingpassages?: {
+            passages: {
+                location: number[];
+                id: number;
+                score: number;
+                rlocation: number[];
+                highlightedText: string;
+                $expanded?: boolean | undefined;
+            }[];
+        } | undefined;
+        $hasPassages?: boolean | undefined;
+    }>;
+    openPreview: EventEmitter<ChatContextAttachment>;
+    loading$: EventEmitter<boolean>;
+    error: EventEmitter<any>;
+    _config: EventEmitter<ChatConfig>;
+    messageList?: ElementRef<HTMLUListElement>;
+    questionInput?: ElementRef<HTMLTextAreaElement>;
+    loadingTpl?: TemplateRef<any>;
+    chatService: ChatService;
+    config: ChatConfig;
+    messages$: BehaviorSubject<ChatMessage[] | undefined>;
+    question: string;
+    _actions: Action[];
+    sub: Subscription;
+    dataSubscription: Subscription | undefined;
+    /** Variables that depend on the type of model in use */
+    modelDescription?: GllmModelDescription;
+    assistantIcon: string;
+    privacyUrl: string;
+    messageToEdit?: number;
+    changes$: BehaviorSubject<SimpleChanges | undefined>;
+    currentMessageIndex: number | undefined;
+    firstChangesHandled: boolean;
+    isAtBottom: boolean;
+    initializationError: boolean;
+    enabledUserInput: boolean;
     constructor();
     ngOnInit(): void;
     ngOnChanges(changes: SimpleChanges): void;
@@ -1080,6 +1086,7 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
     instantiateChatService(): void;
     get actions(): Action[];
     private handleChanges;
+    private triggerReloadAfterQueryChange;
     private addScrollListener;
     updateModelDescription(): void;
     submitQuestion(): void;
@@ -1097,16 +1104,37 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
     updateData(messages: ChatMessage[]): void;
     private toggleScrollButtonVisibility;
     scrollDown(): void;
+    /**
+     * Start a new chat with the defaultValues settings
+     * The savedChatId in the chat service will be reset, so that the upcoming saved chat operations will be performed on the fresh new chat
+     * If the savedChat feature is enabled, the list of saved chats will be refreshed
+     */
     newChat(): 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
+     */
     loadDefaultChat(): void;
+    /**
+     * Start/open a new chat with the provided messages and chatId
+     * 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 chatId  The id of the 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
+     */
     openChat(messages: RawMessage[], chatId?: string): void;
+    /**
+     * Reset the chat by clearing the messages and the chat history
+     * The question input will be focused after the chat is reset
+     * The fetch subscription will be terminated
+     */
     resetChat(): void;
     onLoadChat(): void;
     terminateFetch(): void;
     editMessage(index: number): void;
     regenerateMessage(index: number): void;
     onKeyUp(event: KeyboardEvent): void;
-    private navigateMessage;
+    calculateHeight(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ChatComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ChatComponent, "sq-chat-v3", never, { "instanceId": "instanceId"; "query": "query"; "protocol": "protocol"; "messageHandlers": "messageHandlers"; "automaticScrollToLastResponse": "automaticScrollToLastResponse"; "chat": "chat"; "enableChat": "enableChat"; "showCredits": "showCredits"; "customAssistantIcon": "customAssistantIcon"; }, { "data": "data"; "referenceClicked": "referenceClicked"; "openPreview": "openPreview"; "loading$": "loading"; "error": "error"; "_config": "config"; }, ["loadingTpl"], 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"; "customAssistantIcon": "customAssistantIcon"; }, { "data": "data"; "referenceClicked": "referenceClicked"; "openPreview": "openPreview"; "loading$": "loading"; "error": "error"; "_config": "config"; }, ["loadingTpl"], never, true>;
 }