@petercatai/whisker-client 0.1.202504101329-dev → 0.1.202504211811-dev

package/dist/api.d.ts

@@ -1,3 +1,42 @@
+/** TaskStatus */
+export declare enum ITaskStatus {
+    Pending = "pending",
+    Running = "running",
+    Success = "success",
+    Failed = "failed",
+    Skipped = "skipped",
+    Canceled = "canceled",
+    PendingRetry = "pending_retry"
+}
+/**
+ * KnowledgeTypeEnum
+ * mime type of the knowledge
+ */
+export declare enum IKnowledgeTypeEnum {
+    Text = "text",
+    Image = "image",
+    Markdown = "markdown",
+    Json = "json",
+    Docx = "docx",
+    Pdf = "pdf",
+    Qa = "qa",
+    Folder = "folder"
+}
+/** KnowledgeSourceEnum */
+export declare enum IKnowledgeSourceEnum {
+    GithubRepo = "github_repo",
+    GithubFile = "github_file",
+    UserInputText = "user_input_text",
+    UserUploadFile = "user_upload_file"
+}
+/** EmbeddingModelEnum */
+export declare enum IEmbeddingModelEnum {
+    Openai = "openai",
+    SentenceTransformersAllMiniLML6V2 = "sentence-transformers/all-MiniLM-L6-v2",
+    SentenceTransformersAllMpnetBaseV2 = "sentence-transformers/all-mpnet-base-v2",
+    SentenceTransformersParaphraseMultilingualMiniLML12V2 = "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
+    Shibing624Text2VecBaseChinese = "shibing624/text2vec-base-chinese"
+}
 /**
  * BaseCharSplitConfig
  * Base split configuration class
@@ -70,14 +109,6 @@ export interface IChunk {
      */
     gmt_modified?: string;
 }
-/** EmbeddingModelEnum */
-export declare enum IEmbeddingModelEnum {
-    Openai = "openai",
-    SentenceTransformersAllMiniLML6V2 = "sentence-transformers/all-MiniLM-L6-v2",
-    SentenceTransformersAllMpnetBaseV2 = "sentence-transformers/all-mpnet-base-v2",
-    SentenceTransformersParaphraseMultilingualMiniLML12V2 = "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
-    Shibing624Text2VecBaseChinese = "shibing624/text2vec-base-chinese"
-}
 /** GithubFileSourceConfig */
 export interface IGithubFileSourceConfig {
     /**
@@ -326,7 +357,100 @@ export interface IJSONSplitConfig {
     key_filters?: string[] | null;
 }
 /** Knowledge */
-export interface IKnowledge {
+export interface IKnowledgeInput {
+    /**
+     * Knowledge Id
+     * knowledge id
+     */
+    knowledge_id?: string;
+    /**
+     * Space Id
+     * the space of knowledge, example: petercat bot id, github repo name
+     */
+    space_id: string;
+    /**
+     * Tenant Id
+     * tenant id
+     */
+    tenant_id: string;
+    /**
+     * type of knowledge resource
+     * @default "text"
+     */
+    knowledge_type?: IKnowledgeTypeEnum;
+    /**
+     * Knowledge Name
+     * name of the knowledge resource
+     * @maxLength 255
+     */
+    knowledge_name: string;
+    /**
+     * source type
+     * @default "user_input_text"
+     */
+    source_type?: IKnowledgeSourceEnum;
+    /**
+     * Source Config
+     * source config of the knowledge
+     */
+    source_config: IGithubRepoSourceConfig | IGithubFileSourceConfig | IS3SourceConfig | IOpenUrlSourceConfig | ITextSourceConfig;
+    /**
+     * Embedding Model Name
+     * name of the embedding model. you can set any other model if target embedding service registered
+     * @default "openai"
+     */
+    embedding_model_name?: IEmbeddingModelEnum | string;
+    /**
+     * Split Config
+     * configuration for splitting the knowledge
+     */
+    split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | IPDFSplitConfig | ITextSplitConfig | IJSONSplitConfig;
+    /**
+     * File Sha
+     * SHA of the file
+     */
+    file_sha?: string | null;
+    /**
+     * File Size
+     * size of the file
+     */
+    file_size?: number | null;
+    /**
+     * Metadata
+     * additional metadata, user can update it
+     * @default {}
+     */
+    metadata?: Record<string, any>;
+    /**
+     * Retrieval Count
+     * count of the retrieval
+     * @default 0
+     */
+    retrieval_count?: number;
+    /**
+     * Parent Id
+     * parent knowledge id
+     */
+    parent_id?: string | null;
+    /**
+     * Enabled
+     * is knowledge enabled
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Gmt Create
+     * creation time
+     */
+    gmt_create?: string | null;
+    /**
+     * Gmt Modified
+     * update time
+     */
+    gmt_modified?: string | null;
+}
+/** Knowledge */
+export interface IKnowledgeOutput {
     /**
      * Knowledge Id
      * knowledge id
@@ -382,6 +506,12 @@ export interface IKnowledge {
      * additional metadata, user can update it
      */
     metadata?: Record<string, any> | null;
+    /**
+     * Retrieval Count
+     * count of the retrieval
+     * @default 0
+     */
+    retrieval_count?: number;
     /**
      * Parent Id
      * parent knowledge id
@@ -485,27 +615,6 @@ export interface IKnowledgeCreate {
      */
     enabled?: boolean;
 }
-/** KnowledgeSourceEnum */
-export declare enum IKnowledgeSourceEnum {
-    GithubRepo = "github_repo",
-    GithubFile = "github_file",
-    UserInputText = "user_input_text",
-    UserUploadFile = "user_upload_file"
-}
-/**
- * KnowledgeTypeEnum
- * mime type of the knowledge
- */
-export declare enum IKnowledgeTypeEnum {
-    Text = "text",
-    Image = "image",
-    Markdown = "markdown",
-    Json = "json",
-    Docx = "docx",
-    Pdf = "pdf",
-    Qa = "qa",
-    Folder = "folder"
-}
 /** MarkdownCreate */
 export interface IMarkdownCreate {
     /**
@@ -814,20 +923,7 @@ export interface IPageResponseChunk {
 /** PageResponse[Knowledge] */
 export interface IPageResponseKnowledge {
     /** Items */
-    items: IKnowledge[];
-    /** Total */
-    total: number;
-    /** Page */
-    page: number;
-    /** Page Size */
-    page_size: number;
-    /** Total Pages */
-    total_pages: number;
-}
-/** PageResponse[Task] */
-export interface IPageResponseTask {
-    /** Items */
-    items: ITask[];
+    items: IKnowledgeOutput[];
     /** Total */
     total: number;
     /** Page */
@@ -908,7 +1004,7 @@ export interface IResponseModel {
 export interface IResponseModelKnowledge {
     /** Success */
     success: boolean;
-    data?: IKnowledge | null;
+    data?: IKnowledgeOutput | null;
     /** Message */
     message?: string | null;
 }
@@ -917,7 +1013,7 @@ export interface IResponseModelListKnowledge {
     /** Success */
     success: boolean;
     /** Data */
-    data?: IKnowledge[] | null;
+    data?: IKnowledgeOutput[] | null;
     /** Message */
     message?: string | null;
 }
@@ -964,11 +1060,11 @@ export interface IResponseModelPageResponseKnowledge {
     /** Message */
     message?: string | null;
 }
-/** ResponseModel[PageResponse[Task]] */
-export interface IResponseModelPageResponseTask {
+/** ResponseModel[StatusStatisticsPageResponse[Task]] */
+export interface IResponseModelStatusStatisticsPageResponseTask {
     /** Success */
     success: boolean;
-    data?: IPageResponseTask | null;
+    data?: IStatusStatisticsPageResponseTask | null;
     /** Message */
     message?: string | null;
 }
@@ -1156,6 +1252,24 @@ export interface IS3SourceConfig {
      */
     session_token?: string | null;
 }
+/** StatusStatisticsPageResponse[Task] */
+export interface IStatusStatisticsPageResponseTask {
+    /** Items */
+    items: ITask[];
+    /** Total */
+    total: number;
+    /** Page */
+    page: number;
+    /** Page Size */
+    page_size: number;
+    /** Total Pages */
+    total_pages: number;
+    /**
+     * Success
+     * @default 0
+     */
+    success?: number;
+}
 /** Task */
 export interface ITask {
     /**
@@ -1217,16 +1331,6 @@ export interface ITaskRestartRequest {
      */
     task_id_list: string[];
 }
-/** TaskStatus */
-export declare enum ITaskStatus {
-    Pending = "pending",
-    Running = "running",
-    Success = "success",
-    Failed = "failed",
-    Skipped = "skipped",
-    Canceled = "canceled",
-    PendingRetry = "pending_retry"
-}
 /** Tenant */
 export interface ITenant {
     /**
@@ -1257,6 +1361,11 @@ export interface ITenant {
      * @default true
      */
     is_active?: boolean;
+    /**
+     * Metadata
+     * Metadata for the tenant
+     */
+    metadata?: Record<string, any> | null;
     /**
      * Gmt Create
      * tenant created time
@@ -1366,13 +1475,13 @@ export interface ITextSplitConfig {
      * Whether to keep the separator and where to place it in each corresponding chunk (True='start')
      * @default false
      */
-    keep_separator?: boolean | "start" | "end";
+    keep_separator?: boolean | "start" | "end" | null;
     /**
      * Strip Whitespace
      * If `True`, strips whitespace from the start and end of every document
      * @default false
      */
-    strip_whitespace?: boolean;
+    strip_whitespace?: boolean | null;
 }
 /** ValidationError */
 export interface IValidationError {
@@ -1443,7 +1552,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title whisker rag server
- * @version 1.0.2
+ * @version 1.0.3
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
     /**
@@ -1464,6 +1573,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/api/knowledge/add
          */
         addKnowledge: (data: (IKnowledgeCreate | ITextCreate | IImageCreate | IJSONCreate | IMarkdownCreate | IPDFCreate | IGithubRepoCreate | IQACreate)[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListKnowledge, void | IHTTPValidationError>>;
+        /**
+         * @description Only makes modifications to the enabled field.
+         *
+         * @tags knowledge
+         * @name UpdateKnowledge
+         * @summary Update Knowledge
+         * @request POST:/api/knowledge/update
+         */
+        updateKnowledge: (data: IKnowledgeInput[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListKnowledge, void | IHTTPValidationError>>;
         /**
          * No description
          *
@@ -1528,6 +1646,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/api/task/restart
          */
         restartTask: (data: ITaskRestartRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelListTask, void | IHTTPValidationError>>;
+        /**
+         * No description
+         *
+         * @tags task
+         * @name CancelTask
+         * @summary Cancel Task
+         * @request POST:/api/task/cancel
+         */
+        cancelTask: (data: ITaskRestartRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelListTask, void | IHTTPValidationError>>;
         /**
          * No description
          *
@@ -1536,7 +1663,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @summary Get Task List
          * @request POST:/api/task/list
          */
-        getTaskList: (data: IPageParamsTask, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseTask, void | IHTTPValidationError>>;
+        getTaskList: (data: IPageParamsTask, params?: RequestParams) => Promise<HttpResponse<IResponseModelStatusStatisticsPageResponseTask, void | IHTTPValidationError>>;
         /**
          * No description
          *
@@ -1549,6 +1676,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             /** Task Id */
             task_id: string;
         }, params?: RequestParams) => Promise<HttpResponse<IResponseModelTask, void | IHTTPValidationError>>;
+        /**
+         * No description
+         *
+         * @tags task
+         * @name DeleteTaskById
+         * @summary Delete Task By Id
+         * @request DELETE:/api/task/delete
+         */
+        deleteTaskById: (query: {
+            /** Task Id */
+            task_id: string;
+        }, params?: RequestParams) => Promise<HttpResponse<IResponseModelTask, void | IHTTPValidationError>>;
     };
     chunk: {
         /**

package/dist/api.js

@@ -22,24 +22,18 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Api = exports.HttpClient = exports.ContentType = exports.ITaskStatus = exports.IKnowledgeTypeEnum = exports.IKnowledgeSourceEnum = exports.IEmbeddingModelEnum = void 0;
-/** EmbeddingModelEnum */
-var IEmbeddingModelEnum;
-(function (IEmbeddingModelEnum) {
-    IEmbeddingModelEnum["Openai"] = "openai";
-    IEmbeddingModelEnum["SentenceTransformersAllMiniLML6V2"] = "sentence-transformers/all-MiniLM-L6-v2";
-    IEmbeddingModelEnum["SentenceTransformersAllMpnetBaseV2"] = "sentence-transformers/all-mpnet-base-v2";
-    IEmbeddingModelEnum["SentenceTransformersParaphraseMultilingualMiniLML12V2"] = "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2";
-    IEmbeddingModelEnum["Shibing624Text2VecBaseChinese"] = "shibing624/text2vec-base-chinese";
-})(IEmbeddingModelEnum || (exports.IEmbeddingModelEnum = IEmbeddingModelEnum = {}));
-/** KnowledgeSourceEnum */
-var IKnowledgeSourceEnum;
-(function (IKnowledgeSourceEnum) {
-    IKnowledgeSourceEnum["GithubRepo"] = "github_repo";
-    IKnowledgeSourceEnum["GithubFile"] = "github_file";
-    IKnowledgeSourceEnum["UserInputText"] = "user_input_text";
-    IKnowledgeSourceEnum["UserUploadFile"] = "user_upload_file";
-})(IKnowledgeSourceEnum || (exports.IKnowledgeSourceEnum = IKnowledgeSourceEnum = {}));
+exports.Api = exports.HttpClient = exports.ContentType = exports.IEmbeddingModelEnum = exports.IKnowledgeSourceEnum = exports.IKnowledgeTypeEnum = exports.ITaskStatus = void 0;
+/** TaskStatus */
+var ITaskStatus;
+(function (ITaskStatus) {
+    ITaskStatus["Pending"] = "pending";
+    ITaskStatus["Running"] = "running";
+    ITaskStatus["Success"] = "success";
+    ITaskStatus["Failed"] = "failed";
+    ITaskStatus["Skipped"] = "skipped";
+    ITaskStatus["Canceled"] = "canceled";
+    ITaskStatus["PendingRetry"] = "pending_retry";
+})(ITaskStatus || (exports.ITaskStatus = ITaskStatus = {}));
 /**
  * KnowledgeTypeEnum
  * mime type of the knowledge
@@ -55,17 +49,23 @@ var IKnowledgeTypeEnum;
     IKnowledgeTypeEnum["Qa"] = "qa";
     IKnowledgeTypeEnum["Folder"] = "folder";
 })(IKnowledgeTypeEnum || (exports.IKnowledgeTypeEnum = IKnowledgeTypeEnum = {}));
-/** TaskStatus */
-var ITaskStatus;
-(function (ITaskStatus) {
-    ITaskStatus["Pending"] = "pending";
-    ITaskStatus["Running"] = "running";
-    ITaskStatus["Success"] = "success";
-    ITaskStatus["Failed"] = "failed";
-    ITaskStatus["Skipped"] = "skipped";
-    ITaskStatus["Canceled"] = "canceled";
-    ITaskStatus["PendingRetry"] = "pending_retry";
-})(ITaskStatus || (exports.ITaskStatus = ITaskStatus = {}));
+/** KnowledgeSourceEnum */
+var IKnowledgeSourceEnum;
+(function (IKnowledgeSourceEnum) {
+    IKnowledgeSourceEnum["GithubRepo"] = "github_repo";
+    IKnowledgeSourceEnum["GithubFile"] = "github_file";
+    IKnowledgeSourceEnum["UserInputText"] = "user_input_text";
+    IKnowledgeSourceEnum["UserUploadFile"] = "user_upload_file";
+})(IKnowledgeSourceEnum || (exports.IKnowledgeSourceEnum = IKnowledgeSourceEnum = {}));
+/** EmbeddingModelEnum */
+var IEmbeddingModelEnum;
+(function (IEmbeddingModelEnum) {
+    IEmbeddingModelEnum["Openai"] = "openai";
+    IEmbeddingModelEnum["SentenceTransformersAllMiniLML6V2"] = "sentence-transformers/all-MiniLM-L6-v2";
+    IEmbeddingModelEnum["SentenceTransformersAllMpnetBaseV2"] = "sentence-transformers/all-mpnet-base-v2";
+    IEmbeddingModelEnum["SentenceTransformersParaphraseMultilingualMiniLML12V2"] = "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2";
+    IEmbeddingModelEnum["Shibing624Text2VecBaseChinese"] = "shibing624/text2vec-base-chinese";
+})(IEmbeddingModelEnum || (exports.IEmbeddingModelEnum = IEmbeddingModelEnum = {}));
 var ContentType;
 (function (ContentType) {
     ContentType["Json"] = "application/json";
@@ -89,8 +89,12 @@ class HttpClient {
             this.securityData = data;
         };
         this.contentFormatters = {
-            [ContentType.Json]: (input) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
-            [ContentType.Text]: (input) => (input !== null && typeof input !== "string" ? JSON.stringify(input) : input),
+            [ContentType.Json]: (input) => input !== null && (typeof input === "object" || typeof input === "string")
+                ? JSON.stringify(input)
+                : input,
+            [ContentType.Text]: (input) => input !== null && typeof input !== "string"
+                ? JSON.stringify(input)
+                : input,
             [ContentType.FormData]: (input) => Object.keys(input || {}).reduce((formData, key) => {
                 const property = input[key];
                 formData.append(key, property instanceof Blob
@@ -131,7 +135,13 @@ class HttpClient {
             const queryString = query && this.toQueryString(query);
             const payloadFormatter = this.contentFormatters[type || ContentType.Json];
             const responseFormat = format || requestParams.format;
-            return this.customFetch(`${baseUrl || this.baseUrl || ""}${path}${queryString ? `?${queryString}` : ""}`, Object.assign(Object.assign({}, requestParams), { headers: Object.assign(Object.assign({}, (requestParams.headers || {})), (type && type !== ContentType.FormData ? { "Content-Type": type } : {})), signal: (cancelToken ? this.createAbortSignal(cancelToken) : requestParams.signal) || null, body: typeof body === "undefined" || body === null ? null : payloadFormatter(body) })).then(async (response) => {
+            return this.customFetch(`${baseUrl || this.baseUrl || ""}${path}${queryString ? `?${queryString}` : ""}`, Object.assign(Object.assign({}, requestParams), { headers: Object.assign(Object.assign({}, (requestParams.headers || {})), (type && type !== ContentType.FormData
+                    ? { "Content-Type": type }
+                    : {})), signal: (cancelToken
+                    ? this.createAbortSignal(cancelToken)
+                    : requestParams.signal) || null, body: typeof body === "undefined" || body === null
+                    ? null
+                    : payloadFormatter(body) })).then(async (response) => {
                 const r = response.clone();
                 r.data = null;
                 r.error = null;
@@ -176,7 +186,9 @@ class HttpClient {
         const query = rawQuery || {};
         const keys = Object.keys(query).filter((key) => "undefined" !== typeof query[key]);
         return keys
-            .map((key) => (Array.isArray(query[key]) ? this.addArrayQueryParam(query, key) : this.addQueryParam(query, key)))
+            .map((key) => Array.isArray(query[key])
+            ? this.addArrayQueryParam(query, key)
+            : this.addQueryParam(query, key))
             .join("&");
     }
     addQueryParams(rawQuery) {
@@ -190,7 +202,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title whisker rag server
- * @version 1.0.2
+ * @version 1.0.3
  */
 class Api extends HttpClient {
     constructor() {
@@ -213,6 +225,15 @@ class Api extends HttpClient {
              * @request POST:/api/knowledge/add
              */
             addKnowledge: (data, params = {}) => this.request(Object.assign({ path: `/api/knowledge/add`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * @description Only makes modifications to the enabled field.
+             *
+             * @tags knowledge
+             * @name UpdateKnowledge
+             * @summary Update Knowledge
+             * @request POST:/api/knowledge/update
+             */
+            updateKnowledge: (data, params = {}) => this.request(Object.assign({ path: `/api/knowledge/update`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -271,6 +292,15 @@ class Api extends HttpClient {
              * @request POST:/api/task/restart
              */
             restartTask: (data, params = {}) => this.request(Object.assign({ path: `/api/task/restart`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags task
+             * @name CancelTask
+             * @summary Cancel Task
+             * @request POST:/api/task/cancel
+             */
+            cancelTask: (data, params = {}) => this.request(Object.assign({ path: `/api/task/cancel`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -289,6 +319,15 @@ class Api extends HttpClient {
              * @request GET:/api/task/detail
              */
             getTaskDetail: (query, params = {}) => this.request(Object.assign({ path: `/api/task/detail`, method: "GET", query: query, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags task
+             * @name DeleteTaskById
+             * @summary Delete Task By Id
+             * @request DELETE:/api/task/delete
+             */
+            deleteTaskById: (query, params = {}) => this.request(Object.assign({ path: `/api/task/delete`, method: "DELETE", query: query, format: "json" }, params)),
         };
         this.chunk = {
             /**

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@petercatai/whisker-client",
-    "version": "0.1.202504101329-dev",
-    "description": "Generated API client (preview)",
+    "version": "0.1.202504211811-dev",
+    "description": "Generated API client (dev)",
     "main": "dist/api.js",
     "types": "dist/api.d.ts",
     "files": [
@@ -16,7 +16,7 @@
         "tag": "dev"
     },
     "devDependencies": {
-        "@types/node": "^22.14.0",
+        "@types/node": "^22.14.1",
         "axios": "^1.8.4",
         "typescript": "^5.8.3"
     }