AddDocuments - 添加文档到知识库
把已上传到知识库存储的文件注册为知识库文档并**自动触发解析**(切片、embedding)。支持两类导入: - `LOCAL_UPLOAD`:配合 `GetKnowledgeBasePreSignedUrl` 直传流程(本接口只注册,不再校验文件是否已真实上传,因此必须先完成 PUT 上传); - `OSS_IMPORT`:从外部 OSS 导入,接口先创建异步导入任务,返回 `knowledge_import_task_id`,由系统后台执行下载与注册。 单次最多 100 个文件。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /api/v1/datasets/{datasetId}/documents/addDocuments HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| datasetId |
string |
否 |
知识库 ID |
kd-03ec1e2385fcf |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求体 |
|
| KnowledgeBaseId |
string |
否 |
知识库 ID |
kb-3bd02617e9be335f |
| ImportType |
string |
否 |
导入类型 |
LOCAL_UPLOAD |
| StrategyId |
string |
否 |
处理策略 ID |
kb-strategy-7043984ca395eabd |
| Documents |
array<object> |
否 |
文档列表 |
|
|
object |
否 |
导入文档 |
||
| Path |
string |
否 |
文档路径,上传时使用的文件名/相对路径(与预签名请求一致) |
2026_06_23_17_49_52WwGSUezpG2u2iHWxyYGzkf9KtormhkxN/CHANGELOG.md |
| Name |
string |
否 |
文档名称 |
CHANGELOG.md |
| Size |
integer |
否 |
文件大小 |
1024 |
| StrategyId |
string |
否 |
处理策略 ID |
kb-strategy-7043984ca395eabd |
| Dedup |
object |
否 |
去重配置 |
|
| ContentDedup |
boolean |
否 |
是否启用内容去重 |
true |
| DocNameDedup |
boolean |
否 |
是否启用文档名去重 |
true |
| MetaFields |
any |
否 |
批量标签配置,Key 需为知识库已定义标签字段;Value 支持 string/int64/float32/bool/list |
{"department":"legal","topics":["policy","contract"],"reviewed":true} |
| dingTalkConfiguration |
object |
否 |
暂不支持,忽略 |
|
| userId |
string |
否 |
暂不支持,忽略 |
ignore |
| appId |
string |
否 |
暂不支持,忽略 |
ignore |
| appPassword |
string |
否 |
暂不支持,忽略 |
ignore |
| knowledgeType |
string |
否 |
暂不支持,忽略 |
ignore |
| knowledgeId |
string |
否 |
暂不支持,忽略 |
ignore |
| dingDocMcpLink |
string |
否 |
暂不支持,忽略 |
ignore |
| dingTableMcpLink |
string |
否 |
暂不支持,忽略 |
ignore |
| parentId |
string |
否 |
Defaults to root when omitted. |
root |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
请求 ID |
DDDBE0E5-4314-156F-B7F1-C4BCFD25A509 |
| data |
object |
返回结果 |
|
| errors |
array |
错误列表 |
|
|
string |
错误信息 |
文档添加失败 |
|
| documents |
array<object> |
文档列表 |
|
|
object |
文档 |
||
| id |
string |
文档 ID |
doc-123 |
| name |
string |
文档名称 |
example.pdf |
| datasetId |
string |
知识库 ID |
kb-123 |
| chunkMethod |
string |
切片方法 |
naive |
| run |
string |
处理状态 |
RUNNING |
| progress |
number |
处理进度 |
0 |
| size |
integer |
文件大小 |
1024 |
| location |
string |
对象路径 |
uploaded/doc-id/example.pdf |
| suffix |
string |
文件后缀 |
|
| thumbnail |
string |
缩略图 |
"" |
| tokenCount |
integer |
Token 数量 |
0 |
| chunkCount |
integer |
切片数量 |
0 |
| code |
integer |
返回状态码 |
0 |
| message |
string |
响应消息。 |
success |
| accessDeniedDetail |
string |
权限校验失败详情 |
{"PolicyType":"AccountLevelIdentityBasedPolicy","AuthPrincipalOwnerId":"1234567890123456","AuthPrincipalType":"SubUser","AuthPrincipalDisplayName":"1234567890123456","NoPermissionType":"ImplicitDeny","AuthAction":"milvusknowledgebase:ListDatasets"} |
| success |
boolean |
请求是否成功 |
true |
| httpStatusCode |
integer |
HTTP 状态码 |
403 |
{
"code": 0,
"message": "success",
"requestId": "DDDBE0E5-4314-156F-B7F1-C4BCFD25A509",
"success": true,
"data": {
"errors": [],
"documents": [
{
"id": "a38f814a914f11f19f10b19d12783d11",
"name": "contract-2026.md",
"datasetId": "kd-8b682030a90e5",
"chunkMethod": "naive",
"run": "RUNNING",
"progress": 0,
"size": 189385,
"location": "uploaded/a38f814a914f11f19f10b19d12783d11/contract-2026.md",
"suffix": "md",
"thumbnail": "",
"tokenCount": 0,
"chunkCount": 0
}
]
}
}
示例
正常返回示例
JSON格式
{
"requestId": "DDDBE0E5-4314-156F-B7F1-C4BCFD25A509",
"data": {
"errors": [
"文档添加失败"
],
"documents": [
{
"id": "doc-123",
"name": "example.pdf",
"datasetId": "kb-123",
"chunkMethod": "naive",
"run": "RUNNING",
"progress": 0,
"size": 1024,
"location": "uploaded/doc-id/example.pdf",
"suffix": "pdf",
"thumbnail": "\"\"",
"tokenCount": 0,
"chunkCount": 0
}
]
},
"code": 0,
"message": "success",
"accessDeniedDetail": "{\"PolicyType\":\"AccountLevelIdentityBasedPolicy\",\"AuthPrincipalOwnerId\":\"1234567890123456\",\"AuthPrincipalType\":\"SubUser\",\"AuthPrincipalDisplayName\":\"1234567890123456\",\"NoPermissionType\":\"ImplicitDeny\",\"AuthAction\":\"milvusknowledgebase:ListDatasets\"}",
"success": true,
"httpStatusCode": 403
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。