1、功能说明
调用此指令，可获取扣子知识库文件的上传与处理进度。文件 ID 可从 “创建知识库文件” 类指令的返回结果中获取。当 API 调用失败时，指令会直接抛出错误。
API 接口详细介绍见：https://www.coze.cn/open/docs/developer_guides/get_dataset_progress
2、配置参数
| 参数名 | 必填 | 说明 |
|---|---|---|
| Token | 是 | 用于身份验证的令牌，确保请求的合法性。 |
| 知识库 ID | 是 | 目标知识库的唯一标识，由【知识库 - 创建知识库】指令生成。 |
| 文件 ID 列表 | 是 | 待查询进度的文件 ID 集合，可从 “创建知识库文件” 指令的返回结果中获取。 |
| 返回结果 | 是 | 接口返回的完整响应内容，为字典格式，包含每个文件的进度与状态。 |
返回结果示例
成功响应
{
"code": 0,
"msg": "success",
"data": [
{
"file_id": "file_657dxxxxxxxxx_01",
"status": "completed",
"progress": 100,
"processed_chunks": 24,
"total_chunks": 24
},
{
"file_id": "file_657dxxxxxxxxx_02",
"status": "processing",
"progress": 65,
"processed_chunks": 13,
"total_chunks": 20
}
]
}失败响应
API调用失败，指令会抛出错误。
3、示例场景
- 从 “创建知识库文件 - 本地文本文件” 指令的返回结果中，提取
file_ids列表。 - 填入
文件ID列表参数，例如： - ["file_657dxxxxxxxxx_01", "file_657dxxxxxxxxx_02"]
- 运行指令，即可获取这两个文件的实时上传与处理进度。
4、注意事项
- 依赖前置指令：
文件ID列表必须从 “创建知识库文件” 类指令的返回结果中获取，否则查询会失败。 - 错误处理：当 API 调用失败时，指令会抛出错误，需根据错误信息排查问题（如 Token 无效、文件 ID 错误等）。
- 返回结果格式：返回结果为字典类型，可从中获取每个文件的状态（如
completed/processing/failed）、进度百分比等信息。