百宝箱开放平台 ✖️ 发起知识库召回

通过调用本接口，开发者可以发起一次知识库召回。

说明： 知识库召回是指从一个庞大的知识库中，根据用户的查询（Query）或问题，快速、准确地找出所有可能相关的知识条目或文档片段的过程。

请求地址

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

请求头

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

请求参数

参数名	必填	类型	说明	示例
query	是	String	查询内容	库存商品
datasetId	是	String	目标知识库 ID	2025****58063
limit	否	Interger	返回召回内容的条数，默认是 5，上限是 10	5

请求示例

curl --location 'https://api.tbox.cn/api/datasets/retrieve' \
--header 'Authorization: {your_token}' \
--header 'Content-Type: application/json' \
--data '{
    "query":"库存商品",
    "datasetId":"20250804tpAo00457894"
}'

返回参数

参数名	类型	说明	示例
errorCode	String	错误码，为 0 表示成功。	0
errorMsg	String	错误信息。	success
data	List	召回对象信息	-
traceId	String	本次请求的唯一标识，通常用于发生错误时的排查定位。	0b****4d9

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

data 定义

参数名	类型	说明
content	String	召回内容
originFileName	String	原始文件名
score	Double	关联度分

返回示例

成功示例

{
    "data": [
        {
            "content": "{"商品名称":"猫粮","订单号":"","快递公司":"顺丰","省市区":"浙江省杭州市西湖区","订单编号":"1.0","收货人姓名":"","收货人电话号码":"","详细收货地址":"shippingAddress"}",
            "originFileName": "订单信息.xlsx",
            "score": 0.06375612
        }
    ],
    "errorCode": "0",
    "errorMsg": "success",
    "traceId": "0b446a3117543806882455710e5f2c"
}

失败返回

{
    "errorCode": "P_1_00_005",
    "errorMsg": "query不能为空",
    "solution": "请确认参数值是否正确！",
    "traceId": "0be8c63017543810866326652e1a1e"
}

错误码

公共错误码

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

参数校验与业务错误码

errorCode	errorMsg	说明
P_1_00_005	query不能为空	- 原因：未填入必填参数 query。 解决方案：请填入 query 后，重试。
P_1_00_005	datasetId不能为空	- 原因：未填入必填参数 datasetId。 解决方案：请填入正确的 datasetId 后，重试。
P_1_00_005	limit最大不能超过10	- 原因：请求参数超出限制。 解决方案：请修改后，重试。
P_1_06_361	不存在知识库	- 原因：填入的知识库 ID 不正确或不存在。 解决方案：请输入通过创建知识库接口创建的 datasetId。
P_1_00_002	权限不足	- 原因：当前 token 与知识库所在租户不匹配。 解决方案：请重新传入对应资源所在租户的 token 后重试。
P_1_15_760	额度已耗尽，如需更多额度，请联系百宝箱平台获取。	- 原因：额度已耗尽。 解决方案：请点击此处与我们取得联系，进行额度调整。