1、功能说明
调用此指令,可向指定的扣子知识库上传文件,支持文本知识库和图片知识库两种类型。上传时可通过配置分段规则,对文本进行自动分割与清洗处理。
相关 API 接口详细介绍见:https://www.coze.cn/open/docs/developer_guides/create_knowledge_files
2、配置参数
| 参数名 | 必填 | 说明 |
|---|---|---|
| Token | 是 | 用于身份验证的令牌,确保请求的合法性。 |
| 知识库 ID | 是 | 目标知识库的唯一标识,由【知识库 - 创建知识库】指令成功后生成。 |
| 文件元数据信息列表 | 是 | 待上传文件的元数据集合,包含文件名称、文件路径、文件类型等信息。本地文本文件可使用【知识库-构建文件元数据信息(本地文本文件)】指令构建。 |
| 分段规则 | 否 | 对应接口中的chunk_strategy参数,传入ChunkStrategy类型的字典,可通过【知识库 - 构建分段规则】指令生成,仅对文本知识库生效。 |
| 知识库类型 | 是 | 选择目标知识库的类型,可选值:文本知识库、图片知识库。 |
| 返回结果 | 是 | 接口返回的完整响应内容,为字典格式,包含上传状态、文件处理结果等信息。 |
当调用API接口失败时,指令会抛出错误。
3、示例场景
场景 1:向文本知识库上传文件并使用自定义分段规则
- 通过【知识库 - 创建知识库】指令获取目标
知识库ID。 - 通过【知识库 - 构建分段规则】指令生成
分段规则字典(自定义分段标识符为\n\n,最大分段长度为500)。 - 配置
文件元数据信息列表,填入待上传的文本文件路径与名称。 - 在 “知识库类型” 中选择
文本知识库。 - 运行指令,文件将按自定义规则分割后上传至指定知识库。
场景 2:向图片知识库上传文件
- 准备目标图片知识库的
知识库ID。 - 配置
文件元数据信息列表,填入图片文件的路径与名称。 - 在 “知识库类型” 中选择
图片知识库。 - 无需配置
分段规则,直接运行指令即可完成图片上传。
4、注意事项
- 依赖前置指令:
知识库ID必须通过【知识库 - 创建知识库】指令成功生成,分段规则需通过【知识库 - 构建分段规则】指令生成。 - 类型匹配:
知识库类型需与目标知识库的实际类型保持一致,否则上传会失败。 - 分段规则生效范围:分段规则仅对文本知识库生效,图片知识库场景下无需配置。
- 返回结果格式:返回结果为字典类型,可从中获取上传成功的文件 ID、处理状态等信息,供后续操作使用。