@petercatai/whisker-client 3.0.0 → 3.0.202603061556

package/dist/api.d.ts

@@ -256,11 +256,12 @@ export declare enum IKnowledgeSourceEnum {
     CloudStorageText = "cloud_storage_text",
     CloudStorageFile = "cloud_storage_file",
     CloudStorageImage = "cloud_storage_image",
-    Os = "os",
+    Virtual = "virtual",
     Yuque = "yuque",
     YuquePersonalDoc = "yuque_personal_doc",
     YuquePersonalNote = "yuque_personal_note",
-    HituNodePackage = "hitu_node_package"
+    HituNodePackage = "hitu_node_package",
+    Webpage = "webpage"
 }
 /** CliChangeOp */
 export declare enum ICliChangeOp {
@@ -1208,6 +1209,7 @@ export interface ICliApplyResultItem {
     knowledge_type?: string | null;
     /** Message */
     message?: string | null;
+    sync_item_after?: ISyncSnapshotItem | null;
 }
 /** CliChangesetEntry */
 export interface ICliChangesetEntry {
@@ -1246,6 +1248,64 @@ export interface ICondition {
     /** Value */
     value: any;
 }
+/**
+ * DocxCreate
+ * Word 文档创建 DTO - 通过 markitdown 转换为 Markdown 后处理
+ */
+export interface IDocxCreate {
+    /**
+     * Space Id
+     * the space of knowledge, example: petercat bot id, github repo name
+     */
+    space_id: string;
+    /**
+     * Knowledge Type
+     * type of knowledge resource
+     * @default "docx"
+     */
+    knowledge_type?: "docx";
+    /**
+     * Knowledge Name
+     * name of the knowledge resource
+     * @maxLength 255
+     */
+    knowledge_name: string;
+    /**
+     * Metadata
+     * additional metadata, user can update it
+     * @default {}
+     */
+    metadata?: Record<string, any>;
+    /** source type */
+    source_type: IKnowledgeSourceEnum;
+    /**
+     * Embedding Model Name
+     * name of the embedding model. you can set any other model if target embedding service registered
+     */
+    embedding_model_name: string;
+    /**
+     * File Sha
+     * SHA of the file
+     */
+    file_sha: string;
+    /**
+     * File Size
+     * Byte size of the file
+     */
+    file_size: number;
+    /**
+     * Parent Id
+     * parent id of the knowledge
+     */
+    parent_id?: string | null;
+    /**
+     * Source Config
+     * source config of the knowledge
+     */
+    source_config: IOpenUrlSourceConfig | IOpenIdSourceConfig | IS3SourceConfig;
+    /** split config of the knowledge (markdown after markitdown conversion) */
+    split_config: IMarkdownSplitConfig;
+}
 /** EnableStatusUpdate */
 export interface IEnableStatusUpdate {
     /** Knowledge Id */
@@ -1319,10 +1379,10 @@ export interface IFolderCreate {
     metadata?: Record<string, any>;
     /**
      * Source Type
-     * folder source type
-     * @default "os"
+     * virtual source type for folder knowledge
+     * @default "virtual"
      */
-    source_type?: "os";
+    source_type?: "virtual";
     /**
      * Embedding Model Name
      * name of the embedding model. you can set any other model if target embedding service registered
@@ -2860,12 +2920,12 @@ export interface IPDFCreate {
      * File Sha
      * SHA of the file
      */
-    file_sha?: string | null;
+    file_sha: string;
     /**
      * File Size
      * Byte size of the file
      */
-    file_size?: number | null;
+    file_size: number;
     /**
      * Parent Id
      * parent id of the knowledge
@@ -5035,6 +5095,8 @@ export interface ISyncMaterializeItem {
     source_locator?: Record<string, any> | null;
     /** Materialize Error */
     materialize_error?: string | null;
+    /** Remote Revision */
+    remote_revision?: string | null;
 }
 /** SyncMaterializeRequest */
 export interface ISyncMaterializeRequest {
@@ -5042,6 +5104,8 @@ export interface ISyncMaterializeRequest {
     space_id: string;
     /** Knowledge Ids */
     knowledge_ids?: string[];
+    /** Expected Snapshot Token */
+    expected_snapshot_token?: string | null;
 }
 /** SyncSnapshotData */
 export interface ISyncSnapshotData {
@@ -5072,6 +5136,8 @@ export interface ISyncSnapshotItem {
     metadata_digest?: string | null;
     /** Parent Id */
     parent_id?: string | null;
+    /** Remote Revision */
+    remote_revision?: string | null;
 }
 /** Tag */
 export interface ITag {
@@ -5350,6 +5416,17 @@ export interface ITenantCreate {
     email: string;
     /** Metadata */
     metadata?: Record<string, any> | null;
+    /**
+     * Notify
+     * 是否发送邮件通知，默认 true
+     * @default true
+     */
+    notify?: boolean;
+    /**
+     * Tenant Id
+     * 租户ID（可选），支持字母、数字、下划线、中划线
+     */
+    tenant_id?: string | null;
 }
 /** TenantLog */
 export interface ITenantLog {
@@ -5779,8 +5856,12 @@ export interface IWebpageCreate {
      * @default {}
      */
     metadata?: Record<string, any>;
-    /** source type */
-    source_type: IKnowledgeSourceEnum;
+    /**
+     * Source Type
+     * source type
+     * @default "webpage"
+     */
+    source_type?: "webpage";
     /**
      * Embedding Model Name
      * name of the embedding model. you can set any other model if target embedding service registered
@@ -6086,7 +6167,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @summary Add Knowledge
          * @request POST:/api/knowledge/add
          */
-        addKnowledge: (data: (ITextCreate | IImageCreate | IJSONCreate | IMarkdownCreate | IPDFCreate | IPowerPointCreate | IWebpageCreate | IGithubRepoCreate | IQACreate | IYuqueCreate | IHituNodePackageCreate | IHituNodePackageElementCreate | IFolderCreate)[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListKnowledge, void | IHTTPValidationError>>;
+        addKnowledge: (data: (ITextCreate | IImageCreate | IJSONCreate | IMarkdownCreate | IPDFCreate | IDocxCreate | IPowerPointCreate | IWebpageCreate | IGithubRepoCreate | IQACreate | IYuqueCreate | IHituNodePackageCreate | IHituNodePackageElementCreate | IFolderCreate)[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListKnowledge, void | IHTTPValidationError>>;
         /**
          * @description 更新知识（全量更新） 更新知识的完整信息，支持以下字段变更： - 元数据(metadata)变更：同步更新对应 chunk 的 metadata - 启用状态(enabled)变更：同步更新对应 chunk 的启用状态 - 嵌入模型/分片配置/来源配置变更：自动触发重新入库任务 注意：knowledge_type、source_type 等核心字段不可变更。 Args: knowledge: 完整的知识对象，需包含 knowledge_id Returns: 更新后的知识对象（auth_info 字段已脱敏）
          *
@@ -6448,7 +6529,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         checkTenantName: (data: ITenantNameCheckRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelTenantNameCheckResponse, void | IHTTPValidationError>>;
         /**
-         * @description 创建租户 创建新租户并自动生成认证密钥（secret_key）： - tenant_id 和 secret_key 由系统自动生成 - secret_key 仅在创建时返回一次，后续无法再次获取，请妥善保存 - 创建成功后会发送通知邮件到指定邮箱 Args: params.tenant_name: 租户名称，必须唯一 params.email: 联系邮箱，用于接收通知 params.metadata: 自定义元数据（可选） Returns: 创建的租户信息，包含 secret_key（仅此一次） Raises: 400: 租户名称已存在
+         * @description 创建租户 创建新租户并自动生成认证密钥（secret_key）： - tenant_id 可自定义或由系统自动生成 - secret_key 由系统自动生成，仅在创建时返回一次 - 创建成功后根据 notify 参数决定是否发送通知邮件 Args: params.tenant_name: 租户名称，必须唯一 params.email: 联系邮箱，用于接收通知 params.metadata: 自定义元数据（可选） params.notify: 是否发送邮件通知，默认 true params.tenant_id: 自定义租户ID（可选），支持字母、数字、下划线、中划线 Returns: 创建的租户信息，包含 secret_key（仅此一次） Raises: 400: 租户名称或ID已存在
          *
          * @tags tenant
          * @name CreateTenant

package/dist/api.js

@@ -301,11 +301,12 @@ var IKnowledgeSourceEnum;
     IKnowledgeSourceEnum["CloudStorageText"] = "cloud_storage_text";
     IKnowledgeSourceEnum["CloudStorageFile"] = "cloud_storage_file";
     IKnowledgeSourceEnum["CloudStorageImage"] = "cloud_storage_image";
-    IKnowledgeSourceEnum["Os"] = "os";
+    IKnowledgeSourceEnum["Virtual"] = "virtual";
     IKnowledgeSourceEnum["Yuque"] = "yuque";
     IKnowledgeSourceEnum["YuquePersonalDoc"] = "yuque_personal_doc";
     IKnowledgeSourceEnum["YuquePersonalNote"] = "yuque_personal_note";
     IKnowledgeSourceEnum["HituNodePackage"] = "hitu_node_package";
+    IKnowledgeSourceEnum["Webpage"] = "webpage";
 })(IKnowledgeSourceEnum || (exports.IKnowledgeSourceEnum = IKnowledgeSourceEnum = {}));
 /** CliChangeOp */
 var ICliChangeOp;
@@ -845,7 +846,7 @@ class Api extends HttpClient {
              */
             checkTenantName: (data, params = {}) => this.request(Object.assign({ path: `/api/tenant/check-name`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
             /**
-             * @description 创建租户 创建新租户并自动生成认证密钥（secret_key）： - tenant_id 和 secret_key 由系统自动生成 - secret_key 仅在创建时返回一次，后续无法再次获取，请妥善保存 - 创建成功后会发送通知邮件到指定邮箱 Args: params.tenant_name: 租户名称，必须唯一 params.email: 联系邮箱，用于接收通知 params.metadata: 自定义元数据（可选） Returns: 创建的租户信息，包含 secret_key（仅此一次） Raises: 400: 租户名称已存在
+             * @description 创建租户 创建新租户并自动生成认证密钥（secret_key）： - tenant_id 可自定义或由系统自动生成 - secret_key 由系统自动生成，仅在创建时返回一次 - 创建成功后根据 notify 参数决定是否发送通知邮件 Args: params.tenant_name: 租户名称，必须唯一 params.email: 联系邮箱，用于接收通知 params.metadata: 自定义元数据（可选） params.notify: 是否发送邮件通知，默认 true params.tenant_id: 自定义租户ID（可选），支持字母、数字、下划线、中划线 Returns: 创建的租户信息，包含 secret_key（仅此一次） Raises: 400: 租户名称或ID已存在
              *
              * @tags tenant
              * @name CreateTenant

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@petercatai/whisker-client",
-    "version": "3.0.0",
+    "version": "3.0.202603061556",
     "description": "Generated API client (Production)",
     "main": "dist/api.js",
     "types": "dist/api.d.ts",
@@ -16,7 +16,7 @@
         "tag": "latest"
     },
     "devDependencies": {
-        "@types/node": "^25.3.3",
+        "@types/node": "^25.3.5",
         "axios": "^1.13.6",
         "typescript": "^5.9.3"
     }