@petercatai/whisker-client 0.1.202505220227-dev → 0.1.202505281015-dev

package/dist/api.d.ts

@@ -9,6 +9,18 @@ export declare enum ITaskStatus {
     PendingRetry = "pending_retry",
     Deleted = "deleted"
 }
+/** Resource */
+export declare enum IResource {
+    Retrieval = "retrieval",
+    Tenant = "tenant",
+    Space = "space",
+    Knowledge = "knowledge",
+    Chunk = "chunk",
+    ApiKey = "api_key",
+    Task = "task",
+    Rule = "rule",
+    Public = "public"
+}
 /**
  * KnowledgeTypeEnum
  * mime type of the knowledge. If multiple files are included and require a decomposer, please set the type to 'folder'
@@ -44,6 +56,123 @@ export declare enum IEmbeddingModelEnum {
     SentenceTransformersParaphraseMultilingualMiniLML12V2 = "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
     Shibing624Text2VecBaseChinese = "shibing624/text2vec-base-chinese"
 }
+/** Action */
+export declare enum IAction {
+    Create = "create",
+    Read = "read",
+    Update = "update",
+    Delete = "delete",
+    Value = "*"
+}
+/** APIKey */
+export interface IAPIKey {
+    /**
+     * Gmt Create
+     * creation time
+     */
+    gmt_create?: string;
+    /**
+     * Gmt Modified
+     * update time
+     */
+    gmt_modified?: string;
+    /**
+     * Key Id
+     * key id
+     */
+    key_id?: string;
+    /**
+     * Tenant Id
+     * tenant id
+     */
+    tenant_id: string;
+    /**
+     * Key Name
+     * key name
+     * @default ""
+     */
+    key_name?: string;
+    /**
+     * Key Value
+     * key value
+     */
+    key_value: string;
+    /**
+     * Permissions
+     * permissions config
+     */
+    permissions?: IPermission[];
+    /**
+     * Rate Limit
+     * rate limit per minute
+     * @min 0
+     * @default 0
+     */
+    rate_limit?: number;
+    /**
+     * Expires At
+     * expire time
+     */
+    expires_at?: string | null;
+    /**
+     * Is Active
+     * key status
+     * @default true
+     */
+    is_active?: boolean;
+    /**
+     * Metadata
+     * key metadata
+     */
+    metadata?: Record<string, any> | null;
+}
+/** APIKeyCreate */
+export interface IAPIKeyCreate {
+    /**
+     * Key Name
+     * @default ""
+     */
+    key_name?: string;
+    /** Description */
+    description?: string | null;
+    /** Permissions */
+    permissions?: IPermission[];
+    /**
+     * Rate Limit
+     * @default 0
+     */
+    rate_limit?: number | null;
+    /** Expires At */
+    expires_at?: string | null;
+    /** Metadata */
+    metadata?: Record<string, any> | null;
+}
+/** APIKeyUpdate */
+export interface IAPIKeyUpdate {
+    /** Key Id */
+    key_id: string;
+    /** Key Name */
+    key_name?: string | null;
+    /** Description */
+    description?: string | null;
+    /** Permissions */
+    permissions?: IPermission[];
+    /** Rate Limit */
+    rate_limit?: number | null;
+    /** Expires At */
+    expires_at?: string | null;
+    /** Is Active */
+    is_active?: boolean | null;
+    /** Metadata */
+    metadata?: Record<string, any> | null;
+}
+/** ActiveStatusUpdate */
+export interface IActiveStatusUpdate {
+    /** Key Id */
+    key_id: string;
+    /** Status */
+    status: boolean;
+}
 /**
  * BaseCharSplitConfig
  * Base char split configuration class
@@ -216,11 +345,6 @@ export interface IGithubRepoCreate {
      * the space of knowledge, example: petercat bot id, github repo name
      */
     space_id: string;
-    /**
-     * Knowledge Id
-     * id of the knowledge resource (letters, numbers, hyphens and underscores allowed, max 36 chars)
-     */
-    knowledge_id?: string | null;
     /**
      * Knowledge Type
      * type of knowledge resource
@@ -297,11 +421,6 @@ export interface IImageCreate {
      * the space of knowledge, example: petercat bot id, github repo name
      */
     space_id: string;
-    /**
-     * Knowledge Id
-     * id of the knowledge resource (letters, numbers, hyphens and underscores allowed, max 36 chars)
-     */
-    knowledge_id?: string | null;
     /**
      * Knowledge Type
      * type of knowledge resource
@@ -364,11 +483,6 @@ export interface IJSONCreate {
      * the space of knowledge, example: petercat bot id, github repo name
      */
     space_id: string;
-    /**
-     * Knowledge Id
-     * id of the knowledge resource (letters, numbers, hyphens and underscores allowed, max 36 chars)
-     */
-    knowledge_id?: string | null;
     /**
      * Knowledge Type
      * type of knowledge resource
@@ -623,11 +737,6 @@ export interface IMarkdownCreate {
      * the space of knowledge, example: petercat bot id, github repo name
      */
     space_id: string;
-    /**
-     * Knowledge Id
-     * id of the knowledge resource (letters, numbers, hyphens and underscores allowed, max 36 chars)
-     */
-    knowledge_id?: string | null;
     /**
      * Knowledge Type
      * type of knowledge resource
@@ -739,11 +848,6 @@ export interface IPDFCreate {
      * the space of knowledge, example: petercat bot id, github repo name
      */
     space_id: string;
-    /**
-     * Knowledge Id
-     * id of the knowledge resource (letters, numbers, hyphens and underscores allowed, max 36 chars)
-     */
-    knowledge_id?: string | null;
     /**
      * Knowledge Type
      * type of knowledge resource
@@ -825,6 +929,40 @@ export interface IPDFSplitConfig {
      */
     table_extract_mode?: string;
 }
+/** PageQueryParams[APIKey] */
+export interface IPageQueryParamsAPIKey {
+    /**
+     * Order By
+     * order by field
+     */
+    order_by?: string | null;
+    /**
+     * Order Direction
+     * asc or desc
+     * @default "asc"
+     */
+    order_direction?: string | null;
+    /**
+     * Eq Conditions
+     * list of equality conditions, each as a dict with key and value
+     */
+    eq_conditions?: Record<string, any> | null;
+    /**
+     * Page
+     * page number
+     * @min 1
+     * @default 1
+     */
+    page?: number;
+    /**
+     * Page Size
+     * page size
+     * @min 1
+     * @max 1000
+     * @default 10
+     */
+    page_size?: number;
+}
 /** PageQueryParams[Chunk] */
 export interface IPageQueryParamsChunk {
     /**
@@ -961,6 +1099,19 @@ export interface IPageQueryParamsTask {
      */
     page_size?: number;
 }
+/** PageResponse[APIKey] */
+export interface IPageResponseAPIKey {
+    /** Items */
+    items: IAPIKey[];
+    /** Total */
+    total: number;
+    /** Page */
+    page: number;
+    /** Page Size */
+    page_size: number;
+    /** Total Pages */
+    total_pages: number;
+}
 /** PageResponse[Chunk] */
 export interface IPageResponseChunk {
     /** Items */
@@ -1013,6 +1164,14 @@ export interface IPageResponseTenant {
     /** Total Pages */
     total_pages: number;
 }
+/** Permission */
+export interface IPermission {
+    resource: IResource;
+    /** Actions */
+    actions: IAction[];
+    /** Conditions */
+    conditions?: Record<string, any> | null;
+}
 /** QACreate */
 export interface IQACreate {
     /**
@@ -1020,11 +1179,6 @@ export interface IQACreate {
      * the space of knowledge, example: petercat bot id, github repo name
      */
     space_id: string;
-    /**
-     * Knowledge Id
-     * id of the knowledge resource (letters, numbers, hyphens and underscores allowed, max 36 chars)
-     */
-    knowledge_id?: string | null;
     /**
      * Knowledge Type
      * type of knowledge resource
@@ -1089,6 +1243,14 @@ export interface IResponseModel {
     /** Message */
     message?: string | null;
 }
+/** ResponseModel[APIKey] */
+export interface IResponseModelAPIKey {
+    /** Success */
+    success: boolean;
+    data?: IAPIKey | null;
+    /** Message */
+    message?: string | null;
+}
 /** ResponseModel[Chunk] */
 export interface IResponseModelChunk {
     /** Success */
@@ -1105,6 +1267,15 @@ export interface IResponseModelKnowledge {
     /** Message */
     message?: string | null;
 }
+/** ResponseModel[List[APIKey]] */
+export interface IResponseModelListAPIKey {
+    /** Success */
+    success: boolean;
+    /** Data */
+    data?: IAPIKey[] | null;
+    /** Message */
+    message?: string | null;
+}
 /** ResponseModel[List[Knowledge]] */
 export interface IResponseModelListKnowledge {
     /** Success */
@@ -1141,6 +1312,14 @@ export interface IResponseModelNoneType {
     /** Message */
     message?: string | null;
 }
+/** ResponseModel[PageResponse[APIKey]] */
+export interface IResponseModelPageResponseAPIKey {
+    /** Success */
+    success: boolean;
+    data?: IPageResponseAPIKey | null;
+    /** Message */
+    message?: string | null;
+}
 /** ResponseModel[PageResponse[Chunk]] */
 export interface IResponseModelPageResponseChunk {
     /** Success */
@@ -1214,6 +1393,15 @@ export interface IResponseModelObject {
     /** Message */
     message?: string | null;
 }
+/** ResponseModel[str] */
+export interface IResponseModelStr {
+    /** Success */
+    success: boolean;
+    /** Data */
+    data?: string | null;
+    /** Message */
+    message?: string | null;
+}
 /** RetrievalByKnowledgeRequest */
 export interface IRetrievalByKnowledgeRequest {
     /**
@@ -1679,11 +1867,6 @@ export interface ITextCreate {
      * the space of knowledge, example: petercat bot id, github repo name
      */
     space_id: string;
-    /**
-     * Knowledge Id
-     * id of the knowledge resource (letters, numbers, hyphens and underscores allowed, max 36 chars)
-     */
-    knowledge_id?: string | null;
     /**
      * Knowledge Type
      * type of knowledge resource
@@ -1801,11 +1984,6 @@ export interface IYuqueCreate {
      * the space of knowledge, example: petercat bot id, github repo name
      */
     space_id: string;
-    /**
-     * Knowledge Id
-     * id of the knowledge resource (letters, numbers, hyphens and underscores allowed, max 36 chars)
-     */
-    knowledge_id?: string | null;
     /**
      * Knowledge Type
      * type of knowledge resource
@@ -2300,6 +2478,82 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getSpaceById: (spaceId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelSpaceResponse, void | IHTTPValidationError>>;
     };
+    rule: {
+        /**
+         * No description
+         *
+         * @tags rule
+         * @name GetGlobalRule
+         * @summary Get Global Rule
+         * @request GET:/api/rule/global
+         */
+        getGlobalRule: (params?: RequestParams) => Promise<HttpResponse<IResponseModelStr, void | IHTTPValidationError>>;
+        /**
+         * No description
+         *
+         * @tags rule
+         * @name GetSpaceRule
+         * @summary Get Space Rule
+         * @request GET:/api/rule/space/{space_id}
+         */
+        getSpaceRule: (spaceId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelStr, void | IHTTPValidationError>>;
+    };
+    apiKey: {
+        /**
+         * No description
+         *
+         * @tags api key
+         * @name CreateApiKey
+         * @summary Create Api Key
+         * @request POST:/api/api_key/create
+         */
+        createApiKey: (data: IAPIKeyCreate, params?: RequestParams) => Promise<HttpResponse<IResponseModelAPIKey, void | IHTTPValidationError>>;
+        /**
+         * No description
+         *
+         * @tags api key
+         * @name UpdateApiKey
+         * @summary Update Api Key
+         * @request POST:/api/api_key/update
+         */
+        updateApiKey: (data: IAPIKeyUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelAPIKey, void | IHTTPValidationError>>;
+        /**
+         * No description
+         *
+         * @tags api key
+         * @name GetApiKeyList
+         * @summary Get Api Key List
+         * @request POST:/api/api_key/list
+         */
+        getApiKeyList: (data: IPageQueryParamsAPIKey, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseAPIKey, void | IHTTPValidationError>>;
+        /**
+         * No description
+         *
+         * @tags api key
+         * @name DeleteApiKey
+         * @summary Delete Api Key
+         * @request DELETE:/api/api_key/delete/{key_id}
+         */
+        deleteApiKey: (keyId: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
+        /**
+         * No description
+         *
+         * @tags api key
+         * @name DeactivateApiKey
+         * @summary Change Api Key Status
+         * @request POST:/api/api_key/deactivate/{key_id}
+         */
+        deactivateApiKey: (keyId: string, data: IActiveStatusUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
+        /**
+         * No description
+         *
+         * @tags api key
+         * @name GetAllExpiredApiKeys
+         * @summary Get All Expired Api Keys
+         * @request GET:/api/api_key/expired
+         */
+        getAllExpiredApiKeys: (params?: RequestParams) => Promise<HttpResponse<IResponseModelListAPIKey, void | IHTTPValidationError>>;
+    };
     healthChecker: {
         /**
          * No description

package/dist/api.js

@@ -22,7 +22,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Api = exports.HttpClient = exports.ContentType = exports.IEmbeddingModelEnum = exports.IKnowledgeSourceEnum = exports.IKnowledgeTypeEnum = exports.ITaskStatus = void 0;
+exports.Api = exports.HttpClient = exports.ContentType = exports.IAction = exports.IEmbeddingModelEnum = exports.IKnowledgeSourceEnum = exports.IKnowledgeTypeEnum = exports.IResource = exports.ITaskStatus = void 0;
 /** TaskStatus */
 var ITaskStatus;
 (function (ITaskStatus) {
@@ -35,6 +35,19 @@ var ITaskStatus;
     ITaskStatus["PendingRetry"] = "pending_retry";
     ITaskStatus["Deleted"] = "deleted";
 })(ITaskStatus || (exports.ITaskStatus = ITaskStatus = {}));
+/** Resource */
+var IResource;
+(function (IResource) {
+    IResource["Retrieval"] = "retrieval";
+    IResource["Tenant"] = "tenant";
+    IResource["Space"] = "space";
+    IResource["Knowledge"] = "knowledge";
+    IResource["Chunk"] = "chunk";
+    IResource["ApiKey"] = "api_key";
+    IResource["Task"] = "task";
+    IResource["Rule"] = "rule";
+    IResource["Public"] = "public";
+})(IResource || (exports.IResource = IResource = {}));
 /**
  * KnowledgeTypeEnum
  * mime type of the knowledge. If multiple files are included and require a decomposer, please set the type to 'folder'
@@ -73,6 +86,15 @@ var IEmbeddingModelEnum;
     IEmbeddingModelEnum["SentenceTransformersParaphraseMultilingualMiniLML12V2"] = "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2";
     IEmbeddingModelEnum["Shibing624Text2VecBaseChinese"] = "shibing624/text2vec-base-chinese";
 })(IEmbeddingModelEnum || (exports.IEmbeddingModelEnum = IEmbeddingModelEnum = {}));
+/** Action */
+var IAction;
+(function (IAction) {
+    IAction["Create"] = "create";
+    IAction["Read"] = "read";
+    IAction["Update"] = "update";
+    IAction["Delete"] = "delete";
+    IAction["Value"] = "*";
+})(IAction || (exports.IAction = IAction = {}));
 var ContentType;
 (function (ContentType) {
     ContentType["Json"] = "application/json";
@@ -513,6 +535,82 @@ class Api extends HttpClient {
              */
             getSpaceById: (spaceId, params = {}) => this.request(Object.assign({ path: `/api/space/${spaceId}`, method: "GET", format: "json" }, params)),
         };
+        this.rule = {
+            /**
+             * No description
+             *
+             * @tags rule
+             * @name GetGlobalRule
+             * @summary Get Global Rule
+             * @request GET:/api/rule/global
+             */
+            getGlobalRule: (params = {}) => this.request(Object.assign({ path: `/api/rule/global`, method: "GET", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags rule
+             * @name GetSpaceRule
+             * @summary Get Space Rule
+             * @request GET:/api/rule/space/{space_id}
+             */
+            getSpaceRule: (spaceId, params = {}) => this.request(Object.assign({ path: `/api/rule/space/${spaceId}`, method: "GET", format: "json" }, params)),
+        };
+        this.apiKey = {
+            /**
+             * No description
+             *
+             * @tags api key
+             * @name CreateApiKey
+             * @summary Create Api Key
+             * @request POST:/api/api_key/create
+             */
+            createApiKey: (data, params = {}) => this.request(Object.assign({ path: `/api/api_key/create`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags api key
+             * @name UpdateApiKey
+             * @summary Update Api Key
+             * @request POST:/api/api_key/update
+             */
+            updateApiKey: (data, params = {}) => this.request(Object.assign({ path: `/api/api_key/update`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags api key
+             * @name GetApiKeyList
+             * @summary Get Api Key List
+             * @request POST:/api/api_key/list
+             */
+            getApiKeyList: (data, params = {}) => this.request(Object.assign({ path: `/api/api_key/list`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags api key
+             * @name DeleteApiKey
+             * @summary Delete Api Key
+             * @request DELETE:/api/api_key/delete/{key_id}
+             */
+            deleteApiKey: (keyId, params = {}) => this.request(Object.assign({ path: `/api/api_key/delete/${keyId}`, method: "DELETE", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags api key
+             * @name DeactivateApiKey
+             * @summary Change Api Key Status
+             * @request POST:/api/api_key/deactivate/{key_id}
+             */
+            deactivateApiKey: (keyId, data, params = {}) => this.request(Object.assign({ path: `/api/api_key/deactivate/${keyId}`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags api key
+             * @name GetAllExpiredApiKeys
+             * @summary Get All Expired Api Keys
+             * @request GET:/api/api_key/expired
+             */
+            getAllExpiredApiKeys: (params = {}) => this.request(Object.assign({ path: `/api/api_key/expired`, method: "GET", format: "json" }, params)),
+        };
         this.healthChecker = {
             /**
              * No description

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@petercatai/whisker-client",
-    "version": "0.1.202505220227-dev",
+    "version": "0.1.202505281015-dev",
     "description": "Generated API client (preview)",
     "main": "dist/api.js",
     "types": "dist/api.d.ts",
@@ -16,7 +16,7 @@
         "tag": "dev"
     },
     "devDependencies": {
-        "@types/node": "^22.15.21",
+        "@types/node": "^22.15.23",
         "axios": "^1.9.0",
         "typescript": "^5.8.3"
     }