修改知识库召回状态-j9九游会登录
功能介绍
该接口用于修改知识库召回状态,启用或禁用知识库召回功能。若知识库被禁用,将无法被agent使用。
调用方法
请参见。
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 |
请求错误。 |
错误码
请参见错误码。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨