使用 DeleteDocuments 接口删除指定的文档及其所有切片。
前提条件
已创建 AgentStorage 实例且状态为
normal,并获取实例访问地址(endpoint)和实例名。已创建 API Key。
待删除的文档已存在,删除不可逆。
请求参数
参数 | 类型 | 说明 |
| string | 知识库名称(必填) |
| string | 子空间名称。开启 subspace 时必填 |
| list<object> | 要删除的文档列表(必填),单次默认最多 10 个 |
| string | 文档 ID。与 `ossKey` 二选一 |
| string | OSS 路径。与 `docId` 二选一 |
请求示例
使用 API Key 认证时,通过 x-ots-instancename 和 x-ots-apikey 请求头传入实例名和 API Key。
curl -X POST https://<endpoint>/DeleteDocuments \
-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",
"documents": [
{"ossKey": "oss://example-bucket/docs/manual.pdf"}
]
}'响应
{
"code": "SUCCESS",
"data": {
"documentDetails": [
{
"ossKey": "oss://example-bucket/docs/manual.pdf",
"status": "succeed"
}
]
},
"message": "succeed"
}