@sinequa/assistant 3.6.2 → 3.7.1

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;
@@ -71,7 +72,7 @@ export interface ChatContextAttachment extends RawAttachment {
  */
 export interface RawResponse {
     history: RawMessage[];
-    executionTime: string;
+    executionTime: string | undefined;
 }
 /**
  * Enriched response of the chat API
@@ -126,30 +127,35 @@ export declare const connectionSettingsSchema: z.ZodEffects<z.ZodObject<{
     websocketEndpoint: z.ZodOptional<z.ZodString>;
     signalRTransport: z.ZodEnum<["WebSockets", "ServerSentEvents", "LongPolling", "None"]>;
     signalRLogLevel: z.ZodEnum<["Critical", "Debug", "Error", "Information", "None", "Trace", "Warning"]>;
+    signalRServerTimeoutInMilliseconds: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     connectionErrorMessage: string;
     signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
     signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
     restEndpoint?: string | undefined;
     websocketEndpoint?: string | undefined;
+    signalRServerTimeoutInMilliseconds?: number | undefined;
 }, {
     connectionErrorMessage: string;
     signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
     signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
     restEndpoint?: string | undefined;
     websocketEndpoint?: string | undefined;
+    signalRServerTimeoutInMilliseconds?: number | undefined;
 }>, {
     connectionErrorMessage: string;
     signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
     signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
     restEndpoint?: string | undefined;
     websocketEndpoint?: string | undefined;
+    signalRServerTimeoutInMilliseconds?: number | undefined;
 }, {
     connectionErrorMessage: string;
     signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
     signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
     restEndpoint?: string | undefined;
     websocketEndpoint?: string | undefined;
+    signalRServerTimeoutInMilliseconds?: number | undefined;
 }>;
 export declare type ConnectionSettings = z.infer<typeof connectionSettingsSchema>;
 declare const serviceSettingsSchema: z.ZodObject<{
@@ -260,7 +266,16 @@ declare const defaultValuesSchema: z.ZodObject<{
 }>;
 export interface DefaultValues extends z.infer<typeof defaultValuesSchema> {
 }
-declare const modeSettingsSchema: z.ZodObject<{
+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;
     sendUserPrompt: z.ZodBoolean;
@@ -268,23 +283,52 @@ declare const modeSettingsSchema: z.ZodObject<{
         event: z.ZodEnum<["Query", "Prompt"]>;
         forcedWorkflow: z.ZodOptional<z.ZodString>;
         displayUserQuery: z.ZodOptional<z.ZodBoolean>;
+        chatStarters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            text: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            text: string;
+        }, {
+            text: string;
+        }>, "many">>;
     }, "strip", z.ZodTypeAny, {
         event: "Query" | "Prompt";
         forcedWorkflow?: string | undefined;
         displayUserQuery?: boolean | undefined;
+        chatStarters?: {
+            text: string;
+        }[] | undefined;
     }, {
         event: "Query" | "Prompt";
         forcedWorkflow?: string | undefined;
         displayUserQuery?: boolean | undefined;
+        chatStarters?: {
+            text: string;
+        }[] | undefined;
     }>, {
         event: "Query" | "Prompt";
         forcedWorkflow?: string | undefined;
         displayUserQuery?: boolean | undefined;
+        chatStarters?: {
+            text: string;
+        }[] | undefined;
     }, {
         event: "Query" | "Prompt";
         forcedWorkflow?: string | undefined;
         displayUserQuery?: boolean | undefined;
+        chatStarters?: {
+            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;
@@ -293,7 +337,14 @@ declare const modeSettingsSchema: z.ZodObject<{
         event: "Query" | "Prompt";
         forcedWorkflow?: string | undefined;
         displayUserQuery?: boolean | undefined;
+        chatStarters?: {
+            text: string;
+        }[] | undefined;
     };
+    actions?: globalThis.Record<string, {
+        forcedWorkflow: string;
+        forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+    }> | undefined;
 }, {
     displayUserPrompt: boolean;
     enabledUserInput: boolean;
@@ -302,7 +353,46 @@ declare const modeSettingsSchema: z.ZodObject<{
         event: "Query" | "Prompt";
         forcedWorkflow?: string | undefined;
         displayUserQuery?: boolean | undefined;
+        chatStarters?: {
+            text: string;
+        }[] | undefined;
     };
+    actions?: globalThis.Record<string, {
+        forcedWorkflow: string;
+        forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+    }> | undefined;
+}>, {
+    displayUserPrompt: boolean;
+    enabledUserInput: boolean;
+    sendUserPrompt: boolean;
+    initialization: {
+        event: "Query" | "Prompt";
+        forcedWorkflow?: string | undefined;
+        displayUserQuery?: boolean | undefined;
+        chatStarters?: {
+            text: string;
+        }[] | undefined;
+    };
+    actions?: globalThis.Record<string, {
+        forcedWorkflow: string;
+        forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+    }> | undefined;
+}, {
+    displayUserPrompt: boolean;
+    enabledUserInput: boolean;
+    sendUserPrompt: boolean;
+    initialization: {
+        event: "Query" | "Prompt";
+        forcedWorkflow?: string | undefined;
+        displayUserQuery?: boolean | undefined;
+        chatStarters?: {
+            text: string;
+        }[] | undefined;
+    };
+    actions?: globalThis.Record<string, {
+        forcedWorkflow: string;
+        forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+    }> | undefined;
 }>;
 export interface ModeSettings extends z.infer<typeof modeSettingsSchema> {
 }
@@ -327,30 +417,35 @@ export declare const chatConfigSchema: z.ZodObject<{
         websocketEndpoint: z.ZodOptional<z.ZodString>;
         signalRTransport: z.ZodEnum<["WebSockets", "ServerSentEvents", "LongPolling", "None"]>;
         signalRLogLevel: z.ZodEnum<["Critical", "Debug", "Error", "Information", "None", "Trace", "Warning"]>;
+        signalRServerTimeoutInMilliseconds: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         connectionErrorMessage: string;
         signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
+        signalRServerTimeoutInMilliseconds?: number | undefined;
     }, {
         connectionErrorMessage: string;
         signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
+        signalRServerTimeoutInMilliseconds?: number | undefined;
     }>, {
         connectionErrorMessage: string;
         signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
+        signalRServerTimeoutInMilliseconds?: number | undefined;
     }, {
         connectionErrorMessage: string;
         signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
+        signalRServerTimeoutInMilliseconds?: number | undefined;
     }>;
     defaultValues: z.ZodObject<{
         service_id: z.ZodString;
@@ -398,7 +493,7 @@ export declare const chatConfigSchema: z.ZodObject<{
         systemPrompt: string;
         userPrompt: string;
     }>;
-    modeSettings: z.ZodObject<{
+    modeSettings: z.ZodEffects<z.ZodObject<{
         enabledUserInput: z.ZodBoolean;
         displayUserPrompt: z.ZodBoolean;
         sendUserPrompt: z.ZodBoolean;
@@ -406,23 +501,52 @@ export declare const chatConfigSchema: z.ZodObject<{
             event: z.ZodEnum<["Query", "Prompt"]>;
             forcedWorkflow: z.ZodOptional<z.ZodString>;
             displayUserQuery: z.ZodOptional<z.ZodBoolean>;
+            chatStarters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                text: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                text: string;
+            }, {
+                text: string;
+            }>, "many">>;
         }, "strip", z.ZodTypeAny, {
             event: "Query" | "Prompt";
             forcedWorkflow?: string | undefined;
             displayUserQuery?: boolean | undefined;
+            chatStarters?: {
+                text: string;
+            }[] | undefined;
         }, {
             event: "Query" | "Prompt";
             forcedWorkflow?: string | undefined;
             displayUserQuery?: boolean | undefined;
+            chatStarters?: {
+                text: string;
+            }[] | undefined;
         }>, {
             event: "Query" | "Prompt";
             forcedWorkflow?: string | undefined;
             displayUserQuery?: boolean | undefined;
+            chatStarters?: {
+                text: string;
+            }[] | undefined;
         }, {
             event: "Query" | "Prompt";
             forcedWorkflow?: string | undefined;
             displayUserQuery?: boolean | undefined;
+            chatStarters?: {
+                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;
@@ -431,7 +555,46 @@ export declare const chatConfigSchema: z.ZodObject<{
             event: "Query" | "Prompt";
             forcedWorkflow?: string | undefined;
             displayUserQuery?: boolean | undefined;
+            chatStarters?: {
+                text: string;
+            }[] | undefined;
+        };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
+    }, {
+        displayUserPrompt: boolean;
+        enabledUserInput: boolean;
+        sendUserPrompt: boolean;
+        initialization: {
+            event: "Query" | "Prompt";
+            forcedWorkflow?: string | undefined;
+            displayUserQuery?: boolean | undefined;
+            chatStarters?: {
+                text: string;
+            }[] | undefined;
+        };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
+    }>, {
+        displayUserPrompt: boolean;
+        enabledUserInput: boolean;
+        sendUserPrompt: boolean;
+        initialization: {
+            event: "Query" | "Prompt";
+            forcedWorkflow?: string | undefined;
+            displayUserQuery?: boolean | undefined;
+            chatStarters?: {
+                text: string;
+            }[] | undefined;
         };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
     }, {
         displayUserPrompt: boolean;
         enabledUserInput: boolean;
@@ -440,7 +603,14 @@ export declare const chatConfigSchema: z.ZodObject<{
             event: "Query" | "Prompt";
             forcedWorkflow?: string | undefined;
             displayUserQuery?: boolean | undefined;
+            chatStarters?: {
+                text: string;
+            }[] | undefined;
         };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
     }>;
     uiSettings: z.ZodObject<{
         display: z.ZodBoolean;
@@ -519,6 +689,7 @@ export declare const chatConfigSchema: z.ZodObject<{
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
+        signalRServerTimeoutInMilliseconds?: number | undefined;
     };
     defaultValues: {
         debug: boolean;
@@ -542,7 +713,14 @@ export declare const chatConfigSchema: z.ZodObject<{
             event: "Query" | "Prompt";
             forcedWorkflow?: string | undefined;
             displayUserQuery?: boolean | undefined;
+            chatStarters?: {
+                text: string;
+            }[] | undefined;
         };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
     };
     uiSettings: {
         display: boolean;
@@ -578,6 +756,7 @@ export declare const chatConfigSchema: z.ZodObject<{
         signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
         restEndpoint?: string | undefined;
         websocketEndpoint?: string | undefined;
+        signalRServerTimeoutInMilliseconds?: number | undefined;
     };
     defaultValues: {
         debug: boolean;
@@ -601,7 +780,14 @@ export declare const chatConfigSchema: z.ZodObject<{
             event: "Query" | "Prompt";
             forcedWorkflow?: string | undefined;
             displayUserQuery?: boolean | undefined;
+            chatStarters?: {
+                text: string;
+            }[] | undefined;
         };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
     };
     uiSettings: {
         display: boolean;

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

@@ -9,12 +9,11 @@ import * as i0 from "@angular/core";
 export declare class WebSocketChatService extends ChatService {
     connection: HubConnection | undefined;
     private _messageHandlers;
+    private _response;
     private _actionMap;
     private _progress;
-    private _content;
     private _executionTime;
     private _attachments;
-    private _suggestedActions;
     private _debugMessages;
     signalRService: SignalRWebService;
     authenticationService: AuthenticationService;
@@ -34,6 +33,7 @@ export declare class WebSocketChatService extends ChatService {
     listModels(): Observable<GllmModelDescription[] | undefined>;
     listFunctions(): Observable<GllmFunction[] | undefined>;
     fetch(messages: ChatMessage[], query: Query): Observable<ChatResponse>;
+    stopGeneration(): Observable<boolean>;
     listSavedChat(): void;
     getSavedChat(id: string): Observable<SavedChatHistory | undefined>;
     addSavedChat(messages: ChatMessage[]): Observable<SavedChat>;
@@ -41,7 +41,7 @@ export declare class WebSocketChatService extends ChatService {
     deleteSavedChat(ids: string[]): Observable<number>;
     /**
      * Initialize out-of-the-box handlers
-     * It is a placeholder for non-streaming scenarios, where you invoke a specific hub method, and the server responds with a single message or a result
+     * It is a placeholder for non-streaming scenarios, where you invoke a specific hub method, and the server responds with frame message(s)
      */
     initMessageHandlers(): void;
     /**
@@ -52,7 +52,7 @@ export declare class WebSocketChatService extends ChatService {
     /**
      * Add a listener for a specific event.
      * If a listener for this same event already exists, it will be overridden.
-     * If the listener has "isChatGlobalHandler" set to true, it will be registered to the hub connection.
+     * If the listener has "isGlobalHandler" set to true, it will be registered to the hub connection.
      * @param eventName Name of the event to register a listener for
      * @param eventHandler The handler to be called when the event is received
      */
@@ -93,8 +93,8 @@ export declare class WebSocketChatService extends ChatService {
      * @returns Promise that resolves when the connection is stopped
      */
     stopConnection(): Promise<void>;
-    private getTransports;
-    private getLogLevel;
+    private _getTransports;
+    private _getLogLevel;
     get defaultOptions(): ConnectionOptions;
     static ɵfac: i0.ɵɵFactoryDeclaration<WebSocketChatService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<WebSocketChatService>;