更新知识库(Token认证)
功能介绍
该接口用于更新知识库,注意必须将知识库停用后才能更新知识库信息。
调用方法
请参见如何调用API。
URI
PUT https://aiae.appstage.myhuaweicloud.com/v1/unidata/knowledge-bases/{knowledge_base_id}
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
retrieval_config |
是 |
RetrievalConfig object |
参数解释: 检索配置。 约束限制: 不涉及。 取值范围: 不允许为空。 默认取值: 不涉及。 |
description |
否 |
String |
参数解释: 知识库描述。 约束限制: 不涉及。 取值范围: 只能包含英文,中文,数字,下划线,中划线,空格及,.?:;"':;“”’‘,。?、()()/等符号,最长255个字符。 默认取值: 不涉及。 |
knowledge_data_sets |
否 |
KnowledgeDataSet object |
参数解释: 知识数据集信息列表,选择知识数据集创建知识库。 约束限制: 不涉及。 取值范围: 不允许为空,数量最小为1,最大为5。 默认取值: 不涉及。 |
scope |
否 |
String |
参数解释: 知识库范围类型。 约束限制: 不涉及。 取值范围: 枚举值:
默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
retrieval_modes |
是 |
Array of strings |
参数解释: 检索模式,用于设置知识库检索召回时的检索方式。 约束限制: 不涉及。 取值范围: 可传多个值。枚举值:
默认取值: 不涉及。 |
retrieval_hybrid_mode |
否 |
String |
参数解释: 此参数用于指定混合检索的模式。 “retrieval_modes”选择SEMANTIC_RETRIEVAL和FULL_TEXT_RETRIEVAL时,为混合检索。 约束限制: “retrieval_modes”选择SEMANTIC_RETRIEVAL和FULL_TEXT_RETRIEVAL。 取值范围: 支持RRF,枚举值:RRF。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
data_set_id |
是 |
String |
参数解释: 知识数据集ID,获取方式:
约束限制: 需要先调用创建知识数据集接口,接口返回即为知识数据集ID。 取值范围: 仅支持数字、字母和中划线。 默认取值: 不涉及。 |
data_set_version |
是 |
String |
参数解释: 数据集版本。 约束限制: 需根据知识数据集ID,调用查询数据集详情接口,获取版本。 取值范围: 格式为:v2024-11-21T11:36:55Z。 默认取值: 不涉及。 |
index_config_id |
是 |
String |
参数解释: 索引配置ID。 约束限制: 需根据知识数据集ID,调用查询数据集详情接口,获取索引配置ID。 取值范围: 仅支持数字、字母和中划线。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
Boolean |
参数解释: 正常返回的结果。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 异常错误码。 取值范围: 不涉及。 |
error_msg |
String |
参数解释: 异常错误信息。 取值范围: 不涉及。 |
请求示例
https://xxx.x.x.x:xxxx/v1/unidata/knowledge-bases/{knowledge_base_id} { "description" : "0725第二次修改", "knowledge_data_sets" : [ { "data_set_id" : "3971729f-6f0d-4219-b228-6a8d9df6e8da", "data_set_version" : "v2025-07-16T14:14:23Z", "index_config_id" : "b723287c-ccd7-460e-bbe0-2af6bf486f44" } ], "retrieval_config" : { "retrieval_modes" : [ "SEMANTIC_RETRIEVAL" ], "retrieval_hybrid_mode" : null }, "scope" : "PRIVATE" }
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
修改知识库响应。 |
400 |
请求错误。 |
错误码
请参见错误码。