vectocore4 1.0.2 → 1.0.4

package/dist/cjs/index.js

@@ -122,6 +122,7 @@ class Vectocore {
      * @param {string} params.docBody.imageUrl doc_type이 "image"일 경우 사용하는 필드로 웹에서 접근 가능한 이미지의 경로를 입력.
      * @param {object} params.docBody.metadata 문서 저장시 추가로 남기고 싶은 정보를 json 형식으로 추가하면 향후 검색 결과시 리턴. 문서명이나, 페이지 번호 등을 입력하여 출처 확인용으로 사용할 수 있다
      * @param {boolean} params.docBody.refOnlyText lens 기능 사용시 사용하는 옵션으로 doc_type이 "image"인 경우 "image_url"의 경로를 자동으로 멀티모달로 전달하는데 ref_only_text : true로 설정한 경우 멀티모달을 전달하지 않고 "data" 필드의 정보만 context로 활용한다.
+     * @param {string[]} params.docBody.tags 키:값 형태의 문자열 목록을 입력하면 향후 정교한 필터링 식으로 활용할 수 있습니다.
      *
      * ---
      * @returns
@@ -129,7 +130,7 @@ class Vectocore {
      */
     putExtremeData(_a) {
         return __awaiter(this, arguments, void 0, function* ({ indexName, docBody }) {
-            var _b, _c;
+            var _b, _c, _d;
             const requestParam = {
                 command: "put_extreme_data",
                 params: {
@@ -140,6 +141,7 @@ class Vectocore {
                         data: docBody.data,
                         doc_type: (_b = docBody.docType) !== null && _b !== void 0 ? _b : "text",
                         ref_only_text: (_c = docBody.refOnlyText) !== null && _c !== void 0 ? _c : false,
+                        tags: (_d = docBody.tags) !== null && _d !== void 0 ? _d : [],
                     },
                 },
             };
@@ -265,13 +267,14 @@ class Vectocore {
      * @param {string[]} params.indexName 사용자의 질문을 검색하고자하는 인덱스 목록, 생략하거나 []를 전송시 전체 인덱스에서 검색 실행
      * @param {number} params.top 결과로 보고싶은 목록의 최대 건수, 생략시 10건을 조회.
      * @param {boolean} params.rerank 검색 mode가 hybrid일 경우 벡터 검색과 키워드 검색 결과를 ai가 다시 score를 산정하는 방식으로 별도의 토큰이 소모 됨.
+     * @param {string[]} params.tags 데이터 생성시 입력한 tags를 eq필터링 식으로 핕러링 할 수 있습니다.
      *
      * ---
      * @returns
      * - 순위가 있는 문서 목록
      */
     extremeSearch(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ mode, indexNames, question, top, rerank }) {
+        return __awaiter(this, arguments, void 0, function* ({ mode, indexNames, question, top, rerank, tags }) {
             const requestParam = {
                 command: "extreme_search",
                 params: {
@@ -280,6 +283,7 @@ class Vectocore {
                     question: question,
                     top: top !== null && top !== void 0 ? top : 10,
                     rerank: rerank !== null && rerank !== void 0 ? rerank : false,
+                    tags: tags !== null && tags !== void 0 ? tags : [],
                 },
             };
             const response = yield this.requestPost(requestParam);
@@ -407,7 +411,7 @@ class Lens {
      */
     chat(_a) {
         return __awaiter(this, arguments, void 0, function* ({ question, stream = true, model = "4o", xfinder, webSearch, agentic, imageUrls, fileUrls, customContext, sessionKey, maxHisCount, withStatus, staticInfo, customSystemPrompt, }) {
-            var _b, _c;
+            var _b, _c, _d, _e, _f, _g;
             const requestParam = {
                 command: "lens_chat",
                 params: {
@@ -417,12 +421,19 @@ class Lens {
             };
             if (model)
                 requestParam.params.model = model;
-            if (xfinder)
-                requestParam.params.xfinder = xfinder;
+            if (xfinder) {
+                requestParam.params.xfinder = {
+                    mode: (_b = xfinder.mode) !== null && _b !== void 0 ? _b : "hybrid",
+                    index_names: (_c = xfinder.indexNames) !== null && _c !== void 0 ? _c : [],
+                    top: xfinder.top,
+                    rerank: (_d = xfinder.rerank) !== null && _d !== void 0 ? _d : false,
+                    text_only: (_e = xfinder.textOnly) !== null && _e !== void 0 ? _e : false,
+                };
+            }
             if (webSearch) {
                 requestParam.params.web_search = {
-                    with_image: (_b = webSearch.withImage) !== null && _b !== void 0 ? _b : false,
-                    with_video: (_c = webSearch.withVideo) !== null && _c !== void 0 ? _c : false,
+                    with_image: (_f = webSearch.withImage) !== null && _f !== void 0 ? _f : false,
+                    with_video: (_g = webSearch.withVideo) !== null && _g !== void 0 ? _g : false,
                 };
             }
             if (agentic)

package/dist/index.d.ts

@@ -52,6 +52,8 @@ export interface PutExtremeDataParams {
         metadata?: any;
         /** lens 기능 사용시 사용하는 옵션으로 doc_type이 "image"인 경우 "image_url"의 경로를 자동으로 멀티모달로 전달하는데 ref_only_text : true로 설정한 경우 멀티모달을 전달하지 않고 "data" 필드의 정보만 context로 활용합니다. */
         refOnlyText?: boolean;
+        /** 키:값 형태의 list를 데이터 생성시 저장하면 extreme_search때 eq식의 필터링이 가능합니다. */
+        tags?: string[];
     };
 }
 export interface ListExtremeDataParams {
@@ -98,6 +100,8 @@ export interface ExtremeSearchParams {
     top?: number;
     /** 검색 mode가 hybrid일 경우 벡터 검색과 키워드 검색 결과를 ai가 다시 score를 산정하는 방식으로 별도의 토큰이 소모 됨. */
     rerank?: boolean;
+    /** 데이터 생성시 입력한 tags를 필터링 값으로 사용 가능합니다. */
+    tags?: string[];
 }
 export interface WebSearchParams {
     /** 검색어 */
@@ -267,6 +271,7 @@ export declare class Vectocore {
      * @param {string} params.docBody.imageUrl doc_type이 "image"일 경우 사용하는 필드로 웹에서 접근 가능한 이미지의 경로를 입력.
      * @param {object} params.docBody.metadata 문서 저장시 추가로 남기고 싶은 정보를 json 형식으로 추가하면 향후 검색 결과시 리턴. 문서명이나, 페이지 번호 등을 입력하여 출처 확인용으로 사용할 수 있다
      * @param {boolean} params.docBody.refOnlyText lens 기능 사용시 사용하는 옵션으로 doc_type이 "image"인 경우 "image_url"의 경로를 자동으로 멀티모달로 전달하는데 ref_only_text : true로 설정한 경우 멀티모달을 전달하지 않고 "data" 필드의 정보만 context로 활용한다.
+     * @param {string[]} params.docBody.tags 키:값 형태의 문자열 목록을 입력하면 향후 정교한 필터링 식으로 활용할 수 있습니다.
      *
      * ---
      * @returns
@@ -334,12 +339,13 @@ export declare class Vectocore {
      * @param {string[]} params.indexName 사용자의 질문을 검색하고자하는 인덱스 목록, 생략하거나 []를 전송시 전체 인덱스에서 검색 실행
      * @param {number} params.top 결과로 보고싶은 목록의 최대 건수, 생략시 10건을 조회.
      * @param {boolean} params.rerank 검색 mode가 hybrid일 경우 벡터 검색과 키워드 검색 결과를 ai가 다시 score를 산정하는 방식으로 별도의 토큰이 소모 됨.
+     * @param {string[]} params.tags 데이터 생성시 입력한 tags를 eq필터링 식으로 핕러링 할 수 있습니다.
      *
      * ---
      * @returns
      * - 순위가 있는 문서 목록
      */
-    extremeSearch({ mode, indexNames, question, top, rerank }: ExtremeSearchParams): Promise<any>;
+    extremeSearch({ mode, indexNames, question, top, rerank, tags }: ExtremeSearchParams): Promise<any>;
     /**
      * 웹검색
      * ---

package/dist/mjs/index.js

@@ -104,6 +104,7 @@ export class Vectocore {
      * @param {string} params.docBody.imageUrl doc_type이 "image"일 경우 사용하는 필드로 웹에서 접근 가능한 이미지의 경로를 입력.
      * @param {object} params.docBody.metadata 문서 저장시 추가로 남기고 싶은 정보를 json 형식으로 추가하면 향후 검색 결과시 리턴. 문서명이나, 페이지 번호 등을 입력하여 출처 확인용으로 사용할 수 있다
      * @param {boolean} params.docBody.refOnlyText lens 기능 사용시 사용하는 옵션으로 doc_type이 "image"인 경우 "image_url"의 경로를 자동으로 멀티모달로 전달하는데 ref_only_text : true로 설정한 경우 멀티모달을 전달하지 않고 "data" 필드의 정보만 context로 활용한다.
+     * @param {string[]} params.docBody.tags 키:값 형태의 문자열 목록을 입력하면 향후 정교한 필터링 식으로 활용할 수 있습니다.
      *
      * ---
      * @returns
@@ -120,6 +121,7 @@ export class Vectocore {
                     data: docBody.data,
                     doc_type: docBody.docType ?? "text",
                     ref_only_text: docBody.refOnlyText ?? false,
+                    tags: docBody.tags ?? [],
                 },
             },
         };
@@ -236,12 +238,13 @@ export class Vectocore {
      * @param {string[]} params.indexName 사용자의 질문을 검색하고자하는 인덱스 목록, 생략하거나 []를 전송시 전체 인덱스에서 검색 실행
      * @param {number} params.top 결과로 보고싶은 목록의 최대 건수, 생략시 10건을 조회.
      * @param {boolean} params.rerank 검색 mode가 hybrid일 경우 벡터 검색과 키워드 검색 결과를 ai가 다시 score를 산정하는 방식으로 별도의 토큰이 소모 됨.
+     * @param {string[]} params.tags 데이터 생성시 입력한 tags를 eq필터링 식으로 핕러링 할 수 있습니다.
      *
      * ---
      * @returns
      * - 순위가 있는 문서 목록
      */
-    async extremeSearch({ mode, indexNames, question, top, rerank }) {
+    async extremeSearch({ mode, indexNames, question, top, rerank, tags }) {
         const requestParam = {
             command: "extreme_search",
             params: {
@@ -250,6 +253,7 @@ export class Vectocore {
                 question: question,
                 top: top ?? 10,
                 rerank: rerank ?? false,
+                tags: tags ?? [],
             },
         };
         const response = await this.requestPost(requestParam);
@@ -381,8 +385,15 @@ export class Lens {
         };
         if (model)
             requestParam.params.model = model;
-        if (xfinder)
-            requestParam.params.xfinder = xfinder;
+        if (xfinder) {
+            requestParam.params.xfinder = {
+                mode: xfinder.mode ?? "hybrid",
+                index_names: xfinder.indexNames ?? [],
+                top: xfinder.top,
+                rerank: xfinder.rerank ?? false,
+                text_only: xfinder.textOnly ?? false,
+            };
+        }
         if (webSearch) {
             requestParam.params.web_search = {
                 with_image: webSearch.withImage ?? false,

package/package.json

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