修改知识库召回状态
功能介绍
该接口用于修改知识库召回状态,启用或禁用知识库召回功能。若知识库被禁用,将无法被agent使用。
调用方法
请参见如何调用API。
URI
PUT https://aiae.appstage.myhuaweicloud.com/v1/knowledge-bases/{knowledge_base_id}/retrieval-status
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
knowledge_base_id |
是 |
String |
参数解释: 知识库id。获取方式: 1.从创建知识库接口返回获取。 2.进入AI原生应用引擎,在左侧导航栏选择“知识中心 > 知识库”,可从页面知识库id栏获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Authorization |
是 |
String |
参数解释: 鉴权信息。获取平台API Key,并为API Key添加前缀Bearer,得到标准鉴权信息,例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
- |
否 |
String |
参数解释: 知识库召回状态。 约束限制: 不涉及。 取值范围: 枚举值:ENABLE(启用召回)与DISABLE(禁用召回)。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
Boolean |
参数解释: 正常返回的结果。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 异常错误码。 取值范围: 不涉及。 |
error_msg |
String |
参数解释: 异常错误信息。 取值范围: 不涉及。 |
请求示例
ENABLE
响应示例
状态码:200
操作成功,返回操作结果。
{ "data" : true }
状态码:400
请求错误。
{ "error_code" : "AIAE.40001001", "error_msg" : "参数xxxx不合法。" }
状态码
状态码 |
描述 |
---|---|
200 |
操作成功,返回操作结果。 |
400 |
请求错误。 |
错误码
请参见错误码。