@kevisual/cnb 0.0.75 → 0.0.77

package/dist/routes.d.ts

@@ -13,6 +13,7 @@ type CNBCoreOptions<T = {}> = {
     cors?: {
         baseUrl?: string;
     };
+    openapi?: boolean;
 } & T;
 type RequestOptions = {
     url?: string;
@@ -21,6 +22,7 @@ type RequestOptions = {
     body?: any;
     params?: Record<string, any>;
     headers?: Record<string, any>;
+    token?: string;
     useCookie?: boolean;
     useOrigin?: boolean;
 };
@@ -30,8 +32,9 @@ declare class CNBCore {
     token: string;
     cookie?: string;
     isCors: boolean;
+    openapi?: boolean;
     constructor(options: CNBCoreOptions);
-    request({ url, method, data, params, headers, body, useCookie, useOrigin }: RequestOptions): Promise<any>;
+    request({ url, method, data, params, headers, body, useCookie, useOrigin, ...rest }: RequestOptions): Promise<any>;
     makeUrl(url?: string): string;
     get<T = any>({ url, ...REST }: RequestOptions): Promise<T>;
     post<T = any>({ url, ...REST }: RequestOptions): Promise<T>;
@@ -39,10 +42,11 @@ declare class CNBCore {
     delete<T = any>({ url, ...REST }: RequestOptions): Promise<T>;
     patch<T = any>({ url, ...REST }: RequestOptions): Promise<T>;
     /**
-   * 通过 PUT 请求上传文件内容
-   * @param data 包含 URL、token 和文件内容
-   * @returns 上传结果
-   */
+     * 通过 PUT 请求上传文件内容
+     * assets上传的时候，第一次会获取到一个上传 URL 和 token，然后使用这个方法将文件内容上传到指定的 URL
+     * @param data 包含 URL、token 和文件内容
+     * @returns 上传结果
+     */
     putFile(data: {
         url: string;
         token: string;
@@ -249,24 +253,26 @@ declare class KnowledgeBase extends CNBCore {
     deleteBase(repo: string): Promise<Result<any>>;
     /**
      * 未暴露
+     *
+     * 创建知识库接口，cnb 界面操作定制模块功能依赖该接口实现
      * @param repo
      * @param data
      * @returns
      */
-    createKnowledgeBase(repo: string, data: {
-        embedding_model_name: string;
+    createKnowledgeBase(repo: string, params: {
+        /**
+         * hunyuan | bge-m3
+         */
+        model_name: string;
         include: string;
         exclude: string;
+        chunk_size: number;
+        chunk_overlap: number;
+        text_separator: string;
         issue_sync_enabled?: boolean;
-        processing?: {
-            chunk_size: number;
-            chunk_overlap: number;
-            text_separator: string;
-        };
-        issue?: {
-            labels: string;
-            state: string;
-        };
+        issue_labels?: string;
+        issue_exclude_labels?: string;
+        issue_state?: string;
     }): Promise<Result<any>>;
     /**
      * 未暴露
@@ -285,23 +291,28 @@ declare class KnowledgeBase extends CNBCore {
      * @returns
      */
     getEmbedding(repo: string, text: string): Promise<Result<{
-        embedding: number[];
+        embeddings: number[];
     }>>;
     /**
-     *  未暴露
+     * 未暴露
+     * 只能运行在流水线，使用流水线的CNB_TOKEN去使用
+     * 否则会报错：sn not found in meta
+     * opts的token必须是流水线的CNB_TOKEN，不能是用户的token
      * @param repo
      * @param chunksData
      * @returns
      */
-    addDocument(repo: string, chunksData: {
-        path: string;
-        chunks: Array<{
-            content: string;
-            hash: string;
-            offset: number;
-            size: number;
-        }>;
-    }): Promise<Result<any>>;
+    addDocument(repo: string, AddDocument: AddDocument, opts?: RequestOptions): Promise<Result<null>>;
+    /**
+     * 未暴露
+     * @param repo
+     * @param paths
+        size: number;
+      }>;
+    }): Promise<Result<any>> {
+      const url = `/${repo}/-/knowledge/documents/upsert-document-with-chunks`;
+      return this.post({ url, data: chunksData });
+    }
     /**
      * 未暴露
      * @param repo
@@ -316,7 +327,7 @@ declare class KnowledgeBase extends CNBCore {
      * @param page_size
      * @returns
      */
-    listDocument(repo: string, page?: number, page_size?: number): Promise<Result<any[]>>;
+    listDocuments(repo: string, page?: number, page_size?: number): Promise<Result<any[]>>;
 }
 type MetadataFilteringConditions = {
     conditions: Array<{
@@ -341,6 +352,24 @@ type QueryRag = {
         url: string;
     };
 };
+type AddDocument = {
+    path: string;
+    name: string;
+    extension: string;
+    size: number;
+    hash: string;
+    type: "code" | "issue";
+    url: string;
+    chunks: Array<{
+        "content": string;
+        "hash": string;
+        "position": number;
+        "embedding": number[];
+    }>;
+    batch_index: number;
+    batch_count: number;
+    is_last_batch: boolean;
+};
 
 declare class Repo extends CNBCore {
     constructor(options: CNBCoreOptions);
@@ -1012,10 +1041,10 @@ declare class Mission extends CNBCore {
     /**
      * 改变任务集可见性
      * @param mission 任务集路径
-     * @param visibility 可见性 (Private 或 Public)
+     * @param visibility 可见性 (private 或 public)
      * @returns 操作结果
      */
-    setVisibility(mission: string, visibility: 'Private' | 'Public'): Promise<Result<any>>;
+    setVisibility(mission: string, visibility: 'private' | 'public'): Promise<Result<any>>;
     /**
      * 查询任务集资源
      * @param repo 仓库路径
@@ -1034,16 +1063,23 @@ type GetMissionsParams = {
     search?: string;
 };
 type CreateMissionData = {
+    /**
+     * 任务集名称，必填
+     */
     name: string;
     description?: string;
-    visibility?: 'Private' | 'Public';
+    visibility?: 'private' | 'public';
+    /**
+     * 关联的仓库列表，格式为 `${group}/${repo}`，如 `my-group/my-repo`
+     */
+    repos: string[];
 };
 type Missions4User = {
     id: string;
     name: string;
     slug_path: string;
     description: string;
-    visibility: 'Private' | 'Public';
+    visibility: 'private' | 'public';
     created_at: string;
     updated_at: string;
     web_url: string;
@@ -1151,6 +1187,11 @@ declare class RepoLabel extends CNBCore {
      * @param params 分页和搜索参数
      */
     list(repo: string, params?: ListLabelsParams): Promise<Result<Label[]>>;
+    getAll(repo: string): Promise<Result<Label[]>>;
+    importLabels(opts: {
+        repo: string;
+        labels: PostLabelForm[];
+    }): Promise<Result>;
     /**
      * 创建一个标签
      * @param repo 仓库路径
@@ -1170,6 +1211,10 @@ declare class RepoLabel extends CNBCore {
      * @param name 标签名称
      */
     remove(repo: string, name: string): Promise<Result<void>>;
+    removeLabels(opts: {
+        repo: string;
+        labels: string[];
+    }): Promise<Result>;
 }
 type ListLabelsParams = {
     /** 分页页码 */