@sinequa/assistant 3.9.1 → 3.9.3

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';

package/chat/saved-chats/i18n/en.json

@@ -1,4 +1,5 @@
 {
   "rename": "Rename",
-  "delete": "Delete"
+  "delete": "Delete",
+  "listError": "Oops! We're having trouble loading your past chats right now. Please try again later. If the problem persists, contact support for assistance."
 }

package/chat/saved-chats/i18n/fr.json

@@ -1,4 +1,5 @@
 {
   "rename": "Renommer",
-  "delete": "Supprimer"
+  "delete": "Supprimer",
+  "listError": "Oups ! Nous avons un problème pour charger vos anciennes conversations. Veuillez réessayer plus tard. Si le problème persiste, contactez le support pour assistance."
 }

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

@@ -19,6 +19,7 @@ export declare class SavedChatsComponent implements OnInit, OnDestroy {
     instanceManagerService: InstanceManagerService;
     notificationsService: NotificationsService;
     private readonly transloco;
+    private readonly assistantUtils;
     ngOnInit(): void;
     ngOnDestroy(): void;
     instantiateChatService(): void;

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

@@ -0,0 +1,27 @@
+import { Observable } from 'rxjs';
+import { ChatMessage, SavedChat, SavedChatHistory, SavedChatResponse, DeleteSavedChatResponse } from '../types';
+import * as i0 from "@angular/core";
+export interface SavedChatsOperationConfig {
+    getAppName: () => string;
+    getInstanceId: () => string;
+    getRestUrl: () => string;
+    getDebugFlag: () => boolean;
+    isSavedChatsEnabled: () => boolean;
+    setSavedChatsErrorStatus: (hasError: boolean) => void;
+    updateSavedChatsList: (chats: SavedChat[]) => void;
+    generateAuditEvent: (type: string, details: Record<string, any>, id?: string) => Promise<void>;
+}
+export declare class SavedChatsService {
+    private operationConfig;
+    constructor();
+    init(config: SavedChatsOperationConfig): void;
+    private ensureInitialized;
+    listChats(): void;
+    getChatById(id: string): Observable<SavedChatHistory | undefined>;
+    addChat(id: string, messages: ChatMessage[]): Observable<SavedChatResponse>;
+    updateChat(id: string, name?: string, messages?: ChatMessage[]): Observable<SavedChatResponse>;
+    deleteChat(ids: string[]): Observable<DeleteSavedChatResponse>;
+    isExistingChat(id: string): Observable<boolean>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SavedChatsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SavedChatsService>;
+}

package/chat/services/assistant-configuration.service.d.ts

@@ -0,0 +1,34 @@
+import { ChatConfig } from '../types';
+import * as i0 from "@angular/core";
+export interface AssistantConfigurationOperationContext {
+    getChatInstanceId: () => string;
+    getChatId: () => string;
+    getAssistantConfigValue: () => ChatConfig | undefined;
+    setAssistantConfig: (config: ChatConfig | undefined) => void;
+    setWSRequestsUrl: (url: string) => void;
+    setRESTRequestsUrl: (url: string) => void;
+    setInitConfigStatus: (status: boolean) => void;
+    generateAuditEvent: (type: string, details: Record<string, any>, id?: string) => Promise<void>;
+}
+export declare class AssistantConfigurationService {
+    private context;
+    private appService;
+    private userSettingsService;
+    private principalService;
+    private modalService;
+    private notificationsService;
+    private transloco;
+    constructor();
+    init(context: AssistantConfigurationOperationContext): void;
+    private ensureInitialized;
+    getAssistantsSetting(): any;
+    initChatConfig(): Promise<void>;
+    updateChatConfig(config: ChatConfig, hashes?: {
+        "applied-defaultValues-hash"?: string;
+        "skipped-defaultValues-hash"?: string;
+    }, notify?: boolean, successCallback?: () => any, errorCallback?: () => any): void;
+    getWSRequestsUrl(): void;
+    getRESTRequestsUrl(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AssistantConfigurationService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AssistantConfigurationService>;
+}

package/chat/services/assistant-metadata.service.d.ts

@@ -0,0 +1,18 @@
+import { Observable } from 'rxjs';
+import { ChatConfig, GllmModelDescription, GllmFunction } from '../types';
+import * as i0 from "@angular/core";
+export interface AssistantMetadataOperationContext {
+    getRestUrl: () => string;
+    getAssistantConfigValue: () => ChatConfig | undefined;
+    setModels: (models: GllmModelDescription[] | undefined) => void;
+    setFunctions: (functions: GllmFunction[] | undefined) => void;
+}
+export declare class AssistantMetadataService {
+    private context;
+    init(context: AssistantMetadataOperationContext): void;
+    private ensureInitialized;
+    listModels(): Observable<GllmModelDescription[] | undefined>;
+    listFunctions(): Observable<GllmFunction[] | undefined>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AssistantMetadataService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AssistantMetadataService>;
+}

package/chat/services/assistant-tokens-tracking.service.d.ts

@@ -0,0 +1,23 @@
+import { ChatConfig, ChatUsageMetrics, GllmModelDescription, Quota, TokenConsumption, UserTokenConsumption } from '../types';
+import * as i0 from "@angular/core";
+export interface AssistantTokensTrackingOperationContext {
+    getAssistantConfigValue: () => ChatConfig | undefined;
+    setQuota: (quota: Quota | undefined) => void;
+    setUserTokenConsumption: (consumption: UserTokenConsumption | undefined) => void;
+    setChatUsageMetrics: (metrics: ChatUsageMetrics | undefined) => void;
+    setChatTokenConsumption: (consumption: TokenConsumption | undefined) => void;
+    generateAuditEvent: (type: string, details: Record<string, any>, id?: string) => Promise<void>;
+    getModel: (serviceId: string, modelId: string) => GllmModelDescription | undefined;
+}
+export declare class AssistantTokensTrackingService {
+    private context;
+    private assistantUtils;
+    private notificationsService;
+    constructor();
+    init(context: AssistantTokensTrackingOperationContext): void;
+    private ensureInitialized;
+    updateQuota(quota: Quota, propagateError?: boolean): void;
+    updateChatUsageMetrics(chatUsageMetrics: ChatUsageMetrics): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AssistantTokensTrackingService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AssistantTokensTrackingService>;
+}

package/chat/services/assistant-ws-frames.service.d.ts

@@ -0,0 +1,50 @@
+import { HubConnection } from '@microsoft/signalr';
+import { Observable } from 'rxjs';
+import { Query } from "@sinequa/atomic";
+import { ChatConfig, ChatMessage, ChatResponse, ChatUsageMetrics, MessageHandler, Quota, SavedChatResponse } from '../types';
+import * as i0 from "@angular/core";
+export interface AssistantWsFramesContext {
+    getAssistantConfig: () => ChatConfig | undefined;
+    getChatInstanceId: () => string;
+    getChatId: () => string;
+    getHubConnection: () => HubConnection | undefined;
+    getChatHistory: () => ChatMessage[] | undefined;
+    setStreamingStatus: (isStreaming: boolean) => void;
+    setChatHistory: (history: ChatMessage[] | undefined) => void;
+    setStoppingGenerationStatus: (isStopping: boolean) => void;
+    setSavedChatsErrorStatus: (hasError: boolean) => void;
+    updateQuota: (quota: Quota, propagateError?: boolean) => void;
+    updateChatUsageMetrics: (metrics: ChatUsageMetrics) => void;
+    generateAuditEvent: (type: string, details: Record<string, any>, id?: string) => Promise<void>;
+    addSavedChat: (id: string, messages: ChatMessage[]) => Observable<SavedChatResponse>;
+    updateSavedChat: (id: string, name?: string, messages?: ChatMessage[]) => Observable<SavedChatResponse>;
+    listSavedChat: () => void;
+    isExistingSavedChat: (id: string) => Observable<boolean>;
+}
+export declare class AssistantWsFramesService {
+    private context;
+    private appService;
+    private transloco;
+    private assistantUtils;
+    private notificationsService;
+    private _messageHandlers;
+    private _response;
+    private _actionMap;
+    private _progress;
+    private _executionTime;
+    private _executionTimeMilliseconds?;
+    private _attachments;
+    private _debugMessages;
+    init(context: AssistantWsFramesContext): void;
+    private ensureInitialized;
+    fetch(messages: ChatMessage[], query: Query): Observable<ChatResponse>;
+    initMessageHandlers(): void;
+    overrideMessageHandlers<T>(_messageHandlers: Map<string, MessageHandler<T>>): void;
+    addMessageHandler<T>(eventName: string, eventHandler: MessageHandler<T>): void;
+    registerMessageHandler<T>(eventName: string, eventHandler: MessageHandler<T>): void;
+    removeMessageHandler(eventName: string): void;
+    unsubscribeMessageHandler(eventName: string): void;
+    stopGeneration(): Observable<boolean>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AssistantWsFramesService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AssistantWsFramesService>;
+}

package/chat/services/signalR-connection.service.d.ts

@@ -0,0 +1,25 @@
+import { HubConnection } from '@microsoft/signalr';
+import { ConnectionOptions } from './signalR.web.service';
+import { ChatConfig } from '../types';
+import * as i0 from "@angular/core";
+export interface SignalRConnectionOperationConfig {
+    getWsRequestUrl: () => string;
+    getAssistantConfigValue: () => ChatConfig | undefined;
+    getHubConnection: () => HubConnection | undefined;
+    setHubConnection: (connection: HubConnection | undefined) => void;
+}
+export declare class SignalRConnectionService {
+    private operationConfig;
+    private signalRWebService;
+    private assistantUtils;
+    init(config: SignalRConnectionOperationConfig): void;
+    private ensureInitialized;
+    private _getLogLevel;
+    private _getTransports;
+    private getDefaultOptions;
+    buildConnection(options?: ConnectionOptions): Promise<void>;
+    startConnection(): Promise<void>;
+    stopConnection(): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SignalRConnectionService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SignalRConnectionService>;
+}

package/chat/services/signalR.web.service.d.ts

@@ -5,6 +5,7 @@ export interface ConnectionOptions {
     withCredentials?: boolean;
     headers?: MessageHeaders;
     transport?: HttpTransportType | ITransport;
+    skipNegotiation?: boolean;
     accessTokenFactory?: () => string | Promise<string>;
 }
 /** A token that is used to inject the transports allowed to use by hub connection.

package/chat/types.d.ts

@@ -24,6 +24,7 @@ export interface RawMessage {
  */
 export interface ChatMessage extends RawMessage {
     additionalProperties: {
+        messageId: string;
         display?: boolean;
         $progress?: ChatProgress[];
         $attachment?: ChatContextAttachment[];
@@ -144,6 +145,7 @@ export declare const connectionSettingsSchema: z.ZodEffects<z.ZodObject<{
     connectionErrorMessage: z.ZodString;
     restEndpoint: z.ZodOptional<z.ZodString>;
     websocketEndpoint: z.ZodOptional<z.ZodString>;
+    signalRSkipNegotiation: z.ZodOptional<z.ZodBoolean>;
     signalRTransport: z.ZodEnum<["WebSockets", "ServerSentEvents", "LongPolling", "None"]>;
     signalRLogLevel: z.ZodEnum<["Critical", "Debug", "Error", "Information", "None", "Trace", "Warning"]>;
     signalRServerTimeoutInMilliseconds: z.ZodOptional<z.ZodNumber>;
@@ -153,6 +155,7 @@ export declare const connectionSettingsSchema: z.ZodEffects<z.ZodObject<{
     signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
     restEndpoint?: string | undefined;
     websocketEndpoint?: string | undefined;
+    signalRSkipNegotiation?: boolean | undefined;
     signalRServerTimeoutInMilliseconds?: number | undefined;
 }, {
     connectionErrorMessage: string;
@@ -160,6 +163,7 @@ export declare const connectionSettingsSchema: z.ZodEffects<z.ZodObject<{
     signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
     restEndpoint?: string | undefined;
     websocketEndpoint?: string | undefined;
+    signalRSkipNegotiation?: boolean | undefined;
     signalRServerTimeoutInMilliseconds?: number | undefined;
 }>, {
     connectionErrorMessage: string;
@@ -167,6 +171,7 @@ export declare const connectionSettingsSchema: z.ZodEffects<z.ZodObject<{
     signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
     restEndpoint?: string | undefined;
     websocketEndpoint?: string | undefined;
+    signalRSkipNegotiation?: boolean | undefined;
     signalRServerTimeoutInMilliseconds?: number | undefined;
 }, {
     connectionErrorMessage: string;
@@ -174,6 +179,7 @@ export declare const connectionSettingsSchema: z.ZodEffects<z.ZodObject<{
     signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
     restEndpoint?: string | undefined;
     websocketEndpoint?: string | undefined;
+    signalRSkipNegotiation?: boolean | undefined;
     signalRServerTimeoutInMilliseconds?: number | undefined;
 }>;
 export type ConnectionSettings = z.infer<typeof connectionSettingsSchema>;
@@ -395,6 +401,7 @@ export declare const chatConfigSchema: z.ZodObject<{
         connectionErrorMessage: z.ZodString;
         restEndpoint: z.ZodOptional<z.ZodString>;
         websocketEndpoint: z.ZodOptional<z.ZodString>;
+        signalRSkipNegotiation: z.ZodOptional<z.ZodBoolean>;
         signalRTransport: z.ZodEnum<["WebSockets", "ServerSentEvents", "LongPolling", "None"]>;
         signalRLogLevel: z.ZodEnum<["Critical", "Debug", "Error", "Information", "None", "Trace", "Warning"]>;
         signalRServerTimeoutInMilliseconds: z.ZodOptional<z.ZodNumber>;
@@ -404,6 +411,7 @@ export declare const chatConfigSchema: z.ZodObject<{
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
+        signalRSkipNegotiation?: boolean | undefined;
         signalRServerTimeoutInMilliseconds?: number | undefined;
     }, {
         connectionErrorMessage: string;
@@ -411,6 +419,7 @@ export declare const chatConfigSchema: z.ZodObject<{
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
+        signalRSkipNegotiation?: boolean | undefined;
         signalRServerTimeoutInMilliseconds?: number | undefined;
     }>, {
         connectionErrorMessage: string;
@@ -418,6 +427,7 @@ export declare const chatConfigSchema: z.ZodObject<{
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
+        signalRSkipNegotiation?: boolean | undefined;
         signalRServerTimeoutInMilliseconds?: number | undefined;
     }, {
         connectionErrorMessage: string;
@@ -425,6 +435,7 @@ export declare const chatConfigSchema: z.ZodObject<{
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
+        signalRSkipNegotiation?: boolean | undefined;
         signalRServerTimeoutInMilliseconds?: number | undefined;
     }>;
     defaultValues: z.ZodObject<{
@@ -642,6 +653,7 @@ export declare const chatConfigSchema: z.ZodObject<{
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
+        signalRSkipNegotiation?: boolean | undefined;
         signalRServerTimeoutInMilliseconds?: number | undefined;
     };
     defaultValues: {
@@ -708,6 +720,7 @@ export declare const chatConfigSchema: z.ZodObject<{
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
+        signalRSkipNegotiation?: boolean | undefined;
         signalRServerTimeoutInMilliseconds?: number | undefined;
     };
     defaultValues: {
@@ -780,8 +793,8 @@ export interface ChatPayload {
         targetUrl?: string;
         accessToken?: string;
     };
-    instanceId?: string;
-    savedChatId?: string;
+    instanceId: string;
+    chatId: string;
     genericChatErrorMessage?: string;
 }
 export type ActionMessage = {
@@ -892,7 +905,15 @@ export interface ListObject {
     items: (KvObject | ListObject)[];
     expanded: boolean;
 }
-export type DebugMessage = KvObject | ListObject;
+export type DebugMessage = {
+    title: string;
+    chatId: string;
+    executionId: string;
+    debugMessageId: string;
+    $expanded?: boolean;
+    $loading?: boolean;
+    $details?: ListObject[];
+};
 export type MessageHandler<T> = {
     handler: (data: T) => void;
     isGlobalHandler: boolean;

package/chat/utils/utils.service.d.ts

@@ -0,0 +1,67 @@
+import { TranslocoService } from "@jsverse/transloco";
+import { ChatMessage } from "../types";
+import * as i0 from "@angular/core";
+export declare class AssistantUtils {
+    readonly localID: string | null;
+    protected readonly transloco: TranslocoService;
+    /**
+     * Retrieves the rank (1-based index) of a message within a chat history array based on its message ID.
+     * If the message is not found, returns -1.
+     *
+     * @param array - An array of `ChatMessage` objects or `undefined`. Represents the chat history.
+     * @param messageId - The unique identifier of the message to locate.
+     * @returns The 1-based index of the message in the array, or -1 if the message is not found.
+     */
+    getMessageRankInChatHistory(array: ChatMessage[] | undefined, messageId: string): number;
+    /**
+     * 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
+     */
+    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;
+    /**
+     * Get the current locale name.
+     * @returns The current locale name or an empty string if not available.
+     */
+    getCurrentLocaleName(): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AssistantUtils, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AssistantUtils>;
+}