@petercatai/whisker-client 0.1.202512041323 → 0.1.202512231541
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.d.ts +182 -26
- package/dist/api.js +47 -17
- package/package.json +2 -2
package/dist/api.d.ts
CHANGED
|
@@ -113,7 +113,9 @@ export declare enum IKnowledgeTypeEnum {
|
|
|
113
113
|
Perl = "perl",
|
|
114
114
|
Haskell = "haskell",
|
|
115
115
|
Elixir = "elixir",
|
|
116
|
-
Powershell = "powershell"
|
|
116
|
+
Powershell = "powershell",
|
|
117
|
+
NodePackage = "node_package",
|
|
118
|
+
NodePackageElement = "node_package_element"
|
|
117
119
|
}
|
|
118
120
|
/**
|
|
119
121
|
* KnowledgeSourceEnum
|
|
@@ -127,7 +129,8 @@ export declare enum IKnowledgeSourceEnum {
|
|
|
127
129
|
CloudStorageImage = "cloud_storage_image",
|
|
128
130
|
Yuque = "yuque",
|
|
129
131
|
YuquePersonalDoc = "yuque_personal_doc",
|
|
130
|
-
YuquePersonalNote = "yuque_personal_note"
|
|
132
|
+
YuquePersonalNote = "yuque_personal_note",
|
|
133
|
+
HituNodePackage = "hitu_node_package"
|
|
131
134
|
}
|
|
132
135
|
/** Action */
|
|
133
136
|
export declare enum IAction {
|
|
@@ -828,6 +831,21 @@ export interface IEnableStatusUpdate {
|
|
|
828
831
|
/** Status */
|
|
829
832
|
status: boolean;
|
|
830
833
|
}
|
|
834
|
+
/** FilterFieldsUpdate */
|
|
835
|
+
export interface IFilterFieldsUpdate {
|
|
836
|
+
/** Knowledge Id */
|
|
837
|
+
knowledge_id: string;
|
|
838
|
+
/** F1 */
|
|
839
|
+
f1?: string | null;
|
|
840
|
+
/** F2 */
|
|
841
|
+
f2?: string | null;
|
|
842
|
+
/** F3 */
|
|
843
|
+
f3?: string | null;
|
|
844
|
+
/** F4 */
|
|
845
|
+
f4?: string | null;
|
|
846
|
+
/** F5 */
|
|
847
|
+
f5?: string | null;
|
|
848
|
+
}
|
|
831
849
|
/** FilterGroup */
|
|
832
850
|
export interface IFilterGroup {
|
|
833
851
|
operator: IOperator;
|
|
@@ -1030,6 +1048,62 @@ export interface IHTTPValidationError {
|
|
|
1030
1048
|
/** Detail */
|
|
1031
1049
|
detail?: IValidationError[];
|
|
1032
1050
|
}
|
|
1051
|
+
/** HituNodePackageCreate */
|
|
1052
|
+
export interface IHituNodePackageCreate {
|
|
1053
|
+
/**
|
|
1054
|
+
* Space Id
|
|
1055
|
+
* the space of knowledge, example: petercat bot id, github repo name
|
|
1056
|
+
*/
|
|
1057
|
+
space_id: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* Knowledge Type
|
|
1060
|
+
* type of knowledge resource
|
|
1061
|
+
* @default "node_package"
|
|
1062
|
+
*/
|
|
1063
|
+
knowledge_type?: "node_package";
|
|
1064
|
+
/**
|
|
1065
|
+
* Knowledge Name
|
|
1066
|
+
* name of the knowledge resource
|
|
1067
|
+
* @maxLength 255
|
|
1068
|
+
*/
|
|
1069
|
+
knowledge_name: string;
|
|
1070
|
+
/**
|
|
1071
|
+
* Metadata
|
|
1072
|
+
* additional metadata, user can update it
|
|
1073
|
+
* @default {}
|
|
1074
|
+
*/
|
|
1075
|
+
metadata?: Record<string, any>;
|
|
1076
|
+
/**
|
|
1077
|
+
* Source Type
|
|
1078
|
+
* source type
|
|
1079
|
+
* @default "hitu_node_package"
|
|
1080
|
+
*/
|
|
1081
|
+
source_type?: "hitu_node_package";
|
|
1082
|
+
/**
|
|
1083
|
+
* Embedding Model Name
|
|
1084
|
+
* name of the embedding model. you can set any other model if target embedding service registered
|
|
1085
|
+
*/
|
|
1086
|
+
embedding_model_name: string;
|
|
1087
|
+
/**
|
|
1088
|
+
* File Sha
|
|
1089
|
+
* SHA of the file
|
|
1090
|
+
*/
|
|
1091
|
+
file_sha?: string | null;
|
|
1092
|
+
/**
|
|
1093
|
+
* File Size
|
|
1094
|
+
* size of the file
|
|
1095
|
+
*/
|
|
1096
|
+
file_size?: number | null;
|
|
1097
|
+
/**
|
|
1098
|
+
* Parent Id
|
|
1099
|
+
* parent id of the knowledge
|
|
1100
|
+
*/
|
|
1101
|
+
parent_id?: string | null;
|
|
1102
|
+
/** source config of the knowledge */
|
|
1103
|
+
source_config: INodePackageSourceConfig;
|
|
1104
|
+
/** split config of the knowledge */
|
|
1105
|
+
split_config: INodePackageParseConfig;
|
|
1106
|
+
}
|
|
1033
1107
|
/** Image */
|
|
1034
1108
|
export interface IImage {
|
|
1035
1109
|
/** Url */
|
|
@@ -1236,7 +1310,7 @@ export interface IKnowledgeInput {
|
|
|
1236
1310
|
* Source Config
|
|
1237
1311
|
* source config of the knowledge
|
|
1238
1312
|
*/
|
|
1239
|
-
source_config: IGithubRepoSourceConfig | IGithubFileSourceConfig | IS3SourceConfig | IOpenUrlSourceConfig | ITextSourceConfig | IYuqueSourceConfig | IYuquePersonalDocSourceConfig | IYuquePersonalNoteSourceConfig;
|
|
1313
|
+
source_config: IGithubRepoSourceConfig | IGithubFileSourceConfig | IS3SourceConfig | IOpenUrlSourceConfig | ITextSourceConfig | IYuqueSourceConfig | IYuquePersonalDocSourceConfig | IYuquePersonalNoteSourceConfig | INodePackageSourceConfig;
|
|
1240
1314
|
/**
|
|
1241
1315
|
* Embedding Model Name
|
|
1242
1316
|
* name of the embedding model. you can set any other model if target embedding service registered
|
|
@@ -1246,7 +1320,7 @@ export interface IKnowledgeInput {
|
|
|
1246
1320
|
* Split Config
|
|
1247
1321
|
* configuration for splitting the knowledge
|
|
1248
1322
|
*/
|
|
1249
|
-
split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | ITextSplitConfig | IJSONSplitConfig | IPDFSplitConfig | IYuqueSplitConfig | IGeaGraphSplitConfig | IGithubRepoParseConfig | IBaseCodeSplitConfig | IImageSplitConfig;
|
|
1323
|
+
split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | ITextSplitConfig | IJSONSplitConfig | IPDFSplitConfig | IYuqueSplitConfig | IGeaGraphSplitConfig | IGithubRepoParseConfig | IBaseCodeSplitConfig | IImageSplitConfig | INodePackageParseConfig;
|
|
1250
1324
|
/**
|
|
1251
1325
|
* File Sha
|
|
1252
1326
|
* SHA of the file
|
|
@@ -1322,7 +1396,7 @@ export interface IKnowledgeOutput {
|
|
|
1322
1396
|
* Source Config
|
|
1323
1397
|
* source config of the knowledge
|
|
1324
1398
|
*/
|
|
1325
|
-
source_config: IGithubRepoSourceConfig | IGithubFileSourceConfig | IS3SourceConfig | IOpenUrlSourceConfig | ITextSourceConfig | IYuqueSourceConfig | IYuquePersonalDocSourceConfig | IYuquePersonalNoteSourceConfig;
|
|
1399
|
+
source_config: IGithubRepoSourceConfig | IGithubFileSourceConfig | IS3SourceConfig | IOpenUrlSourceConfig | ITextSourceConfig | IYuqueSourceConfig | IYuquePersonalDocSourceConfig | IYuquePersonalNoteSourceConfig | INodePackageSourceConfig;
|
|
1326
1400
|
/**
|
|
1327
1401
|
* Embedding Model Name
|
|
1328
1402
|
* name of the embedding model. you can set any other model if target embedding service registered
|
|
@@ -1332,7 +1406,7 @@ export interface IKnowledgeOutput {
|
|
|
1332
1406
|
* Split Config
|
|
1333
1407
|
* configuration for splitting the knowledge
|
|
1334
1408
|
*/
|
|
1335
|
-
split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | ITextSplitConfig | IJSONSplitConfig | IPDFSplitConfig | IYuqueSplitConfig | IGeaGraphSplitConfig | IGithubRepoParseConfig | IBaseCodeSplitConfig | IImageSplitConfig;
|
|
1409
|
+
split_config: IBaseCharSplitConfig | IMarkdownSplitConfig | ITextSplitConfig | IJSONSplitConfig | IPDFSplitConfig | IYuqueSplitConfig | IGeaGraphSplitConfig | IGithubRepoParseConfig | IBaseCodeSplitConfig | IImageSplitConfig | INodePackageParseConfig;
|
|
1336
1410
|
/**
|
|
1337
1411
|
* File Sha
|
|
1338
1412
|
* SHA of the file
|
|
@@ -1471,6 +1545,30 @@ export interface IMarkdownSplitConfig {
|
|
|
1471
1545
|
*/
|
|
1472
1546
|
extract_header_first?: boolean | null;
|
|
1473
1547
|
}
|
|
1548
|
+
/** NodePackageParseConfig */
|
|
1549
|
+
export interface INodePackageParseConfig {
|
|
1550
|
+
/**
|
|
1551
|
+
* Type
|
|
1552
|
+
* @default "node_package"
|
|
1553
|
+
*/
|
|
1554
|
+
type?: "node_package";
|
|
1555
|
+
}
|
|
1556
|
+
/**
|
|
1557
|
+
* NodePackageSourceConfig
|
|
1558
|
+
* Node package source config
|
|
1559
|
+
*/
|
|
1560
|
+
export interface INodePackageSourceConfig {
|
|
1561
|
+
/**
|
|
1562
|
+
* Package Name
|
|
1563
|
+
* the hitu package id
|
|
1564
|
+
*/
|
|
1565
|
+
package_name: string;
|
|
1566
|
+
/**
|
|
1567
|
+
* Package Version
|
|
1568
|
+
* the hitu package version
|
|
1569
|
+
*/
|
|
1570
|
+
package_version: string;
|
|
1571
|
+
}
|
|
1474
1572
|
/** OpenIdSourceConfig */
|
|
1475
1573
|
export interface IOpenIdSourceConfig {
|
|
1476
1574
|
/**
|
|
@@ -2437,6 +2535,14 @@ export interface IResponseModelTask {
|
|
|
2437
2535
|
/** Message */
|
|
2438
2536
|
message?: string | null;
|
|
2439
2537
|
}
|
|
2538
|
+
/** ResponseModel[TenantNameCheckResponse] */
|
|
2539
|
+
export interface IResponseModelTenantNameCheckResponse {
|
|
2540
|
+
/** Success */
|
|
2541
|
+
success: boolean;
|
|
2542
|
+
data?: ITenantNameCheckResponse | null;
|
|
2543
|
+
/** Message */
|
|
2544
|
+
message?: string | null;
|
|
2545
|
+
}
|
|
2440
2546
|
/** ResponseModel[Tenant] */
|
|
2441
2547
|
export interface IResponseModelTenant {
|
|
2442
2548
|
/** Success */
|
|
@@ -3294,6 +3400,13 @@ export interface ITaggingCreate {
|
|
|
3294
3400
|
*/
|
|
3295
3401
|
object_id: string;
|
|
3296
3402
|
}
|
|
3403
|
+
/** TagsUpdate */
|
|
3404
|
+
export interface ITagsUpdate {
|
|
3405
|
+
/** Knowledge Id */
|
|
3406
|
+
knowledge_id: string;
|
|
3407
|
+
/** Tags */
|
|
3408
|
+
tags: string[];
|
|
3409
|
+
}
|
|
3297
3410
|
/** Task */
|
|
3298
3411
|
export interface ITaskInput {
|
|
3299
3412
|
/**
|
|
@@ -3542,6 +3655,22 @@ export interface ITenantLogQuery {
|
|
|
3542
3655
|
/** End Time */
|
|
3543
3656
|
end_time?: string | null;
|
|
3544
3657
|
}
|
|
3658
|
+
/** TenantNameCheckRequest */
|
|
3659
|
+
export interface ITenantNameCheckRequest {
|
|
3660
|
+
/**
|
|
3661
|
+
* Tenant Name
|
|
3662
|
+
* @minLength 1
|
|
3663
|
+
* @maxLength 100
|
|
3664
|
+
*/
|
|
3665
|
+
tenant_name: string;
|
|
3666
|
+
}
|
|
3667
|
+
/** TenantNameCheckResponse */
|
|
3668
|
+
export interface ITenantNameCheckResponse {
|
|
3669
|
+
/** Available */
|
|
3670
|
+
available: boolean;
|
|
3671
|
+
/** Message */
|
|
3672
|
+
message: string;
|
|
3673
|
+
}
|
|
3545
3674
|
/** TenantUpdate */
|
|
3546
3675
|
export interface ITenantUpdate {
|
|
3547
3676
|
/** Tenant Name */
|
|
@@ -3713,7 +3842,7 @@ export interface IYuqueCreate {
|
|
|
3713
3842
|
* type of knowledge resource
|
|
3714
3843
|
* @default "yuquedoc"
|
|
3715
3844
|
*/
|
|
3716
|
-
knowledge_type?: "yuquedoc";
|
|
3845
|
+
knowledge_type?: "yuquedoc" | "yuque_book";
|
|
3717
3846
|
/**
|
|
3718
3847
|
* Knowledge Name
|
|
3719
3848
|
* name of the knowledge resource
|
|
@@ -3756,7 +3885,7 @@ export interface IYuqueCreate {
|
|
|
3756
3885
|
* Source Config
|
|
3757
3886
|
* source config of the knowledge
|
|
3758
3887
|
*/
|
|
3759
|
-
source_config: IYuqueSourceConfig |
|
|
3888
|
+
source_config: IYuqueSourceConfig | IYuquePersonalDocSourceConfig | IYuquePersonalNoteSourceConfig;
|
|
3760
3889
|
/**
|
|
3761
3890
|
* Split Config
|
|
3762
3891
|
* split config of the knowledge
|
|
@@ -3947,16 +4076,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3947
4076
|
};
|
|
3948
4077
|
knowledge: {
|
|
3949
4078
|
/**
|
|
3950
|
-
* @description
|
|
4079
|
+
* @description 批量添加知识 支持批量创建知识条目,自动处理重复检测和增量更新: - 根据 space_id + knowledge_name + knowledge_type 判断知识唯一性 - 若知识不存在则新增;若存在但 file_sha 不同则删除旧版本后重新添加 - 若知识已存在且内容相同则跳过,返回空列表 创建成功后自动触发异步处理任务(如向量化入库)。 Args: body: 知识创建请求列表,支持多种来源类型(文件、URL、语雀等) Returns: 成功创建的知识列表,已存在且未变更的知识不会返回
|
|
3951
4080
|
*
|
|
3952
4081
|
* @tags knowledge
|
|
3953
4082
|
* @name AddKnowledge
|
|
3954
4083
|
* @summary Add Knowledge
|
|
3955
4084
|
* @request POST:/api/knowledge/add
|
|
3956
4085
|
*/
|
|
3957
|
-
addKnowledge: (data: (ITextCreate | IImageCreate | IJSONCreate | IMarkdownCreate | IPDFCreate | IGithubRepoCreate | IQACreate | IYuqueCreate)[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListKnowledge, void | IHTTPValidationError>>;
|
|
4086
|
+
addKnowledge: (data: (ITextCreate | IImageCreate | IJSONCreate | IMarkdownCreate | IPDFCreate | IGithubRepoCreate | IQACreate | IYuqueCreate | IHituNodePackageCreate)[], params?: RequestParams) => Promise<HttpResponse<IResponseModelListKnowledge, void | IHTTPValidationError>>;
|
|
3958
4087
|
/**
|
|
3959
|
-
* @description
|
|
4088
|
+
* @description 更新知识(全量更新) 更新知识的完整信息,支持以下字段变更: - 元数据(metadata)变更:同步更新对应 chunk 的 metadata - 启用状态(enabled)变更:同步更新对应 chunk 的启用状态 - 嵌入模型/分片配置/来源配置变更:自动触发重新入库任务 注意:knowledge_type、source_type 等核心字段不可变更。 Args: knowledge: 完整的知识对象,需包含 knowledge_id Returns: 更新后的知识对象(auth_info 字段已脱敏)
|
|
3960
4089
|
*
|
|
3961
4090
|
* @tags knowledge
|
|
3962
4091
|
* @name UpdateKnowledge
|
|
@@ -3965,7 +4094,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3965
4094
|
*/
|
|
3966
4095
|
updateKnowledge: (data: IKnowledgeInput, params?: RequestParams) => Promise<HttpResponse<IResponseModelKnowledge, void | IHTTPValidationError>>;
|
|
3967
4096
|
/**
|
|
3968
|
-
* @description 更新知识启用状态
|
|
4097
|
+
* @description 更新知识启用状态 单独更新知识的启用/禁用状态,同步更新向量数据库中对应 chunk 的启用状态。 禁用后的知识在召回时将被过滤。 Args: body.knowledge_id: 知识ID body.status: True 启用,False 禁用
|
|
3969
4098
|
*
|
|
3970
4099
|
* @tags knowledge
|
|
3971
4100
|
* @name UpdateKnowledgeEnableStatus
|
|
@@ -3974,7 +4103,25 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3974
4103
|
*/
|
|
3975
4104
|
updateKnowledgeEnableStatus: (data: IEnableStatusUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
|
|
3976
4105
|
/**
|
|
3977
|
-
* @description
|
|
4106
|
+
* @description 更新知识标签 更新知识的标签列表,同步更新向量数据库中对应 chunk 的 tags 字段。 标签可用于召回时的过滤条件。 Args: body.knowledge_id: 知识ID body.tags: 新的标签列表,将完全替换原有标签 Returns: 更新后的知识对象(auth_info 字段已脱敏)
|
|
4107
|
+
*
|
|
4108
|
+
* @tags knowledge
|
|
4109
|
+
* @name UpdateKnowledgeTags
|
|
4110
|
+
* @summary Update Knowledge Tags
|
|
4111
|
+
* @request POST:/api/knowledge/update/tags
|
|
4112
|
+
*/
|
|
4113
|
+
updateKnowledgeTags: (data: ITagsUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelKnowledge, void | IHTTPValidationError>>;
|
|
4114
|
+
/**
|
|
4115
|
+
* @description 更新知识自定义过滤字段 更新知识的自定义过滤字段(f1-f5),同步更新向量数据库中对应 chunk 的字段。 这些字段可用于召回时的精确过滤条件。 Args: body.knowledge_id: 知识ID body.f1-f5: 自定义过滤字段,None 表示保持原值不变,至少需提供一个非空字段 Returns: 更新后的知识对象(auth_info 字段已脱敏)
|
|
4116
|
+
*
|
|
4117
|
+
* @tags knowledge
|
|
4118
|
+
* @name UpdateKnowledgeFilterFields
|
|
4119
|
+
* @summary Update Knowledge Filter Fields
|
|
4120
|
+
* @request POST:/api/knowledge/update/filter_fields
|
|
4121
|
+
*/
|
|
4122
|
+
updateKnowledgeFilterFields: (data: IFilterFieldsUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelKnowledge, void | IHTTPValidationError>>;
|
|
4123
|
+
/**
|
|
4124
|
+
* @description 分页查询知识列表 支持灵活的查询条件: - eq_conditions: 等值查询条件,如 {"space_id": "xxx", "enabled": true} - advanced_filter: 高级过滤条件,支持 AND/OR 组合及多种比较操作符 - order_by/order_direction: 排序字段和方向 Args: body: 分页查询参数,包含 page、page_size 和过滤条件 Returns: 分页结果,包含 items、total、page、page_size、total_pages
|
|
3978
4125
|
*
|
|
3979
4126
|
* @tags knowledge
|
|
3980
4127
|
* @name GetKnowledgeList
|
|
@@ -3983,7 +4130,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3983
4130
|
*/
|
|
3984
4131
|
getKnowledgeList: (data: IPageQueryParamsKnowledge, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseKnowledge, void | IHTTPValidationError>>;
|
|
3985
4132
|
/**
|
|
3986
|
-
* @description
|
|
4133
|
+
* @description 获取知识详情 根据知识ID获取完整的知识信息,包含元数据、配置等所有字段。 Args: knowledge_id: 知识ID Returns: 知识详情(auth_info 字段已脱敏) Raises: 404: 知识不存在
|
|
3987
4134
|
*
|
|
3988
4135
|
* @tags knowledge
|
|
3989
4136
|
* @name GetKnowledgeById
|
|
@@ -3995,7 +4142,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3995
4142
|
knowledge_id: string;
|
|
3996
4143
|
}, params?: RequestParams) => Promise<HttpResponse<IResponseModelKnowledge, void | IHTTPValidationError>>;
|
|
3997
4144
|
/**
|
|
3998
|
-
* @description 删除知识
|
|
4145
|
+
* @description 删除知识 级联删除知识及其关联数据: - 删除 MySQL 中的知识记录和相关任务 - 删除向量数据库中的所有 chunk 数据 - 清除所属 Space 的总结时间标记(下次总结时将进行全量总结) Args: knowledge_id: 要删除的知识ID Raises: 404: 知识不存在
|
|
3999
4146
|
*
|
|
4000
4147
|
* @tags knowledge
|
|
4001
4148
|
* @name DeleteKnowledge
|
|
@@ -4007,7 +4154,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4007
4154
|
knowledge_id: string;
|
|
4008
4155
|
}, params?: RequestParams) => Promise<HttpResponse<IResponseModelNoneType, void | IHTTPValidationError>>;
|
|
4009
4156
|
/**
|
|
4010
|
-
*
|
|
4157
|
+
* @description 获取可用的嵌入模型列表 返回系统中所有已注册的嵌入模型及其元数据信息, 用于创建知识时选择合适的向量化模型。 Returns: 模型列表,每项包含 name(模型标识)和 metadata(模型元数据)
|
|
4011
4158
|
*
|
|
4012
4159
|
* @tags knowledge
|
|
4013
4160
|
* @name GetEmbeddingModelsList
|
|
@@ -4016,7 +4163,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4016
4163
|
*/
|
|
4017
4164
|
getEmbeddingModelsList: (params?: RequestParams) => Promise<HttpResponse<any, void | IHTTPValidationError>>;
|
|
4018
4165
|
/**
|
|
4019
|
-
* @description
|
|
4166
|
+
* @description 根据名称批量查询知识 在指定 Space 下,根据知识名称列表批量查询知识详情。 适用于已知知识名称需要获取完整信息的场景。 Args: body.space_id: 空间ID body.knowledge_names: 知识名称列表 Returns: 符合条件的知识列表(auth_info 字段已脱敏)
|
|
4020
4167
|
*
|
|
4021
4168
|
* @tags knowledge
|
|
4022
4169
|
* @name BatchQueryKnowledgeByNames
|
|
@@ -4025,7 +4172,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4025
4172
|
*/
|
|
4026
4173
|
batchQueryKnowledgeByNames: (data: IBatchQueryRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelListKnowledge, void | IHTTPValidationError>>;
|
|
4027
4174
|
/**
|
|
4028
|
-
* @description
|
|
4175
|
+
* @description 获取知识原文内容 加载知识的原始内容,根据知识来源类型采用不同策略: - GitHub 类型:从已入库的 chunk 中合并还原原文 - 其他类型:通过对应的 Loader 重新加载原始内容 Args: knowledge_id: 知识ID Returns: 原文内容列表,可能包含 Text(文本)、Image(图片)或 Blob(二进制)类型 Raises: 404: 知识不存在 400: 未注册对应类型的 Loader
|
|
4029
4176
|
*
|
|
4030
4177
|
* @tags knowledge
|
|
4031
4178
|
* @name GetKnowledgeOriginalContent
|
|
@@ -4039,7 +4186,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4039
4186
|
};
|
|
4040
4187
|
retrieval: {
|
|
4041
4188
|
/**
|
|
4042
|
-
* @description 获取所有召回配置的 JSON Schema,用于前端动态渲染表单。 返回格式: { "deep_retrieval": { ... schema ... }, "region_retrieval": { ... schema ... }, ... }
|
|
4189
|
+
* @description 获取所有召回配置的 JSON Schema,用于前端动态渲染表单。 返回格式: { "deep_retrieval": { ... schema ... }, "region_retrieval": { ... schema ... }, "web_search": { ... schema ... }, ... }
|
|
4043
4190
|
*
|
|
4044
4191
|
* @tags retrieval
|
|
4045
4192
|
* @name GetRetrievalConfigSchemas
|
|
@@ -4186,7 +4333,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4186
4333
|
};
|
|
4187
4334
|
tenant: {
|
|
4188
4335
|
/**
|
|
4189
|
-
* @description
|
|
4336
|
+
* @description 检查租户名称是否可用 用于前端表单实时校验租户名称的唯一性。 此接口无需认证,但有基于 IP 的访问频率限制。 Args: params.tenant_name: 要检查的租户名称 Returns: available: True 表示名称可用,False 表示已被占用 message: 检查结果说明 Raises: 429: 请求过于频繁
|
|
4337
|
+
*
|
|
4338
|
+
* @tags tenant
|
|
4339
|
+
* @name CheckTenantName
|
|
4340
|
+
* @summary Check Tenant Name
|
|
4341
|
+
* @request POST:/api/tenant/check-name
|
|
4342
|
+
*/
|
|
4343
|
+
checkTenantName: (data: ITenantNameCheckRequest, params?: RequestParams) => Promise<HttpResponse<IResponseModelTenantNameCheckResponse, void | IHTTPValidationError>>;
|
|
4344
|
+
/**
|
|
4345
|
+
* @description 创建租户 创建新租户并自动生成认证密钥(secret_key): - tenant_id 和 secret_key 由系统自动生成 - secret_key 仅在创建时返回一次,后续无法再次获取,请妥善保存 - 创建成功后会发送通知邮件到指定邮箱 Args: params.tenant_name: 租户名称,必须唯一 params.email: 联系邮箱,用于接收通知 params.metadata: 自定义元数据(可选) Returns: 创建的租户信息,包含 secret_key(仅此一次) Raises: 400: 租户名称已存在
|
|
4190
4346
|
*
|
|
4191
4347
|
* @tags tenant
|
|
4192
4348
|
* @name CreateTenant
|
|
@@ -4195,7 +4351,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4195
4351
|
*/
|
|
4196
4352
|
createTenant: (data: ITenantCreate, params?: RequestParams) => Promise<HttpResponse<IResponseModelTenant, void | IHTTPValidationError>>;
|
|
4197
4353
|
/**
|
|
4198
|
-
* @description 根据ID查询租户
|
|
4354
|
+
* @description 根据ID查询租户 获取指定租户的详细信息。需要当前租户具有 READ 或 UPDATE 权限。 Args: id: 租户ID Returns: 租户详细信息(secret_key 字段已脱敏) Raises: 404: 租户不存在
|
|
4199
4355
|
*
|
|
4200
4356
|
* @tags tenant
|
|
4201
4357
|
* @name GetTenantById
|
|
@@ -4204,7 +4360,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4204
4360
|
*/
|
|
4205
4361
|
getTenantById: (id: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelTenant, void | IHTTPValidationError>>;
|
|
4206
4362
|
/**
|
|
4207
|
-
* @description 删除租户
|
|
4363
|
+
* @description 删除租户 永久删除指定租户。此操作不可逆。 注意:当前版本不会检查关联数据(空间、知识等),请确保租户下无重要数据。 Args: id: 要删除的租户ID Raises: 404: 租户不存在
|
|
4208
4364
|
*
|
|
4209
4365
|
* @tags tenant
|
|
4210
4366
|
* @name DeleteTenantById
|
|
@@ -4213,7 +4369,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4213
4369
|
*/
|
|
4214
4370
|
deleteTenantById: (id: string, params?: RequestParams) => Promise<HttpResponse<IResponseModelObject, void | IHTTPValidationError>>;
|
|
4215
4371
|
/**
|
|
4216
|
-
* @description
|
|
4372
|
+
* @description 更新当前租户信息 部分更新当前认证租户的信息,仅提供的字段会被更新: - tenant_name: 更新名称时会检查是否与其他租户冲突 - email: 更新联系邮箱 - metadata: 更新自定义元数据(完全替换) Args: params: 更新参数,所有字段均为可选 Returns: 更新后的租户信息 Raises: 400: 租户名称已被占用
|
|
4217
4373
|
*
|
|
4218
4374
|
* @tags tenant
|
|
4219
4375
|
* @name UpdateTenant
|
|
@@ -4222,7 +4378,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4222
4378
|
*/
|
|
4223
4379
|
updateTenant: (data: ITenantUpdate, params?: RequestParams) => Promise<HttpResponse<IResponseModelTenant, void | IHTTPValidationError>>;
|
|
4224
4380
|
/**
|
|
4225
|
-
* @description
|
|
4381
|
+
* @description 分页获取租户列表 获取系统中所有租户的分页列表。 Args: page: 页码,从 1 开始,默认 1 page_size: 每页数量,默认 10 Returns: 分页结果,包含 items、total、page、page_size、total_pages
|
|
4226
4382
|
*
|
|
4227
4383
|
* @tags tenant
|
|
4228
4384
|
* @name GetTenantList
|
|
@@ -4242,7 +4398,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4242
4398
|
page_size?: number;
|
|
4243
4399
|
}, params?: RequestParams) => Promise<HttpResponse<IResponseModelPageResponseTenant, void | IHTTPValidationError>>;
|
|
4244
4400
|
/**
|
|
4245
|
-
* @description 获取当前租户信息
|
|
4401
|
+
* @description 获取当前租户信息 通过请求头中的认证信息(secret_key)获取当前租户的详细信息。 无需传入任何参数,系统自动从认证上下文中识别租户身份。 Returns: 当前认证租户的详细信息(secret_key 字段已脱敏)
|
|
4246
4402
|
*
|
|
4247
4403
|
* @tags tenant
|
|
4248
4404
|
* @name GetTenant
|
|
@@ -4251,7 +4407,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4251
4407
|
*/
|
|
4252
4408
|
getTenant: (params?: RequestParams) => Promise<HttpResponse<IResponseModelTenant, void | IHTTPValidationError>>;
|
|
4253
4409
|
/**
|
|
4254
|
-
* @description 绑定 Wohu
|
|
4410
|
+
* @description 绑定 Wohu 产品空间信息 将 Wohu 产品空间ID绑定到当前租户,存储在 metadata._wohu_product_space_id 字段。 用于关联 Wohu 平台的产品空间与本系统租户。 Args: params.wohu_product_space_id: Wohu 产品空间ID Returns: 更新后的租户信息 Raises: 404: 租户不存在
|
|
4255
4411
|
*
|
|
4256
4412
|
* @tags tenant
|
|
4257
4413
|
* @name BindWohuInfo
|
package/dist/api.js
CHANGED
|
@@ -145,6 +145,8 @@ var IKnowledgeTypeEnum;
|
|
|
145
145
|
IKnowledgeTypeEnum["Haskell"] = "haskell";
|
|
146
146
|
IKnowledgeTypeEnum["Elixir"] = "elixir";
|
|
147
147
|
IKnowledgeTypeEnum["Powershell"] = "powershell";
|
|
148
|
+
IKnowledgeTypeEnum["NodePackage"] = "node_package";
|
|
149
|
+
IKnowledgeTypeEnum["NodePackageElement"] = "node_package_element";
|
|
148
150
|
})(IKnowledgeTypeEnum || (exports.IKnowledgeTypeEnum = IKnowledgeTypeEnum = {}));
|
|
149
151
|
/**
|
|
150
152
|
* KnowledgeSourceEnum
|
|
@@ -160,6 +162,7 @@ var IKnowledgeSourceEnum;
|
|
|
160
162
|
IKnowledgeSourceEnum["Yuque"] = "yuque";
|
|
161
163
|
IKnowledgeSourceEnum["YuquePersonalDoc"] = "yuque_personal_doc";
|
|
162
164
|
IKnowledgeSourceEnum["YuquePersonalNote"] = "yuque_personal_note";
|
|
165
|
+
IKnowledgeSourceEnum["HituNodePackage"] = "hitu_node_package";
|
|
163
166
|
})(IKnowledgeSourceEnum || (exports.IKnowledgeSourceEnum = IKnowledgeSourceEnum = {}));
|
|
164
167
|
/** Action */
|
|
165
168
|
var IAction;
|
|
@@ -342,7 +345,7 @@ class Api extends HttpClient {
|
|
|
342
345
|
};
|
|
343
346
|
this.knowledge = {
|
|
344
347
|
/**
|
|
345
|
-
* @description
|
|
348
|
+
* @description 批量添加知识 支持批量创建知识条目,自动处理重复检测和增量更新: - 根据 space_id + knowledge_name + knowledge_type 判断知识唯一性 - 若知识不存在则新增;若存在但 file_sha 不同则删除旧版本后重新添加 - 若知识已存在且内容相同则跳过,返回空列表 创建成功后自动触发异步处理任务(如向量化入库)。 Args: body: 知识创建请求列表,支持多种来源类型(文件、URL、语雀等) Returns: 成功创建的知识列表,已存在且未变更的知识不会返回
|
|
346
349
|
*
|
|
347
350
|
* @tags knowledge
|
|
348
351
|
* @name AddKnowledge
|
|
@@ -351,7 +354,7 @@ class Api extends HttpClient {
|
|
|
351
354
|
*/
|
|
352
355
|
addKnowledge: (data, params = {}) => this.request(Object.assign({ path: `/api/knowledge/add`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
353
356
|
/**
|
|
354
|
-
* @description
|
|
357
|
+
* @description 更新知识(全量更新) 更新知识的完整信息,支持以下字段变更: - 元数据(metadata)变更:同步更新对应 chunk 的 metadata - 启用状态(enabled)变更:同步更新对应 chunk 的启用状态 - 嵌入模型/分片配置/来源配置变更:自动触发重新入库任务 注意:knowledge_type、source_type 等核心字段不可变更。 Args: knowledge: 完整的知识对象,需包含 knowledge_id Returns: 更新后的知识对象(auth_info 字段已脱敏)
|
|
355
358
|
*
|
|
356
359
|
* @tags knowledge
|
|
357
360
|
* @name UpdateKnowledge
|
|
@@ -360,7 +363,7 @@ class Api extends HttpClient {
|
|
|
360
363
|
*/
|
|
361
364
|
updateKnowledge: (data, params = {}) => this.request(Object.assign({ path: `/api/knowledge/update`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
362
365
|
/**
|
|
363
|
-
* @description 更新知识启用状态
|
|
366
|
+
* @description 更新知识启用状态 单独更新知识的启用/禁用状态,同步更新向量数据库中对应 chunk 的启用状态。 禁用后的知识在召回时将被过滤。 Args: body.knowledge_id: 知识ID body.status: True 启用,False 禁用
|
|
364
367
|
*
|
|
365
368
|
* @tags knowledge
|
|
366
369
|
* @name UpdateKnowledgeEnableStatus
|
|
@@ -369,7 +372,25 @@ class Api extends HttpClient {
|
|
|
369
372
|
*/
|
|
370
373
|
updateKnowledgeEnableStatus: (data, params = {}) => this.request(Object.assign({ path: `/api/knowledge/update/enabled`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
371
374
|
/**
|
|
372
|
-
* @description
|
|
375
|
+
* @description 更新知识标签 更新知识的标签列表,同步更新向量数据库中对应 chunk 的 tags 字段。 标签可用于召回时的过滤条件。 Args: body.knowledge_id: 知识ID body.tags: 新的标签列表,将完全替换原有标签 Returns: 更新后的知识对象(auth_info 字段已脱敏)
|
|
376
|
+
*
|
|
377
|
+
* @tags knowledge
|
|
378
|
+
* @name UpdateKnowledgeTags
|
|
379
|
+
* @summary Update Knowledge Tags
|
|
380
|
+
* @request POST:/api/knowledge/update/tags
|
|
381
|
+
*/
|
|
382
|
+
updateKnowledgeTags: (data, params = {}) => this.request(Object.assign({ path: `/api/knowledge/update/tags`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
383
|
+
/**
|
|
384
|
+
* @description 更新知识自定义过滤字段 更新知识的自定义过滤字段(f1-f5),同步更新向量数据库中对应 chunk 的字段。 这些字段可用于召回时的精确过滤条件。 Args: body.knowledge_id: 知识ID body.f1-f5: 自定义过滤字段,None 表示保持原值不变,至少需提供一个非空字段 Returns: 更新后的知识对象(auth_info 字段已脱敏)
|
|
385
|
+
*
|
|
386
|
+
* @tags knowledge
|
|
387
|
+
* @name UpdateKnowledgeFilterFields
|
|
388
|
+
* @summary Update Knowledge Filter Fields
|
|
389
|
+
* @request POST:/api/knowledge/update/filter_fields
|
|
390
|
+
*/
|
|
391
|
+
updateKnowledgeFilterFields: (data, params = {}) => this.request(Object.assign({ path: `/api/knowledge/update/filter_fields`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
392
|
+
/**
|
|
393
|
+
* @description 分页查询知识列表 支持灵活的查询条件: - eq_conditions: 等值查询条件,如 {"space_id": "xxx", "enabled": true} - advanced_filter: 高级过滤条件,支持 AND/OR 组合及多种比较操作符 - order_by/order_direction: 排序字段和方向 Args: body: 分页查询参数,包含 page、page_size 和过滤条件 Returns: 分页结果,包含 items、total、page、page_size、total_pages
|
|
373
394
|
*
|
|
374
395
|
* @tags knowledge
|
|
375
396
|
* @name GetKnowledgeList
|
|
@@ -378,7 +399,7 @@ class Api extends HttpClient {
|
|
|
378
399
|
*/
|
|
379
400
|
getKnowledgeList: (data, params = {}) => this.request(Object.assign({ path: `/api/knowledge/list`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
380
401
|
/**
|
|
381
|
-
* @description
|
|
402
|
+
* @description 获取知识详情 根据知识ID获取完整的知识信息,包含元数据、配置等所有字段。 Args: knowledge_id: 知识ID Returns: 知识详情(auth_info 字段已脱敏) Raises: 404: 知识不存在
|
|
382
403
|
*
|
|
383
404
|
* @tags knowledge
|
|
384
405
|
* @name GetKnowledgeById
|
|
@@ -387,7 +408,7 @@ class Api extends HttpClient {
|
|
|
387
408
|
*/
|
|
388
409
|
getKnowledgeById: (query, params = {}) => this.request(Object.assign({ path: `/api/knowledge/detail`, method: "GET", query: query, format: "json" }, params)),
|
|
389
410
|
/**
|
|
390
|
-
* @description 删除知识
|
|
411
|
+
* @description 删除知识 级联删除知识及其关联数据: - 删除 MySQL 中的知识记录和相关任务 - 删除向量数据库中的所有 chunk 数据 - 清除所属 Space 的总结时间标记(下次总结时将进行全量总结) Args: knowledge_id: 要删除的知识ID Raises: 404: 知识不存在
|
|
391
412
|
*
|
|
392
413
|
* @tags knowledge
|
|
393
414
|
* @name DeleteKnowledge
|
|
@@ -396,7 +417,7 @@ class Api extends HttpClient {
|
|
|
396
417
|
*/
|
|
397
418
|
deleteKnowledge: (query, params = {}) => this.request(Object.assign({ path: `/api/knowledge/delete`, method: "DELETE", query: query, format: "json" }, params)),
|
|
398
419
|
/**
|
|
399
|
-
*
|
|
420
|
+
* @description 获取可用的嵌入模型列表 返回系统中所有已注册的嵌入模型及其元数据信息, 用于创建知识时选择合适的向量化模型。 Returns: 模型列表,每项包含 name(模型标识)和 metadata(模型元数据)
|
|
400
421
|
*
|
|
401
422
|
* @tags knowledge
|
|
402
423
|
* @name GetEmbeddingModelsList
|
|
@@ -405,7 +426,7 @@ class Api extends HttpClient {
|
|
|
405
426
|
*/
|
|
406
427
|
getEmbeddingModelsList: (params = {}) => this.request(Object.assign({ path: `/api/knowledge/embedding/models`, method: "GET", format: "json" }, params)),
|
|
407
428
|
/**
|
|
408
|
-
* @description
|
|
429
|
+
* @description 根据名称批量查询知识 在指定 Space 下,根据知识名称列表批量查询知识详情。 适用于已知知识名称需要获取完整信息的场景。 Args: body.space_id: 空间ID body.knowledge_names: 知识名称列表 Returns: 符合条件的知识列表(auth_info 字段已脱敏)
|
|
409
430
|
*
|
|
410
431
|
* @tags knowledge
|
|
411
432
|
* @name BatchQueryKnowledgeByNames
|
|
@@ -414,7 +435,7 @@ class Api extends HttpClient {
|
|
|
414
435
|
*/
|
|
415
436
|
batchQueryKnowledgeByNames: (data, params = {}) => this.request(Object.assign({ path: `/api/knowledge/batch_query_by_names`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
416
437
|
/**
|
|
417
|
-
* @description
|
|
438
|
+
* @description 获取知识原文内容 加载知识的原始内容,根据知识来源类型采用不同策略: - GitHub 类型:从已入库的 chunk 中合并还原原文 - 其他类型:通过对应的 Loader 重新加载原始内容 Args: knowledge_id: 知识ID Returns: 原文内容列表,可能包含 Text(文本)、Image(图片)或 Blob(二进制)类型 Raises: 404: 知识不存在 400: 未注册对应类型的 Loader
|
|
418
439
|
*
|
|
419
440
|
* @tags knowledge
|
|
420
441
|
* @name GetKnowledgeOriginalContent
|
|
@@ -425,7 +446,7 @@ class Api extends HttpClient {
|
|
|
425
446
|
};
|
|
426
447
|
this.retrieval = {
|
|
427
448
|
/**
|
|
428
|
-
* @description 获取所有召回配置的 JSON Schema,用于前端动态渲染表单。 返回格式: { "deep_retrieval": { ... schema ... }, "region_retrieval": { ... schema ... }, ... }
|
|
449
|
+
* @description 获取所有召回配置的 JSON Schema,用于前端动态渲染表单。 返回格式: { "deep_retrieval": { ... schema ... }, "region_retrieval": { ... schema ... }, "web_search": { ... schema ... }, ... }
|
|
429
450
|
*
|
|
430
451
|
* @tags retrieval
|
|
431
452
|
* @name GetRetrievalConfigSchemas
|
|
@@ -566,7 +587,16 @@ class Api extends HttpClient {
|
|
|
566
587
|
};
|
|
567
588
|
this.tenant = {
|
|
568
589
|
/**
|
|
569
|
-
* @description
|
|
590
|
+
* @description 检查租户名称是否可用 用于前端表单实时校验租户名称的唯一性。 此接口无需认证,但有基于 IP 的访问频率限制。 Args: params.tenant_name: 要检查的租户名称 Returns: available: True 表示名称可用,False 表示已被占用 message: 检查结果说明 Raises: 429: 请求过于频繁
|
|
591
|
+
*
|
|
592
|
+
* @tags tenant
|
|
593
|
+
* @name CheckTenantName
|
|
594
|
+
* @summary Check Tenant Name
|
|
595
|
+
* @request POST:/api/tenant/check-name
|
|
596
|
+
*/
|
|
597
|
+
checkTenantName: (data, params = {}) => this.request(Object.assign({ path: `/api/tenant/check-name`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
598
|
+
/**
|
|
599
|
+
* @description 创建租户 创建新租户并自动生成认证密钥(secret_key): - tenant_id 和 secret_key 由系统自动生成 - secret_key 仅在创建时返回一次,后续无法再次获取,请妥善保存 - 创建成功后会发送通知邮件到指定邮箱 Args: params.tenant_name: 租户名称,必须唯一 params.email: 联系邮箱,用于接收通知 params.metadata: 自定义元数据(可选) Returns: 创建的租户信息,包含 secret_key(仅此一次) Raises: 400: 租户名称已存在
|
|
570
600
|
*
|
|
571
601
|
* @tags tenant
|
|
572
602
|
* @name CreateTenant
|
|
@@ -575,7 +605,7 @@ class Api extends HttpClient {
|
|
|
575
605
|
*/
|
|
576
606
|
createTenant: (data, params = {}) => this.request(Object.assign({ path: `/api/tenant/create`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
577
607
|
/**
|
|
578
|
-
* @description 根据ID查询租户
|
|
608
|
+
* @description 根据ID查询租户 获取指定租户的详细信息。需要当前租户具有 READ 或 UPDATE 权限。 Args: id: 租户ID Returns: 租户详细信息(secret_key 字段已脱敏) Raises: 404: 租户不存在
|
|
579
609
|
*
|
|
580
610
|
* @tags tenant
|
|
581
611
|
* @name GetTenantById
|
|
@@ -584,7 +614,7 @@ class Api extends HttpClient {
|
|
|
584
614
|
*/
|
|
585
615
|
getTenantById: (id, params = {}) => this.request(Object.assign({ path: `/api/tenant/id/${id}`, method: "GET", format: "json" }, params)),
|
|
586
616
|
/**
|
|
587
|
-
* @description 删除租户
|
|
617
|
+
* @description 删除租户 永久删除指定租户。此操作不可逆。 注意:当前版本不会检查关联数据(空间、知识等),请确保租户下无重要数据。 Args: id: 要删除的租户ID Raises: 404: 租户不存在
|
|
588
618
|
*
|
|
589
619
|
* @tags tenant
|
|
590
620
|
* @name DeleteTenantById
|
|
@@ -593,7 +623,7 @@ class Api extends HttpClient {
|
|
|
593
623
|
*/
|
|
594
624
|
deleteTenantById: (id, params = {}) => this.request(Object.assign({ path: `/api/tenant/${id}`, method: "DELETE", format: "json" }, params)),
|
|
595
625
|
/**
|
|
596
|
-
* @description
|
|
626
|
+
* @description 更新当前租户信息 部分更新当前认证租户的信息,仅提供的字段会被更新: - tenant_name: 更新名称时会检查是否与其他租户冲突 - email: 更新联系邮箱 - metadata: 更新自定义元数据(完全替换) Args: params: 更新参数,所有字段均为可选 Returns: 更新后的租户信息 Raises: 400: 租户名称已被占用
|
|
597
627
|
*
|
|
598
628
|
* @tags tenant
|
|
599
629
|
* @name UpdateTenant
|
|
@@ -602,7 +632,7 @@ class Api extends HttpClient {
|
|
|
602
632
|
*/
|
|
603
633
|
updateTenant: (data, params = {}) => this.request(Object.assign({ path: `/api/tenant/update`, method: "POST", body: data, type: ContentType.Json, format: "json" }, params)),
|
|
604
634
|
/**
|
|
605
|
-
* @description
|
|
635
|
+
* @description 分页获取租户列表 获取系统中所有租户的分页列表。 Args: page: 页码,从 1 开始,默认 1 page_size: 每页数量,默认 10 Returns: 分页结果,包含 items、total、page、page_size、total_pages
|
|
606
636
|
*
|
|
607
637
|
* @tags tenant
|
|
608
638
|
* @name GetTenantList
|
|
@@ -611,7 +641,7 @@ class Api extends HttpClient {
|
|
|
611
641
|
*/
|
|
612
642
|
getTenantList: (query, params = {}) => this.request(Object.assign({ path: `/api/tenant/list`, method: "GET", query: query, format: "json" }, params)),
|
|
613
643
|
/**
|
|
614
|
-
* @description 获取当前租户信息
|
|
644
|
+
* @description 获取当前租户信息 通过请求头中的认证信息(secret_key)获取当前租户的详细信息。 无需传入任何参数,系统自动从认证上下文中识别租户身份。 Returns: 当前认证租户的详细信息(secret_key 字段已脱敏)
|
|
615
645
|
*
|
|
616
646
|
* @tags tenant
|
|
617
647
|
* @name GetTenant
|
|
@@ -620,7 +650,7 @@ class Api extends HttpClient {
|
|
|
620
650
|
*/
|
|
621
651
|
getTenant: (params = {}) => this.request(Object.assign({ path: `/api/tenant/me`, method: "GET", format: "json" }, params)),
|
|
622
652
|
/**
|
|
623
|
-
* @description 绑定 Wohu
|
|
653
|
+
* @description 绑定 Wohu 产品空间信息 将 Wohu 产品空间ID绑定到当前租户,存储在 metadata._wohu_product_space_id 字段。 用于关联 Wohu 平台的产品空间与本系统租户。 Args: params.wohu_product_space_id: Wohu 产品空间ID Returns: 更新后的租户信息 Raises: 404: 租户不存在
|
|
624
654
|
*
|
|
625
655
|
* @tags tenant
|
|
626
656
|
* @name BindWohuInfo
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@petercatai/whisker-client",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.202512231541",
|
|
4
4
|
"description": "Generated API client (Production)",
|
|
5
5
|
"main": "dist/api.js",
|
|
6
6
|
"types": "dist/api.d.ts",
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"tag": "latest"
|
|
17
17
|
},
|
|
18
18
|
"devDependencies": {
|
|
19
|
-
"@types/node": "^
|
|
19
|
+
"@types/node": "^25.0.3",
|
|
20
20
|
"axios": "^1.13.2",
|
|
21
21
|
"typescript": "^5.9.3"
|
|
22
22
|
}
|