@sinequa/assistant 3.2.2 → 3.3.0-DEV.16

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, Record } from "@sinequa/core/web-services";
+import { PrincipalWebService } from "@sinequa/core/web-services";
 import { SearchService } from "@sinequa/components/search";
-import { ChatContextAttachment, ChatMessage } from "../types";
+import { ChatContextAttachment, ChatMessage, SuggestedAction } from "../types";
 import { Processor } from "unified";
 import { Node } from "unist";
 import { UIService } from "@sinequa/components/utils";
@@ -16,12 +16,14 @@ export declare class ChatMessageComponent implements OnChanges, AfterViewInit {
     el: ElementRef;
     message: ChatMessage;
     conversation: ChatMessage[];
-    assistantIcon: string;
+    suggestedActions: SuggestedAction[] | undefined;
+    assistantMessageIcon: string;
+    userMessageIcon: string;
     streaming: boolean;
     canEdit: boolean;
     canRegenerate: boolean;
     canCopy: boolean;
-    referenceClicked: EventEmitter<{
+    openDocument: EventEmitter<{
         filename: string;
         id: string;
         title: string;
@@ -126,19 +128,20 @@ export declare class ChatMessageComponent implements OnChanges, AfterViewInit {
         } | undefined;
         $hasPassages?: boolean | undefined;
     }>;
+    openPreview: EventEmitter<ChatContextAttachment>;
+    suggestAction: EventEmitter<SuggestedAction>;
     edit: EventEmitter<ChatMessage>;
     regenerate: EventEmitter<ChatMessage>;
-    openPreview: EventEmitter<ChatContextAttachment>;
     processor: Processor;
     references: string[];
     referenceMap: Map<string, ChatContextAttachment>;
     showReferences: boolean;
     collapseProgress: boolean;
+    iconSize: number;
     get name(): string;
     constructor(searchService: SearchService, ui: UIService, principalService: PrincipalWebService, cdr: ChangeDetectorRef, el: ElementRef);
     ngOnChanges(changes: SimpleChanges): void;
     ngAfterViewInit(): void;
-    openDocument(record: Record): void;
     /**
      * This Unified plugin looks a text nodes and replaces any reference in the
      * form [1], [2.3], etc. with custom nodes of type "chat-reference".
@@ -156,5 +159,5 @@ export declare class ChatMessageComponent implements OnChanges, AfterViewInit {
     getReferenceMatches(content: string): RegExpMatchArray[];
     copyToClipboard(text: string): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ChatMessageComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ChatMessageComponent, "sq-chat-message", never, { "message": "message"; "conversation": "conversation"; "assistantIcon": "assistantIcon"; "streaming": "streaming"; "canEdit": "canEdit"; "canRegenerate": "canRegenerate"; "canCopy": "canCopy"; }, { "referenceClicked": "referenceClicked"; "edit": "edit"; "regenerate": "regenerate"; "openPreview": "openPreview"; }, never, never, true>;
+    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"; }, { "openDocument": "openDocument"; "openPreview": "openPreview"; "suggestAction": "suggestAction"; "edit": "edit"; "regenerate": "regenerate"; }, never, never, true>;
 }

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

@@ -5,6 +5,7 @@ import { Subscription } from "rxjs";
 import { InstanceManagerService } from "../instance-manager.service";
 import { PrincipalWebService } from "@sinequa/core/web-services";
 import { LoginService } from "@sinequa/core/login";
+import { AppService } from "@sinequa/core/app-utils";
 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 */
@@ -23,6 +24,7 @@ export declare class ChatSettingsV3Component implements OnInit, OnDestroy {
     loginService: LoginService;
     instanceManagerService: InstanceManagerService;
     principalService: PrincipalWebService;
+    appService: AppService;
     ngOnInit(): void;
     ngOnDestroy(): void;
     get hasPrompts(): boolean;
@@ -35,6 +37,7 @@ export declare class ChatSettingsV3Component implements OnInit, OnDestroy {
     private initFunctionsList;
     /**
      * Save the new chat config in the chat service and the user preferences
+     * If the user has never modified the default values, we need to save the hash of the standard default values, as defined by the admin, in order to properly track changes afterwards.
      */
     save(): void;
     /**

package/chat/chat.component.d.ts

@@ -6,15 +6,12 @@ import { Query } from "@sinequa/core/app-utils";
 import { PrincipalWebService } from "@sinequa/core/web-services";
 import { BehaviorSubject, Subscription } from "rxjs";
 import { ChatService } from "./chat.service";
-import { ChatContextAttachment, ChatConfig, ChatMessage, GllmModelDescription, MessageHandler, RawMessage } from "./types";
+import { ChatContextAttachment, ChatConfig, ChatMessage, GllmModelDescription, MessageHandler, RawMessage, SuggestedAction, InitChat } from "./types";
 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 * as i0 from "@angular/core";
-export interface InitChat {
-    messages: RawMessage[];
-}
 export declare class ChatComponent extends AbstractFacet implements OnInit, OnChanges, OnDestroy {
     loginService: LoginService;
     websocketService: WebSocketChatService;
@@ -939,17 +936,23 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
      * @param newQuery The new query
      * @returns true if the chat should be reloaded, false otherwise
      */
-    queryChangeShouldTriggerReload: (prevQuery: any, newQuery: any) => boolean;
+    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 */
     automaticScrollToLastResponse: boolean;
+    /** A chat discussion that the component should get initialized with it */
     chat?: InitChat;
-    customAssistantIcon: string;
+    /** Icon to use for the assistant messages */
+    assistantMessageIcon: string;
+    /** Icon to use for the user messages */
+    userMessageIcon: string;
+    /** Event emitter triggered each time the assistant updates the current chat */
     data: EventEmitter<ChatMessage[]>;
-    referenceClicked: EventEmitter<{
+    /** Event emitter triggered when the user clicks to open the original document representing the context attachment*/
+    openDocument: EventEmitter<{
         filename: string;
         id: string;
         title: string;
@@ -1054,9 +1057,13 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
         } | undefined;
         $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>;
-    error: EventEmitter<any>;
+    /** Emits the assistant configuration used when instantiating the component */
     _config: EventEmitter<ChatConfig>;
     messageList?: ElementRef<HTMLUListElement>;
     questionInput?: ElementRef<HTMLTextAreaElement>;
@@ -1070,8 +1077,6 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
     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;
@@ -1079,10 +1084,15 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
     isAtBottom: boolean;
     initializationError: boolean;
     enabledUserInput: boolean;
+    private _previousQuery;
     constructor();
     ngOnInit(): void;
     ngOnChanges(changes: SimpleChanges): void;
     ngOnDestroy(): void;
+    /**
+     * Instantiate the chat service based on the provided @input protocol
+     * The chat service instance will then be stored in the instanceManagerService with provided @input instanceId as a key
+     */
     instantiateChatService(): void;
     get actions(): Action[];
     private handleChanges;
@@ -1092,8 +1102,7 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
     submitQuestion(): void;
     private fetchAnswer;
     /**
-     * Given a list of messages, fetch the server for a continuation and updates
-     * the list of messages accordingly.
+     * Given a list of messages, the chat endpoint is invoked for a continuation and updates the list of messages accordingly.
      * @param messages
      */
     fetch(messages: ChatMessage[]): void;
@@ -1124,17 +1133,29 @@ export declare class ChatComponent extends AbstractFacet implements OnInit, OnCh
      */
     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
+     * Reset the chat by clearing the chat history and the UI accordingly
+     * The user input will be cleared
      * The fetch subscription will be terminated
      */
     resetChat(): void;
     onLoadChat(): void;
     terminateFetch(): void;
+    /**
+     * Copy a previous user message of the chat history to the chat user input.
+     * Thus, the user can edit and resubmit the message.
+     * 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.
+     * @param index The index of the user's message to edit
+     */
     editMessage(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.
+     * @param index The index of the assistant's message to regenerate
+     */
     regenerateMessage(index: number): void;
     onKeyUp(event: KeyboardEvent): void;
     calculateHeight(): 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"; "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"; "assistantMessageIcon": "assistantMessageIcon"; "userMessageIcon": "userMessageIcon"; }, { "data": "data"; "openDocument": "openDocument"; "openPreview": "openPreview"; "suggestAction": "suggestAction"; "loading$": "loading"; "_config": "config"; }, ["loadingTpl"], never, true>;
 }

package/chat/chat.service.d.ts

@@ -3,7 +3,7 @@ import { LoginService } from "@sinequa/core/login";
 import { NotificationsService } from "@sinequa/core/notification";
 import { AuditWebService, UserSettingsWebService } from "@sinequa/core/web-services";
 import { BehaviorSubject, Observable } from "rxjs";
-import { ChatConfig, ChatMessage, ChatResponse, GllmFunction, GllmModelDescription, SavedChat, SavedChatHistory } from "./types";
+import { ChatConfig, ChatMessage, ChatResponse, ChatUsageMetrics, GllmFunction, GllmModelDescription, Quota, SavedChat, SavedChatHistory, TokenConsumption, UserTokenConsumption } from "./types";
 import { AppService, Query } from "@sinequa/core/app-utils";
 import { IntlService } from "@sinequa/core/intl";
 import { ModalService } from "@sinequa/core/modal";
@@ -29,6 +29,14 @@ export declare abstract class ChatService {
     savedChats$: BehaviorSubject<SavedChat[]>;
     /** Emit the saved chat to load */
     loadSavedChat$: BehaviorSubject<SavedChat | undefined>;
+    /** Emit the quota each time the chat is invoked */
+    quota$: BehaviorSubject<Quota | undefined>;
+    /** Emit the calculated user's token consumption based on the quota */
+    userTokenConsumption$: BehaviorSubject<UserTokenConsumption | undefined>;
+    /** Emit the chat usage metrics each time the generation of the assistant response is completed */
+    chatUsageMetrics$: BehaviorSubject<ChatUsageMetrics | undefined>;
+    /** Emit the calculated chat's token consumption based on the chat usage metrics */
+    chatTokenConsumption$: BehaviorSubject<TokenConsumption | undefined>;
     /** Instance ID of the chat service defining the assistant instance */
     private _chatInstanceId;
     /** ID of the current chat discussion which is used to update/get/delete it */
@@ -81,12 +89,13 @@ export declare abstract class ChatService {
     /**
      * Update the chat config and store its defaultValues in the user preferences
      * @param config  The updated chat config
+     * @param hashes  The updated hashes to store in the user preferences
      * @param notify  Whether to notify the user about the update
      * @param successCallback  The callback to execute if the update is successful
      * @param errorCallback  The callback to execute if the update fails
      */
     updateChatConfig(config: ChatConfig, hashes?: {
-        "applied-defaultValues-hash": string;
+        "applied-defaultValues-hash"?: string;
         "skipped-defaultValues-hash"?: string;
     }, notify?: boolean, successCallback?: () => any, errorCallback?: () => any): void;
     /**
@@ -101,6 +110,19 @@ 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>;
+    /**
+     * 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.
+     * @param quota The updated quota
+     * @param propagateError Whether to propagate the error to the caller
+     */
+    updateQuota(quota: Quota, propagateError?: boolean): void;
+    /**
+     * A handler for chat usage metrics each time the generation of the assistant response is completed.
+     * It emits the chat usage metrics to the chatUsageMetrics$ subject, emits accordingly the updated chat's tokens consumption
+     * @param chatUsageMetrics The chat usage metrics
+     */
+    updateChatUsageMetrics(chatUsageMetrics: ChatUsageMetrics): void;
     /**
      * Get the model description for the given (serviceId + modelId)
      * If a model is not found, an error message is returned

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

@@ -1,5 +1,4 @@
 import { EventEmitter, OnDestroy, OnInit } from "@angular/core";
-import { AuditWebService } from "@sinequa/core/web-services";
 import { Subscription, BehaviorSubject } from "rxjs";
 import { LoginService } from "@sinequa/core/login";
 import { ModalService } from "@sinequa/core/modal";
@@ -21,7 +20,6 @@ export declare class SavedChatsComponent implements OnInit, OnDestroy {
     }[]>;
     loginService: LoginService;
     instanceManagerService: InstanceManagerService;
-    auditService: AuditWebService;
     modalService: ModalService;
     notificationsService: NotificationsService;
     ngOnInit(): void;

package/chat/token-progress-bar/token-progress-bar.component.d.ts

@@ -0,0 +1,27 @@
+import { OnDestroy, OnInit } from '@angular/core';
+import { Subscription } from 'rxjs';
+import { ChatConfig } from '../types';
+import { LoginService } from '@sinequa/core/login';
+import { InstanceManagerService } from '../instance-manager.service';
+import { ChatService } from '../chat.service';
+import * as i0 from "@angular/core";
+export declare class TokenProgressBarComponent implements OnInit, OnDestroy {
+    /** Define the key based on it, the appropriate chatService instance will be returned from instanceManagerService */
+    instanceId: string;
+    chatService: ChatService;
+    config: ChatConfig;
+    subscription: Subscription;
+    userPercentage?: number;
+    userTitle?: string;
+    chatPercentage?: number;
+    chatTitle?: string;
+    loginService: LoginService;
+    instanceManagerService: InstanceManagerService;
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    instantiateChatService(): void;
+    onUserTokensConsumption(): void;
+    onChatTokensConsumption(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TokenProgressBarComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<TokenProgressBarComponent, "sq-token-progress-bar", never, { "instanceId": "instanceId"; }, {}, never, never, true>;
+}

package/chat/types.d.ts

@@ -25,9 +25,11 @@ export interface ChatMessage extends RawMessage {
         display?: boolean;
         $progress?: ChatProgress[];
         $attachment?: ChatContextAttachment[];
+        $suggestedAction?: SuggestedAction[];
         forcedWorkflow?: string;
         query?: Query;
         isUserInput?: boolean;
+        usageMetrics?: ChatUsageMetrics;
         [key: string]: any;
     };
 }
@@ -83,6 +85,8 @@ export interface GllmModelDescription {
     serviceId: string;
     modelId: string;
     enable: boolean;
+    maxGenerationSize: number;
+    contextWindowSize: number;
 }
 /**
  * Response of the ListFunctions API
@@ -466,10 +470,16 @@ export declare const chatConfigSchema: z.ZodObject<{
     }>;
     globalSettings: z.ZodObject<{
         disclaimer: z.ZodOptional<z.ZodString>;
+        displayUserQuotaConsumption: z.ZodOptional<z.ZodBoolean>;
+        displayChatTokensConsumption: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         disclaimer?: string | undefined;
+        displayUserQuotaConsumption?: boolean | undefined;
+        displayChatTokensConsumption?: boolean | undefined;
     }, {
         disclaimer?: string | undefined;
+        displayUserQuotaConsumption?: boolean | undefined;
+        displayChatTokensConsumption?: boolean | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     connectionSettings: {
@@ -520,6 +530,8 @@ export declare const chatConfigSchema: z.ZodObject<{
     };
     globalSettings: {
         disclaimer?: string | undefined;
+        displayUserQuotaConsumption?: boolean | undefined;
+        displayChatTokensConsumption?: boolean | undefined;
     };
 }, {
     connectionSettings: {
@@ -570,6 +582,8 @@ export declare const chatConfigSchema: z.ZodObject<{
     };
     globalSettings: {
         disclaimer?: string | undefined;
+        displayUserQuotaConsumption?: boolean | undefined;
+        displayChatTokensConsumption?: boolean | undefined;
     };
 }>;
 export interface ChatConfig extends z.infer<typeof chatConfigSchema> {
@@ -610,9 +624,19 @@ export interface Quota {
     nextResetUTC: string;
     maxQuotaReached: boolean;
 }
+export interface SuggestedAction {
+    content: string;
+    type: string;
+}
+export interface InitChat {
+    messages: RawMessage[];
+}
 /**
  * List of events data that can be emitted by the websocket chat endpoint
  */
+export declare type SuggestedActionsEvent = {
+    suggestedActions: SuggestedAction[];
+};
 export declare type QuotaEvent = {
     quota: Quota;
 };
@@ -643,6 +667,7 @@ export declare type HistoryEvent = {
  */
 export declare type HttpChatResponse = {
     quota: Quota;
+    suggestedActions: SuggestedAction[];
     debug: any;
     context: {
         content: string;
@@ -652,6 +677,18 @@ export declare type HttpChatResponse = {
     history: RawMessage[];
     executionTime: string;
 };
+export interface TokenConsumption {
+    percentage: number;
+}
+export interface UserTokenConsumption extends TokenConsumption {
+    nextResetDate: string;
+}
+export interface ChatUsageMetrics {
+    totalTokenCount: number;
+    promptTokenCount: number;
+    completionTokenCount: number;
+    tokenizerType: string;
+}
 export declare type MessageHandler<T> = {
     handler: (data: T) => void;
     isGlobalHandler: boolean;

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

@@ -16,6 +16,7 @@ export declare class WebSocketChatService extends ChatService {
     private _content;
     private _executionTime;
     private _attachments;
+    private _suggestedActions;
     signalRService: SignalRWebService;
     authenticationService: AuthenticationService;
     constructor();