调用本接口返回 Mainboard 生成的 Markdown 预签名下载地址和重导入元数据,不返回文件流。
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
scope | String | 是 | Markdown 下载范围
|
doc_id | Number | 是 | VeRAG 文档ID,doc 模式必填 |
page_size | Number | 否 | 整库下载的顶层文档页大小 |
page_token | Number | 否 | 整库下载游标 |
include_import_params | Boolean | 否 | 是否返回重导入参数 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
code | Number | 是 | 响应码:0=成功,非0=失败 |
msg | String | 否 | Code非0时,返回错误信息 |
message | String | 否 | 错误信息 |
data | Object | 是 | 数据,详情请参见下文 data 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
scope | String | 是 | Markdown 下载范围
|
items | Array | 否 | 根文档列表,详情请参见下文 items 表 |
total_count | Number | 否 | 顶层文档总数 |
success_count | Number | 否 | 当前树中可下载节点数 |
next_page_token | Number | 否 | 下一页游标 |
has_more | Boolean | 否 | 是否还有下一页 |
total_doc_count | Number | 否 | 含子文档的总文档数 |
returned_doc_count | Number | 否 | 当前响应节点数 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
doc_id | Number | 是 | Mainboard 文档ID,所有递归节点均有值 |
verag_doc_id | Number | 否 | VeRAG 文档ID;仅存在本地映射时返回 |
task_id | Number | 否 | 导入任务ID |
status | String | 是 | 单个 Mainboard entry 的 Markdown 可下载状态,而非整个 RPC 的执行结果。
|
reason | String | 否 | 不可下载原因 |
download_url | String | 否 | 可直接访问的下载地址 |
expire_at | Number | 否 | 下载地址过期时间戳 |
file_metadata | Object | 否 | 文件元数据,详情请参见下文 file_metadata 表 |
import_params | Object | 否 | 重导入参数,详情请参见下文 import_params 表 |
import_params_reason | String | 否 | 重导入参数缺失原因 |
parent_entry_id | Number | 否 | 父 Mainboard entry ID |
direct_child_count | Number | 否 | 直接子文档数 |
descendant_count | Number | 否 | 所有层级子文档数 |
children | Array | 否 | 递归子文档,支持递归配置 items 参数 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
original_file_name | String | 否 | 原始文件名 |
markdown_file_name | String | 否 | Markdown 文件名 |
doc_type | String | 否 | 文档类型 |
source | String | 否 | 导入来源 |
markdown_object_key | String | 否 | Markdown 对象元数据路径 |
metadata_source | String | 否 | 对象键来源 |
content_type | String | 否 | 内容类型 |
create_time | Number | 否 | 创建时间戳 |
modify_time | Number | 否 | 修改时间戳 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
import_settings | String | 否 | 导入配置JSON |
chunk_settings | String | 否 | 切分配置JSON |
tags | Array | 否 | 重导入标签,详情请参见下文 tags 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
key | String | 否 | 标签键 |
field | String | 否 | 标签字段 |
value | Array | 否 | 标签值 |