vectocore4 0.0.4 → 0.0.6

package/dist/cjs/index.js

@@ -75,11 +75,11 @@ class Vectocore {
             return response;
         });
     }
-    putExtreamData(_a) {
+    putExtremeData(_a) {
         return __awaiter(this, arguments, void 0, function* ({ indexName, docBody }) {
             var _b, _c;
             const requestParam = {
-                command: "put_extream_data",
+                command: "put_extreme_data",
                 params: {
                     index_name: indexName,
                     doc_body: {
@@ -101,10 +101,10 @@ class Vectocore {
             return response;
         });
     }
-    getExtreamData(_a) {
+    getExtremeData(_a) {
         return __awaiter(this, arguments, void 0, function* ({ indexName, documentId }) {
             const requestParam = {
-                command: "get_extream_data",
+                command: "get_extreme_data",
                 params: {
                     index_name: indexName,
                     document_id: documentId,
@@ -114,10 +114,10 @@ class Vectocore {
             return response;
         });
     }
-    listExtreamData(_a) {
+    listExtremeData(_a) {
         return __awaiter(this, arguments, void 0, function* ({ indexName, lastKey }) {
             const requestParam = {
-                command: "list_extream_data",
+                command: "list_extreme_data",
                 params: {
                     index_name: indexName,
                 },
@@ -129,10 +129,10 @@ class Vectocore {
             return response;
         });
     }
-    listAllExtreamData(_a) {
+    listAllExtremeData(_a) {
         return __awaiter(this, arguments, void 0, function* ({ indexName }) {
             const requestParam = {
-                command: "list_all_extream_data",
+                command: "list_all_extreme_data",
                 params: {
                     index_name: indexName,
                 },
@@ -141,41 +141,31 @@ class Vectocore {
             return response;
         });
     }
-    deleteExtreamData(_a) {
+    deleteExtremeData(_a) {
         return __awaiter(this, arguments, void 0, function* ({ indexName, documentId }) {
             const requestParam = {
-                command: "delete_extream_data",
-                index_name: indexName,
-                document_id: documentId,
+                command: "delete_extreme_data",
+                params: {
+                    index_name: indexName,
+                    document_id: documentId,
+                },
             };
             const response = yield this.requestPost(requestParam);
             return response;
         });
     }
-    extreamSearch(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ indexName, question, maxCount, mode, webSearch, findIndexPrompt, docOnly, }) {
-            var _b, _c, _d;
+    extremeSearch(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ mode, indexNames, question, top, rerank }) {
             const requestParam = {
-                command: "extream_search",
-                question: question,
-            };
-            if (indexName)
-                requestParam.index_name = indexName;
-            if (mode)
-                requestParam.mode = mode;
-            if (maxCount)
-                requestParam.max_count = maxCount;
-            if (findIndexPrompt)
-                requestParam.find_index_prompt = findIndexPrompt;
-            if (docOnly)
-                requestParam.doc_only = docOnly;
-            let __webSearch = {
-                model: (_b = webSearch === null || webSearch === void 0 ? void 0 : webSearch.model) !== null && _b !== void 0 ? _b : "bing",
-                with_image: (_c = webSearch === null || webSearch === void 0 ? void 0 : webSearch.withImage) !== null && _c !== void 0 ? _c : false,
-                with_video: (_d = webSearch === null || webSearch === void 0 ? void 0 : webSearch.withVideo) !== null && _d !== void 0 ? _d : false,
+                command: "extreme_search",
+                params: {
+                    mode: mode !== null && mode !== void 0 ? mode : "vector",
+                    index_names: indexNames !== null && indexNames !== void 0 ? indexNames : [],
+                    question: question,
+                    top: top !== null && top !== void 0 ? top : 10,
+                    rerank: rerank !== null && rerank !== void 0 ? rerank : false,
+                },
             };
-            if (webSearch)
-                requestParam.web_search = __webSearch;
             const response = yield this.requestPost(requestParam);
             return response;
         });
@@ -184,7 +174,9 @@ class Vectocore {
         return __awaiter(this, arguments, void 0, function* ({ question }) {
             const requestParam = {
                 command: "web_search",
-                question: question,
+                params: {
+                    question: question,
+                },
             };
             const response = yield this.requestPost(requestParam);
             return response;

package/dist/index.d.ts

@@ -49,7 +49,7 @@ export interface DeleteIndexParams {
      */
     indexName: string;
 }
-export interface PutExtreamDataParams {
+export interface PutExtremeDataParams {
     /**
      * 지식을 추가할 인덱스의 이름입니다.
      */
@@ -74,42 +74,47 @@ export interface PutExtreamDataParams {
         refOnlyText?: boolean;
     };
 }
-export interface ListExtreamDataParams {
+export interface ListExtremeDataParams {
     /** 데이터 목록을 조회할 인덱스의 이름입니다. */
     indexName: string;
     /** 페이징된 결과를 받았을때 해당 key부터 다음 페이징까지 결과를 조회하는 기준 키 입니다. */
     lastKey?: string | null;
 }
-export interface ListAllExtreamDataParams {
+export interface ListAllExtremeDataParams {
     /** 데이터 목록을 조회할 인덱스의 이름입니다. */
     indexName: string;
 }
-export interface GetExtreamDataParams {
+export interface GetExtremeDataParams {
     /** 조회할 문서가 저장되어 있는 인덱스의 이름입니다. */
     indexName: string;
     /** 조회할 문서의 ID입니다. */
     documentId: string;
 }
-export interface DeleteExtreamDataParams {
+export interface DeleteExtremeDataParams {
     /** 삭제할 문서가 저장되어 있는 인덱스의 이름입니다. */
     indexName: string;
     /** 삭제할 문서의 ID입니다. */
     documentId: string;
 }
-export interface ExtreamSearchParams {
-    indexName?: string | string[] | undefined;
+export interface ExtremeSearchParams {
+    /** 사용자의 질문을 검색하고자하는 인덱스 목록, 생략하거나 []를 전송시 전체 인덱스에서 검색 실행합니다. */
+    indexNames?: string[];
+    /** 사용자 질문 (시멘틱 검색을 사용하기때문에 서술형을 질문해도 의미를 파악하여 유사한 결과를 유사도 순위별로 리턴.) */
     question: string;
-    maxCount?: number | undefined;
-    mode?: "VECTOR" | "BOTH" | "WEB" | undefined;
-    webSearch?: {
-        model?: "google" | "bing";
-        withImage?: boolean;
-        withVideo?: boolean;
-    };
-    findIndexPrompt?: string | undefined;
-    docOnly?: boolean;
+    /**
+     * • vector 모드 : 시멘틱 유사도만 사용
+     * • keyword 모드 : 키워드 유사도만 사용, 키워드 모드인 경우 해당 "단어"가 문서에 없으면 빈 list를 리턴
+     * • hybrid 모드 : 시멘틱 검색 순위와 키워드 검색 순위를 모두 사용하여 순위 결정
+     * @default "vector"
+     */
+    mode?: "vector" | "keyword" | "hybrid";
+    /** 결과로 보고싶은 목록의 최대 건수, 생략시 10건을 조회. */
+    top?: number;
+    /** 검색 mode가 hybrid일 경우 벡터 검색과 키워드 검색 결과를 ai가 다시 score를 산정하는 방식으로 별도의 토큰이 소모 됨. */
+    rerank?: boolean;
 }
 export interface WebSearchParams {
+    /** 검색어 */
     question: string;
 }
 export type FileType = {
@@ -161,12 +166,12 @@ export declare class Vectocore {
     putIndex({ indexName, description }: PutIndexParams): Promise<any>;
     deleteIndex({ indexName }: DeleteIndexParams): Promise<any>;
     listIndex(): Promise<any>;
-    putExtreamData({ indexName, docBody }: PutExtreamDataParams): Promise<any>;
-    getExtreamData({ indexName, documentId }: GetExtreamDataParams): Promise<any>;
-    listExtreamData({ indexName, lastKey }: ListExtreamDataParams): Promise<any>;
-    listAllExtreamData({ indexName }: ListAllExtreamDataParams): Promise<any>;
-    deleteExtreamData({ indexName, documentId }: DeleteExtreamDataParams): Promise<any>;
-    extreamSearch({ indexName, question, maxCount, mode, webSearch, findIndexPrompt, docOnly, }: ExtreamSearchParams): Promise<any>;
+    putExtremeData({ indexName, docBody }: PutExtremeDataParams): Promise<any>;
+    getExtremeData({ indexName, documentId }: GetExtremeDataParams): Promise<any>;
+    listExtremeData({ indexName, lastKey }: ListExtremeDataParams): Promise<any>;
+    listAllExtremeData({ indexName }: ListAllExtremeDataParams): Promise<any>;
+    deleteExtremeData({ indexName, documentId }: DeleteExtremeDataParams): Promise<any>;
+    extremeSearch({ mode, indexNames, question, top, rerank }: ExtremeSearchParams): Promise<any>;
     webSearch({ question }: WebSearchParams): Promise<any>;
 }
 export declare class Lens {

package/dist/mjs/index.js

@@ -54,9 +54,9 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
-    async putExtreamData({ indexName, docBody }) {
+    async putExtremeData({ indexName, docBody }) {
         const requestParam = {
-            command: "put_extream_data",
+            command: "put_extreme_data",
             params: {
                 index_name: indexName,
                 doc_body: {
@@ -77,9 +77,9 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
-    async getExtreamData({ indexName, documentId }) {
+    async getExtremeData({ indexName, documentId }) {
         const requestParam = {
-            command: "get_extream_data",
+            command: "get_extreme_data",
             params: {
                 index_name: indexName,
                 document_id: documentId,
@@ -88,9 +88,9 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
-    async listExtreamData({ indexName, lastKey }) {
+    async listExtremeData({ indexName, lastKey }) {
         const requestParam = {
-            command: "list_extream_data",
+            command: "list_extreme_data",
             params: {
                 index_name: indexName,
             },
@@ -101,9 +101,9 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
-    async listAllExtreamData({ indexName }) {
+    async listAllExtremeData({ indexName }) {
         const requestParam = {
-            command: "list_all_extream_data",
+            command: "list_all_extreme_data",
             params: {
                 index_name: indexName,
             },
@@ -111,44 +111,37 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
-    async deleteExtreamData({ indexName, documentId }) {
+    async deleteExtremeData({ indexName, documentId }) {
         const requestParam = {
-            command: "delete_extream_data",
-            index_name: indexName,
-            document_id: documentId,
+            command: "delete_extreme_data",
+            params: {
+                index_name: indexName,
+                document_id: documentId,
+            },
         };
         const response = await this.requestPost(requestParam);
         return response;
     }
-    async extreamSearch({ indexName, question, maxCount, mode, webSearch, findIndexPrompt, docOnly, }) {
+    async extremeSearch({ mode, indexNames, question, top, rerank }) {
         const requestParam = {
-            command: "extream_search",
-            question: question,
-        };
-        if (indexName)
-            requestParam.index_name = indexName;
-        if (mode)
-            requestParam.mode = mode;
-        if (maxCount)
-            requestParam.max_count = maxCount;
-        if (findIndexPrompt)
-            requestParam.find_index_prompt = findIndexPrompt;
-        if (docOnly)
-            requestParam.doc_only = docOnly;
-        let __webSearch = {
-            model: webSearch?.model ?? "bing",
-            with_image: webSearch?.withImage ?? false,
-            with_video: webSearch?.withVideo ?? false,
+            command: "extreme_search",
+            params: {
+                mode: mode ?? "vector",
+                index_names: indexNames ?? [],
+                question: question,
+                top: top ?? 10,
+                rerank: rerank ?? false,
+            },
         };
-        if (webSearch)
-            requestParam.web_search = __webSearch;
         const response = await this.requestPost(requestParam);
         return response;
     }
     async webSearch({ question }) {
         const requestParam = {
             command: "web_search",
-            question: question,
+            params: {
+                question: question,
+            },
         };
         const response = await this.requestPost(requestParam);
         return response;

package/package.json

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