Document Transfer 模块
文档迁移接口
本文介绍文档迁移相关的 3 个接口。异步导出 document、下载导出文件,以及异步导入 document,用于数据迁移。
调用说明
- 接入地址:
https://cloud.memory.bj.baidubce.com/api,下文路径直接拼接在该地址后。
- 请求头:
Authorization: Bearer <token> 必填;有 JSON 请求体时需携带 Content-Type: application/json。
- 错误码、异步操作和
operationId 的说明见 API 简介。
接口列表
| 接口 |
方法 |
路径 |
| 异步导出 document |
POST |
/v1/default/banks/{bank_id}/document-transfer/export |
| 下载导出文件 |
GET |
/v1/default/files/download/{key} |
| 导入 document(异步) |
POST |
/v1/default/banks/{bank_id}/document-transfer |
异步导出 document
POST /v1/default/banks/{bank_id}/document-transfer/export
提交异步 document 导出任务,将 Bank 中的 document(抽取的事实、entity 名称、因果链接和 chunks)打包为迁移用 ZIP 归档。归档不包含 embeddings 和数据库 ID;导入时会使用目标 Bank 的模型重新生成 embedding 并解析实体。除非设置 include_observations=true,否则不会导出 consolidation 后的 observations。传入 document_id 查询参数可导出指定 document;省略时导出整个 Bank。接口立即返回 operation_id,可通过异步操作接口查询进度;完成后从操作结果中取得下载地址。
参数
| 名称 |
In |
类型 |
必填 |
说明 |
bank_id |
path |
string |
是 |
Bank 的唯一标识符。 |
document_id |
query |
array<string>? |
否 |
要导出的 document ID;省略时导出全部 documents。 |
include_observations |
query |
boolean |
否 |
同时导出 consolidation 后的 observations(导入时恢复);默认值:false |
请求头
| 名称 |
In |
类型 |
必填 |
说明 |
Authorization |
header |
string |
是 |
Bearer token。 |
响应
- 状态码:
202 — 已接受导出任务
- 格式:
application/json
| 字段 |
类型 |
必填 |
说明 |
operation_id |
string |
是 |
异步导出操作的 ID。 |
status |
string |
否 |
初始状态,通常为pending。 |
响应示例
1{
2 "operation_id": "550e8400-e29b-41d4-a716-446655440000",
3 "status": "pending"
4}
响应
- 状态码:
422 — 校验错误
- 格式:
application/json
| 字段 |
类型 |
必填 |
说明 |
detail |
array<ValidationError> |
否 |
详细信息或校验错误列表。 |
detail[] · ValidationError
数据结构 ValidationError:
| 字段 |
类型 |
必填 |
说明 |
loc |
array<string \| integer> |
是 |
发生校验错误的位置路径;数组元素可以是字段名或索引。 |
msg |
string |
是 |
错误消息或状态消息。 |
type |
string |
是 |
对象或错误的类型。 |
input |
any |
否 |
触发校验的原始输入值。 |
ctx |
Context |
否 |
错误上下文信息。 |
响应示例
1{
2 "detail": [
3 {
4 "loc": [],
5 "msg": "string",
6 "type": "string",
7 "input": null,
8 "ctx": {}
9 }
10 ]
11}
operationId=export_documents
下载导出文件
GET /v1/default/files/download/{key}
下载异步导出任务生成并存入文件存储的 ZIP 归档。key 来自导出操作的 result_metadata(storage_key 或 download_url);服务端会根据该 key 所属的 Bank 校验访问权限,并以附件形式返回文件。
参数
| 名称 |
In |
类型 |
必填 |
说明 |
key |
path |
string |
是 |
要下载的文件 key。 |
请求头
| 名称 |
In |
类型 |
必填 |
说明 |
Authorization |
header |
string |
是 |
Bearer token。 |
响应
- 状态码:
200 — 文件内容
- 格式:
application/octet-stream
响应
- 状态码:
422 — 校验错误
- 格式:
application/json
| 字段 |
类型 |
必填 |
说明 |
detail |
array<ValidationError> |
否 |
校验错误列表。 |
detail[] · ValidationError
| 字段 |
类型 |
必填 |
说明 |
loc |
array<string \| integer> |
是 |
发生校验错误的位置路径。 |
msg |
string |
是 |
错误消息。 |
type |
string |
是 |
错误类型。 |
input |
any |
否 |
触发校验的原始输入值。 |
ctx |
Context |
否 |
错误上下文。 |
operationId=download_file
导入 document(异步)
POST /v1/default/banks/{bank_id}/document-transfer
提交 transfer archive(由 export 接口生成)导入 Bank。作为后台 operation 运行:使用目标 Bank 的 embedding model 重新生成 facts embedding,并重新解析 entities,不执行 LLM 抽取。返回 operation_id;轮询 GET /v1/default/banks/{bank_id}/operations/{operation_id} 获取状态及 result_metadata 中导入/跳过的数量。使用 on_conflict 控制已有 document ID:skip(默认)、replace 或 new-id。
参数
| 名称 |
In |
类型 |
必填 |
说明 |
bank_id |
path |
string |
是 |
Bank 的唯一标识符。 |
on_conflict |
query |
string |
否 |
skip| replace | new-id;默认值:"skip" |
请求头
| 名称 |
In |
类型 |
必填 |
说明 |
Authorization |
header |
string |
是 |
Bearer token。 |
Content-Type |
header |
string |
是 |
固定multipart/form-data |
请求体
- 格式:
multipart/form-data
- 必填:是
| 字段 |
类型 |
必填 |
说明 |
file |
string(binary) |
是 |
用于传输的 ZIP archive。 |
请求示例
响应
- 状态码:
202 — 成功响应
- 格式:
application/json
| 字段 |
类型 |
必填 |
说明 |
operation_id |
string |
是 |
异步操作 的唯一标识符,可用于查询状态。 |
status |
string |
否 |
默认值:"pending" |
响应示例
1{
2 "operation_id": "string",
3 "status": "pending"
4}
响应
- 状态码:
422 — 校验错误
- 格式:
application/json
| 字段 |
类型 |
必填 |
说明 |
detail |
array<ValidationError> |
否 |
详细信息或校验错误列表。 |
detail[] · ValidationError
数据结构 ValidationError:
| 字段 |
类型 |
必填 |
说明 |
loc |
array<string \| integer> |
是 |
发生校验错误的位置路径;数组元素可以是字段名或索引。 |
msg |
string |
是 |
错误消息或状态消息。 |
type |
string |
是 |
对象或错误的类型。 |
input |
any |
否 |
触发校验的原始输入值。 |
ctx |
Context |
否 |
错误上下文信息。 |
响应示例
1{
2 "detail": [
3 {
4 "loc": [],
5 "msg": "string",
6 "type": "string",
7 "input": null,
8 "ctx": {}
9 }
10 ]
11}
operationId=import_documents