@sinequa/assistant 3.1.1

package/chat/types.d.ts

@@ -0,0 +1,1241 @@
+import { z } from 'zod';
+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;
+    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[];
+        [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 of used the referenced part */
+    $partId?: number;
+}
+/**
+ * Raw response of the API
+ */
+export interface RawResponse {
+    history: RawMessage[];
+    executionTime: string;
+}
+/**
+ * Enriched response of the API
+ */
+export interface ChatResponse extends RawResponse {
+    history: ChatMessage[];
+}
+export interface GllmModelDescription {
+    provider: string;
+    displayName: string;
+    serviceId: string;
+    modelId: string;
+    size: number;
+    enable: boolean;
+    supportStreaming: boolean;
+    supportFunctions: boolean;
+}
+export interface GllmFunction {
+    functionName: string;
+    fullyQualifiedName: string;
+    description: string;
+    pluginName: string;
+    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 conversation
+ */
+export interface SavedChatHistory extends SavedChat {
+    History: ChatMessage[];
+}
+export declare const globalSettingsSchema: z.ZodEffects<z.ZodObject<{
+    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"]>;
+}, "strip", z.ZodTypeAny, {
+    signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
+    signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
+    restEndpoint?: string | undefined;
+    websocketEndpoint?: string | undefined;
+}, {
+    signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
+    signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
+    restEndpoint?: string | undefined;
+    websocketEndpoint?: string | undefined;
+}>, {
+    signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
+    signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
+    restEndpoint?: string | undefined;
+    websocketEndpoint?: string | undefined;
+}, {
+    signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
+    signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
+    restEndpoint?: string | undefined;
+    websocketEndpoint?: string | undefined;
+}>;
+export declare type GlobalSettings = z.infer<typeof globalSettingsSchema>;
+declare const serviceSettingsSchema: z.ZodObject<{
+    service_id: z.ZodString;
+    model_id: z.ZodString;
+    temperature: z.ZodNumber;
+    top_p: z.ZodNumber;
+    maxTokens: z.ZodNumber;
+    results_per_prompt: z.ZodNumber;
+    presence_penalty: z.ZodNumber;
+    frequency_penalty: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    service_id: string;
+    model_id: string;
+    temperature: number;
+    top_p: number;
+    maxTokens: number;
+    results_per_prompt: number;
+    presence_penalty: number;
+    frequency_penalty: number;
+}, {
+    service_id: string;
+    model_id: string;
+    temperature: number;
+    top_p: number;
+    maxTokens: number;
+    results_per_prompt: number;
+    presence_penalty: number;
+    frequency_penalty: number;
+}>;
+export interface ServiceSettings extends z.infer<typeof serviceSettingsSchema> {
+}
+declare const textChunksOptionsSchema: z.ZodObject<{
+    extendMode: z.ZodOptional<z.ZodEnum<["None", "Sentence", "Chars"]>>;
+    extendScope: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+    extendScope?: number | undefined;
+}, {
+    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+    extendScope?: number | undefined;
+}>;
+export interface TextChunksOptions extends z.infer<typeof textChunksOptionsSchema> {
+}
+declare const contextOptionsSchema: z.ZodObject<{
+    docColumns: z.ZodArray<z.ZodString, "many">;
+    textChunkFillGaps: z.ZodNumber;
+    html: z.ZodBoolean;
+    topPassagesOptions: z.ZodObject<{
+        topPassages: z.ZodNumber;
+        topPassagesMinScore: z.ZodNumber;
+        textChunkOptions: z.ZodObject<{
+            extendMode: z.ZodOptional<z.ZodEnum<["None", "Sentence", "Chars"]>>;
+            extendScope: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        }, {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        topPassages: number;
+        topPassagesMinScore: number;
+        textChunkOptions: {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        };
+    }, {
+        topPassages: number;
+        topPassagesMinScore: number;
+        textChunkOptions: {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        };
+    }>;
+    matchingPassagesOptions: z.ZodObject<{
+        matchingPassagesPerDoc: z.ZodNumber;
+        fromTopDocuments: z.ZodNumber;
+        matchingPassagesMinScore: z.ZodNumber;
+        textChunkOptions: z.ZodObject<{
+            extendMode: z.ZodOptional<z.ZodEnum<["None", "Sentence", "Chars"]>>;
+            extendScope: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        }, {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        textChunkOptions: {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        };
+        matchingPassagesPerDoc: number;
+        fromTopDocuments: number;
+        matchingPassagesMinScore: number;
+    }, {
+        textChunkOptions: {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        };
+        matchingPassagesPerDoc: number;
+        fromTopDocuments: number;
+        matchingPassagesMinScore: number;
+    }>;
+    relevantExtractsOptions: z.ZodObject<{
+        topRelevantExtractsPerDoc: z.ZodNumber;
+        fromTopDocuments: z.ZodNumber;
+        textChunkOptions: z.ZodObject<{
+            extendMode: z.ZodOptional<z.ZodEnum<["None", "Sentence", "Chars"]>>;
+            extendScope: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        }, {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        textChunkOptions: {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        };
+        fromTopDocuments: number;
+        topRelevantExtractsPerDoc: number;
+    }, {
+        textChunkOptions: {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        };
+        fromTopDocuments: number;
+        topRelevantExtractsPerDoc: number;
+    }>;
+    htmlOptions: z.ZodObject<{
+        images: z.ZodBoolean;
+        links: z.ZodBoolean;
+        tables: z.ZodBoolean;
+        extendTables: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        links: boolean;
+        images: boolean;
+        tables: boolean;
+        extendTables: boolean;
+    }, {
+        links: boolean;
+        images: boolean;
+        tables: boolean;
+        extendTables: boolean;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    html: boolean;
+    docColumns: string[];
+    textChunkFillGaps: number;
+    topPassagesOptions: {
+        topPassages: number;
+        topPassagesMinScore: number;
+        textChunkOptions: {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        };
+    };
+    matchingPassagesOptions: {
+        textChunkOptions: {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        };
+        matchingPassagesPerDoc: number;
+        fromTopDocuments: number;
+        matchingPassagesMinScore: number;
+    };
+    relevantExtractsOptions: {
+        textChunkOptions: {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        };
+        fromTopDocuments: number;
+        topRelevantExtractsPerDoc: number;
+    };
+    htmlOptions: {
+        links: boolean;
+        images: boolean;
+        tables: boolean;
+        extendTables: boolean;
+    };
+}, {
+    html: boolean;
+    docColumns: string[];
+    textChunkFillGaps: number;
+    topPassagesOptions: {
+        topPassages: number;
+        topPassagesMinScore: number;
+        textChunkOptions: {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        };
+    };
+    matchingPassagesOptions: {
+        textChunkOptions: {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        };
+        matchingPassagesPerDoc: number;
+        fromTopDocuments: number;
+        matchingPassagesMinScore: number;
+    };
+    relevantExtractsOptions: {
+        textChunkOptions: {
+            extendMode?: "None" | "Sentence" | "Chars" | undefined;
+            extendScope?: number | undefined;
+        };
+        fromTopDocuments: number;
+        topRelevantExtractsPerDoc: number;
+    };
+    htmlOptions: {
+        links: boolean;
+        images: boolean;
+        tables: boolean;
+        extendTables: boolean;
+    };
+}>;
+export interface ContextOptions extends z.infer<typeof contextOptionsSchema> {
+}
+declare const contextSettingsSchema: z.ZodObject<{
+    app: z.ZodOptional<z.ZodString>;
+    query: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
+    contextOptions: z.ZodObject<{
+        docColumns: z.ZodArray<z.ZodString, "many">;
+        textChunkFillGaps: z.ZodNumber;
+        html: z.ZodBoolean;
+        topPassagesOptions: z.ZodObject<{
+            topPassages: z.ZodNumber;
+            topPassagesMinScore: z.ZodNumber;
+            textChunkOptions: z.ZodObject<{
+                extendMode: z.ZodOptional<z.ZodEnum<["None", "Sentence", "Chars"]>>;
+                extendScope: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            }, {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            topPassages: number;
+            topPassagesMinScore: number;
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+        }, {
+            topPassages: number;
+            topPassagesMinScore: number;
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+        }>;
+        matchingPassagesOptions: z.ZodObject<{
+            matchingPassagesPerDoc: z.ZodNumber;
+            fromTopDocuments: z.ZodNumber;
+            matchingPassagesMinScore: z.ZodNumber;
+            textChunkOptions: z.ZodObject<{
+                extendMode: z.ZodOptional<z.ZodEnum<["None", "Sentence", "Chars"]>>;
+                extendScope: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            }, {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+            matchingPassagesPerDoc: number;
+            fromTopDocuments: number;
+            matchingPassagesMinScore: number;
+        }, {
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+            matchingPassagesPerDoc: number;
+            fromTopDocuments: number;
+            matchingPassagesMinScore: number;
+        }>;
+        relevantExtractsOptions: z.ZodObject<{
+            topRelevantExtractsPerDoc: z.ZodNumber;
+            fromTopDocuments: z.ZodNumber;
+            textChunkOptions: z.ZodObject<{
+                extendMode: z.ZodOptional<z.ZodEnum<["None", "Sentence", "Chars"]>>;
+                extendScope: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            }, {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+            fromTopDocuments: number;
+            topRelevantExtractsPerDoc: number;
+        }, {
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+            fromTopDocuments: number;
+            topRelevantExtractsPerDoc: number;
+        }>;
+        htmlOptions: z.ZodObject<{
+            images: z.ZodBoolean;
+            links: z.ZodBoolean;
+            tables: z.ZodBoolean;
+            extendTables: z.ZodBoolean;
+        }, "strip", z.ZodTypeAny, {
+            links: boolean;
+            images: boolean;
+            tables: boolean;
+            extendTables: boolean;
+        }, {
+            links: boolean;
+            images: boolean;
+            tables: boolean;
+            extendTables: boolean;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        html: boolean;
+        docColumns: string[];
+        textChunkFillGaps: number;
+        topPassagesOptions: {
+            topPassages: number;
+            topPassagesMinScore: number;
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+        };
+        matchingPassagesOptions: {
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+            matchingPassagesPerDoc: number;
+            fromTopDocuments: number;
+            matchingPassagesMinScore: number;
+        };
+        relevantExtractsOptions: {
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+            fromTopDocuments: number;
+            topRelevantExtractsPerDoc: number;
+        };
+        htmlOptions: {
+            links: boolean;
+            images: boolean;
+            tables: boolean;
+            extendTables: boolean;
+        };
+    }, {
+        html: boolean;
+        docColumns: string[];
+        textChunkFillGaps: number;
+        topPassagesOptions: {
+            topPassages: number;
+            topPassagesMinScore: number;
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+        };
+        matchingPassagesOptions: {
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+            matchingPassagesPerDoc: number;
+            fromTopDocuments: number;
+            matchingPassagesMinScore: number;
+        };
+        relevantExtractsOptions: {
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+            fromTopDocuments: number;
+            topRelevantExtractsPerDoc: number;
+        };
+        htmlOptions: {
+            links: boolean;
+            images: boolean;
+            tables: boolean;
+            extendTables: boolean;
+        };
+    }>;
+}, "strip", z.ZodTypeAny, {
+    contextOptions: {
+        html: boolean;
+        docColumns: string[];
+        textChunkFillGaps: number;
+        topPassagesOptions: {
+            topPassages: number;
+            topPassagesMinScore: number;
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+        };
+        matchingPassagesOptions: {
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+            matchingPassagesPerDoc: number;
+            fromTopDocuments: number;
+            matchingPassagesMinScore: number;
+        };
+        relevantExtractsOptions: {
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+            fromTopDocuments: number;
+            topRelevantExtractsPerDoc: number;
+        };
+        htmlOptions: {
+            links: boolean;
+            images: boolean;
+            tables: boolean;
+            extendTables: boolean;
+        };
+    };
+    app?: string | undefined;
+    query?: {} | undefined;
+}, {
+    contextOptions: {
+        html: boolean;
+        docColumns: string[];
+        textChunkFillGaps: number;
+        topPassagesOptions: {
+            topPassages: number;
+            topPassagesMinScore: number;
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+        };
+        matchingPassagesOptions: {
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+            matchingPassagesPerDoc: number;
+            fromTopDocuments: number;
+            matchingPassagesMinScore: number;
+        };
+        relevantExtractsOptions: {
+            textChunkOptions: {
+                extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                extendScope?: number | undefined;
+            };
+            fromTopDocuments: number;
+            topRelevantExtractsPerDoc: number;
+        };
+        htmlOptions: {
+            links: boolean;
+            images: boolean;
+            tables: boolean;
+            extendTables: boolean;
+        };
+    };
+    app?: string | undefined;
+    query?: {} | undefined;
+}>;
+export interface ContextSettings extends z.infer<typeof contextSettingsSchema> {
+}
+declare const uiSettingsSchema: z.ZodObject<{
+    display: z.ZodBoolean;
+    servicesModels: z.ZodBoolean;
+    functions: z.ZodBoolean;
+    temperature: z.ZodBoolean;
+    top_p: z.ZodBoolean;
+    maxTokens: z.ZodBoolean;
+    debug: z.ZodBoolean;
+    displaySystemPrompt: z.ZodBoolean;
+    systemPrompt: z.ZodString;
+    displayUserPrompt: z.ZodBoolean;
+    userPrompt: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    display: boolean;
+    debug: boolean;
+    temperature: boolean;
+    top_p: boolean;
+    maxTokens: boolean;
+    servicesModels: boolean;
+    functions: boolean;
+    displaySystemPrompt: boolean;
+    systemPrompt: string;
+    displayUserPrompt: boolean;
+    userPrompt: string;
+}, {
+    display: boolean;
+    debug: boolean;
+    temperature: boolean;
+    top_p: boolean;
+    maxTokens: boolean;
+    servicesModels: boolean;
+    functions: boolean;
+    displaySystemPrompt: boolean;
+    systemPrompt: string;
+    displayUserPrompt: boolean;
+    userPrompt: string;
+}>;
+export interface UiSettings extends z.infer<typeof uiSettingsSchema> {
+}
+export declare const chatConfigSchema: z.ZodObject<{
+    globalSettings: z.ZodEffects<z.ZodObject<{
+        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"]>;
+    }, "strip", z.ZodTypeAny, {
+        signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
+        signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
+        restEndpoint?: string | undefined;
+        websocketEndpoint?: string | undefined;
+    }, {
+        signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
+        signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
+        restEndpoint?: string | undefined;
+        websocketEndpoint?: string | undefined;
+    }>, {
+        signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
+        signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
+        restEndpoint?: string | undefined;
+        websocketEndpoint?: string | undefined;
+    }, {
+        signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
+        signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
+        restEndpoint?: string | undefined;
+        websocketEndpoint?: string | undefined;
+    }>;
+    serviceSettings: z.ZodObject<{
+        service_id: z.ZodString;
+        model_id: z.ZodString;
+        temperature: z.ZodNumber;
+        top_p: z.ZodNumber;
+        maxTokens: z.ZodNumber;
+        results_per_prompt: z.ZodNumber;
+        presence_penalty: z.ZodNumber;
+        frequency_penalty: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        service_id: string;
+        model_id: string;
+        temperature: number;
+        top_p: number;
+        maxTokens: number;
+        results_per_prompt: number;
+        presence_penalty: number;
+        frequency_penalty: number;
+    }, {
+        service_id: string;
+        model_id: string;
+        temperature: number;
+        top_p: number;
+        maxTokens: number;
+        results_per_prompt: number;
+        presence_penalty: number;
+        frequency_penalty: number;
+    }>;
+    contextSettings: z.ZodObject<{
+        app: z.ZodOptional<z.ZodString>;
+        query: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
+        contextOptions: z.ZodObject<{
+            docColumns: z.ZodArray<z.ZodString, "many">;
+            textChunkFillGaps: z.ZodNumber;
+            html: z.ZodBoolean;
+            topPassagesOptions: z.ZodObject<{
+                topPassages: z.ZodNumber;
+                topPassagesMinScore: z.ZodNumber;
+                textChunkOptions: z.ZodObject<{
+                    extendMode: z.ZodOptional<z.ZodEnum<["None", "Sentence", "Chars"]>>;
+                    extendScope: z.ZodOptional<z.ZodNumber>;
+                }, "strip", z.ZodTypeAny, {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                }, {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                }>;
+            }, "strip", z.ZodTypeAny, {
+                topPassages: number;
+                topPassagesMinScore: number;
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+            }, {
+                topPassages: number;
+                topPassagesMinScore: number;
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+            }>;
+            matchingPassagesOptions: z.ZodObject<{
+                matchingPassagesPerDoc: z.ZodNumber;
+                fromTopDocuments: z.ZodNumber;
+                matchingPassagesMinScore: z.ZodNumber;
+                textChunkOptions: z.ZodObject<{
+                    extendMode: z.ZodOptional<z.ZodEnum<["None", "Sentence", "Chars"]>>;
+                    extendScope: z.ZodOptional<z.ZodNumber>;
+                }, "strip", z.ZodTypeAny, {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                }, {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                }>;
+            }, "strip", z.ZodTypeAny, {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                matchingPassagesPerDoc: number;
+                fromTopDocuments: number;
+                matchingPassagesMinScore: number;
+            }, {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                matchingPassagesPerDoc: number;
+                fromTopDocuments: number;
+                matchingPassagesMinScore: number;
+            }>;
+            relevantExtractsOptions: z.ZodObject<{
+                topRelevantExtractsPerDoc: z.ZodNumber;
+                fromTopDocuments: z.ZodNumber;
+                textChunkOptions: z.ZodObject<{
+                    extendMode: z.ZodOptional<z.ZodEnum<["None", "Sentence", "Chars"]>>;
+                    extendScope: z.ZodOptional<z.ZodNumber>;
+                }, "strip", z.ZodTypeAny, {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                }, {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                }>;
+            }, "strip", z.ZodTypeAny, {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                fromTopDocuments: number;
+                topRelevantExtractsPerDoc: number;
+            }, {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                fromTopDocuments: number;
+                topRelevantExtractsPerDoc: number;
+            }>;
+            htmlOptions: z.ZodObject<{
+                images: z.ZodBoolean;
+                links: z.ZodBoolean;
+                tables: z.ZodBoolean;
+                extendTables: z.ZodBoolean;
+            }, "strip", z.ZodTypeAny, {
+                links: boolean;
+                images: boolean;
+                tables: boolean;
+                extendTables: boolean;
+            }, {
+                links: boolean;
+                images: boolean;
+                tables: boolean;
+                extendTables: boolean;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            html: boolean;
+            docColumns: string[];
+            textChunkFillGaps: number;
+            topPassagesOptions: {
+                topPassages: number;
+                topPassagesMinScore: number;
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+            };
+            matchingPassagesOptions: {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                matchingPassagesPerDoc: number;
+                fromTopDocuments: number;
+                matchingPassagesMinScore: number;
+            };
+            relevantExtractsOptions: {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                fromTopDocuments: number;
+                topRelevantExtractsPerDoc: number;
+            };
+            htmlOptions: {
+                links: boolean;
+                images: boolean;
+                tables: boolean;
+                extendTables: boolean;
+            };
+        }, {
+            html: boolean;
+            docColumns: string[];
+            textChunkFillGaps: number;
+            topPassagesOptions: {
+                topPassages: number;
+                topPassagesMinScore: number;
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+            };
+            matchingPassagesOptions: {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                matchingPassagesPerDoc: number;
+                fromTopDocuments: number;
+                matchingPassagesMinScore: number;
+            };
+            relevantExtractsOptions: {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                fromTopDocuments: number;
+                topRelevantExtractsPerDoc: number;
+            };
+            htmlOptions: {
+                links: boolean;
+                images: boolean;
+                tables: boolean;
+                extendTables: boolean;
+            };
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        contextOptions: {
+            html: boolean;
+            docColumns: string[];
+            textChunkFillGaps: number;
+            topPassagesOptions: {
+                topPassages: number;
+                topPassagesMinScore: number;
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+            };
+            matchingPassagesOptions: {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                matchingPassagesPerDoc: number;
+                fromTopDocuments: number;
+                matchingPassagesMinScore: number;
+            };
+            relevantExtractsOptions: {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                fromTopDocuments: number;
+                topRelevantExtractsPerDoc: number;
+            };
+            htmlOptions: {
+                links: boolean;
+                images: boolean;
+                tables: boolean;
+                extendTables: boolean;
+            };
+        };
+        app?: string | undefined;
+        query?: {} | undefined;
+    }, {
+        contextOptions: {
+            html: boolean;
+            docColumns: string[];
+            textChunkFillGaps: number;
+            topPassagesOptions: {
+                topPassages: number;
+                topPassagesMinScore: number;
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+            };
+            matchingPassagesOptions: {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                matchingPassagesPerDoc: number;
+                fromTopDocuments: number;
+                matchingPassagesMinScore: number;
+            };
+            relevantExtractsOptions: {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                fromTopDocuments: number;
+                topRelevantExtractsPerDoc: number;
+            };
+            htmlOptions: {
+                links: boolean;
+                images: boolean;
+                tables: boolean;
+                extendTables: boolean;
+            };
+        };
+        app?: string | undefined;
+        query?: {} | undefined;
+    }>;
+    uiSettings: z.ZodObject<{
+        display: z.ZodBoolean;
+        servicesModels: z.ZodBoolean;
+        functions: z.ZodBoolean;
+        temperature: z.ZodBoolean;
+        top_p: z.ZodBoolean;
+        maxTokens: z.ZodBoolean;
+        debug: z.ZodBoolean;
+        displaySystemPrompt: z.ZodBoolean;
+        systemPrompt: z.ZodString;
+        displayUserPrompt: z.ZodBoolean;
+        userPrompt: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        display: boolean;
+        debug: boolean;
+        temperature: boolean;
+        top_p: boolean;
+        maxTokens: boolean;
+        servicesModels: boolean;
+        functions: boolean;
+        displaySystemPrompt: boolean;
+        systemPrompt: string;
+        displayUserPrompt: boolean;
+        userPrompt: string;
+    }, {
+        display: boolean;
+        debug: boolean;
+        temperature: boolean;
+        top_p: boolean;
+        maxTokens: boolean;
+        servicesModels: boolean;
+        functions: boolean;
+        displaySystemPrompt: boolean;
+        systemPrompt: string;
+        displayUserPrompt: boolean;
+        userPrompt: string;
+    }>;
+    functions: z.ZodArray<z.ZodString, "many">;
+    debug: z.ZodBoolean;
+    saveChats: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    debug: boolean;
+    functions: string[];
+    globalSettings: {
+        signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
+        signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
+        restEndpoint?: string | undefined;
+        websocketEndpoint?: string | undefined;
+    };
+    serviceSettings: {
+        service_id: string;
+        model_id: string;
+        temperature: number;
+        top_p: number;
+        maxTokens: number;
+        results_per_prompt: number;
+        presence_penalty: number;
+        frequency_penalty: number;
+    };
+    contextSettings: {
+        contextOptions: {
+            html: boolean;
+            docColumns: string[];
+            textChunkFillGaps: number;
+            topPassagesOptions: {
+                topPassages: number;
+                topPassagesMinScore: number;
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+            };
+            matchingPassagesOptions: {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                matchingPassagesPerDoc: number;
+                fromTopDocuments: number;
+                matchingPassagesMinScore: number;
+            };
+            relevantExtractsOptions: {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                fromTopDocuments: number;
+                topRelevantExtractsPerDoc: number;
+            };
+            htmlOptions: {
+                links: boolean;
+                images: boolean;
+                tables: boolean;
+                extendTables: boolean;
+            };
+        };
+        app?: string | undefined;
+        query?: {} | undefined;
+    };
+    uiSettings: {
+        display: boolean;
+        debug: boolean;
+        temperature: boolean;
+        top_p: boolean;
+        maxTokens: boolean;
+        servicesModels: boolean;
+        functions: boolean;
+        displaySystemPrompt: boolean;
+        systemPrompt: string;
+        displayUserPrompt: boolean;
+        userPrompt: string;
+    };
+    saveChats: boolean;
+}, {
+    debug: boolean;
+    functions: string[];
+    globalSettings: {
+        signalRTransport: "None" | "WebSockets" | "ServerSentEvents" | "LongPolling";
+        signalRLogLevel: "None" | "Critical" | "Debug" | "Error" | "Information" | "Trace" | "Warning";
+        restEndpoint?: string | undefined;
+        websocketEndpoint?: string | undefined;
+    };
+    serviceSettings: {
+        service_id: string;
+        model_id: string;
+        temperature: number;
+        top_p: number;
+        maxTokens: number;
+        results_per_prompt: number;
+        presence_penalty: number;
+        frequency_penalty: number;
+    };
+    contextSettings: {
+        contextOptions: {
+            html: boolean;
+            docColumns: string[];
+            textChunkFillGaps: number;
+            topPassagesOptions: {
+                topPassages: number;
+                topPassagesMinScore: number;
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+            };
+            matchingPassagesOptions: {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                matchingPassagesPerDoc: number;
+                fromTopDocuments: number;
+                matchingPassagesMinScore: number;
+            };
+            relevantExtractsOptions: {
+                textChunkOptions: {
+                    extendMode?: "None" | "Sentence" | "Chars" | undefined;
+                    extendScope?: number | undefined;
+                };
+                fromTopDocuments: number;
+                topRelevantExtractsPerDoc: number;
+            };
+            htmlOptions: {
+                links: boolean;
+                images: boolean;
+                tables: boolean;
+                extendTables: boolean;
+            };
+        };
+        app?: string | undefined;
+        query?: {} | undefined;
+    };
+    uiSettings: {
+        display: boolean;
+        debug: boolean;
+        temperature: boolean;
+        top_p: boolean;
+        maxTokens: boolean;
+        servicesModels: boolean;
+        functions: boolean;
+        displaySystemPrompt: boolean;
+        systemPrompt: string;
+        displayUserPrompt: boolean;
+        userPrompt: string;
+    };
+    saveChats: boolean;
+}>;
+export interface ChatConfig extends z.infer<typeof chatConfigSchema> {
+}
+export interface ChatPayload {
+    functions: string[];
+    debug: boolean;
+    serviceSettings: ServiceSettings;
+    contextSettings: ContextSettings;
+    history: ChatMessage[];
+    instanceId?: string;
+    savedChatId?: 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;
+}
+/**
+ * List of events data that can be emitted by the websocket chat endpoint
+ */
+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;
+};
+/**
+ * Data emitted by the http chat endpoint
+ */
+export declare type HttpChatResponse = {
+    quota: Quota;
+    debug: any;
+    context: {
+        content: string;
+        additionalProperties: ChatContextAttachment;
+    }[];
+    actions: ActionMessage[];
+    history: RawMessage[];
+    executionTime: string;
+};
+export declare type MessageHandler<T> = {
+    handler: (data: T) => void;
+    isGlobalHandler: boolean;
+};
+export {};