飞书关键信息获取及配置流程请移步 关键信息获取 页面。
| 字段 | 必填 | 说明 | 默认值 |
|---|---|---|---|
| type | 否 | 从知识库下载(wiki)/我的空间(space)下载文档 | space |
| wikiId | 否 | 知识库ID | - |
| folderToken | 否 | 目标文件夹token | - |
| appId | 是 | 飞书自建应用appId | - |
| appSecret | 是 | 飞书自建应用appSecret | - |
| baseUrl | 否 | 飞书 api 请求地址,国内飞书无须配置,国际版飞书可配置为https://open.larksuite.com/open-apis | https://open.feishu.cn/open-apis |
| disableParentDoc | 否 | 是否忽略存在子文档的父文档,将其视作文件夹。0.12.1 及以上版本可用 |
false |
| limit | 否 | 文档下载并发数 | 3 |
当
type为space(我的空间)时,folderToken为必填,表示从「我的空间」中的指定文件夹内下载文档。
当 type 为 wiki(知识库)时,wikiId 为必填,folderToken可选,表示从指定知识库中的指定目录内下载文档,folderToken不填时,默认下载整个知识库。
type 不填时,默认为从我的空间下载,folderToken为必填字段
「我的空间」中存在文件夹,文档可以放置在文件夹之下
「知识库」中不存在文件夹,但文档本身可以当做文件夹,文档下可以继续放置文档
当开启按目录存放文档 时,因为知识库中不存在文件夹概念,如果父文档下有子文档,会在本地生成父文档的同时,创建和父文档同名的文件夹,子文档会放在该文件夹之下。
0.12.1及以上版本可设置 disableParentDoc 属性,用来控制:当父文档下存在文档时,父文档是否作为文件夹使用

例如:当disableParentDoc=false或不设置时,默认是将以上 6 个文档全部下载,会在本地生成父文档的同时,创建和父文档同名的文件夹,子文档会放在该文件夹之下。
当disableParentDoc=true时,则只会下载「测试」和「四级文档」两篇文档。其他文档因为其children存在文档,会将其作为文件夹,下载到本地的「四级文档」会被放置在文件夹之中。