百宝箱开放平台 ✖️ 添加知识库文件

蚂蚁百宝箱
14 阅读5分钟

通过调用本接口，开发者可以将通过文件上传接口上传的文件添加至指定的知识库中。

前提条件

  • 在调用本接口前，请先通过文件上传接口完成文件上传，并获取对应的 fileId，详细说明请参见，文件上传。

请求地址

POST``https://api.tbox.cn/api/datasets/createDatasetDocument

请求头

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

请求参数

参数名必填类型说明示例
datasetId是String知识库 ID，指文件上传的目标知识库 ID。2555****sdf
fileId是String文件 ID，通过文件上传 API 或 SDK 上传文件时返回的文件标识。2156****112

请求示例

curl --location 'https://api.tbox.cn/api/datasets/createDatasetDocument' \
--header 'Authorization: {your_token}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "fileId":"202508****554030",
    "datasetId":"2025080****00458209"
}'

返回参数

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

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

返回示例

成功示例

{
    "data": "20250805****9457696",
    "errorCode": "0",
    "errorMsg": "success",
    "traceId": "0b446a1f17543847325624439e41a7"
}

失败返回

{
    "errorCode": "P_1_06_361",
    "errorMsg": "不存在知识库",
    "solution": "请检查datasetId是否输错",
    "traceId": "1ee603881754385338419138937634"
}

错误码

公共错误码

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_00_005datasetId 不能为空- 原因：未填入必填参数 datasetId。 解决方案：请填入正确的 datasetId 后，重试。
P_1_00_005fileId 不能为空- 原因：未填入必填参数 fileId。 解决方案：请填入正确的 fileId 后，重试。
P_1_06_361不存在知识库- 原因：填入的知识库 ID 不正确或不存在。 解决方案：请输入通过创建知识库接口创建的 datasetId。
P_1_00_002权限不足- 原因：当前 token 与知识库所在租户不匹配。 解决方案：请重新传入对应资源所在租户的 token 后重试。
P_1_00_002权限不足- 原因：添加的文件不属于当前租户。 解决方案：请使用当前租户下的文件重新添加。
P_1_15_760额度已耗尽，如需更多额度，请联系百宝箱平台获取。- 原因：额度已耗尽。 解决方案：请点击此处与我们取得联系，进行额度调整。
P_1_13_565未获取租户信息- 原因：token 过期或不正确。 解决方案：请参考授权管理重新完成 token 的获取。
P_1_02_111文件不存在- 原因：文件不存在或 fileId 不正确。 解决方案：请上传文件或输入正确的 fileId 后重试。
P_1_02_113文件大小不能超过20M- 原因：当前所选文件大小超出 20M 限制。 解决方案：请选择符合要求的文件后重试。
P_1_02_113单元内最多20000行数据- 原因：文件内容超出行数最多 20000 行的限制。 解决方案：请调整文件内容至符合要求后重试。
P_1_02_114请确认文件是否有扩展名或文件名中不能包含.- 原因：不支持添加当前所选的文件类型。 解决方案：请选择 txt，pdf，md，docx，xlsx，xls，csv 格式的文件，且保证文件格式扩展名正确后重试。
avatar
文章
阅读
粉丝