使用 UpdateDocument 接口更新指定文档的 metadata。待更新的文档状态为 completed。metadata 采用覆盖式更新,传入的值会全量替换原有 metadata;如果只想更新一个字段,必须把所有字段都带上。传入 `"metadata": null` 会清空所有 metadata。
前提条件
已创建 AgentStorage 实例且状态为
normal,并获取实例访问地址(endpoint)和实例名。已创建 API Key。
待更新的文档状态为 completed。
请求参数
参数 | 类型 | 说明 |
| string | 知识库名称(必填) |
| string | 子空间名称。开启 subspace 时必填 |
| string | 文档 OSS 路径。与 `docId` 二选一 |
| string | 文档 ID。与 `ossKey` 二选一 |
| map | 新的 metadata(可选)。省略该字段保留原值,并返回 NO_OP;显式传 null 清空全部元数据;传对象时全量替换原有元数据 |
请求示例
使用 API Key 认证时,通过 x-ots-instancename 和 x-ots-apikey 请求头传入实例名和 API Key。
curl -X POST https://<endpoint>/UpdateDocument \
-H "x-ots-instancename: <instance-name>" \
-H "x-ots-apikey: <your-api-key>" \
-H "Content-Type: application/json" \
-d '{
"knowledgeBaseName": "product_docs_kb",
"subspace": "default",
"ossKey": "oss://example-bucket/docs/manual.pdf",
"metadata": {"author": "李四", "date": "2026-02-01 12:00:00", "score": 80}
}'响应
字段 | 类型 | 说明 |
| string | 文档 ID |
| string | OSS 路径 |
| long | 更新时间戳 |
| string | NO_OP` 或 `UPDATED |