@sinequa/assistant 3.8.0 → 3.9.0

package/chat/tooltip/tooltip.directive.d.ts

@@ -0,0 +1,81 @@
+import { ElementRef, OnDestroy, TemplateRef } from "@angular/core";
+import { ConnectedPosition, Overlay, OverlayPositionBuilder } from "@angular/cdk/overlay";
+import { Observable } from "rxjs";
+import * as i0 from "@angular/core";
+export type Placement = "top" | "bottom" | "right" | "left";
+/**
+ * Directive that attaches a tooltip to the host element
+ *
+ * @example
+ * <div sqTooltip="This is a tooltip's text"></div>
+ *
+ * @example
+ * // A template can be passed to the directive instead of a string. Here 'tooltip' is a template reference
+ * <div sqTooltip="tooltip"></div>
+ *
+ * <ng-template #tooltip>
+ *  <h2>Title</h2>
+ *  <p>{{ "this is a comment" | uppercase }}</p>
+ *  <h3>Other text</h3>
+ * </ng-template>
+ *
+ * @example
+ * //HTML can be used directly (not recommanded)
+ * <div sqTooltip="<h1>Title</h1><br><p>This is a comment</p>"></div>
+ */
+export declare class TooltipDirective<TooltipData = undefined, TooltipDisplay = string> implements OnDestroy {
+    private overlay;
+    private overlayPositionBuilder;
+    private elementRef;
+    /**
+     * Defining a property called textOrTemplate that can be a string, a function that
+     * returns an Observable of a string or undefined, or a TemplateRef.
+     */
+    value?: TooltipDisplay | ((data?: TooltipData) => Observable<TooltipDisplay | undefined> | undefined);
+    data?: TooltipData;
+    template?: TemplateRef<any>;
+    /**
+     * Setting the default value of the placement property to `bottom`
+     */
+    placement: Placement;
+    /**
+     * List of fallback placement if *Placement* defined can't be applyied
+     */
+    fallbackPlacements: Placement[];
+    /**
+     * Delay in millisecond before showing/hiding the tooltip.
+     *
+     * Default value is 300ms
+     */
+    delay: number;
+    /**
+     * If the tooltip should stay opened on hover
+     */
+    hoverableTooltip: boolean;
+    /**
+     * Custom class for the tooltip
+     */
+    tooltipClass?: string;
+    /**
+     * Applies the "has-tooltip" class to its host when displayed
+     */
+    hasTooltip: boolean;
+    private overlayRef;
+    private subscription?;
+    private clearTimeout?;
+    static activeTooltip?: TooltipDirective<any, any>;
+    constructor(overlay: Overlay, overlayPositionBuilder: OverlayPositionBuilder, elementRef: ElementRef);
+    ngOnDestroy(): void;
+    show(): void;
+    mouseClick(): void;
+    hide(): void;
+    cancelHide(): void;
+    /**
+     * Clear timeout function and detach overlayRef
+     */
+    clear(): void;
+    position(placement?: Placement): ConnectedPosition;
+    fallbackPositions(): ConnectedPosition[];
+    static ɵfac: i0.ɵɵFactoryDeclaration<TooltipDirective<any, any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<TooltipDirective<any, any>, "[sqTooltip]", never, { "value": { "alias": "sqTooltip"; "required": false; }; "data": { "alias": "sqTooltipData"; "required": false; }; "template": { "alias": "sqTooltipTemplate"; "required": false; }; "placement": { "alias": "placement"; "required": false; }; "fallbackPlacements": { "alias": "fallbackPlacements"; "required": false; }; "delay": { "alias": "delay"; "required": false; }; "hoverableTooltip": { "alias": "hoverableTooltip"; "required": false; }; "tooltipClass": { "alias": "tooltipClass"; "required": false; }; }, {}, never, never, true, never>;
+}

package/chat/types/message-content.types.d.ts

@@ -0,0 +1,54 @@
+/** Supported message type */
+export type MessageType = "text" | "image" | "video";
+/** Generic message content schema */
+export type MessageContent = {
+    type: MessageType;
+};
+/** Text specific message content */
+export type TextMessageContent = MessageContent & {
+    type: "text";
+    text: string;
+};
+/**
+ * Image specific message content
+ * Images can be:
+ * - Pageshot: Image from a page (offset, length, pageNumber, remappedOffset, remappedLength)
+ * - Base64: Image encoded in base64 (base64)
+ * - External URL: Image from an URL (isFromDC = false)
+ * - Document cache: Image from an indexed document (isFromDC = true)
+ */
+export type ImageMessageContent = MessageContent & {
+    type: "image";
+    imageData: {
+        $type: "base64" | "url";
+        mimeType: string;
+        name: string;
+        base64?: string;
+        description?: string;
+        isFromDC?: true;
+        length?: number;
+        offSet?: number;
+        pageNumber?: number;
+        remappedLength?: number;
+        remappedOffset?: number;
+        url?: string;
+    };
+};
+/**
+ * Video specific message content
+ * Image correspond to the send image to the LLM and can be used as thumbnail
+ */
+export type VideoMessageContent = MessageContent & {
+    type: "video";
+    videoData: {
+        name: string;
+        description: string;
+        fileName: string;
+        imageMimeType: string;
+        imageUrl: string;
+        videoMimeType: string;
+        videoUrl: string;
+        timeCode: number;
+    };
+};
+export type RawMessageContent = string | MessageContent[];

package/chat/types/message-reference.types.d.ts

@@ -0,0 +1,11 @@
+import { Article } from "@sinequa/atomic";
+/** Type of a context image reference */
+export type MessageImageReference = {
+    name?: string;
+    description?: string;
+    url?: string;
+    type?: string;
+    mimeType?: string;
+    article?: Article;
+    articleId?: string;
+};