通过调用本接口,开发者可以删除目标知识库内的指定文件。
前提条件
- 在调用本接口前,请解除目标文件与智能体应用的关联关系。
请求地址
DELETEhttps://api.tbox.cn/api/datasets/deleteDocument
请求头
参数名 |
必填 |
类型 |
说明 |
示例 |
Authorization |
是 |
String |
用于验证客户端身份的访问令牌,你可以在百宝箱中获取,获取方式可参见:授权管理。 |
|
Content-Type |
application/json |
解释请求正文的方式。 |
- |
请求参数
参数名 |
必填 |
类型 |
说明 |
示例 |
documentId |
是 |
String |
知识库内指定文件 ID。 |
2025****58063 |
请求示例
curl --location --request DELETE 'https://api.tbox.cn/api/datasets/deleteDocument' \ --header 'Authorization: {your_token}' \ --header 'Content-Type: application/json' \ --data '{ "documentId":"2025****58063" }'
返回参数
参数名 |
类型 |
说明 |
示例 |
errorCode |
String |
错误码,为 0 表示成功。 |
0 |
errorMsg |
String |
错误信息。 |
success |
traceId |
String |
本次请求的唯一标识,通常用于发生错误时的排查定位。 |
0b****4d9 |
其中,errorCode 与 errorMsg 的对照关系以及对应的解决方案,请参见下方错误码。
返回示例
{ "errorCode": "0", "errorMsg": "success", "traceId": "0be8ed2317543652744847731e39a7" }
{ "errorCode": "P_1_06_385", "errorMsg": "知识库文档不存在", "solution": "请检查documentId是否输错", "traceId": "1ee603881754378335441132526365" }
错误码
公共错误码
errorCode |
errorMsg |
说明 |
S40000 |
系统异常 |
|
P_1_10_183 |
授权令牌无效 |
|
P_1_10_184 |
授权令牌已失效 |
|
P_1_10_185 |
未检测到授权令牌 |
|
P_1_13_682 |
非法访问,请联系平台 |
|
参数校验与业务错误码
errorCode |
errorMsg |
说明 |
P_1_06_385 |
知识库文档不存在 |
|
P_1_00_002 |
权限不足 |
|
P_1_06_365 |
数据集还存在关联的应用 |
|