通过调用本接口,开发者可以将通过文件上传接口上传的文件添加至指定的知识库中。
前提条件
- 在调用本接口前,请先通过文件上传接口完成文件上传,并获取对应的 fileId,详细说明请参见,文件上传。
请求地址
POSThttps://api.tbox.cn/api/datasets/createDatasetDocument
请求头
参数名 |
必填 |
类型 |
说明 |
示例 |
Authorization |
是 |
String |
用于验证客户端身份的访问令牌,你可以在百宝箱中获取,获取方式可参见:授权管理。 |
|
Content-Type |
application/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" }'
返回参数
参数名 |
类型 |
说明 |
示例 |
errorCode |
String |
错误码,为 0 表示成功。 |
0 |
errorMsg |
String |
错误信息。 |
success |
data |
String |
目标知识库 ID。 |
202508059********063 |
traceId |
String |
本次请求的唯一标识,通常用于发生错误时的排查定位。 |
0b****4d9 |
其中,errorCode 与 errorMsg 的对照关系以及对应的解决方案,请参见下方错误码。
返回示例
{ "data": "20250805****9457696", "errorCode": "0", "errorMsg": "success", "traceId": "0b446a1f17543847325624439e41a7" }
{ "errorCode": "P_1_06_361", "errorMsg": "不存在知识库", "solution": "请检查datasetId是否输错", "traceId": "1ee603881754385338419138937634" }
错误码
公共错误码
errorCode |
errorMsg |
说明 |
S40000 |
系统异常 |
|
P_1_10_183 |
授权令牌无效 |
|
P_1_10_184 |
授权令牌已失效 |
|
P_1_10_185 |
未检测到授权令牌 |
|
P_1_13_682 |
非法访问,请联系平台 |
|
参数校验与业务错误码
errorCode |
errorMsg |
说明 |
P_1_00_005 |
datasetId 不能为空 |
|
P_1_00_005 |
fileId 不能为空 |
|
P_1_06_361 |
不存在知识库 |
|
P_1_00_002 |
权限不足 |
|
P_1_00_002 |
权限不足 |
|
P_1_15_760 |
额度已耗尽,如需更多额度,请联系百宝箱平台获取。 |
|
P_1_13_565 |
未获取租户信息 |
|
P_1_02_111 |
文件不存在 |
|
P_1_02_113 |
文件大小不能超过20M |
|
P_1_02_113 |
单元内最多20000行数据 |
|
P_1_02_114 |
请确认文件是否有扩展名或文件名中不能包含. |
|