vectocore4 0.0.11 → 0.0.20

package/dist/cjs/index.js

@@ -41,6 +41,13 @@ class Vectocore {
             return response.data;
         });
     }
+    /**
+     * 인덱스를 생성/수정합니다.
+     * @param params ({@link PutIndexParams})
+     * - **indexName**: string (필수) 생성 및 수정할 인덱스 명
+     * - description: string (선택) 인덱스에 대한 설명
+     * @returns 식제 결과
+     */
     putIndex(_a) {
         return __awaiter(this, arguments, void 0, function* ({ indexName, description }) {
             const requestParam = {
@@ -54,6 +61,12 @@ class Vectocore {
             return response;
         });
     }
+    /**
+     * 인덱스를 삭제합니다.
+     * @param params ({@link DeleteIndexParams})
+     * - **indexName**: string (필수) 삭제할 인덱스의 이름
+     * @returns 식제 결과
+     */
     deleteIndex(_a) {
         return __awaiter(this, arguments, void 0, function* ({ indexName }) {
             const requestParam = {
@@ -66,6 +79,10 @@ class Vectocore {
             return response;
         });
     }
+    /**
+     * 인덱스 목록을 조회합니다.
+     * @returns 인덱스 목록
+     */
     listIndex() {
         return __awaiter(this, void 0, void 0, function* () {
             const requestParam = {
@@ -75,6 +92,20 @@ class Vectocore {
             return response;
         });
     }
+    /**
+     * 인덱스에 문서 저장
+     * @param params ({@link PutExtremeDataParams})
+     * - **indexName**: string (필수) 문서를 저장할 인덱스의 이름
+     * - **docBody**: json (필수)
+     *  - **id**: string (선택) 도큐먼트 ID (소문자, 영문, -), 값은 인덱스내에서 유일해야함, 신규 row일 경우 각 시스템에서 직접 채번하거나 ""빈값으로 보내면 자동으로 채번함
+     *  - **keywords**: string (필수) 검색의 대상이 되는 필드. 사용자 질문의 의도를 파악하여 RAG내에서 유사도를 비교하여 높은 순서로 결과를 리턴 받는다.
+     *  - **data**: string (필수) 키워드에 해당하는 문서의 실제 내용
+     *  - docType: "text"|"image" (선택) Default : "text", 저장할 지식의 타입으로 Default는 "text". doc_type이 "image"일 경우 추가로 "image_url" 필드를 사용합니다.
+     *  - imageUrl: string (선택) doc_type이 "image"일 경우 사용하는 필드로 웹에서 접근 가능한 이미지의 경로를 입력.
+     *  - metadata: json (선택) 문서 저장시 추가로 남기고 싶은 정보를 json 형식으로 추가하면 향후 검색 결과시 리턴. 문서명이나, 페이지 번호 등을 입력하여 출처 확인용으로 사용할 수 있다
+     *  - refOnlyText: bool (선택) ens 기능 사용시 사용하는 옵션으로 doc_type이 "image"인 경우 "image_url"의 경로를 자동으로 멀티모달로 전달하는데 ref_only_text : true로 설정한 경우 멀티모달을 전달하지 않고 "data" 필드의 정보만 context로 활용한다.
+     * @returns 문서 저장 결과
+     */
     putExtremeData(_a) {
         return __awaiter(this, arguments, void 0, function* ({ indexName, docBody }) {
             var _b, _c;
@@ -101,6 +132,13 @@ class Vectocore {
             return response;
         });
     }
+    /**
+     * 특정 문서를 조회합니다.
+     * @param params - 조회에 필요한 매개변수 객체 ({@link GetExtremeDataParams})
+     * - **indexName**: string (필수) 문서가 저장되어 있는 인덱스의 이름
+     * - **documentId**: string (필수) 문서의 ID
+     * @returns 문서 정보
+     */
     getExtremeData(_a) {
         return __awaiter(this, arguments, void 0, function* ({ indexName, documentId }) {
             const requestParam = {
@@ -114,6 +152,14 @@ class Vectocore {
             return response;
         });
     }
+    /**
+     * 특정 인덱스에 저장된 지식 데이터를 조회합니다.(페이징)
+     * @param params - 조회에 필요한 매개변수 객체 ({@link ListExtremeDataParams})
+     * - **indexName**: string (필수)
+     * - lastKey: string (선택) 최초 검색 결과에서 전달 받은 토큰값
+     * - withVectorValye: bool (선택) 결과에 벡터값 포함 여부. 기본값 : 'false'
+     * @returns 인덱스 목록
+     */
     listExtremeData(_a) {
         return __awaiter(this, arguments, void 0, function* ({ indexName, lastKey, withVectorValue }) {
             const requestParam = {
@@ -132,7 +178,7 @@ class Vectocore {
     }
     /**
      * 특정 인덱스에 저장된 모든 지식 데이터를 조회합니다.
-     * * @param params - 조회에 필요한 매개변수 객체 ({@link ListAllExtremeDataParams})
+     * @param params - 조회에 필요한 매개변수 객체 ({@link ListAllExtremeDataParams})
      * - **indexName**: string (필수)
      * - withVectorValye: bool (선택) 결과에 벡터값 포함 여부. 기본값 : 'false'
      * @returns 인덱스 목록
@@ -150,6 +196,13 @@ class Vectocore {
             return response;
         });
     }
+    /**
+     * 특정 문서를 삭제합니다.
+     * @param params ({@link DeleteExtremeDataParams})
+     * - **indexName**: string (필수) 문서가 저장되어 있는 인덱스의 이름
+     * - **documentId**: string (필수) 문서의 ID
+     * @returns 삭제 결과
+     */
     deleteExtremeData(_a) {
         return __awaiter(this, arguments, void 0, function* ({ indexName, documentId }) {
             const requestParam = {
@@ -163,6 +216,19 @@ class Vectocore {
             return response;
         });
     }
+    /**
+     * X-Finder의 문서를 AI 검색합니다.
+     * @param params ({@link ExtremeSearchParams})
+     * - **question**: string (필수) 사용자 질문 (시멘틱 검색을 사용하기때문에 서술형을 질문해도 의미를 파악하여 유사한 결과를 유사도 순위별로 리턴.)
+     * - **mode**: "vector" | "keyword" | "hybrid" (선택) Default : "vector"
+     *  - vector 모드 : 시멘틱 유사도만 사용
+     *  - keyword 모드 : 키워드 유사도만 사용, 키워드 모드인 경우 해당 "단어"가 문서에 없으면 빈 list를 리턴
+     *  - hybrid 모드 : 시멘틱 검색 순위와 키워드 검색 순위를 모두 사용하여 순위 결정
+     * - indexNames: string[] (선택) 사용자의 질문을 검색하고자하는 인덱스 목록, 생략하거나 []를 전송시 전체 인덱스에서 검색 실행
+     * - top: number (선택) 결과로 보고싶은 목록의 최대 건수, 생략시 10건을 조회.
+     * - rerank: bool (선택) 검색 mode가 hybrid일 경우 벡터 검색과 키워드 검색 결과를 ai가 다시 score를 산정하는 방식으로 별도의 토큰이 소모 됨.
+     * @returns 순위가 있는 문서 목록
+     */
     extremeSearch(_a) {
         return __awaiter(this, arguments, void 0, function* ({ mode, indexNames, question, top, rerank }) {
             const requestParam = {
@@ -179,6 +245,12 @@ class Vectocore {
             return response;
         });
     }
+    /**
+     * 웹검색
+     * @param params ({@link WebSearchParams})
+     * - **question**: string (필수) 사용자 질문
+     * @returns 웹 검색 결과
+     */
     webSearch(_a) {
         return __awaiter(this, arguments, void 0, function* ({ question }) {
             const requestParam = {
@@ -197,9 +269,9 @@ class Lens {
     /**
      * API Client for interfacing with the Lens API.
      *
-     * @param {string | undefined} [opts.tenantKey=process.env['VECTOCORE_TENANT_KEY'] ?? undefined]
+     * @param {string | undefined} [opts.tenantKey=process.env['VECTOCORE4_TENANT_KEY'] ?? undefined]
      */
-    constructor({ tenantKey, baseURL, role, rule, outputFormat, mode, webSearch, agentic, maxHisCount, sessionKey, numOfRef, customSystemPrompt, staticInfo, }) {
+    constructor({ tenantKey, baseURL }) {
         if (tenantKey === undefined) {
             throw new Error("error tenantKey is undefined");
         }
@@ -210,17 +282,6 @@ class Lens {
         else {
             this.baseURL = baseURL;
         }
-        this.role = role;
-        this.rule = rule;
-        this.outputFormat = outputFormat;
-        this.mode = mode;
-        this.maxHisCount = maxHisCount;
-        this.sessionKey = sessionKey;
-        this.numOfRef = numOfRef;
-        this.customSystemPrompt = customSystemPrompt || undefined;
-        this.staticInfo = staticInfo || undefined;
-        this.webSearch = webSearch;
-        this.agentic = agentic;
     }
     requestStream(requestBody) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -253,59 +314,42 @@ class Lens {
         });
     }
     chat(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ question, imageUrls, fileUrls, stream, indexName, customData, model, textOnlyRef, isFirstMsg, withStatus, }) {
+        return __awaiter(this, arguments, void 0, function* ({ question, stream, model, xfinder, webSearch, agentic, imageUrls, fileUrls, customContext, sessionKey, maxHisCount, withStatus, staticInfo, }) {
             const requestParam = {
-                command: "lensChat",
-                question: question,
+                command: "lens_chat",
+                params: {
+                    question: question,
+                    stream: stream !== null && stream !== void 0 ? stream : true,
+                },
             };
-            if (this.role)
-                requestParam.role = this.role;
-            if (this.rule)
-                requestParam.rule = this.rule;
-            if (this.outputFormat)
-                requestParam.outputFormat = this.outputFormat;
-            if (this.mode)
-                requestParam.mode = this.mode;
-            if (this.maxHisCount)
-                requestParam.maxHisCount = this.maxHisCount;
-            if (this.sessionKey)
-                requestParam.sessionKey = this.sessionKey;
-            if (this.numOfRef)
-                requestParam.numOfRef = this.numOfRef;
-            if (this.customSystemPrompt)
-                requestParam.customSystemPrompt = this.customSystemPrompt;
-            if (this.staticInfo)
-                requestParam.staticInfo = this.staticInfo;
-            if (this.webSearch)
-                requestParam.webSearch = this.webSearch;
-            if (this.agentic)
-                requestParam.agentic = this.agentic;
+            if (model)
+                requestParam.params.model = model;
+            if (xfinder)
+                requestParam.params.xfinder = xfinder;
+            if (webSearch)
+                requestParam.params.web_search = webSearch;
+            if (agentic)
+                requestParam.params.agentic = agentic;
             if (imageUrls)
-                requestParam.imageUrls = imageUrls;
+                requestParam.params.imageUrls = imageUrls;
             if (fileUrls)
-                requestParam.fileUrls = fileUrls;
-            if (customData)
-                requestParam.customData = customData;
-            if (indexName)
-                requestParam.indexName = indexName;
-            if (model)
-                requestParam.model = model;
-            if (textOnlyRef)
-                requestParam.textOnlyRef = textOnlyRef;
-            if (isFirstMsg !== undefined) {
-                requestParam.isFirstMsg = isFirstMsg;
-            }
-            else {
-                requestParam.isFirstMsg = true;
-            }
-            requestParam.withStatus = withStatus ? withStatus : false;
+                requestParam.params.file_urls = fileUrls;
+            if (customContext)
+                requestParam.params.custom_context = customContext;
+            if (sessionKey)
+                requestParam.params.session_key = sessionKey;
+            if (maxHisCount)
+                requestParam.params.max_his_count = maxHisCount;
+            if (withStatus)
+                requestParam.params.with_status = withStatus;
+            if (staticInfo)
+                requestParam.params.static_info = staticInfo;
             let response = yield this.requestStream(requestParam);
             if (stream) {
-                return response;
+                return response.body.getReader();
             }
             else {
-                const res = yield this.genStreamResponse(response);
-                return res;
+                return response.json();
             }
         });
     }
@@ -370,7 +414,7 @@ class AIMS {
     /**
      * API Client for interfacing with the Vectocore API.
      *
-     * @param {string | undefined} [opts.tenantKey=process.env['VECTOCORE_TENANT_KEY'] ?? undefined]
+     * @param {string | undefined} [opts.tenantKey=process.env['VECTOCORE4_TENANT_KEY'] ?? undefined]
      */
     constructor({ baseURL, tenantKey } = {}) {
         if (tenantKey === undefined) {

package/dist/index.d.ts

@@ -10,27 +10,6 @@ export interface ClientOptions {
      */
     baseURL?: string;
 }
-export interface CustomDataParams {
-    type: "text" | "image";
-    text?: string;
-    image_url?: string;
-}
-export interface LensClientOptions {
-    tenantKey?: string;
-    baseURL?: string;
-    role?: string;
-    rule?: string;
-    outputFormat?: any;
-    mode?: "VECTOR" | "BOTH" | "WEB" | "CUSTOM";
-    webSearch?: WebSearchOption;
-    agentic?: AgenticOption;
-    maxHisCount?: number;
-    sessionKey?: string;
-    customData?: CustomDataParams;
-    customSystemPrompt?: string;
-    numOfRef?: number;
-    staticInfo?: any;
-}
 export interface PutIndexParams {
     /**
      * 생성할 인덱스의 이름입니다.
@@ -127,17 +106,96 @@ export type FileType = {
     url: string;
     extImgUrls?: string[];
 };
-export interface ChatParams {
+type XFinderOptions = {
+    /**
+     * vector | keyword | hybrid (Default : hybrid)
+     */
+    mode?: "vector" | "keyword" | "hybrid";
+    /**
+     * 검색에 사용할 index명 목록, 생략 또는 []시 전체 인덱스 스캔
+     */
+    indexNames?: string[];
+    /**
+     * 검색 max count, 숫자가 많을 수록 많은 토큰을 소모함.
+     */
+    top?: number;
+    /**
+     * AI rerank 사용 여부(Default : false), 사용시 토큰 소모
+     */
+    rerank?: boolean;
+    /**
+     * 벡터 Context에 image_url등 멀티모달 이미지가 존재해도 무시하고자 할 경우 사용
+     */
+    textOnly?: boolean;
+};
+type WebSearchOptions = {
+    /** 이미지 검색 결과도 보여주고 싶을 때 사용 (Default : false) */
+    with_image?: boolean;
+    /**  비디오 검색 결과도 보여주고 싶을 때 사용 (Default : false) */
+    with_video?: boolean;
+};
+type AgenticOptions = {
+    /** 추론모드 사용 여부 (추론 모드는 ai agent를 우선순위대로 하나씩 호출하면서 추론 과정을 거침. 정확도는 높으나 속도가 매우 느림) */
+    reasoning?: boolean;
+};
+type CustomContextOptions = {
+    /** ext 타입의 사용자 정의 Context */
+    text?: string;
+    /** 멀티모달 Context로 전송할 이미지 경로 URL */
+    imageUrls?: string;
+};
+export interface LensChatParams {
+    /** 사용자 질문 (필수) */
     question: string;
+    /** 스트림 응답 모드 (선택) 기본값 : true */
+    stream?: boolean;
+    /**
+     * 모델 선택 (선택) 기본값 : 5.1chat
+     * - 5.1chat, 5chat, 4o, mini, Default : 5.1chat
+     *  - ‼️ 단, chat 모델의 경우 만료될 수 있음.
+     *  - ‼️ mini 모델은 멀티모달을 사용할 수 없음.
+     * */
+    model?: "5.1chat" | "5chat" | "4o" | "mini";
+    /** 사전에 등록한 내부지식(X-Finder)를 사용하고자 할 경우 아래 파라미터 추가 ({@link XFinderOptions}) */
+    xfinder?: XFinderOptions;
+    /** 웹 검색 결과를 Context로 제공하고자 할 때 사용(별도 권한 필요) ({@link WebSearchOptions}) */
+    webSearch?: WebSearchOptions;
+    /** AI 추론 과정에서 ai agent들을 호출하고 싶을때 사용. Vectocore가 ai agent를 자동으로 호출 ({@link AgenticOptions}) */
+    agentic?: AgenticOptions;
+    /** 사용자 멀티모달 이미지 입력 시 자동으로 호출 */
     imageUrls?: string[];
-    fileUrls?: FileType[];
-    stream?: boolean | undefined;
-    indexName?: string | string[] | undefined;
-    customData?: CustomDataParams;
-    model?: string | undefined;
-    textOnlyRef?: boolean | undefined;
-    isFirstMsg?: boolean | undefined;
-    withStatus?: boolean | undefined;
+    /** 사용자 멀티모달 파일(페이지별 이미지) 입력 시, 순수 파일을 올릴 수는 없고 별도의 pdf to images 와 같은 전처리 과정을 거쳐 문서의 각 페이지별 이미지 캡쳐본을 올릴 수 있음. 자동으로 호출 */
+    fileUrls?: string[];
+    /**
+     * 사용자가 직접 정의한 Context 내에서 답변하고자 할 경우 ({@link CustomContextOptions})
+     * 해당 파라미터가 있는 경우 Rag를 무시하고 사용자가 입력한 Context 내에서만 답변합니다.
+     */
+    customContext?: CustomContextOptions;
+    /**
+     * 사용자의 이전 대화를 참고하여 연속성있는 챗봇을 구성할때 사용하는 값. 세션키가 없는 경우 챗봇이 이전대화를 활용하지 않아 소모되는 토큰을 절약할 수 있지만 연속성 있는 대화를 할 수 없습니다. 세션키를 입력하면 이전대화를 참고하여 프롬프트를 생성하기 때문에 토큰의 비용이 올라가지만 연속성있는 대화를 통해 사용자의 경험을 개선할 수 있습니다.
+     * ※ 세션키는 각 챗봇 시스템에서 사용자 1인을 구분할 수 있는 유일한 값으로 전달하는게 좋습니다.(예 : 고객ID)
+     */
+    sessionKey?: string;
+    /**
+     * 세션키가 있는 경우 불러올 이전대화의 목록 건수 입니다. Default : 2. 대화 목록을 지나치게 불러오면 토큰의 비용이 비약적으로 증가할 수 있으며 AI 챗봇의 프롬프트 해석 능력도 떨어질 수 있습니다. 적절한 건수를 설정하세요.
+     */
+    maxHisCount?: number;
+    /**
+     * AI 백엔드에서 진행되는 상태를 구간별로 전송받는 데이터입니다.
+     * * @example
+     * ```typescript
+     * {
+     * status_0000: ["20260120101650200000", "채팅을 시작합니다."],
+     * status_1000: ["20260120101650208399", "채팅 이력을 확인합니다."],
+     * status_2000: ["20260120101651151011", "지식 검색을 시작합니다."],
+     * // ... 중략
+     * status_3019: ["20260120101713662980", "AI 답변이 완료되었습니다."]
+     * }
+     * ```
+     */
+    withStatus?: boolean;
+    /** 사용자의 질문으로 보낼 수 없는 고유한 정보들이 있는 경우 static_info에 보내면 해당 데이터를 AI가 참고함. */
+    staticInfo?: any;
 }
 export interface ChatHistoryParams {
     sessionKey: string;
@@ -148,15 +206,6 @@ export interface TranslateParams {
     text: string;
     stream?: boolean | undefined;
 }
-type WebSearchOption = {
-    model?: "google" | "bing";
-    withImage?: boolean;
-    withVideo?: boolean;
-};
-type AgenticOption = {
-    enable?: boolean;
-    reasoning?: boolean;
-};
 export declare class Vectocore {
     tenantKey: string | undefined;
     baseURL: string;
@@ -167,47 +216,108 @@ export declare class Vectocore {
      */
     constructor({ baseURL, tenantKey }?: ClientOptions);
     protected requestPost(requestBody: any): Promise<any>;
+    /**
+     * 인덱스를 생성/수정합니다.
+     * @param params ({@link PutIndexParams})
+     * - **indexName**: string (필수) 생성 및 수정할 인덱스 명
+     * - description: string (선택) 인덱스에 대한 설명
+     * @returns 식제 결과
+     */
     putIndex({ indexName, description }: PutIndexParams): Promise<any>;
+    /**
+     * 인덱스를 삭제합니다.
+     * @param params ({@link DeleteIndexParams})
+     * - **indexName**: string (필수) 삭제할 인덱스의 이름
+     * @returns 식제 결과
+     */
     deleteIndex({ indexName }: DeleteIndexParams): Promise<any>;
+    /**
+     * 인덱스 목록을 조회합니다.
+     * @returns 인덱스 목록
+     */
     listIndex(): Promise<any>;
+    /**
+     * 인덱스에 문서 저장
+     * @param params ({@link PutExtremeDataParams})
+     * - **indexName**: string (필수) 문서를 저장할 인덱스의 이름
+     * - **docBody**: json (필수)
+     *  - **id**: string (선택) 도큐먼트 ID (소문자, 영문, -), 값은 인덱스내에서 유일해야함, 신규 row일 경우 각 시스템에서 직접 채번하거나 ""빈값으로 보내면 자동으로 채번함
+     *  - **keywords**: string (필수) 검색의 대상이 되는 필드. 사용자 질문의 의도를 파악하여 RAG내에서 유사도를 비교하여 높은 순서로 결과를 리턴 받는다.
+     *  - **data**: string (필수) 키워드에 해당하는 문서의 실제 내용
+     *  - docType: "text"|"image" (선택) Default : "text", 저장할 지식의 타입으로 Default는 "text". doc_type이 "image"일 경우 추가로 "image_url" 필드를 사용합니다.
+     *  - imageUrl: string (선택) doc_type이 "image"일 경우 사용하는 필드로 웹에서 접근 가능한 이미지의 경로를 입력.
+     *  - metadata: json (선택) 문서 저장시 추가로 남기고 싶은 정보를 json 형식으로 추가하면 향후 검색 결과시 리턴. 문서명이나, 페이지 번호 등을 입력하여 출처 확인용으로 사용할 수 있다
+     *  - refOnlyText: bool (선택) ens 기능 사용시 사용하는 옵션으로 doc_type이 "image"인 경우 "image_url"의 경로를 자동으로 멀티모달로 전달하는데 ref_only_text : true로 설정한 경우 멀티모달을 전달하지 않고 "data" 필드의 정보만 context로 활용한다.
+     * @returns 문서 저장 결과
+     */
     putExtremeData({ indexName, docBody }: PutExtremeDataParams): Promise<any>;
+    /**
+     * 특정 문서를 조회합니다.
+     * @param params - 조회에 필요한 매개변수 객체 ({@link GetExtremeDataParams})
+     * - **indexName**: string (필수) 문서가 저장되어 있는 인덱스의 이름
+     * - **documentId**: string (필수) 문서의 ID
+     * @returns 문서 정보
+     */
     getExtremeData({ indexName, documentId }: GetExtremeDataParams): Promise<any>;
+    /**
+     * 특정 인덱스에 저장된 지식 데이터를 조회합니다.(페이징)
+     * @param params - 조회에 필요한 매개변수 객체 ({@link ListExtremeDataParams})
+     * - **indexName**: string (필수)
+     * - lastKey: string (선택) 최초 검색 결과에서 전달 받은 토큰값
+     * - withVectorValye: bool (선택) 결과에 벡터값 포함 여부. 기본값 : 'false'
+     * @returns 인덱스 목록
+     */
     listExtremeData({ indexName, lastKey, withVectorValue }: ListExtremeDataParams): Promise<any>;
     /**
      * 특정 인덱스에 저장된 모든 지식 데이터를 조회합니다.
-     * * @param params - 조회에 필요한 매개변수 객체 ({@link ListAllExtremeDataParams})
+     * @param params - 조회에 필요한 매개변수 객체 ({@link ListAllExtremeDataParams})
      * - **indexName**: string (필수)
      * - withVectorValye: bool (선택) 결과에 벡터값 포함 여부. 기본값 : 'false'
      * @returns 인덱스 목록
      */
     listAllExtremeData({ indexName, withVectorValue }: ListAllExtremeDataParams): Promise<any>;
+    /**
+     * 특정 문서를 삭제합니다.
+     * @param params ({@link DeleteExtremeDataParams})
+     * - **indexName**: string (필수) 문서가 저장되어 있는 인덱스의 이름
+     * - **documentId**: string (필수) 문서의 ID
+     * @returns 삭제 결과
+     */
     deleteExtremeData({ indexName, documentId }: DeleteExtremeDataParams): Promise<any>;
+    /**
+     * X-Finder의 문서를 AI 검색합니다.
+     * @param params ({@link ExtremeSearchParams})
+     * - **question**: string (필수) 사용자 질문 (시멘틱 검색을 사용하기때문에 서술형을 질문해도 의미를 파악하여 유사한 결과를 유사도 순위별로 리턴.)
+     * - **mode**: "vector" | "keyword" | "hybrid" (선택) Default : "vector"
+     *  - vector 모드 : 시멘틱 유사도만 사용
+     *  - keyword 모드 : 키워드 유사도만 사용, 키워드 모드인 경우 해당 "단어"가 문서에 없으면 빈 list를 리턴
+     *  - hybrid 모드 : 시멘틱 검색 순위와 키워드 검색 순위를 모두 사용하여 순위 결정
+     * - indexNames: string[] (선택) 사용자의 질문을 검색하고자하는 인덱스 목록, 생략하거나 []를 전송시 전체 인덱스에서 검색 실행
+     * - top: number (선택) 결과로 보고싶은 목록의 최대 건수, 생략시 10건을 조회.
+     * - rerank: bool (선택) 검색 mode가 hybrid일 경우 벡터 검색과 키워드 검색 결과를 ai가 다시 score를 산정하는 방식으로 별도의 토큰이 소모 됨.
+     * @returns 순위가 있는 문서 목록
+     */
     extremeSearch({ mode, indexNames, question, top, rerank }: ExtremeSearchParams): Promise<any>;
+    /**
+     * 웹검색
+     * @param params ({@link WebSearchParams})
+     * - **question**: string (필수) 사용자 질문
+     * @returns 웹 검색 결과
+     */
     webSearch({ question }: WebSearchParams): Promise<any>;
 }
 export declare class Lens {
     tenantKey: string | undefined;
     baseURL: string;
-    role: string | undefined;
-    rule: string | undefined;
-    outputFormat: any;
-    mode: "VECTOR" | "BOTH" | "WEB" | "CUSTOM" | undefined;
-    webSearch: WebSearchOption | undefined;
-    agentic: AgenticOption | undefined;
-    maxHisCount: number | undefined;
-    sessionKey: string | undefined;
-    numOfRef: number | undefined;
-    customSystemPrompt: string | undefined;
-    staticInfo: any;
     /**
      * API Client for interfacing with the Lens API.
      *
-     * @param {string | undefined} [opts.tenantKey=process.env['VECTOCORE_TENANT_KEY'] ?? undefined]
+     * @param {string | undefined} [opts.tenantKey=process.env['VECTOCORE4_TENANT_KEY'] ?? undefined]
      */
-    constructor({ tenantKey, baseURL, role, rule, outputFormat, mode, webSearch, agentic, maxHisCount, sessionKey, numOfRef, customSystemPrompt, staticInfo, }: LensClientOptions);
+    constructor({ tenantKey, baseURL }: ClientOptions);
     protected requestStream(requestBody: any): Promise<ReadableStream<Uint8Array> | null>;
     protected genStreamResponse(streamRes: ReadableStream): Promise<any>;
-    chat({ question, imageUrls, fileUrls, stream, indexName, customData, model, textOnlyRef, isFirstMsg, withStatus, }: ChatParams): Promise<any>;
+    chat({ question, stream, model, xfinder, webSearch, agentic, imageUrls, fileUrls, customContext, sessionKey, maxHisCount, withStatus, staticInfo, }: LensChatParams): Promise<any>;
     history({ sessionKey, limit }: ChatHistoryParams): Promise<any>;
     jsonAutoComplete(jsonString: string): string | null;
 }
@@ -217,7 +327,7 @@ export declare class AIMS {
     /**
      * API Client for interfacing with the Vectocore API.
      *
-     * @param {string | undefined} [opts.tenantKey=process.env['VECTOCORE_TENANT_KEY'] ?? undefined]
+     * @param {string | undefined} [opts.tenantKey=process.env['VECTOCORE4_TENANT_KEY'] ?? undefined]
      */
     constructor({ baseURL, tenantKey }?: ClientOptions);
     protected requestStream(requestBody: any): Promise<ReadableStream<Uint8Array> | null>;

package/dist/mjs/index.js

@@ -26,6 +26,13 @@ export class Vectocore {
         const response = await axios.post(this.baseURL, requestBody, config);
         return response.data;
     }
+    /**
+     * 인덱스를 생성/수정합니다.
+     * @param params ({@link PutIndexParams})
+     * - **indexName**: string (필수) 생성 및 수정할 인덱스 명
+     * - description: string (선택) 인덱스에 대한 설명
+     * @returns 식제 결과
+     */
     async putIndex({ indexName, description }) {
         const requestParam = {
             command: "put_index",
@@ -37,6 +44,12 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
+    /**
+     * 인덱스를 삭제합니다.
+     * @param params ({@link DeleteIndexParams})
+     * - **indexName**: string (필수) 삭제할 인덱스의 이름
+     * @returns 식제 결과
+     */
     async deleteIndex({ indexName }) {
         const requestParam = {
             command: "delete_index",
@@ -47,6 +60,10 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
+    /**
+     * 인덱스 목록을 조회합니다.
+     * @returns 인덱스 목록
+     */
     async listIndex() {
         const requestParam = {
             command: "list_index",
@@ -54,6 +71,20 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
+    /**
+     * 인덱스에 문서 저장
+     * @param params ({@link PutExtremeDataParams})
+     * - **indexName**: string (필수) 문서를 저장할 인덱스의 이름
+     * - **docBody**: json (필수)
+     *  - **id**: string (선택) 도큐먼트 ID (소문자, 영문, -), 값은 인덱스내에서 유일해야함, 신규 row일 경우 각 시스템에서 직접 채번하거나 ""빈값으로 보내면 자동으로 채번함
+     *  - **keywords**: string (필수) 검색의 대상이 되는 필드. 사용자 질문의 의도를 파악하여 RAG내에서 유사도를 비교하여 높은 순서로 결과를 리턴 받는다.
+     *  - **data**: string (필수) 키워드에 해당하는 문서의 실제 내용
+     *  - docType: "text"|"image" (선택) Default : "text", 저장할 지식의 타입으로 Default는 "text". doc_type이 "image"일 경우 추가로 "image_url" 필드를 사용합니다.
+     *  - imageUrl: string (선택) doc_type이 "image"일 경우 사용하는 필드로 웹에서 접근 가능한 이미지의 경로를 입력.
+     *  - metadata: json (선택) 문서 저장시 추가로 남기고 싶은 정보를 json 형식으로 추가하면 향후 검색 결과시 리턴. 문서명이나, 페이지 번호 등을 입력하여 출처 확인용으로 사용할 수 있다
+     *  - refOnlyText: bool (선택) ens 기능 사용시 사용하는 옵션으로 doc_type이 "image"인 경우 "image_url"의 경로를 자동으로 멀티모달로 전달하는데 ref_only_text : true로 설정한 경우 멀티모달을 전달하지 않고 "data" 필드의 정보만 context로 활용한다.
+     * @returns 문서 저장 결과
+     */
     async putExtremeData({ indexName, docBody }) {
         const requestParam = {
             command: "put_extreme_data",
@@ -77,6 +108,13 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
+    /**
+     * 특정 문서를 조회합니다.
+     * @param params - 조회에 필요한 매개변수 객체 ({@link GetExtremeDataParams})
+     * - **indexName**: string (필수) 문서가 저장되어 있는 인덱스의 이름
+     * - **documentId**: string (필수) 문서의 ID
+     * @returns 문서 정보
+     */
     async getExtremeData({ indexName, documentId }) {
         const requestParam = {
             command: "get_extreme_data",
@@ -88,6 +126,14 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
+    /**
+     * 특정 인덱스에 저장된 지식 데이터를 조회합니다.(페이징)
+     * @param params - 조회에 필요한 매개변수 객체 ({@link ListExtremeDataParams})
+     * - **indexName**: string (필수)
+     * - lastKey: string (선택) 최초 검색 결과에서 전달 받은 토큰값
+     * - withVectorValye: bool (선택) 결과에 벡터값 포함 여부. 기본값 : 'false'
+     * @returns 인덱스 목록
+     */
     async listExtremeData({ indexName, lastKey, withVectorValue }) {
         const requestParam = {
             command: "list_extreme_data",
@@ -104,7 +150,7 @@ export class Vectocore {
     }
     /**
      * 특정 인덱스에 저장된 모든 지식 데이터를 조회합니다.
-     * * @param params - 조회에 필요한 매개변수 객체 ({@link ListAllExtremeDataParams})
+     * @param params - 조회에 필요한 매개변수 객체 ({@link ListAllExtremeDataParams})
      * - **indexName**: string (필수)
      * - withVectorValye: bool (선택) 결과에 벡터값 포함 여부. 기본값 : 'false'
      * @returns 인덱스 목록
@@ -120,6 +166,13 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
+    /**
+     * 특정 문서를 삭제합니다.
+     * @param params ({@link DeleteExtremeDataParams})
+     * - **indexName**: string (필수) 문서가 저장되어 있는 인덱스의 이름
+     * - **documentId**: string (필수) 문서의 ID
+     * @returns 삭제 결과
+     */
     async deleteExtremeData({ indexName, documentId }) {
         const requestParam = {
             command: "delete_extreme_data",
@@ -131,6 +184,19 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
+    /**
+     * X-Finder의 문서를 AI 검색합니다.
+     * @param params ({@link ExtremeSearchParams})
+     * - **question**: string (필수) 사용자 질문 (시멘틱 검색을 사용하기때문에 서술형을 질문해도 의미를 파악하여 유사한 결과를 유사도 순위별로 리턴.)
+     * - **mode**: "vector" | "keyword" | "hybrid" (선택) Default : "vector"
+     *  - vector 모드 : 시멘틱 유사도만 사용
+     *  - keyword 모드 : 키워드 유사도만 사용, 키워드 모드인 경우 해당 "단어"가 문서에 없으면 빈 list를 리턴
+     *  - hybrid 모드 : 시멘틱 검색 순위와 키워드 검색 순위를 모두 사용하여 순위 결정
+     * - indexNames: string[] (선택) 사용자의 질문을 검색하고자하는 인덱스 목록, 생략하거나 []를 전송시 전체 인덱스에서 검색 실행
+     * - top: number (선택) 결과로 보고싶은 목록의 최대 건수, 생략시 10건을 조회.
+     * - rerank: bool (선택) 검색 mode가 hybrid일 경우 벡터 검색과 키워드 검색 결과를 ai가 다시 score를 산정하는 방식으로 별도의 토큰이 소모 됨.
+     * @returns 순위가 있는 문서 목록
+     */
     async extremeSearch({ mode, indexNames, question, top, rerank }) {
         const requestParam = {
             command: "extreme_search",
@@ -145,6 +211,12 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
+    /**
+     * 웹검색
+     * @param params ({@link WebSearchParams})
+     * - **question**: string (필수) 사용자 질문
+     * @returns 웹 검색 결과
+     */
     async webSearch({ question }) {
         const requestParam = {
             command: "web_search",
@@ -159,23 +231,12 @@ export class Vectocore {
 export class Lens {
     tenantKey;
     baseURL;
-    role;
-    rule;
-    outputFormat;
-    mode;
-    webSearch;
-    agentic;
-    maxHisCount;
-    sessionKey;
-    numOfRef;
-    customSystemPrompt;
-    staticInfo;
     /**
      * API Client for interfacing with the Lens API.
      *
-     * @param {string | undefined} [opts.tenantKey=process.env['VECTOCORE_TENANT_KEY'] ?? undefined]
+     * @param {string | undefined} [opts.tenantKey=process.env['VECTOCORE4_TENANT_KEY'] ?? undefined]
      */
-    constructor({ tenantKey, baseURL, role, rule, outputFormat, mode, webSearch, agentic, maxHisCount, sessionKey, numOfRef, customSystemPrompt, staticInfo, }) {
+    constructor({ tenantKey, baseURL }) {
         if (tenantKey === undefined) {
             throw new Error("error tenantKey is undefined");
         }
@@ -186,17 +247,6 @@ export class Lens {
         else {
             this.baseURL = baseURL;
         }
-        this.role = role;
-        this.rule = rule;
-        this.outputFormat = outputFormat;
-        this.mode = mode;
-        this.maxHisCount = maxHisCount;
-        this.sessionKey = sessionKey;
-        this.numOfRef = numOfRef;
-        this.customSystemPrompt = customSystemPrompt || undefined;
-        this.staticInfo = staticInfo || undefined;
-        this.webSearch = webSearch;
-        this.agentic = agentic;
     }
     async requestStream(requestBody) {
         let header = {
@@ -224,59 +274,42 @@ export class Lens {
         const payload = JSON.parse(content);
         return payload;
     }
-    async chat({ question, imageUrls, fileUrls, stream, indexName, customData, model, textOnlyRef, isFirstMsg, withStatus, }) {
+    async chat({ question, stream, model, xfinder, webSearch, agentic, imageUrls, fileUrls, customContext, sessionKey, maxHisCount, withStatus, staticInfo, }) {
         const requestParam = {
-            command: "lensChat",
-            question: question,
+            command: "lens_chat",
+            params: {
+                question: question,
+                stream: stream ?? true,
+            },
         };
-        if (this.role)
-            requestParam.role = this.role;
-        if (this.rule)
-            requestParam.rule = this.rule;
-        if (this.outputFormat)
-            requestParam.outputFormat = this.outputFormat;
-        if (this.mode)
-            requestParam.mode = this.mode;
-        if (this.maxHisCount)
-            requestParam.maxHisCount = this.maxHisCount;
-        if (this.sessionKey)
-            requestParam.sessionKey = this.sessionKey;
-        if (this.numOfRef)
-            requestParam.numOfRef = this.numOfRef;
-        if (this.customSystemPrompt)
-            requestParam.customSystemPrompt = this.customSystemPrompt;
-        if (this.staticInfo)
-            requestParam.staticInfo = this.staticInfo;
-        if (this.webSearch)
-            requestParam.webSearch = this.webSearch;
-        if (this.agentic)
-            requestParam.agentic = this.agentic;
+        if (model)
+            requestParam.params.model = model;
+        if (xfinder)
+            requestParam.params.xfinder = xfinder;
+        if (webSearch)
+            requestParam.params.web_search = webSearch;
+        if (agentic)
+            requestParam.params.agentic = agentic;
         if (imageUrls)
-            requestParam.imageUrls = imageUrls;
+            requestParam.params.imageUrls = imageUrls;
         if (fileUrls)
-            requestParam.fileUrls = fileUrls;
-        if (customData)
-            requestParam.customData = customData;
-        if (indexName)
-            requestParam.indexName = indexName;
-        if (model)
-            requestParam.model = model;
-        if (textOnlyRef)
-            requestParam.textOnlyRef = textOnlyRef;
-        if (isFirstMsg !== undefined) {
-            requestParam.isFirstMsg = isFirstMsg;
-        }
-        else {
-            requestParam.isFirstMsg = true;
-        }
-        requestParam.withStatus = withStatus ? withStatus : false;
+            requestParam.params.file_urls = fileUrls;
+        if (customContext)
+            requestParam.params.custom_context = customContext;
+        if (sessionKey)
+            requestParam.params.session_key = sessionKey;
+        if (maxHisCount)
+            requestParam.params.max_his_count = maxHisCount;
+        if (withStatus)
+            requestParam.params.with_status = withStatus;
+        if (staticInfo)
+            requestParam.params.static_info = staticInfo;
         let response = await this.requestStream(requestParam);
         if (stream) {
-            return response;
+            return response.body.getReader();
         }
         else {
-            const res = await this.genStreamResponse(response);
-            return res;
+            return response.json();
         }
     }
     async history({ sessionKey, limit }) {
@@ -339,7 +372,7 @@ export class AIMS {
     /**
      * API Client for interfacing with the Vectocore API.
      *
-     * @param {string | undefined} [opts.tenantKey=process.env['VECTOCORE_TENANT_KEY'] ?? undefined]
+     * @param {string | undefined} [opts.tenantKey=process.env['VECTOCORE4_TENANT_KEY'] ?? undefined]
      */
     constructor({ baseURL, tenantKey } = {}) {
         if (tenantKey === undefined) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vectocore4",
-  "version": "0.0.11",
+  "version": "0.0.20",
   "description": "",
   "types": "dist/index.d.ts",
   "main": "dist/cjs/index.js",