百宝箱开放平台 ✖️ 删除知识库文件

129 阅读3分钟

通过调用本接口,开发者可以删除目标知识库内的指定文件。

前提条件

  • 在调用本接口前,请解除目标文件与智能体应用的关联关系。

请求地址

DELETE``https://api.tbox.cn/api/datasets/deleteDocument

请求头

参数名必填类型说明示例
AuthorizationString用于验证客户端身份的访问令牌,你可以在百宝箱中获取,获取方式可参见:授权管理pat_2j4e******THUIVRH1
Content-Typeapplication/json解释请求正文的方式。-

请求参数

参数名必填类型说明示例
documentIdString知识库内指定文件 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"
}'

返回参数

参数名类型说明示例
errorCodeString错误码,为 0 表示成功。0
errorMsgString错误信息。success
traceIdString本次请求的唯一标识,通常用于发生错误时的排查定位。0b****4d9

其中,errorCode 与 errorMsg 的对照关系以及对应的解决方案,请参见下方错误码。

返回示例

成功示例

{
    "errorCode": "0",
    "errorMsg": "success",
    "traceId": "0be8ed2317543652744847731e39a7"
}

失败示例

{
    "errorCode": "P_1_06_385",
    "errorMsg": "知识库文档不存在",
    "solution": "请检查documentId是否输错",
    "traceId": "1ee603881754378335441132526365"
}

错误码

公共错误码

errorCodeerrorMsg说明
S40000系统异常- 原因:系统出现错误。 解决方案:请稍后重试,若持续报错,请点击此处与我们取得联系,并将错误码与 traceId 一同反馈,帮助我们快速定位问题。
P_1_10_183授权令牌无效- 原因:token 不正确。 解决方案:请校验是否输入了有效令牌或配置新令牌。
P_1_10_184授权令牌已失效- 原因:当前 token 已过期。 解决方案:请前往百宝箱开放平台申请新令牌并更新到调用配置中。
P_1_10_185未检测到授权令牌- 原因:未填写 token 信息。 解决方案:请参考授权管理完成授权令牌的申请和配置。
P_1_13_682非法访问,请联系平台- 原因:系统检测到异常活动。 解决方案:请稍后重试,若持续报错,请点击此处与我们取得联系,并将错误码与 traceId 一同反馈,帮助我们快速定位问题。

参数校验与业务错误码

errorCodeerrorMsg说明
P_1_06_385知识库文档不存在- 原因:填入的 documentId 不正确。 解决方案:请确认目标文件是否存在且确保 documentId 填写无误后重试。
P_1_00_002权限不足- 原因:当前 token 与知识库所在租户不匹配。 解决方案:请重新传入对应资源所在租户的 token 后重试。
P_1_06_365数据集还存在关联的应用- 原因:当前文件与租户内应用存在关联关系。 解决方案:请前往对应应用解除关联关系后重试。