Files 模块
更新时间:2026-11-03
文件接口
本文介绍文件相关的 1 个接口。上传 PDF、DOCX、图片、音频等文件,自动转换为 Markdown 并异步写入记忆。
调用说明
- 接入地址:
https://cloud.memory.bj.baidubce.com/api,下文路径直接拼接在该地址后。 - 请求头:
Authorization: Bearer <token>必填;有 JSON 请求体时需携带Content-Type: application/json。 - 错误码、异步操作和
operationId的说明见 API 简介。
接口列表
| 接口 | 方法 | 路径 |
|---|---|---|
| 将文件转换为记忆 | POST |
/v1/default/banks/{bank_id}/files/retain |
将文件转换为记忆
POST /v1/default/banks/{bank_id}/files/retain
上传文件(PDF、DOCX 等),将其转换为 Markdown,并 Retain 为 memories。
此接口在一次操作中完成文件上传、转换和 memory 创建。
功能:
- 支持 PDF、DOCX、PPTX、XLSX、图片和音频(含 OCR 与音频转写)
- 自动将文件转换为 Markdown
- 将文件存入服务端配置的文件存储
- 每个文件分别生成一个 document,可附带元数据和标签
- 始终异步处理,并立即返回异步操作 ID
系统会自动:
- 将上传的文件存入服务端配置的文件存储
- 将文件转换为 Markdown
- 创建包含文件元数据的 document 记录
- 抽取事实并创建 memory unit(与常规 Retain 相同)
可通过 Operations 接口监控进度。
请求格式: multipart/form-data,包含:
files:一个或多个待上传文件。request: 符合 FileRetainRequest 数据结构的 JSON 字符串。
参数
| 名称 | In | 类型 | 必填 | 说明 |
|---|---|---|---|---|
bank_id |
path | string |
是 | Bank 的唯一标识符。 |
请求头
| 名称 | In | 类型 | 必填 | 说明 |
|---|---|---|---|---|
Authorization |
header | string |
是 | Bearer token。 |
Content-Type |
header | string |
是 | 固定multipart/form-data |
请求体
- 格式:
multipart/form-data - 必填:是
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
files |
array<string(binary)> |
是 | 要上传并转换的文件。 |
request |
string |
是 | 符合 FileRetainRequest 数据结构的 JSON 字符串。 |
请求示例
JSON
1{
2 "files": [
3 "string"
4 ],
5 "request": "string"
6}
响应
- 状态码:
200— 成功响应 - 格式:
application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
operation_ids |
array<string> |
是 | 用于跟踪文件转换 operations 的 ID 列表。使用 GET /v1/default/banks/{bank_id}/operations 列出 operations。 |
响应示例
JSON
1{
2 "operation_ids": [
3 "550e8400-e29b-41d4-a716-446655440000",
4 "550e8400-e29b-41d4-a716-446655440001",
5 "550e8400-e29b-41d4-a716-446655440002"
6 ]
7}
响应
- 状态码:
422— 校验错误 - 格式:
application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
detail |
array<ValidationError> |
否 | 详细信息或校验错误列表。 |
detail[] · ValidationError
数据结构 ValidationError:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
loc |
array<string \| integer> |
是 | 发生校验错误的位置路径;数组元素可以是字段名或索引。 |
msg |
string |
是 | 错误消息或状态消息。 |
type |
string |
是 | 对象或错误的类型。 |
input |
any |
否 | 触发校验的原始输入值。 |
ctx |
Context |
否 | 错误上下文信息。 |
响应示例
JSON
1{
2 "detail": [
3 {
4 "loc": [],
5 "msg": "string",
6 "type": "string",
7 "input": null,
8 "ctx": {}
9 }
10 ]
11}
operationId=file_retain
评价此篇文章
