@lemoncloud/eureka-agents-api 0.26.108

package/dist/modules/agents/types.d.ts

@@ -0,0 +1,578 @@
+/**
+ * `chatbots/types.ts`
+ * - types used in `backed-proxy`
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ * @author      Aiden <aiden@lemoncloud.io>
+ * @date        2025-03-18 refactoring for chatbot service.
+ * @Copyright   (C) 2025 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { ListResult, PaginateParam } from '../../cores/types';
+import { DocumentView } from './views';
+import { GenAIContent, TokenUsageDetail } from '../../lib/types';
+export { GenAIContent, TokenUsageDetail };
+/**
+ * Lookup Table
+ *
+ * WARN! DO NOT EXPORT AS `$LUT`. use default export instead.
+ */
+declare const $LUT: {
+    /**
+     * Possible type of model.
+     */
+    ModelType: {
+        /** agent model */
+        agent: string;
+        /** chat model */
+        chat: string;
+        /** prompt model */
+        prompt: string;
+        /** brain model */
+        brain: string;
+        /** document model */
+        document: string;
+        /** embedding model */
+        embedding: string;
+        /** usage model */
+        usage: string;
+        /** image model */
+        image: string;
+        /** rag model */
+        rag: string;
+    };
+    AgentStereo: {
+        '': string;
+        '#': string;
+    };
+    ChatStereo: {
+        '': string;
+        '#': string;
+        /** root of chat in tree (can be ready w/ `/agents/0/start`) */
+        root: string;
+        /** case of user query */
+        query: string;
+        /** case of answer generated */
+        answer: string;
+        /** (internal) used for rewrite */
+        rewrite: string;
+        /** (internal) used for RAG search w/ embedding */
+        search: string;
+        /** (internal) used for memory(short) */
+        memory: string;
+        /** (internal) 채팅비교시 이용함 (그룹화) */
+        group: string;
+    };
+    PromptStereo: {
+        '': string;
+        '#': string;
+        '#revision': string;
+        system: string;
+        user: string;
+    };
+    BrainStereo: {
+        '': string;
+        llm: string;
+    };
+    EmbeddingStereo: {
+        '': string;
+        '#': string;
+        system: string;
+        unit: string;
+        strategy: string;
+        site: string;
+        item: string;
+        prod: string;
+        '*': string;
+    };
+    UsageStereo: {
+        '': string;
+        '#': string;
+    };
+    ImageStereo: {
+        '': string;
+        '#': string;
+        '#alias': string;
+    };
+    /** document stereo */
+    DocumentStereo: {
+        '': string;
+        /** (internal) alias */
+        '#alias': string;
+        /** document in strategy state */
+        strategy: string;
+        /** document in embedding state */
+        embedding: string;
+        /** external; see `externalId` */
+        external: string;
+        /** document in chunking state */
+        chunking: string;
+    };
+    /** 문서 원본의 타입 */
+    DocumentExternalType: {
+        /** post (posts; 공지사항) */
+        post: string;
+        /** site (sites; 사업지) */
+        site: string;
+        /** content (contents: 유레카박스) */
+        content: string;
+    };
+    /** 문서 원본의 타입 */
+    DocumentResourceType: {
+        /** post (posts; 공지사항) */
+        posts: string;
+        /** site (sites; 사업지) */
+        sites: string;
+    };
+    /**
+     * as `DocumentStrategy`
+     */
+    DocumentStrategyType: {
+        /** '*' means every cases (but known as `default`) */
+        default: string;
+        /** markdown style #1 */
+        md1: string;
+        md2: string;
+        md3: string;
+        /** use json data */
+        json: string;
+    };
+    /**
+     * as `ChatRoleType`
+     */
+    ChatRoleType: {
+        /** system */
+        system: string;
+        /** user */
+        user: string;
+        /** assistant */
+        assistant: string;
+    };
+    /**
+     * as `ChatModelType`
+     */
+    ChatModelType: {
+        /** 'gpt-4o': 'gpt-4o' */
+        'gpt-4o': string;
+        /** 'gpt-4o-mini': 'gpt-4o-mini' */
+        'gpt-4o-mini': string;
+        /** 'gpt-4-turbo': 'gpt-4.0-turbo' */
+        'gpt-4-turbo': string;
+        /** 'gpt-4': 'gpt-4.0' */
+        'gpt-4': string;
+        /** 'gpt-4.1': 'gpt-4.1' */
+        'gpt-4.1': string;
+        /** 'gpt-3.5-turbo': 'gpt-3.5-turbo' */
+        'gpt-3.5-turbo': string;
+        /** 'gpt-5-mini': 'gpt-5-mini' */
+        'gpt-5-mini': string;
+    };
+    /**
+     * as `ChatEmbeddingType`
+     */
+    ChatEmbeddingType: {
+        /** as `openai/text-embedding-ada-002` */
+        ad2: string;
+        /** as `openai/text-embedding-3-small` */
+        sm3: string;
+        /** as `openai/text-embedding-3-large` */
+        lg3: string;
+        /** as `openai/gemini-embedding-001` */
+        gm1: string;
+    };
+    /**
+     * as `ChatStrategyType`
+     * - markdown style
+     */
+    ChatStrategyType: {
+        /** as `md-style-1` */
+        md1: string;
+        /** as `md-style-2` */
+        md2: string;
+        /** as `md-style-3` */
+        md3: string;
+    };
+    /**
+     * as `ChatModelProviderType`
+     */
+    ChatModelProviderType: {
+        amazon: string;
+        openai: string;
+        anthropic: string;
+        deepseek: string;
+    };
+    /**
+     * 다큐먼스 종류 (원본에 대한)
+     */
+    DocumentType: {
+        '': string;
+        '#rag': string;
+        /** as `doc` */
+        doc: string;
+        /** as `post` */
+        post: string;
+        /** as `site` */
+        site: string;
+        /** as `facility` */
+        facility: string;
+        /** as `content` */
+        content: string;
+        code: string;
+        /** as `program` */
+        program: string;
+    };
+    /** Encoding format of OpenAI Embedding */
+    EncodingFormat: {
+        /** as float */
+        float: string;
+        /** as base64 */
+        base64: string;
+    };
+    /** Embedding Dimension Size */
+    EmbeddingDimensions: {
+        ad2: number;
+        sm3: number;
+        lg3: number;
+        gm1: number;
+    };
+    /**
+     * as `VisionModelType`
+     */
+    VisionModelType: {
+        'gpt-4.1': string;
+        'gpt-4.1-mini': string;
+        'gpt-4.1-nano': string;
+        'gpt-4o': string;
+        'gpt-4o-mini': string;
+    };
+    /** Vision level of OpenAI */
+    VisionLevel: {
+        low: string;
+        high: string;
+        auto: string;
+    };
+    TextEmbeddingType: {
+        'text-embedding-ada-002': string;
+        'text-embedding-3-small': string;
+        'text-embedding-3-large': string;
+        'gemini-embedding-001': string;
+    };
+    /** type: TokenUsageType */
+    TokenUsageType: {
+        embedding: string;
+        completion: string;
+        vision: string;
+        classification: string;
+    };
+    /** 메타 정보의 타입 */
+    MetaInfoType: {
+        '': string;
+        /** link */
+        link: string;
+        /** image */
+        image: string;
+        /** phone */
+        phone: string;
+    };
+};
+/**
+ * type: `AgentStereo`
+ */
+export declare type AgentStereo = keyof typeof $LUT.AgentStereo;
+/**
+ * type: `ChatStereo`
+ */
+export declare type ChatStereo = keyof typeof $LUT.ChatStereo;
+/**
+ * type: `PromptStereo`
+ */
+export declare type PromptStereo = keyof typeof $LUT.PromptStereo;
+/**
+ * type: `BrainStereo`
+ */
+export declare type BrainStereo = keyof typeof $LUT.BrainStereo;
+/**
+ * type: `DocumentStereo`
+ */
+export declare type DocumentStereo = keyof typeof $LUT.DocumentStereo;
+/**
+ * type: `EmbeddingStereo`
+ */
+export declare type EmbeddingStereo = keyof typeof $LUT.EmbeddingStereo;
+/**
+ * type: `UsageStereo`
+ */
+export declare type UsageStereo = keyof typeof $LUT.UsageStereo;
+/**
+ * type: `ImageStereo`
+ */
+export declare type ImageStereo = keyof typeof $LUT.ImageStereo;
+/**
+ * type: `DocumentExternalType`
+ */
+export declare type DocumentExternalType = keyof typeof $LUT.DocumentExternalType;
+/**
+ * type: `DocumentResourceType`
+ *
+ * @deprecated use `DocumentOriginalType` instead.
+ */
+export declare type DocumentResourceType = keyof typeof $LUT.DocumentResourceType;
+/**
+ * type: `DocumentStrategyType`
+ */
+export declare type DocumentStrategyType = keyof typeof $LUT.DocumentStrategyType;
+/**
+ * type: `ChatStrategyType`
+ */
+export declare type ChatStrategyType = keyof typeof $LUT.ChatStrategyType;
+/**
+ * type: `ChatRoleType`
+ */
+export declare type ChatRoleType = keyof typeof $LUT.ChatRoleType;
+/**
+ * type: `ChatEmbeddingType`
+ */
+export declare type ChatEmbeddingType = keyof typeof $LUT.ChatEmbeddingType;
+/**
+ * type: `EncodingFormat`
+ */
+export declare type EncodingFormat = keyof typeof $LUT.EncodingFormat;
+/**
+ * type: `DocumentType`
+ */
+export declare type DocumentType = keyof typeof $LUT.DocumentType;
+/**
+ * type: `ChatModelType`
+ */
+export declare type ChatModelType = keyof typeof $LUT.ChatModelType;
+/**
+ * type: `ChatModelProviderType`
+ */
+export declare type ChatModelProviderType = keyof typeof $LUT.ChatModelProviderType;
+/**
+ * type: `VisionLevel`
+ */
+export declare type VisionLevel = keyof typeof $LUT.VisionLevel;
+/**
+ * type: `VisionModelType`
+ */
+export declare type VisionModelType = keyof typeof $LUT.VisionModelType;
+/**
+ * type: `TokenUsageType`
+ */
+export declare type TokenUsageType = keyof typeof $LUT.TokenUsageType;
+/**
+ * type: `TextEmbeddingType`
+ */
+export declare type TextEmbeddingType = keyof typeof $LUT.TextEmbeddingType;
+/**
+ * type: `MetaInfoType`
+ */
+export declare type MetaInfoType = keyof typeof $LUT.MetaInfoType;
+/**
+ * type: `AgentProfileMeta`
+ */
+export interface AgentProfileMeta extends DocumentMeta {
+    /** 닉이름 */
+    nick?: string;
+    /** 나이 */
+    age?: string;
+    /** 역할 */
+    role?: string;
+    /** 목표 */
+    goal?: string;
+    /** 성격 */
+    mind?: string;
+    /** 취미(좋아하는 것) */
+    like?: string;
+    /** 말투(말하는 스타일) */
+    tone?: string;
+    /** 인사말 (처음 인사말) */
+    greet?: string;
+    /** 자기소개 */
+    intro?: string;
+    /** 풀백 메시지 대응 */
+    back?: string;
+    /** 욕설 메시지 대응 */
+    abuse?: string;
+    /** 감사합니다. 표현 */
+    thank?: string;
+}
+/**
+ * type: `AgentConfigSet`
+ * - configuration set for agent
+ */
+export interface AgentConfigSet {
+    /** WARN! only contain string value */
+    [key: string]: string;
+    /** max history depth (default: 12) */
+    maxHistory?: string;
+}
+/**
+ * type: `DocumentSyncPullParam`
+ */
+export interface DocumentSyncPullParam<T = DocumentExternalType> extends PaginateParam {
+    /** 원본 타입 */
+    type?: T;
+    /** (optional) flag to 결과 저장 */
+    save?: string | boolean;
+    /** (optional) show in detail */
+    detail?: string | boolean;
+    /** (optional) force to save */
+    force?: string | boolean;
+    /** using version. (ex: `1`) */
+    version?: number;
+}
+/**
+ * type: `DocumentSyncPullParamV2`
+ */
+export interface DocumentSyncPullParamV2 extends DocumentSyncPullParam<DocumentExternalType> {
+    /** 사업지 ID (type=site) */
+    siteId?: string;
+    /** 시설안내 ID (type=facility) */
+    facilityId?: string;
+    /** 게시판 ID (type=post) */
+    boardId?: string;
+    /** 게시글 ID (type=post) */
+    postId?: string;
+    /** 컨텐츠 ID (type=content) */
+    contentId?: string;
+    /** 코드 ID (type=code) */
+    codeId?: string;
+    /** 프로그램 ID (type=program) */
+    programId?: string;
+    /** stereo (type=program) */
+    stereo?: 'program' | 'seat' | string;
+    /** (for debug) flag to use production */
+    prod?: string;
+}
+/**
+ * type: `DocumentSyncPullResult`
+ */
+export interface DocumentSyncPullResult<T = any> extends ListResult<DocumentView> {
+    /** 원본 목록 */
+    list2?: T[];
+}
+/**
+ * type: `ChatUserProfile`
+ */
+export interface ChatUserProfile {
+    /** id of user */
+    id?: string;
+    /** name of user */
+    name?: string;
+    /** 단지 이름 */
+    site?: string;
+    /** 단지 id */
+    sid?: string;
+    /** 동 */
+    dong?: string;
+    /** 호 */
+    ho?: string;
+    /** 성별 */
+    gender?: string;
+}
+/**
+ * type: `DocumentCommon`
+ * - common information for document
+ */
+export interface DocumentCommon {
+    /** stereo of origin document */
+    stereo?: DocumentType;
+    /** strategy to transform */
+    strategy?: DocumentStrategyType;
+    /** meta data */
+    meta?: DocumentMeta;
+    /** image analysis response message */
+    visionMessage?: string;
+}
+/**
+ * type: `DocumentMeta`
+ */
+export interface DocumentMeta {
+    /** 게시물 작성일 (ts) */
+    date?: string;
+    /** category */
+    category?: string;
+    /** author */
+    author?: string;
+    /** 게시물 url */
+    url?: string;
+    /** images url */
+    images?: string[];
+    /** meta of chunking */
+    chunks?: ChunkMeta[];
+    /** code extension */
+    extension?: string;
+}
+/**
+ * type: `RagChatBody`
+ */
+export interface RagChatBody {
+    /** 사용자 질문 */
+    input?: string;
+    /**
+     * (optional) site-id to apply
+     * - default is from session
+     */
+    sid?: string;
+    /** (optional) websocket connection-id to receive the server-sent events */
+    connectionId?: string;
+}
+/**
+ * type: `ChatParam`
+ */
+export interface RagChatParam {
+    /** system prompt to chat */
+    prompt?: string;
+    /** user prompt to chat */
+    userPrompt?: string;
+    /** strategy to search */
+    strategy?: string | ChatStrategyType;
+    /** embedding model */
+    embedding?: string | ChatEmbeddingType;
+    /** websocket connection-id */
+    connId?: string;
+    /** (optional) parent chat id */
+    parent?: string;
+    /** flag to use quota request */
+    quota?: string | boolean;
+    /** flag to use chat history */
+    history?: string | boolean;
+    /** flag to use RAG search */
+    rag?: string | boolean;
+    /** size of RAG search (default: 6) */
+    size?: number;
+    /**
+     * (optional) type to search.
+     * - default is 'item' (품목)
+     * - '*' (item | prod)
+     * - 'site' (사업지)
+     * - 'prod' (상품)
+     * - 'item' (품목)
+     */
+    type?: 'item' | 'prod' | '*' | 'site';
+}
+/**
+ * type: `MetaInfo`
+ * - chat meta info
+ */
+export interface MetaInfo {
+    /** type of meta info */
+    type?: MetaInfoType;
+    /** text of meta */
+    text?: string;
+}
+/**
+ * type: `ChunkMeta`
+ */
+export interface ChunkMeta {
+    /** start line of chunk */
+    start?: number;
+    /** end line of chunk */
+    end?: number;
+    /** name of chunk */
+    name?: string;
+}
+/** must export $LUT as default */
+export default $LUT;