1、功能说明
调用此指令,可向指定的扣子文本知识库上传本地文件,支持 pdf、txt、doc、docx 格式,每次最多上传 10 个文件。上传时可通过配置分段规则,对文本进行自动分割与清洗处理。
API 接口详细介绍见:https://www.coze.cn/open/docs/developer_guides/create_knowledge_files
2、配置参数
| 参数名 | 必填 | 说明 |
|---|---|---|
| Token | 是 | 用于身份验证的令牌,确保请求的合法性。 |
| 知识库 ID | 是 | 目标文本知识库的唯一标识,由【知识库 - 创建知识库】指令成功后生成。 |
| 文件列表 | 是 | 待上传的本地文件完整路径集合,每个列表项为一个文件路径,支持 pdf、txt、doc、docx 格式,每次最多上传 10 个文件。 |
| 分段规则 | 是 | 对应接口中的chunk_strategy参数,传入ChunkStrategy类型的字典,需通过【知识库 - 构建分段规则】指令生成,用于文本的分割与清洗。 |
| 返回结果 | 是 | 接口返回的完整响应内容,为字典格式,包含上传状态、文件处理结果等信息。 |
返回结果样例
成功响应
{
"code": 0,
"msg": "success",
"data": {
"file_ids": ["file_657dxxxxxxxxx_01", "file_657dxxxxxxxxx_02"],
"dataset_id": "ds_657dxxxxxxxxx",
"processed_count": 2,
"failed_count": 0
}
}失败响应
失败时指令会抛出错误。
3、示例场景
- 通过【知识库 - 创建知识库】指令获取目标文本知识库的
知识库ID。 - 通过【知识库 - 构建分段规则】指令生成
分段规则字典(如自定义分段标识符为\n,最大分段长度为800)。 - 配置
文件列表,填入本地文件路径,例如: - 运行指令,文件将按分段规则处理后上传至指定文本知识库。
4、注意事项
- 依赖前置指令:
知识库ID必须通过【知识库 - 创建知识库】指令生成,分段规则需通过【知识库 - 构建分段规则】指令生成。 - 文件格式与数量:仅支持
pdf、txt、doc、docx格式,且单次上传最多 10 个文件,超出数量会导致上传失败。 - 错误处理:当 API 调用失败时,指令会直接抛出错误,需根据错误信息排查问题(如 Token 无效、文件路径错误等)。
- 返回结果格式:返回结果为字典类型,可从中获取上传成功的文件 ID、处理状态等信息,供后续操作使用。