@sinequa/assistant 3.8.0 → 3.9.0

package/chat/types.d.ts

@@ -1,873 +1,913 @@
-import { z } from 'zod';
-import { Query } from '@sinequa/core/app-utils';
-import { Record } from "@sinequa/core/web-services";
-/**
- * Individual message sent & returned by the ChatGPT API.
- * If this message is an attachment, we attach the minimal
- * information needed to reconstruct this attachment (RawAttachment)
- * as well as the reference id computed at the moment of sending
- * the attachment to the API.
- */
-export interface RawMessage {
-    role: string;
-    content: string;
-    messageType?: 'CHART' | 'MARKDOWN';
-    additionalProperties: {
-        [key: string]: any;
-    };
-}
-/**
- * A chat message that has been processed to include the markdown-formatted
- * content for display, as well as detailed attachment data, and optionally
- * a list of the references extracted from that message
- */
-export interface ChatMessage extends RawMessage {
-    additionalProperties: {
-        display?: boolean;
-        $progress?: ChatProgress[];
-        $attachment?: ChatContextAttachment[];
-        $suggestedAction?: SuggestedAction[];
-        $debug?: DebugMessage[];
-        forcedWorkflow?: string;
-        forcedWorkflowProperties?: any;
-        query?: Query;
-        isUserInput?: boolean;
-        usageMetrics?: ChatUsageMetrics;
-        additionalWorkflowProperties?: any;
-        $liked?: boolean;
-        $disliked?: boolean;
-        [key: string]: any;
-    };
-}
-export interface ChatProgress {
-    title: string;
-    content?: string;
-    done?: boolean;
-    time?: number;
-}
-export interface RawAttachment {
-    /** Type of the attachment */
-    type: string;
-    /** Record id from which this attachment is taken */
-    recordId: string;
-    /** Record from which this this attachment is taken */
-    record: Record;
-}
-export interface DocumentPart {
-    partId: number;
-    offset: number;
-    length: number;
-    text: string;
-}
-export interface ChatContextAttachment extends RawAttachment {
-    /** Type of the attachment */
-    type: "Context";
-    /** Rank of the attachment in the context message */
-    contextId: number;
-    /** Parts of the record that the assistant uses to answer */
-    parts: DocumentPart[];
-    /** The specific id used of the referenced part */
-    $partId?: number;
-}
-/**
- * Raw response of the chat API
- */
-export interface RawResponse {
-    history: RawMessage[];
-    executionTime: string | undefined;
-}
-/**
- * Enriched response of the chat API
- */
-export interface ChatResponse extends RawResponse {
-    history: ChatMessage[];
-}
-/**
- * Response of the ListModels API
- */
-export interface GllmModelDescription {
-    provider: string;
-    name: string;
-    serviceId: string;
-    modelId: string;
-    enable: boolean;
-    maxGenerationSize: number;
-    contextWindowSize: number;
-}
-/**
- * Response of the ListFunctions API
- */
-export interface GllmFunction {
-    functionName: string;
-    description: string;
-    enabled: boolean;
-    parameters: GllmFunctionParameter[];
-}
-export interface GllmFunctionParameter {
-    description: string;
-    isRequired: boolean;
-    name: string;
-    type: string;
-}
-/**
- * Minimal representation of a saved chat
- */
-export interface SavedChat {
-    id: string;
-    title: string;
-    modifiedUTC: string;
-}
-/**
- * Data structure saved to reconstruct a saved chat conversation
- */
-export interface SavedChatHistory extends SavedChat {
-    history: ChatMessage[];
-}
-export declare const connectionSettingsSchema: z.ZodEffects<z.ZodObject<{
-    connectionErrorMessage: z.ZodString;
-    restEndpoint: z.ZodOptional<z.ZodString>;
-    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<{
-    service_id: z.ZodString;
-    model_id: z.ZodString;
-    temperature: z.ZodNumber;
-    top_p: z.ZodNumber;
-    max_tokens: z.ZodNumber;
-}, "strip", z.ZodTypeAny, {
-    service_id: string;
-    model_id: string;
-    temperature: number;
-    top_p: number;
-    max_tokens: number;
-}, {
-    service_id: string;
-    model_id: string;
-    temperature: number;
-    top_p: number;
-    max_tokens: number;
-}>;
-export interface ServiceSettings extends z.infer<typeof serviceSettingsSchema> {
-}
-declare const additionalServiceSettingsSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
-export interface AdditionalServiceSettings extends z.infer<typeof additionalServiceSettingsSchema> {
-}
-declare const additionalWorkflowPropertiesSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
-export interface additionalWorkflowProperties extends z.infer<typeof additionalWorkflowPropertiesSchema> {
-}
-declare const uiSettingsSchema: z.ZodObject<{
-    display: z.ZodBoolean;
-    servicesModels: z.ZodBoolean;
-    functions: z.ZodBoolean;
-    temperature: z.ZodBoolean;
-    top_p: z.ZodBoolean;
-    max_tokens: z.ZodBoolean;
-    debug: z.ZodOptional<z.ZodBoolean>;
-    displaySystemPrompt: z.ZodBoolean;
-    displayUserPrompt: z.ZodBoolean;
-}, "strip", z.ZodTypeAny, {
-    display: boolean;
-    temperature: boolean;
-    top_p: boolean;
-    max_tokens: boolean;
-    servicesModels: boolean;
-    functions: boolean;
-    displaySystemPrompt: boolean;
-    displayUserPrompt: boolean;
-    debug?: boolean | undefined;
-}, {
-    display: boolean;
-    temperature: boolean;
-    top_p: boolean;
-    max_tokens: boolean;
-    servicesModels: boolean;
-    functions: boolean;
-    displaySystemPrompt: boolean;
-    displayUserPrompt: boolean;
-    debug?: boolean | undefined;
-}>;
-export interface UiSettings extends z.infer<typeof uiSettingsSchema> {
-}
-declare const defaultValuesSchema: z.ZodObject<{
-    service_id: z.ZodString;
-    model_id: z.ZodString;
-    functions: z.ZodArray<z.ZodObject<{
-        name: z.ZodString;
-        enabled: z.ZodBoolean;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-        enabled: boolean;
-    }, {
-        name: string;
-        enabled: boolean;
-    }>, "many">;
-    temperature: z.ZodNumber;
-    top_p: z.ZodNumber;
-    max_tokens: z.ZodNumber;
-    debug: z.ZodOptional<z.ZodBoolean>;
-    systemPrompt: z.ZodString;
-    userPrompt: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    service_id: string;
-    model_id: string;
-    temperature: number;
-    top_p: number;
-    max_tokens: number;
-    functions: {
-        name: string;
-        enabled: boolean;
-    }[];
-    systemPrompt: string;
-    userPrompt: string;
-    debug?: boolean | undefined;
-}, {
-    service_id: string;
-    model_id: string;
-    temperature: number;
-    top_p: number;
-    max_tokens: number;
-    functions: {
-        name: string;
-        enabled: boolean;
-    }[];
-    systemPrompt: string;
-    userPrompt: string;
-    debug?: boolean | undefined;
-}>;
-export interface DefaultValues extends z.infer<typeof defaultValuesSchema> {
-}
-declare const modeSettingsSchema: z.ZodObject<{
-    enabledUserInput: z.ZodBoolean;
-    displayUserPrompt: z.ZodBoolean;
-    sendUserPrompt: z.ZodBoolean;
-    initialization: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObject<{
-        event: z.ZodEnum<["Query", "Prompt"]>;
-        forcedWorkflow: z.ZodOptional<z.ZodString>;
-        forcedFunction: z.ZodOptional<z.ZodString>;
-        displayUserQuery: z.ZodOptional<z.ZodBoolean>;
-    }, "strip", z.ZodTypeAny, {
-        event: "Query" | "Prompt";
-        forcedWorkflow?: string | undefined;
-        forcedFunction?: string | undefined;
-        displayUserQuery?: boolean | undefined;
-    }, {
-        event: "Query" | "Prompt";
-        forcedWorkflow?: string | undefined;
-        forcedFunction?: string | undefined;
-        displayUserQuery?: boolean | undefined;
-    }>, {
-        event: "Query" | "Prompt";
-        forcedWorkflow?: string | undefined;
-        forcedFunction?: string | undefined;
-        displayUserQuery?: boolean | undefined;
-    }, {
-        event: "Query" | "Prompt";
-        forcedWorkflow?: string | undefined;
-        forcedFunction?: string | undefined;
-        displayUserQuery?: boolean | undefined;
-    }>, {
-        event: "Query" | "Prompt";
-        forcedWorkflow?: string | undefined;
-        forcedFunction?: string | undefined;
-        displayUserQuery?: boolean | undefined;
-    }, {
-        event: "Query" | "Prompt";
-        forcedWorkflow?: string | undefined;
-        forcedFunction?: string | undefined;
-        displayUserQuery?: boolean | undefined;
-    }>, {
-        event: "Query" | "Prompt";
-        forcedWorkflow?: string | undefined;
-        forcedFunction?: string | undefined;
-        displayUserQuery?: boolean | undefined;
-    }, {
-        event: "Query" | "Prompt";
-        forcedWorkflow?: string | undefined;
-        forcedFunction?: string | undefined;
-        displayUserQuery?: boolean | 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;
-    sendUserPrompt: boolean;
-    initialization: {
-        event: "Query" | "Prompt";
-        forcedWorkflow?: string | undefined;
-        forcedFunction?: string | undefined;
-        displayUserQuery?: boolean | 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;
-        forcedFunction?: string | undefined;
-        displayUserQuery?: boolean | undefined;
-    };
-    actions?: globalThis.Record<string, {
-        forcedWorkflow: string;
-        forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
-    }> | undefined;
-}>;
-export interface ModeSettings extends z.infer<typeof modeSettingsSchema> {
-}
-declare const savedChatSettingsSchema: z.ZodObject<{
-    enabled: z.ZodBoolean;
-    display: z.ZodBoolean;
-}, "strip", z.ZodTypeAny, {
-    display: boolean;
-    enabled: boolean;
-}, {
-    display: boolean;
-    enabled: boolean;
-}>;
-export interface SavedChatSettings extends z.infer<typeof savedChatSettingsSchema> {
-}
-export interface SavedChatSettings extends z.infer<typeof savedChatSettingsSchema> {
-}
-export declare const chatConfigSchema: z.ZodObject<{
-    connectionSettings: z.ZodEffects<z.ZodObject<{
-        connectionErrorMessage: z.ZodString;
-        restEndpoint: z.ZodOptional<z.ZodString>;
-        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;
-        model_id: z.ZodString;
-        functions: z.ZodArray<z.ZodObject<{
-            name: z.ZodString;
-            enabled: z.ZodBoolean;
-        }, "strip", z.ZodTypeAny, {
-            name: string;
-            enabled: boolean;
-        }, {
-            name: string;
-            enabled: boolean;
-        }>, "many">;
-        temperature: z.ZodNumber;
-        top_p: z.ZodNumber;
-        max_tokens: z.ZodNumber;
-        debug: z.ZodOptional<z.ZodBoolean>;
-        systemPrompt: z.ZodString;
-        userPrompt: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        service_id: string;
-        model_id: string;
-        temperature: number;
-        top_p: number;
-        max_tokens: number;
-        functions: {
-            name: string;
-            enabled: boolean;
-        }[];
-        systemPrompt: string;
-        userPrompt: string;
-        debug?: boolean | undefined;
-    }, {
-        service_id: string;
-        model_id: string;
-        temperature: number;
-        top_p: number;
-        max_tokens: number;
-        functions: {
-            name: string;
-            enabled: boolean;
-        }[];
-        systemPrompt: string;
-        userPrompt: string;
-        debug?: boolean | undefined;
-    }>;
-    modeSettings: z.ZodObject<{
-        enabledUserInput: z.ZodBoolean;
-        displayUserPrompt: z.ZodBoolean;
-        sendUserPrompt: z.ZodBoolean;
-        initialization: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObject<{
-            event: z.ZodEnum<["Query", "Prompt"]>;
-            forcedWorkflow: z.ZodOptional<z.ZodString>;
-            forcedFunction: z.ZodOptional<z.ZodString>;
-            displayUserQuery: z.ZodOptional<z.ZodBoolean>;
-        }, "strip", z.ZodTypeAny, {
-            event: "Query" | "Prompt";
-            forcedWorkflow?: string | undefined;
-            forcedFunction?: string | undefined;
-            displayUserQuery?: boolean | undefined;
-        }, {
-            event: "Query" | "Prompt";
-            forcedWorkflow?: string | undefined;
-            forcedFunction?: string | undefined;
-            displayUserQuery?: boolean | undefined;
-        }>, {
-            event: "Query" | "Prompt";
-            forcedWorkflow?: string | undefined;
-            forcedFunction?: string | undefined;
-            displayUserQuery?: boolean | undefined;
-        }, {
-            event: "Query" | "Prompt";
-            forcedWorkflow?: string | undefined;
-            forcedFunction?: string | undefined;
-            displayUserQuery?: boolean | undefined;
-        }>, {
-            event: "Query" | "Prompt";
-            forcedWorkflow?: string | undefined;
-            forcedFunction?: string | undefined;
-            displayUserQuery?: boolean | undefined;
-        }, {
-            event: "Query" | "Prompt";
-            forcedWorkflow?: string | undefined;
-            forcedFunction?: string | undefined;
-            displayUserQuery?: boolean | undefined;
-        }>, {
-            event: "Query" | "Prompt";
-            forcedWorkflow?: string | undefined;
-            forcedFunction?: string | undefined;
-            displayUserQuery?: boolean | undefined;
-        }, {
-            event: "Query" | "Prompt";
-            forcedWorkflow?: string | undefined;
-            forcedFunction?: string | undefined;
-            displayUserQuery?: boolean | 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;
-        sendUserPrompt: boolean;
-        initialization: {
-            event: "Query" | "Prompt";
-            forcedWorkflow?: string | undefined;
-            forcedFunction?: string | undefined;
-            displayUserQuery?: boolean | 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;
-            forcedFunction?: string | undefined;
-            displayUserQuery?: boolean | undefined;
-        };
-        actions?: globalThis.Record<string, {
-            forcedWorkflow: string;
-            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
-        }> | undefined;
-    }>;
-    uiSettings: z.ZodObject<{
-        display: z.ZodBoolean;
-        servicesModels: z.ZodBoolean;
-        functions: z.ZodBoolean;
-        temperature: z.ZodBoolean;
-        top_p: z.ZodBoolean;
-        max_tokens: z.ZodBoolean;
-        debug: z.ZodOptional<z.ZodBoolean>;
-        displaySystemPrompt: z.ZodBoolean;
-        displayUserPrompt: z.ZodBoolean;
-    }, "strip", z.ZodTypeAny, {
-        display: boolean;
-        temperature: boolean;
-        top_p: boolean;
-        max_tokens: boolean;
-        servicesModels: boolean;
-        functions: boolean;
-        displaySystemPrompt: boolean;
-        displayUserPrompt: boolean;
-        debug?: boolean | undefined;
-    }, {
-        display: boolean;
-        temperature: boolean;
-        top_p: boolean;
-        max_tokens: boolean;
-        servicesModels: boolean;
-        functions: boolean;
-        displaySystemPrompt: boolean;
-        displayUserPrompt: boolean;
-        debug?: boolean | undefined;
-    }>;
-    savedChatSettings: z.ZodObject<{
-        enabled: z.ZodBoolean;
-        display: z.ZodBoolean;
-    }, "strip", z.ZodTypeAny, {
-        display: boolean;
-        enabled: boolean;
-    }, {
-        display: boolean;
-        enabled: boolean;
-    }>;
-    globalSettings: z.ZodObject<{
-        searchWarningMessage: z.ZodString;
-        disclaimer: z.ZodOptional<z.ZodString>;
-        genericChatErrorMessage: z.ZodOptional<z.ZodString>;
-        displayUserQuotaConsumption: z.ZodOptional<z.ZodBoolean>;
-        displayChatTokensConsumption: z.ZodOptional<z.ZodBoolean>;
-    }, "strip", z.ZodTypeAny, {
-        searchWarningMessage: string;
-        disclaimer?: string | undefined;
-        genericChatErrorMessage?: string | undefined;
-        displayUserQuotaConsumption?: boolean | undefined;
-        displayChatTokensConsumption?: boolean | undefined;
-    }, {
-        searchWarningMessage: string;
-        disclaimer?: string | undefined;
-        genericChatErrorMessage?: string | undefined;
-        displayUserQuotaConsumption?: boolean | undefined;
-        displayChatTokensConsumption?: boolean | undefined;
-    }>;
-    auditSettings: z.ZodOptional<z.ZodObject<{
-        issueTypes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        issueTypes?: string[] | undefined;
-    }, {
-        issueTypes?: string[] | undefined;
-    }>>;
-    additionalServiceSettings: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
-    additionalWorkflowProperties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
-}, "strip", z.ZodTypeAny, {
-    additionalWorkflowProperties: {};
-    connectionSettings: {
-        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: {
-        service_id: string;
-        model_id: string;
-        temperature: number;
-        top_p: number;
-        max_tokens: number;
-        functions: {
-            name: string;
-            enabled: boolean;
-        }[];
-        systemPrompt: string;
-        userPrompt: string;
-        debug?: boolean | undefined;
-    };
-    modeSettings: {
-        displayUserPrompt: boolean;
-        enabledUserInput: boolean;
-        sendUserPrompt: boolean;
-        initialization: {
-            event: "Query" | "Prompt";
-            forcedWorkflow?: string | undefined;
-            forcedFunction?: string | undefined;
-            displayUserQuery?: boolean | undefined;
-        };
-        actions?: globalThis.Record<string, {
-            forcedWorkflow: string;
-            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
-        }> | undefined;
-    };
-    uiSettings: {
-        display: boolean;
-        temperature: boolean;
-        top_p: boolean;
-        max_tokens: boolean;
-        servicesModels: boolean;
-        functions: boolean;
-        displaySystemPrompt: boolean;
-        displayUserPrompt: boolean;
-        debug?: boolean | undefined;
-    };
-    savedChatSettings: {
-        display: boolean;
-        enabled: boolean;
-    };
-    globalSettings: {
-        searchWarningMessage: string;
-        disclaimer?: string | undefined;
-        genericChatErrorMessage?: string | undefined;
-        displayUserQuotaConsumption?: boolean | undefined;
-        displayChatTokensConsumption?: boolean | undefined;
-    };
-    additionalServiceSettings: {};
-    auditSettings?: {
-        issueTypes?: string[] | undefined;
-    } | undefined;
-}, {
-    additionalWorkflowProperties: {};
-    connectionSettings: {
-        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: {
-        service_id: string;
-        model_id: string;
-        temperature: number;
-        top_p: number;
-        max_tokens: number;
-        functions: {
-            name: string;
-            enabled: boolean;
-        }[];
-        systemPrompt: string;
-        userPrompt: string;
-        debug?: boolean | undefined;
-    };
-    modeSettings: {
-        displayUserPrompt: boolean;
-        enabledUserInput: boolean;
-        sendUserPrompt: boolean;
-        initialization: {
-            event: "Query" | "Prompt";
-            forcedWorkflow?: string | undefined;
-            forcedFunction?: string | undefined;
-            displayUserQuery?: boolean | undefined;
-        };
-        actions?: globalThis.Record<string, {
-            forcedWorkflow: string;
-            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
-        }> | undefined;
-    };
-    uiSettings: {
-        display: boolean;
-        temperature: boolean;
-        top_p: boolean;
-        max_tokens: boolean;
-        servicesModels: boolean;
-        functions: boolean;
-        displaySystemPrompt: boolean;
-        displayUserPrompt: boolean;
-        debug?: boolean | undefined;
-    };
-    savedChatSettings: {
-        display: boolean;
-        enabled: boolean;
-    };
-    globalSettings: {
-        searchWarningMessage: string;
-        disclaimer?: string | undefined;
-        genericChatErrorMessage?: string | undefined;
-        displayUserQuotaConsumption?: boolean | undefined;
-        displayChatTokensConsumption?: boolean | undefined;
-    };
-    additionalServiceSettings: {};
-    auditSettings?: {
-        issueTypes?: string[] | undefined;
-    } | undefined;
-}>;
-export interface ChatConfig extends z.infer<typeof chatConfigSchema> {
-}
-export interface ChatPayload {
-    debug?: boolean;
-    functions: string[];
-    history: ChatMessage[];
-    serviceSettings: ServiceSettings;
-    appQuery: {
-        app: string;
-        query: Query | undefined;
-        targetUrl?: string;
-        accessToken?: string;
-    };
-    instanceId?: string;
-    savedChatId?: string;
-    genericChatErrorMessage?: string;
-}
-export declare type ActionMessage = {
-    guid: string;
-    displayName?: string;
-    displayValue?: string;
-    executionTime?: number;
-};
-export interface TextChunksOptions {
-    extendMode?: 'None' | 'Sentence' | 'Chars';
-    extendScope?: number;
-}
-export interface Quota {
-    lastRequest: string;
-    promptTokenCount: number;
-    completionTokenCount: number;
-    periodTokens: number;
-    resetHours: number;
-    tokenCount: number;
-    nextReset: string;
-    lastResetUTC: string;
-    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;
-};
-export declare type MessageEvent = string;
-export declare type ContextMessageEvent = {
-    content: string;
-    metadata: ChatContextAttachment;
-};
-export declare type ErrorEvent = string;
-export declare type ActionStartEvent = {
-    guid: string;
-    displayName: string;
-};
-export declare type ActionResultEvent = {
-    guid: string;
-    displayValue: string;
-};
-export declare type ActionStopEvent = {
-    guid: string;
-    executionTime: number;
-};
-export declare type HistoryEvent = {
-    history: RawMessage[];
-    executionTime: string;
-};
-export declare type DebugMessageEvent = DebugMessage;
-/**
- * Data emitted by the http chat endpoint
- */
-export declare type HttpChatResponse = {
-    quota: Quota;
-    suggestedActions: SuggestedAction[];
-    debug: any;
-    context: {
-        content: string;
-        additionalProperties: ChatContextAttachment;
-    }[];
-    actions: ActionMessage[];
-    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 interface KvObject {
-    data: {
-        key: string;
-        value: any;
-    };
-    type: 'KV';
-    isError: boolean;
-}
-export interface ListObject {
-    name: string;
-    type: 'LIST';
-    isError: boolean;
-    items: (KvObject | ListObject)[];
-    expanded: boolean;
-}
-export declare type DebugMessage = KvObject | ListObject;
-export declare type MessageHandler<T> = {
-    handler: (data: T) => void;
-    isGlobalHandler: boolean;
-};
-export {};
+import { z } from "zod";
+import { Query, Article as Record } from "@sinequa/atomic";
+import { RawMessageContent } from "./types/message-content.types";
+import { MessageImageReference } from "./types/message-reference.types";
+/**
+ * Individual message sent & returned by the ChatGPT API.
+ * If this message is an attachment, we attach the minimal
+ * information needed to reconstruct this attachment (RawAttachment)
+ * as well as the reference id computed at the moment of sending
+ * the attachment to the API.
+ */
+export interface RawMessage {
+    role: string;
+    content: RawMessageContent;
+    messageType?: "CHART" | "MARKDOWN";
+    additionalProperties: {
+        [key: string]: any;
+    };
+}
+/**
+ * A chat message that has been processed to include the markdown-formatted
+ * content for display, as well as detailed attachment data, and optionally
+ * a list of the references extracted from that message
+ */
+export interface ChatMessage extends RawMessage {
+    additionalProperties: {
+        display?: boolean;
+        $progress?: ChatProgress[];
+        $attachment?: ChatContextAttachment[];
+        $suggestedAction?: SuggestedAction[];
+        $debug?: DebugMessage[];
+        forcedWorkflow?: string;
+        forcedWorkflowProperties?: any;
+        query?: Query;
+        isUserInput?: boolean;
+        usageMetrics?: ChatUsageMetrics;
+        additionalWorkflowProperties?: any;
+        $liked?: boolean;
+        $disliked?: boolean;
+        [key: string]: any;
+    };
+}
+export interface ChatProgress {
+    title: string;
+    content?: string;
+    done?: boolean;
+    time?: number;
+}
+export interface RawAttachment {
+    /** Type of the attachment */
+    type: string;
+    /** Record id from which this attachment is taken */
+    recordId: string;
+    /** Record from which this this attachment is taken */
+    record: Record;
+}
+export interface DocumentPart {
+    partId: number;
+    offset: number;
+    length: number;
+    text: string;
+    images?: string[] | MessageImageReference[];
+}
+export type DocumentPage = {
+    url: string;
+    mimeType: string;
+    name?: string;
+    type?: string;
+    description?: string;
+    length?: number;
+    offSet?: number;
+    pageNumber?: number;
+    remappedLength?: number;
+    remappedOffset?: number;
+};
+export interface ChatContextAttachment extends RawAttachment {
+    /** Type of the attachment */
+    type: "Context";
+    /** Rank of the attachment in the context message */
+    contextId: number;
+    /** Parts of the record that the assistant uses to answer */
+    parts: DocumentPart[];
+    /** Pages of the documents based on the query */
+    pages?: DocumentPage[];
+    /** The specific id used of the referenced part */
+    $partId?: number;
+}
+/**
+ * Raw response of the chat API
+ */
+export interface RawResponse {
+    history: RawMessage[];
+    executionTime: string | undefined;
+    executionTimeMilliseconds: number | undefined;
+}
+/**
+ * Enriched response of the chat API
+ */
+export interface ChatResponse extends RawResponse {
+    history: ChatMessage[];
+}
+/**
+ * Response of the ListModels API
+ */
+export interface GllmModelDescription {
+    provider: string;
+    displayName: string;
+    serviceId: string;
+    modelId: string;
+    enable: boolean;
+    maxGenerationSize: number;
+    contextWindowSize: number;
+}
+/**
+ * Response of the ListFunctions API
+ */
+export interface GllmFunction {
+    functionName: string;
+    description: string;
+    enabled: boolean;
+    parameters: GllmFunctionParameter[];
+}
+export interface GllmFunctionParameter {
+    description: string;
+    isRequired: boolean;
+    name: string;
+    type: string;
+}
+/**
+ * Minimal representation of a saved chat
+ */
+export interface SavedChat {
+    id: string;
+    title: string;
+    modifiedUTC: string;
+}
+/**
+ * Data structure saved to reconstruct a saved chat conversation
+ */
+export interface SavedChatHistory extends SavedChat {
+    history: ChatMessage[];
+}
+export declare const connectionSettingsSchema: z.ZodEffects<z.ZodObject<{
+    connectionErrorMessage: z.ZodString;
+    restEndpoint: z.ZodOptional<z.ZodString>;
+    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 type ConnectionSettings = z.infer<typeof connectionSettingsSchema>;
+declare const serviceSettingsSchema: z.ZodObject<{
+    service_id: z.ZodString;
+    model_id: z.ZodString;
+    temperature: z.ZodNumber;
+    top_p: z.ZodNumber;
+    max_tokens: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    service_id: string;
+    model_id: string;
+    temperature: number;
+    top_p: number;
+    max_tokens: number;
+}, {
+    service_id: string;
+    model_id: string;
+    temperature: number;
+    top_p: number;
+    max_tokens: number;
+}>;
+export interface ServiceSettings extends z.infer<typeof serviceSettingsSchema> {
+}
+declare const additionalServiceSettingsSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+export interface AdditionalServiceSettings extends z.infer<typeof additionalServiceSettingsSchema> {
+}
+declare const additionalWorkflowPropertiesSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+export interface additionalWorkflowProperties extends z.infer<typeof additionalWorkflowPropertiesSchema> {
+}
+declare const uiSettingsSchema: z.ZodObject<{
+    display: z.ZodBoolean;
+    servicesModels: z.ZodBoolean;
+    functions: z.ZodBoolean;
+    temperature: z.ZodBoolean;
+    top_p: z.ZodBoolean;
+    max_tokens: z.ZodBoolean;
+    debug: z.ZodBoolean;
+    displaySystemPrompt: z.ZodBoolean;
+    displayUserPrompt: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    debug: boolean;
+    display: boolean;
+    temperature: boolean;
+    top_p: boolean;
+    max_tokens: boolean;
+    servicesModels: boolean;
+    functions: boolean;
+    displaySystemPrompt: boolean;
+    displayUserPrompt: boolean;
+}, {
+    debug: boolean;
+    display: boolean;
+    temperature: boolean;
+    top_p: boolean;
+    max_tokens: boolean;
+    servicesModels: boolean;
+    functions: boolean;
+    displaySystemPrompt: boolean;
+    displayUserPrompt: boolean;
+}>;
+export interface UiSettings extends z.infer<typeof uiSettingsSchema> {
+}
+declare const defaultValuesSchema: z.ZodObject<{
+    service_id: z.ZodString;
+    model_id: z.ZodString;
+    functions: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        enabled: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        enabled: boolean;
+    }, {
+        name: string;
+        enabled: boolean;
+    }>, "many">;
+    temperature: z.ZodNumber;
+    top_p: z.ZodNumber;
+    max_tokens: z.ZodNumber;
+    debug: z.ZodBoolean;
+    systemPrompt: z.ZodString;
+    userPrompt: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    debug: boolean;
+    service_id: string;
+    model_id: string;
+    temperature: number;
+    top_p: number;
+    max_tokens: number;
+    functions: {
+        name: string;
+        enabled: boolean;
+    }[];
+    systemPrompt: string;
+    userPrompt: string;
+}, {
+    debug: boolean;
+    service_id: string;
+    model_id: string;
+    temperature: number;
+    top_p: number;
+    max_tokens: number;
+    functions: {
+        name: string;
+        enabled: boolean;
+    }[];
+    systemPrompt: string;
+    userPrompt: string;
+}>;
+export interface DefaultValues extends z.infer<typeof defaultValuesSchema> {
+}
+declare const modeSettingsSchema: z.ZodObject<{
+    enabledUserInput: z.ZodBoolean;
+    displayUserPrompt: z.ZodBoolean;
+    sendUserPrompt: z.ZodBoolean;
+    initialization: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObject<{
+        event: z.ZodEnum<["Query", "Prompt"]>;
+        forcedWorkflow: z.ZodOptional<z.ZodString>;
+        forcedFunction: z.ZodOptional<z.ZodString>;
+        displayUserQuery: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        event: "Query" | "Prompt";
+        forcedWorkflow?: string | undefined;
+        forcedFunction?: string | undefined;
+        displayUserQuery?: boolean | undefined;
+    }, {
+        event: "Query" | "Prompt";
+        forcedWorkflow?: string | undefined;
+        forcedFunction?: string | undefined;
+        displayUserQuery?: boolean | undefined;
+    }>, {
+        event: "Query" | "Prompt";
+        forcedWorkflow?: string | undefined;
+        forcedFunction?: string | undefined;
+        displayUserQuery?: boolean | undefined;
+    }, {
+        event: "Query" | "Prompt";
+        forcedWorkflow?: string | undefined;
+        forcedFunction?: string | undefined;
+        displayUserQuery?: boolean | undefined;
+    }>, {
+        event: "Query" | "Prompt";
+        forcedWorkflow?: string | undefined;
+        forcedFunction?: string | undefined;
+        displayUserQuery?: boolean | undefined;
+    }, {
+        event: "Query" | "Prompt";
+        forcedWorkflow?: string | undefined;
+        forcedFunction?: string | undefined;
+        displayUserQuery?: boolean | undefined;
+    }>, {
+        event: "Query" | "Prompt";
+        forcedWorkflow?: string | undefined;
+        forcedFunction?: string | undefined;
+        displayUserQuery?: boolean | undefined;
+    }, {
+        event: "Query" | "Prompt";
+        forcedWorkflow?: string | undefined;
+        forcedFunction?: string | undefined;
+        displayUserQuery?: boolean | 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;
+    sendUserPrompt: boolean;
+    initialization: {
+        event: "Query" | "Prompt";
+        forcedWorkflow?: string | undefined;
+        forcedFunction?: string | undefined;
+        displayUserQuery?: boolean | 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;
+        forcedFunction?: string | undefined;
+        displayUserQuery?: boolean | undefined;
+    };
+    actions?: globalThis.Record<string, {
+        forcedWorkflow: string;
+        forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+    }> | undefined;
+}>;
+export interface ModeSettings extends z.infer<typeof modeSettingsSchema> {
+}
+declare const savedChatSettingsSchema: z.ZodObject<{
+    enabled: z.ZodBoolean;
+    display: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    enabled: boolean;
+    display: boolean;
+}, {
+    enabled: boolean;
+    display: boolean;
+}>;
+export interface SavedChatSettings extends z.infer<typeof savedChatSettingsSchema> {
+}
+export interface SavedChatSettings extends z.infer<typeof savedChatSettingsSchema> {
+}
+export declare const chatConfigSchema: z.ZodObject<{
+    connectionSettings: z.ZodEffects<z.ZodObject<{
+        connectionErrorMessage: z.ZodString;
+        restEndpoint: z.ZodOptional<z.ZodString>;
+        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;
+        model_id: z.ZodString;
+        functions: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            enabled: z.ZodBoolean;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            enabled: boolean;
+        }, {
+            name: string;
+            enabled: boolean;
+        }>, "many">;
+        temperature: z.ZodNumber;
+        top_p: z.ZodNumber;
+        max_tokens: z.ZodNumber;
+        debug: z.ZodBoolean;
+        systemPrompt: z.ZodString;
+        userPrompt: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        debug: boolean;
+        service_id: string;
+        model_id: string;
+        temperature: number;
+        top_p: number;
+        max_tokens: number;
+        functions: {
+            name: string;
+            enabled: boolean;
+        }[];
+        systemPrompt: string;
+        userPrompt: string;
+    }, {
+        debug: boolean;
+        service_id: string;
+        model_id: string;
+        temperature: number;
+        top_p: number;
+        max_tokens: number;
+        functions: {
+            name: string;
+            enabled: boolean;
+        }[];
+        systemPrompt: string;
+        userPrompt: string;
+    }>;
+    modeSettings: z.ZodObject<{
+        enabledUserInput: z.ZodBoolean;
+        displayUserPrompt: z.ZodBoolean;
+        sendUserPrompt: z.ZodBoolean;
+        initialization: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObject<{
+            event: z.ZodEnum<["Query", "Prompt"]>;
+            forcedWorkflow: z.ZodOptional<z.ZodString>;
+            forcedFunction: z.ZodOptional<z.ZodString>;
+            displayUserQuery: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            event: "Query" | "Prompt";
+            forcedWorkflow?: string | undefined;
+            forcedFunction?: string | undefined;
+            displayUserQuery?: boolean | undefined;
+        }, {
+            event: "Query" | "Prompt";
+            forcedWorkflow?: string | undefined;
+            forcedFunction?: string | undefined;
+            displayUserQuery?: boolean | undefined;
+        }>, {
+            event: "Query" | "Prompt";
+            forcedWorkflow?: string | undefined;
+            forcedFunction?: string | undefined;
+            displayUserQuery?: boolean | undefined;
+        }, {
+            event: "Query" | "Prompt";
+            forcedWorkflow?: string | undefined;
+            forcedFunction?: string | undefined;
+            displayUserQuery?: boolean | undefined;
+        }>, {
+            event: "Query" | "Prompt";
+            forcedWorkflow?: string | undefined;
+            forcedFunction?: string | undefined;
+            displayUserQuery?: boolean | undefined;
+        }, {
+            event: "Query" | "Prompt";
+            forcedWorkflow?: string | undefined;
+            forcedFunction?: string | undefined;
+            displayUserQuery?: boolean | undefined;
+        }>, {
+            event: "Query" | "Prompt";
+            forcedWorkflow?: string | undefined;
+            forcedFunction?: string | undefined;
+            displayUserQuery?: boolean | undefined;
+        }, {
+            event: "Query" | "Prompt";
+            forcedWorkflow?: string | undefined;
+            forcedFunction?: string | undefined;
+            displayUserQuery?: boolean | 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;
+        sendUserPrompt: boolean;
+        initialization: {
+            event: "Query" | "Prompt";
+            forcedWorkflow?: string | undefined;
+            forcedFunction?: string | undefined;
+            displayUserQuery?: boolean | 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;
+            forcedFunction?: string | undefined;
+            displayUserQuery?: boolean | undefined;
+        };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
+    }>;
+    uiSettings: z.ZodObject<{
+        display: z.ZodBoolean;
+        servicesModels: z.ZodBoolean;
+        functions: z.ZodBoolean;
+        temperature: z.ZodBoolean;
+        top_p: z.ZodBoolean;
+        max_tokens: z.ZodBoolean;
+        debug: z.ZodBoolean;
+        displaySystemPrompt: z.ZodBoolean;
+        displayUserPrompt: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        debug: boolean;
+        display: boolean;
+        temperature: boolean;
+        top_p: boolean;
+        max_tokens: boolean;
+        servicesModels: boolean;
+        functions: boolean;
+        displaySystemPrompt: boolean;
+        displayUserPrompt: boolean;
+    }, {
+        debug: boolean;
+        display: boolean;
+        temperature: boolean;
+        top_p: boolean;
+        max_tokens: boolean;
+        servicesModels: boolean;
+        functions: boolean;
+        displaySystemPrompt: boolean;
+        displayUserPrompt: boolean;
+    }>;
+    savedChatSettings: z.ZodObject<{
+        enabled: z.ZodBoolean;
+        display: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        enabled: boolean;
+        display: boolean;
+    }, {
+        enabled: boolean;
+        display: boolean;
+    }>;
+    globalSettings: z.ZodObject<{
+        searchWarningMessage: z.ZodString;
+        disclaimer: z.ZodOptional<z.ZodString>;
+        genericChatErrorMessage: z.ZodOptional<z.ZodString>;
+        displayUserQuotaConsumption: z.ZodOptional<z.ZodBoolean>;
+        displayChatTokensConsumption: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        searchWarningMessage: string;
+        disclaimer?: string | undefined;
+        genericChatErrorMessage?: string | undefined;
+        displayUserQuotaConsumption?: boolean | undefined;
+        displayChatTokensConsumption?: boolean | undefined;
+    }, {
+        searchWarningMessage: string;
+        disclaimer?: string | undefined;
+        genericChatErrorMessage?: string | undefined;
+        displayUserQuotaConsumption?: boolean | undefined;
+        displayChatTokensConsumption?: boolean | undefined;
+    }>;
+    auditSettings: z.ZodObject<{
+        issueTypes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        logContent: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        logContent: boolean;
+        issueTypes?: string[] | undefined;
+    }, {
+        logContent: boolean;
+        issueTypes?: string[] | undefined;
+    }>;
+    additionalServiceSettings: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+    additionalWorkflowProperties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+}, "strip", z.ZodTypeAny, {
+    additionalWorkflowProperties: {};
+    connectionSettings: {
+        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: {
+        debug: boolean;
+        service_id: string;
+        model_id: string;
+        temperature: number;
+        top_p: number;
+        max_tokens: number;
+        functions: {
+            name: string;
+            enabled: boolean;
+        }[];
+        systemPrompt: string;
+        userPrompt: string;
+    };
+    modeSettings: {
+        displayUserPrompt: boolean;
+        enabledUserInput: boolean;
+        sendUserPrompt: boolean;
+        initialization: {
+            event: "Query" | "Prompt";
+            forcedWorkflow?: string | undefined;
+            forcedFunction?: string | undefined;
+            displayUserQuery?: boolean | undefined;
+        };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
+    };
+    uiSettings: {
+        debug: boolean;
+        display: boolean;
+        temperature: boolean;
+        top_p: boolean;
+        max_tokens: boolean;
+        servicesModels: boolean;
+        functions: boolean;
+        displaySystemPrompt: boolean;
+        displayUserPrompt: boolean;
+    };
+    savedChatSettings: {
+        enabled: boolean;
+        display: boolean;
+    };
+    globalSettings: {
+        searchWarningMessage: string;
+        disclaimer?: string | undefined;
+        genericChatErrorMessage?: string | undefined;
+        displayUserQuotaConsumption?: boolean | undefined;
+        displayChatTokensConsumption?: boolean | undefined;
+    };
+    auditSettings: {
+        logContent: boolean;
+        issueTypes?: string[] | undefined;
+    };
+    additionalServiceSettings: {};
+}, {
+    additionalWorkflowProperties: {};
+    connectionSettings: {
+        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: {
+        debug: boolean;
+        service_id: string;
+        model_id: string;
+        temperature: number;
+        top_p: number;
+        max_tokens: number;
+        functions: {
+            name: string;
+            enabled: boolean;
+        }[];
+        systemPrompt: string;
+        userPrompt: string;
+    };
+    modeSettings: {
+        displayUserPrompt: boolean;
+        enabledUserInput: boolean;
+        sendUserPrompt: boolean;
+        initialization: {
+            event: "Query" | "Prompt";
+            forcedWorkflow?: string | undefined;
+            forcedFunction?: string | undefined;
+            displayUserQuery?: boolean | undefined;
+        };
+        actions?: globalThis.Record<string, {
+            forcedWorkflow: string;
+            forcedWorkflowProperties?: globalThis.Record<string, unknown> | undefined;
+        }> | undefined;
+    };
+    uiSettings: {
+        debug: boolean;
+        display: boolean;
+        temperature: boolean;
+        top_p: boolean;
+        max_tokens: boolean;
+        servicesModels: boolean;
+        functions: boolean;
+        displaySystemPrompt: boolean;
+        displayUserPrompt: boolean;
+    };
+    savedChatSettings: {
+        enabled: boolean;
+        display: boolean;
+    };
+    globalSettings: {
+        searchWarningMessage: string;
+        disclaimer?: string | undefined;
+        genericChatErrorMessage?: string | undefined;
+        displayUserQuotaConsumption?: boolean | undefined;
+        displayChatTokensConsumption?: boolean | undefined;
+    };
+    auditSettings: {
+        logContent: boolean;
+        issueTypes?: string[] | undefined;
+    };
+    additionalServiceSettings: {};
+}>;
+export interface ChatConfig extends z.infer<typeof chatConfigSchema> {
+}
+export interface ChatPayload {
+    debug: boolean;
+    functions: string[];
+    history: ChatMessage[];
+    serviceSettings: ServiceSettings;
+    appQuery: {
+        app: string;
+        query: Query | undefined;
+        targetUrl?: string;
+        accessToken?: string;
+    };
+    instanceId?: string;
+    savedChatId?: string;
+    genericChatErrorMessage?: string;
+}
+export type ActionMessage = {
+    guid: string;
+    displayName?: string;
+    displayValue?: string;
+    executionTime?: number;
+};
+export interface TextChunksOptions {
+    extendMode?: "None" | "Sentence" | "Chars";
+    extendScope?: number;
+}
+export interface Quota {
+    lastRequest: string;
+    promptTokenCount: number;
+    completionTokenCount: number;
+    periodTokens: number;
+    resetHours: number;
+    tokenCount: number;
+    nextReset: string;
+    lastResetUTC: string;
+    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 type SuggestedActionsEvent = {
+    suggestedActions: SuggestedAction[];
+};
+export type QuotaEvent = {
+    quota: Quota;
+};
+export type MessageEvent = {
+    delta: string;
+    messageId: string;
+};
+export type ContextMessageEvent = {
+    content: string;
+    additionalProperties: ChatContextAttachment;
+};
+export type ErrorEvent = string;
+export type ActionStartEvent = {
+    guid: string;
+    displayName: string;
+};
+export type ActionResultEvent = {
+    guid: string;
+    displayValue: string;
+};
+export type ActionStopEvent = {
+    guid: string;
+    executionTime: number;
+};
+export type HistoryEvent = {
+    history: RawMessage[];
+    executionTime: string;
+    executionTimeMilliseconds?: number;
+};
+export type DebugMessageEvent = DebugMessage;
+/**
+ * Data emitted by the http chat endpoint
+ */
+export type HttpChatResponse = {
+    quota: Quota;
+    suggestedActions: SuggestedAction[];
+    debug: any;
+    context: {
+        content: string;
+        additionalProperties: ChatContextAttachment;
+    }[];
+    actions: ActionMessage[];
+    history: RawMessage[];
+    executionTime: string;
+    executionTimeMilliseconds: number;
+};
+export interface TokenConsumption {
+    percentage: number;
+}
+export interface UserTokenConsumption extends TokenConsumption {
+    nextResetDate: string;
+}
+export interface ChatUsageMetrics {
+    totalTokenCount: number;
+    promptTokenCount: number;
+    completionTokenCount: number;
+    tokenizerType: string;
+}
+export interface KvObject {
+    data: {
+        key: string;
+        value: any;
+    };
+    type: "KV";
+    isError: boolean;
+}
+export interface ListObject {
+    name: string;
+    type: "LIST";
+    isError: boolean;
+    items: (KvObject | ListObject)[];
+    expanded: boolean;
+}
+export type DebugMessage = KvObject | ListObject;
+export type MessageHandler<T> = {
+    handler: (data: T) => void;
+    isGlobalHandler: boolean;
+};
+/**
+ * Data emitted by the saved chat endpoints
+ */
+export type DeleteSavedChatResponse = {
+    deleteCount: number;
+    executionTime: string;
+    executionTimeMilliseconds: number;
+};
+export type SavedChatResponse = {
+    savedChat: SavedChat;
+    executionTime: string;
+    executionTimeMilliseconds: number;
+};
+export {};