删除文档
删除当前 RAG 知识库下的指定文档。服务会尝试删除物理文件、向量数据和数据库记录。
Try It
DELETE
/documents/documentshttps://api-platform.ope.ai认证
使用 Bearer Token 认证。
- Header:
Authorization: Bearer <token> - 示例:
Authorization: Bearer sk-xxxxxx
请求体(application/json)
| 字段 | 类型 | 必填 | 说明 | 默认值 / 范围 |
|---|---|---|---|---|
doc_id | string | 是 | 要删除的文档 ID | - |
请求示例
- cURL
- JavaScript
curl -X DELETE "https://api-platform.ope.ai/documents/documents" \
-H "Authorization: Bearer $OPEAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"doc_id":"doc_1"}'
const res = await fetch("https://api-platform.ope.ai/documents/documents", {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.OPEAI_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({doc_id: "doc_1"}),
});
console.log(await res.json());
响应示例
{
"status": "deleted",
"doc_id": "doc_1"
}
错误响应
| 状态码 | 场景 | 说明 |
|---|---|---|
401 | 鉴权失败 | API Key 缺失、无效或权限不足 |
422 | 参数校验失败 | doc_id 缺失或格式不正确 |
500 | 删除失败 | 文件、向量数据或数据库记录删除失败 |