vectocore4 0.0.22 → 0.0.23

package/dist/index.d.ts

@@ -28,6 +28,7 @@ export interface DeleteIndexParams {
      */
     indexName: string;
 }
+export type XFinderDocType = "text" | "image";
 export interface PutExtremeDataParams {
     /**
      * 지식을 추가할 인덱스의 이름입니다.
@@ -43,8 +44,8 @@ export interface PutExtremeDataParams {
         keywords: string;
         /** 실제 지식 본문 텍스트 데이터 */
         data: string;
-        /** 저장하는 지식의 타입 */
-        docType: "text" | "image";
+        /** 저장하는 지식의 타입  ({@link XFinderDocType}) */
+        docType: XFinderDocType;
         /** docType이 "image"인 경우 함께 업로드할 이미지의 URL입니다. */
         imageUrl?: string;
         /** 문서 저장시 추가로 남기고 싶은 정보를 json 형식으로 추가하면 향후 검색 결과시 리턴. 문서명이나, 페이지 번호 등을 입력하여 출처 확인용으로 사용할 수 있습니다. */
@@ -79,18 +80,20 @@ export interface DeleteExtremeDataParams {
     /** 삭제할 문서의 ID입니다. */
     documentId: string;
 }
+export type XFinderModeType = "vector" | "keyword" | "hybrid";
 export interface ExtremeSearchParams {
     /** 사용자의 질문을 검색하고자하는 인덱스 목록, 생략하거나 []를 전송시 전체 인덱스에서 검색 실행합니다. */
     indexNames?: string[];
     /** 사용자 질문 (시멘틱 검색을 사용하기때문에 서술형을 질문해도 의미를 파악하여 유사한 결과를 유사도 순위별로 리턴.) */
     question: string;
     /**
+     * @type ({@link XFinderModeType})
      * • vector 모드 : 시멘틱 유사도만 사용
      * • keyword 모드 : 키워드 유사도만 사용, 키워드 모드인 경우 해당 "단어"가 문서에 없으면 빈 list를 리턴
      * • hybrid 모드 : 시멘틱 검색 순위와 키워드 검색 순위를 모두 사용하여 순위 결정
      * @default "vector"
      */
-    mode?: "vector" | "keyword" | "hybrid";
+    mode?: XFinderModeType;
     /** 결과로 보고싶은 목록의 최대 건수, 생략시 10건을 조회. */
     top?: number;
     /** 검색 mode가 hybrid일 경우 벡터 검색과 키워드 검색 결과를 ai가 다시 score를 산정하는 방식으로 별도의 토큰이 소모 됨. */
@@ -102,9 +105,9 @@ export interface WebSearchParams {
 }
 type XFinderOptions = {
     /**
-     * vector | keyword | hybrid (Default : hybrid)
+     * vector | keyword | hybrid (Default : hybrid) ({@link XFinderModeType})
      */
-    mode?: "vector" | "keyword" | "hybrid";
+    mode?: XFinderModeType;
     /**
      * 검색에 사용할 index명 목록, 생략 또는 []시 전체 인덱스 스캔
      */
@@ -138,24 +141,25 @@ type CustomContextOptions = {
     /** 멀티모달 Context로 전송할 이미지 경로 URL */
     imageUrls?: string;
 };
-export type FileType = {
+export type LensFileType = {
     type: string;
     name: string;
     url: string;
     extImgUrls?: string[];
 };
+export type LensModelType = "5.1chat" | "5chat" | "4o" | "mini";
 export interface LensChatParams {
     /** 사용자 질문 (필수) */
     question: string;
     /** 스트림 응답 모드 (선택) 기본값 : true */
     stream?: boolean;
     /**
-     * 모델 선택 (선택) 기본값 : 5.1chat
+     * 모델 선택 (선택) 기본값 : 5.1chat ({@link LensModelType})
      * - 5.1chat, 5chat, 4o, mini, Default : 5.1chat
      *  - ‼️ 단, chat 모델의 경우 만료될 수 있음.
      *  - ‼️ mini 모델은 멀티모달을 사용할 수 없음.
      * */
-    model?: "5.1chat" | "5chat" | "4o" | "mini";
+    model?: LensModelType;
     /** 사전에 등록한 내부지식(X-Finder)를 사용하고자 할 경우 아래 파라미터 추가 ({@link XFinderOptions}) */
     xfinder?: XFinderOptions;
     /** 웹 검색 결과를 Context로 제공하고자 할 때 사용(별도 권한 필요) ({@link WebSearchOptions}) */
@@ -164,8 +168,11 @@ export interface LensChatParams {
     agentic?: AgenticOptions;
     /** 사용자 멀티모달 이미지 입력 시 자동으로 호출 */
     imageUrls?: string[];
-    /** 사용자 멀티모달 파일(페이지별 이미지) 입력 시, 순수 파일을 올릴 수는 없고 별도의 pdf to images 와 같은 전처리 과정을 거쳐 문서의 각 페이지별 이미지 캡쳐본을 올릴 수 있음. 자동으로 호출 */
-    fileUrls?: FileType;
+    /**
+     * @type ({@link LensFileType})
+     * 사용자 멀티모달 파일(페이지별 이미지) 입력 시, 순수 파일을 올릴 수는 없고 별도의 pdf to images 와 같은 전처리 과정을 거쳐 문서의 각 페이지별 이미지 캡쳐본을 올릴 수 있음. 자동으로 호출
+     * */
+    fileUrls?: LensFileType;
     /**
      * 사용자가 직접 정의한 Context 내에서 답변하고자 할 경우 ({@link CustomContextOptions})
      * 해당 파라미터가 있는 경우 Rag를 무시하고 사용자가 입력한 Context 내에서만 답변합니다.

package/package.json

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