文档首页/ 应用平台 AppStage/ API参考/ API/ 知识中心/ 修改知识库召回状态
更新时间:2024-12-11 GMT+08:00
分享

修改知识库召回状态

功能介绍

修改知识库召回状态,启用或禁用知识库召回功能

URI

PUT /v1/knowledge-bases/{knowledge_base_id}/retrieval-status

表1 路径参数

参数

是否必选

参数类型

描述

knowledge_base_id

String

知识库id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

AI原生应用引擎鉴权API Key。

1.以管理员身份登录AI原生应用引擎工作台,在左侧导航栏选择“系统管理 > 平台租户鉴权”。

2.在“平台租户鉴权”页面,选择“平台API Key”页签,单击“新增平台API Key”。

3.在“新增平台API Key”对话框中的输入框设置API Key名称,用以区分API Key。

4.在弹出的下载窗口中单击“立即下载”,将API Key下载到本地查看。

5.使用时,需在sk前加上Bearer ,如Bearer sk-xxxxxxxx。

表3 请求Body参数

参数

是否必选

参数类型

描述

-

String

知识库召回状态,启用召回与禁用召回,ENABLE、DISABLE

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

data

Boolean

正常返回的结果

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

异常错误码

error_msg

String

异常错误信息

请求示例

ENABLE

响应示例

状态码: 200

操作成功,返回操作结果

{
  "data" : true
}

状态码: 400

请求错误

{
  "error_code" : "AIAE.40001001",
  "error_msg" : "参数xxxx不合法。"
}

状态码

状态码

描述

200

操作成功,返回操作结果

400

请求错误

错误码

请参见错误码

相关文档