百宝箱知识库 ✖️ 查询知识库文件的构建状态

通过调用本接口，开发者可以查询目标文件的构建状态。

前提条件

• 通过开放能力执行文件向目标知识库的添加操作，若无，请参见：添加知识库文件，完成相关事项。

请求地址

GET``https://api.tbox.cn/api/datasets/queryProgress

请求头

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

请求参数

参数名	必填	类型	说明	示例
documentId	是	String	查询目标文件的 ID。	2025****5552

请求示例

curl  --location --request GET 'https://api.tbox.cn/api/datasets/queryProgress?documentId=2025****afasdf' \
--header 'Authorization: {your_token}' \
--header 'Content-Type: text/plain' 

返回参数

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

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

data 定义

参数名	类型	说明	示例
status	String	文件构建状态，包含：- INIT：初始化 HANDLING：处理中 SUCCESS：构建成功 FAILED：构建失败	SUCCESS
errorMsg	String	文件构建失败原因，仅当 status = FAILED 时返回。	文档分段失败:excel文件解析异常，请检查文件内容后重试

返回示例

请求成功且文件构建成功示例

{
    "data": {
        "status": "SUCCESS"
    },
    "errorCode": "0",
    "errorMsg": "success",
    "traceId": "0be8ed2517543866585838625e231f"
}

请求成功但文件构建失败示例

{
    "data": {
        "errorMsg": " 文档分段失败:excel文件解析异常，请检查文件内容后重试",
        "status": "FAILED"
    },
    "errorCode": "0",
    "errorMsg": "success",
    "traceId": "0be8ed2317543870606746859e39cb"
}

请求失败示例

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

错误码

公共错误码

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	缺少必填参 documentId	- 原因：未填入必填参数 documentId。 解决方案：请填入正确的 documentId 后，重试。
P_1_06_385	知识库文档不存在	- 原因：填入的 documentId 不正确。 解决方案：请填入正确的 documentId 后，重试。
P_1_00_002	权限不足	- 原因：当前 token 与目标文档所在租户不匹配。 解决方案：请重新传入对应资源所在租户的 token 后重试。