@lemoncloud/eureka-agents-api 0.26.108

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

@@ -0,0 +1,602 @@
+/**
+ * `chatbots/model.ts`
+ * - model definitions per account data
+ *
+ * @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 { CoreModel } from 'lemon-model';
+import $LUT, { AgentConfigSet, AgentProfileMeta, AgentStereo, BrainStereo, ChatRoleType, ChatStereo, ChatUserProfile, DocumentExternalType, DocumentResourceType, DocumentStereo, DocumentStrategyType, EmbeddingStereo, ImageStereo, PromptStereo, UsageStereo, ChatStrategyType, ChatEmbeddingType, DocumentMeta, TokenUsageType, ChatModelProviderType, ChatModelType, MetaInfo, TokenUsageDetail, GenAIContent } from './types';
+/**
+ * type: boolean style number.
+ */
+declare type BoolFlag = 0 | 1;
+/**
+ * type: `ModelType`
+ */
+export declare type ModelType = keyof typeof $LUT.ModelType;
+/**
+ * type: `Model`: common model
+ */
+export declare type Model = CoreModel<ModelType>;
+/**
+ * type: `AgentHead`
+ */
+export interface AgentHead {
+    /** id of agent */
+    id?: string;
+    /** name of agent */
+    name?: string;
+    /** stereo */
+    stereo?: AgentStereo;
+}
+/**
+ * type: `AgentModel`
+ * - model for agent (에이전트)
+ * - set of configuration for agent
+ * - (추가) 페르소나에 대한 컨텍스 정보를 담는다.
+ */
+export interface AgentModel extends Model, AgentHead {
+    /** id of agent */
+    id?: string;
+    /** stereo */
+    stereo?: AgentStereo;
+    /** (linked) id of prompt (system) */
+    systemId?: string;
+    /** (linked) partial of prompt (system) */
+    system$?: PromptHead;
+    /** (linked) id of prompt (system) */
+    promptId?: string;
+    /** (linked) partial of prompt (system) */
+    prompt$?: PromptHead;
+    /** (linked) id of brain (language model) */
+    brainId?: string;
+    /** (linked) partial of brain */
+    brain$?: BrainHead;
+    /** (optional) id of agent to rewrite */
+    rewriteId?: string;
+    /** (optional) partial of agent to rewrite */
+    rewrite$?: AgentHead;
+    /** (optional) id of parent */
+    parentId?: string;
+    /** (optional) partial of parent */
+    parent$?: AgentHead;
+    /** (optional) vector embedding of document */
+    embedding?: ChatEmbeddingType;
+    /** (optional) strategy to build document */
+    strategy?: ChatStrategyType;
+    /** profile meta data */
+    meta$?: AgentProfileMeta;
+    /** configuration set */
+    conf$?: AgentConfigSet;
+    /** (integer) temperature in 0~100 */
+    temperature?: number;
+    /** max-tokens in 0~4096 */
+    maxTokens?: number;
+    /** (flag) enables or disables RAG (Retrieval-Augmented Generation) */
+    useRag?: BoolFlag;
+    /** (flag) whether this is public or not. */
+    public?: BoolFlag;
+    /** system prompt content */
+    readonly $system?: GenAIContent<any>;
+    /** user prompt content */
+    readonly $prompt?: GenAIContent<any>;
+}
+/**
+ * type: `ChatHead`
+ */
+export interface ChatHead {
+    /** id of chat */
+    id?: string;
+    /** name of chat */
+    name?: string;
+    /** stereo */
+    stereo?: ChatStereo;
+}
+/**
+ * type: `ChatModel`
+ * - model for chat (채팅)
+ *
+ * **flow**
+ * 1. 채팅은 다음과 같은 구조를 가짐 (thread 단위)
+ *    - `id`: root(parent): auto-seq (ex: `1001`)
+ *    - `id`: child: combination of parent-id and idx (ex: `1001:1`)
+ * 2. 1개의 질문에 대해서 여러개의 채팅을 가짐
+ *   - `group` 으로 묶어서 관리
+ */
+export interface ChatModel extends Model, ChatHead {
+    /**
+     * id of model
+     * - root(parent): auto-seq (ex: `1001`)
+     * - child: combination of parent-id and idx (ex: `1001:1`)
+     */
+    id?: string;
+    /** (internal) number in child */
+    no?: number;
+    /** (internal) depth in child */
+    depth?: number;
+    /** name */
+    name?: string;
+    /** stereo */
+    stereo?: ChatStereo;
+    /** role */
+    role?: ChatRoleType;
+    /** (flag) is hidden */
+    hidden?: number;
+    /** took time interval (msec) */
+    took?: number;
+    /** id of parent */
+    parentId?: string;
+    /** partial of parent */
+    parent$?: ChatHead;
+    /** (linked) id of agent */
+    agentId?: string;
+    /** (linked) partial of agent */
+    agent$?: AgentHead;
+    /** (linked) id of user-prompt (system) */
+    systemId?: string;
+    /** (linked) partial of user-prompt (system) */
+    system$?: PromptHead;
+    /** (linked) id of prompt (user) */
+    promptId?: string;
+    /** (linked) partial of prompt (user) */
+    prompt$?: PromptHead;
+    /** (linked) id of brain (language model) */
+    brainId?: string;
+    /** (linked) partial of brain */
+    brain$?: BrainHead;
+    /** (optional) id of agent to rewrite */
+    rewriteId?: string;
+    /** (optional) partial of agent to rewrite */
+    rewrite$?: AgentHead;
+    /** (linked) id of embedding of this (:= id) */
+    embeddingId?: string;
+    /** (linked) partial of embedding of this (:= id) */
+    embedding$?: EmbeddingHead;
+    /** (immutable) embedding type for chat */
+    embedding?: ChatEmbeddingType;
+    /** (immutable) strategy type for chat */
+    strategy?: ChatStrategyType;
+    /** (linked) id of usage (can be null) */
+    usageIds?: string[];
+    /** (linked) partial of usage */
+    usage$$?: UsageHead[];
+    /** content of the prompt (must be in `md` format) */
+    content?: string;
+    /** (copied) the token usage in detail */
+    usage$?: TokenUsageDetail;
+    /**
+     * (optional) number of child nodes
+     * - if > 0, then this has child nodes.
+     */
+    childNo?: number;
+    /**
+     * (internal) api version when created.
+     * ex) `0.25.618`
+     */
+    _version?: string;
+    /** context of chat-user */
+    profile$?: ChatUserProfile;
+    /** (optional) 이용된 문서 ID 항목 */
+    documentIds?: string[];
+    /** (optional) 찾아진 원본 문서의 일부 내용  */
+    document$$?: DocumentHead[];
+    /** 게시물 링크 정보 @deprecated refactoring under progress */
+    link?: {
+        text?: string;
+        link?: string;
+    }[];
+    /** 이미지 링크 정보 @deprecated refactoring under progress. */
+    image?: {
+        src?: string;
+        href?: string;
+    }[];
+    /** 전화번호 @deprecated refactoring under progress. */
+    phone?: string[];
+    /** 답변의 메타 정보 */
+    meta$$?: MetaInfo[];
+    /** */
+    readonly $childs?: ChatModel[];
+}
+/**
+ * type: `PromptHead`
+ * - common head of prompt-model
+ */
+export interface PromptHead {
+    /** id of chat */
+    id?: string;
+    /** name of chat */
+    name?: string;
+    /** stereo */
+    stereo?: PromptStereo;
+}
+/**
+ * type: `PromptModel`
+ * - model for prompt (including user and system prompt)
+ * - prompt is a part of chat.
+ */
+export interface PromptModel extends Model, PromptHead {
+    /** id of model (auto-seq) */
+    id?: string;
+    /** name */
+    name?: string;
+    /** stereo */
+    stereo?: PromptStereo;
+    /** text of prompt */
+    content?: string;
+    /** (optional) id of parent */
+    parentId?: string;
+    /** (optional) partial of parent */
+    parent$?: PromptHead;
+    /** (flag) is hidden */
+    hidden?: BoolFlag;
+    /**
+     * (optional) number of revisions
+     * - [parent] no-of-revision
+     * - [child] no-in-revision
+     */
+    revisionNo?: number;
+    /**
+     * (optional) number of child nodes
+     * - [parent] no-of-child
+     * - [child] no-in-child
+     */
+    childNo?: number;
+}
+/**
+ * type: `BrainHead`
+ * - common head of brain-model
+ */
+export interface BrainHead {
+    /** id of chat */
+    id?: string;
+    /** name of chat */
+    name?: string;
+    /** stereo */
+    stereo?: BrainStereo;
+    /** type of chat */
+    model?: ChatModelType;
+}
+/**
+ * type: `BrainModel`
+ * - model for brain (LLM: large language model)
+ */
+export interface BrainModel extends Model, BrainHead {
+    /** id of model (auto-seq) */
+    id?: string;
+    /** name */
+    name?: string;
+    /** stereo */
+    stereo?: BrainStereo;
+    /** provider of llm model */
+    provider?: ChatModelProviderType;
+    /** version info */
+    version?: string;
+    /** description */
+    description?: string;
+}
+/**
+ * type: `DocumentHead`
+ * - common head of `DocumentModel`
+ */
+export interface DocumentHead {
+    /** id of model */
+    id?: string;
+    /** stereo */
+    stereo?: DocumentStereo;
+    /** name of document */
+    name?: string;
+    /** score of rate */
+    score?: number;
+}
+/**
+ * type: `DocumentModel`
+ * - model for document (문서) in markdown format
+ *
+ * **[시나리오]**
+ * 1. `sync-pull` 으로 원본 문서를 가져온다.
+ * 2. 간단한 변환을 거쳐서 `content` + `meta$` 를 생성한다.
+ */
+export interface DocumentModel extends Omit<Model, 'meta'>, DocumentHead {
+    /** stereo */
+    stereo?: DocumentStereo;
+    /** name of document */
+    name?: string;
+    /** (internal) alias-id */
+    aliasId?: string;
+    /** title */
+    title?: string;
+    /** (optional) summary in short */
+    summary?: string;
+    /** (internal) error if has */
+    error?: string;
+    /**
+     * transform from `contents` by joining with '\n'.
+     * - this is not a part of `DocumentInput` but for convenience.
+     */
+    content?: string;
+    /** meta data */
+    meta$?: DocumentMeta;
+    /** tags: array of each tag */
+    tags?: string[];
+    /** image linked id */
+    imageIds?: string[];
+    /** (optional) image partial info */
+    image$$?: ImageHead[];
+    /** id of site */
+    siteId?: string;
+    /** name of site */
+    siteName?: string;
+    /** (external) model type of source document */
+    externalType?: DocumentExternalType;
+    /**
+     * (external) id of external document
+     * - this is used to link with external document.
+     * - id := `type:id`
+     * - ex: `pdf:1234567890` or `md:abcdefg`
+     */
+    externalId?: string;
+    /**
+     * (external) stereo of source document
+     * - can be like `notice`, `faq`, `blog`, etc.
+     */
+    externalStereo?: string;
+    /** (external) original document created at */
+    docCreatedAt?: number;
+    /** (external) original document updated at */
+    docUpdatedAt?: number;
+    /** type of strategy */
+    strategy?: DocumentStrategyType;
+    /** type of embedding */
+    embedding?: ChatEmbeddingType;
+    /** (optional) embedding vector if stereo=embedding */
+    vector?: number[];
+    /** (optional) embedding dimensions */
+    dimension?: number;
+    /** (optional) id of parent */
+    parentId?: string;
+    /** (optional) partial of parent */
+    parent$?: DocumentHead;
+    /**
+     * (optional) number of child nodes
+     * - [parent] no-of-child
+     * - [child] no-in-child
+     */
+    childNo?: number;
+    /** document version number (see `DocumentSyncPullParam.version`) */
+    version?: number;
+    /** document revision number (inc by pulling again) */
+    revision?: number;
+    /**
+     * @deprecated use `.meta$` object instead.
+     */
+    meta?: DocumentMeta | string;
+    /**
+     * (external) model type of source document
+     *
+     * @deprecated use `originalType` instead.
+     */
+    resourceType?: DocumentResourceType;
+    /**
+     * (external) id of resource
+     *
+     * @deprecated use `originalId` instead.
+     */
+    resourceId?: string;
+    /** (internal) the linked alias */
+    readonly $alias?: DocumentModel;
+    /** (internal) the linked images */
+    readonly $images?: ImageModel[];
+    /** (internal) the linked childs */
+    readonly $childs?: DocumentModel[];
+    /** (internal) the linked embeddings */
+    readonly $embeddings?: EmbeddingModel[];
+    /** (internal) the used tokens */
+    readonly $usage?: TokenUsageDetail;
+}
+/**
+ * type: `EmbeddingHead`
+ * - common head of `EmbeddingModel`
+ */
+export interface EmbeddingHead {
+    /** id of model */
+    id?: string;
+    /** name of model */
+    name?: string;
+    /** stereo */
+    stereo?: EmbeddingStereo;
+}
+export interface EmbeddingVectorSet {
+    /** (v2) embedding vector by ad2 (float; dim=1536) */
+    ad2?: number[];
+    /** (v2) embedding vector by sm3 (float; dim=256) */
+    sm3?: number[];
+    /** (v2) embedding vector by lg3 (float; dim=1024) */
+    lg3?: number[];
+    /** (v2) embedding vector by gm1 (float; dim=3072) */
+    gm1?: number[];
+}
+/**
+ * type: `EmbeddingModel`
+ * - model for embedding (임베딩) used for RAG (Retrieval-Augmented Generation) search.
+ * - 1 document has 1 or more embedding models.
+ *
+ * - (v2) save the remote model in json format with vector set.
+ */
+export interface EmbeddingModel extends Model, EmbeddingHead {
+    /**
+     * id of model
+     * - system: default auto-seq, or user defined. (ex: 'sg1')
+     * - unit: combination of documentId and parentId (ex: `2001:md1:sg1`)
+     */
+    id?: string;
+    /** stereo */
+    stereo?: EmbeddingStereo;
+    /** model */
+    model?: ChatEmbeddingType;
+    /**
+     * (internal) revision number
+     */
+    revision?: number;
+    /**
+     * typeof strategy
+     */
+    strategy?: DocumentStrategyType;
+    /**
+     * json stringified meta info
+     * - save the original json
+     */
+    meta?: string;
+    /**
+     * (v2) vectors of the embedding
+     * ex: vector$.ad2
+     */
+    vector$?: EmbeddingVectorSet;
+    /** (optional) id of parent */
+    parentId?: string;
+    /** (optional) partial of parent */
+    parent$?: EmbeddingHead;
+    /** (optional) id of document */
+    documentId?: string;
+    /** (optional) partial of document */
+    document$?: DocumentHead;
+    /** (optional) id of usage */
+    usageId?: string;
+    /** (optional) partial of usage */
+    usage$?: UsageHead;
+    /** (internal) score by search */
+    readonly _score?: number;
+    /** (internal) document to use */
+    readonly $document?: DocumentModel;
+}
+/**
+ * type: `UsageHead`
+ * - common head of `UsageModel`
+ */
+export interface UsageHead {
+    /** id of model */
+    id?: string;
+    /** name of model */
+    name?: string;
+    /** stereo */
+    stereo?: UsageStereo;
+    /** type of usage */
+    usage?: TokenUsageType;
+}
+/**
+ * type: `UsageModel`
+ * - model for usage (임베딩) used for RAG (Retrieval-Augmented Generation) search.
+ */
+export interface UsageModel extends Model, UsageHead {
+    /** id of usage */
+    id?: string;
+    /** name of usage */
+    name?: string;
+    /** stereo */
+    stereo?: UsageStereo;
+    /** type of usage */
+    usage?: TokenUsageType;
+    /**
+     * used tokens (must be number/integer)
+     */
+    usage$?: TokenUsageDetail;
+}
+/**
+ * type: `ImageHead`
+ * - common head of `ImageModel`
+ */
+export interface ImageHead {
+    /** id of model */
+    id?: string;
+    /** stereo */
+    stereo?: ImageStereo;
+    /** hash of image url */
+    hash?: string;
+    /** url of image */
+    url?: string;
+    /** (internal) error if has */
+    error?: string;
+    /** (optional) content after described */
+    content?: string;
+}
+/**
+ * type: `ImageModel`
+ * - manage each image referenced in documents.
+ */
+export interface ImageModel extends Model, ImageHead {
+    /** id of image */
+    id?: string;
+    /** stereo */
+    stereo?: ImageStereo;
+    /** (optional) alias of image */
+    aliasId?: string;
+    /** (optional) alias of image */
+    alias$?: ImageHead;
+    /** name of image */
+    name?: string;
+    /** hash of image url */
+    hash?: string;
+    /** original image url */
+    url?: string;
+    /** image content in text */
+    content?: string;
+    /** referenced document-id */
+    documentId?: string;
+    /** (optional) partial of document */
+    document$?: DocumentHead;
+    /** (copied) the token usage in detail */
+    usage$?: TokenUsageDetail;
+}
+/**
+ * extract field names from models
+ * - only fields start with lowercase, or all upper.
+ */
+export declare const filterFields: (fields: string[], base?: string[]) => string[];
+/** field names from head */
+export declare const $HEAD: {
+    agent: string[];
+    chat: string[];
+    prompt: string[];
+    brain: string[];
+    document: string[];
+    embedding: string[];
+    usage: string[];
+    image: string[];
+};
+export declare const $FIELD: {
+    agent: string[];
+    chat: string[];
+    prompt: string[];
+    brain: string[];
+    document: string[];
+    embedding: string[];
+    usage: string[];
+    image: string[];
+};
+/** must export default as below */
+declare const _default: {
+    $HEAD: {
+        agent: string[];
+        chat: string[];
+        prompt: string[];
+        brain: string[];
+        document: string[];
+        embedding: string[];
+        usage: string[];
+        image: string[];
+    };
+    $FIELD: {
+        agent: string[];
+        chat: string[];
+        prompt: string[];
+        brain: string[];
+        document: string[];
+        embedding: string[];
+        usage: string[];
+        image: string[];
+    };
+};
+export default _default;