vectocore4 0.0.6 → 0.0.8

package/dist/cjs/index.js

@@ -115,11 +115,12 @@ class Vectocore {
         });
     }
     listExtremeData(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ indexName, lastKey }) {
+        return __awaiter(this, arguments, void 0, function* ({ indexName, lastKey, withVectorValue }) {
             const requestParam = {
                 command: "list_extreme_data",
                 params: {
                     index_name: indexName,
+                    with_vector_value: withVectorValue !== null && withVectorValue !== void 0 ? withVectorValue : false,
                 },
             };
             if (lastKey) {
@@ -129,12 +130,21 @@ class Vectocore {
             return response;
         });
     }
+    /**
+     * 특정 인덱스에 저장된 모든 지식 데이터를 리스트로 가져옵니다.
+     * * @param {Object} param0 - 조회 매개변수
+     * @param {string} param0.indexName - 데이터를 추출할 **인덱스의 고유 이름**입니다. (필수)
+     * @param {boolean} [param0.withVectorValue=false] - 결과 데이터에 **고차원 벡터값(keywords_vector)을 포함할지** 여부입니다.
+     * true 설정 시 응답 크기가 커질 수 있습니다.
+     * * @returns {Promise<any>} 서버로부터 전달받은 데이터 목록 응답
+     */
     listAllExtremeData(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ indexName }) {
+        return __awaiter(this, arguments, void 0, function* ({ indexName, withVectorValue }) {
             const requestParam = {
                 command: "list_all_extreme_data",
                 params: {
                     index_name: indexName,
+                    with_vector_value: withVectorValue !== null && withVectorValue !== void 0 ? withVectorValue : false,
                 },
             };
             const response = yield this.requestPost(requestParam);

package/dist/index.d.ts

@@ -79,10 +79,14 @@ export interface ListExtremeDataParams {
     indexName: string;
     /** 페이징된 결과를 받았을때 해당 key부터 다음 페이징까지 결과를 조회하는 기준 키 입니다. */
     lastKey?: string | null;
+    /** 임베딩 값을 리턴받고 싶을때 사용. 단 페이로드가 커지는 만큼 성능에 영향을 끼칠 수 있음. */
+    withVectorValue?: boolean;
 }
 export interface ListAllExtremeDataParams {
     /** 데이터 목록을 조회할 인덱스의 이름입니다. */
     indexName: string;
+    /** 임베딩 값을 리턴받고 싶을때 사용. 단 페이로드가 커지는 만큼 성능에 영향을 끼칠 수 있음. */
+    withVectorValue?: boolean;
 }
 export interface GetExtremeDataParams {
     /** 조회할 문서가 저장되어 있는 인덱스의 이름입니다. */
@@ -168,8 +172,16 @@ export declare class Vectocore {
     listIndex(): 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>;
+    listExtremeData({ indexName, lastKey, withVectorValue }: ListExtremeDataParams): Promise<any>;
+    /**
+     * 특정 인덱스에 저장된 모든 지식 데이터를 리스트로 가져옵니다.
+     * * @param {Object} param0 - 조회 매개변수
+     * @param {string} param0.indexName - 데이터를 추출할 **인덱스의 고유 이름**입니다. (필수)
+     * @param {boolean} [param0.withVectorValue=false] - 결과 데이터에 **고차원 벡터값(keywords_vector)을 포함할지** 여부입니다.
+     * true 설정 시 응답 크기가 커질 수 있습니다.
+     * * @returns {Promise<any>} 서버로부터 전달받은 데이터 목록 응답
+     */
+    listAllExtremeData({ indexName, withVectorValue }: ListAllExtremeDataParams): Promise<any>;
     deleteExtremeData({ indexName, documentId }: DeleteExtremeDataParams): Promise<any>;
     extremeSearch({ mode, indexNames, question, top, rerank }: ExtremeSearchParams): Promise<any>;
     webSearch({ question }: WebSearchParams): Promise<any>;

package/dist/mjs/index.js

@@ -88,11 +88,12 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
-    async listExtremeData({ indexName, lastKey }) {
+    async listExtremeData({ indexName, lastKey, withVectorValue }) {
         const requestParam = {
             command: "list_extreme_data",
             params: {
                 index_name: indexName,
+                with_vector_value: withVectorValue ?? false,
             },
         };
         if (lastKey) {
@@ -101,11 +102,20 @@ export class Vectocore {
         const response = await this.requestPost(requestParam);
         return response;
     }
-    async listAllExtremeData({ indexName }) {
+    /**
+     * 특정 인덱스에 저장된 모든 지식 데이터를 리스트로 가져옵니다.
+     * * @param {Object} param0 - 조회 매개변수
+     * @param {string} param0.indexName - 데이터를 추출할 **인덱스의 고유 이름**입니다. (필수)
+     * @param {boolean} [param0.withVectorValue=false] - 결과 데이터에 **고차원 벡터값(keywords_vector)을 포함할지** 여부입니다.
+     * true 설정 시 응답 크기가 커질 수 있습니다.
+     * * @returns {Promise<any>} 서버로부터 전달받은 데이터 목록 응답
+     */
+    async listAllExtremeData({ indexName, withVectorValue }) {
         const requestParam = {
             command: "list_all_extreme_data",
             params: {
                 index_name: indexName,
+                with_vector_value: withVectorValue ?? false,
             },
         };
         const response = await this.requestPost(requestParam);

package/package.json

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