@sinequa/assistant 3.7.0 → 3.7.1

package/chat/chat.component.d.ts

@@ -1077,8 +1077,10 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
     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>;
     reportTpl?: TemplateRef<any>;
     tokenConsumptionTpl?: TemplateRef<any>;
@@ -1128,17 +1130,60 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
      */
     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;
     /**
@@ -1159,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
@@ -1167,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
@@ -1192,8 +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.
@@ -1222,7 +1293,16 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
      * @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

package/chat/types.d.ts

@@ -29,6 +29,7 @@ export interface ChatMessage extends RawMessage {
         $suggestedAction?: SuggestedAction[];
         $debug?: DebugMessage[];
         forcedWorkflow?: string;
+        forcedWorkflowProperties?: any;
         query?: Query;
         isUserInput?: boolean;
         usageMetrics?: ChatUsageMetrics;
@@ -217,15 +218,6 @@ declare const uiSettingsSchema: z.ZodObject<{
 }>;
 export interface UiSettings extends z.infer<typeof uiSettingsSchema> {
 }
-declare const chatStarterSchema: z.ZodObject<{
-    text: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    text: string;
-}, {
-    text: string;
-}>;
-export interface ChatStarter extends z.infer<typeof chatStarterSchema> {
-}
 declare const defaultValuesSchema: z.ZodObject<{
     service_id: z.ZodString;
     model_id: z.ZodString;
@@ -274,6 +266,15 @@ declare const defaultValuesSchema: z.ZodObject<{
 }>;
 export interface DefaultValues extends z.infer<typeof defaultValuesSchema> {
 }
+declare const chatStarterSchema: z.ZodObject<{
+    text: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    text: string;
+}, {
+    text: string;
+}>;
+export interface ChatStarter extends z.infer<typeof chatStarterSchema> {
+}
 declare const modeSettingsSchema: z.ZodEffects<z.ZodObject<{
     enabledUserInput: z.ZodBoolean;
     displayUserPrompt: z.ZodBoolean;
@@ -318,6 +319,16 @@ declare const modeSettingsSchema: z.ZodEffects<z.ZodObject<{
             text: string;
         }[] | undefined;
     }>;
+    actions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        forcedWorkflow: z.ZodString;
+        forcedWorkflowProperties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        forcedWorkflow: string;
+        forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+    }, {
+        forcedWorkflow: string;
+        forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+    }>>>;
 }, "strip", z.ZodTypeAny, {
     displayUserPrompt: boolean;
     enabledUserInput: boolean;
@@ -330,6 +341,10 @@ declare const modeSettingsSchema: z.ZodEffects<z.ZodObject<{
             text: string;
         }[] | undefined;
     };
+    actions?: globalThis.Record<string, {
+        forcedWorkflow: string;
+        forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+    }> | undefined;
 }, {
     displayUserPrompt: boolean;
     enabledUserInput: boolean;
@@ -342,6 +357,10 @@ declare const modeSettingsSchema: z.ZodEffects<z.ZodObject<{
             text: string;
         }[] | undefined;
     };
+    actions?: globalThis.Record<string, {
+        forcedWorkflow: string;
+        forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+    }> | undefined;
 }>, {
     displayUserPrompt: boolean;
     enabledUserInput: boolean;
@@ -354,6 +373,10 @@ declare const modeSettingsSchema: z.ZodEffects<z.ZodObject<{
             text: string;
         }[] | undefined;
     };
+    actions?: globalThis.Record<string, {
+        forcedWorkflow: string;
+        forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+    }> | undefined;
 }, {
     displayUserPrompt: boolean;
     enabledUserInput: boolean;
@@ -366,6 +389,10 @@ declare const modeSettingsSchema: z.ZodEffects<z.ZodObject<{
             text: string;
         }[] | undefined;
     };
+    actions?: globalThis.Record<string, {
+        forcedWorkflow: string;
+        forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+    }> | undefined;
 }>;
 export interface ModeSettings extends z.infer<typeof modeSettingsSchema> {
 }
@@ -510,6 +537,16 @@ export declare const chatConfigSchema: z.ZodObject<{
                 text: string;
             }[] | undefined;
         }>;
+        actions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            forcedWorkflow: z.ZodString;
+            forcedWorkflowProperties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, "strip", z.ZodTypeAny, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }>>>;
     }, "strip", z.ZodTypeAny, {
         displayUserPrompt: boolean;
         enabledUserInput: boolean;
@@ -522,6 +559,10 @@ export declare const chatConfigSchema: z.ZodObject<{
                 text: string;
             }[] | undefined;
         };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
     }, {
         displayUserPrompt: boolean;
         enabledUserInput: boolean;
@@ -534,6 +575,10 @@ export declare const chatConfigSchema: z.ZodObject<{
                 text: string;
             }[] | undefined;
         };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
     }>, {
         displayUserPrompt: boolean;
         enabledUserInput: boolean;
@@ -546,6 +591,10 @@ export declare const chatConfigSchema: z.ZodObject<{
                 text: string;
             }[] | undefined;
         };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
     }, {
         displayUserPrompt: boolean;
         enabledUserInput: boolean;
@@ -558,6 +607,10 @@ export declare const chatConfigSchema: z.ZodObject<{
                 text: string;
             }[] | undefined;
         };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
     }>;
     uiSettings: z.ZodObject<{
         display: z.ZodBoolean;
@@ -664,6 +717,10 @@ export declare const chatConfigSchema: z.ZodObject<{
                 text: string;
             }[] | undefined;
         };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
     };
     uiSettings: {
         display: boolean;
@@ -727,6 +784,10 @@ export declare const chatConfigSchema: z.ZodObject<{
                 text: string;
             }[] | undefined;
         };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
     };
     uiSettings: {
         display: boolean;