Skip to main content
DELETE
批量删除文档文件

Authorizations

Authorization
string
header
required

每个请求都通过 API Key 认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API Key,知识库接口使用知识库 API Key(快速开始)。

API Key 应保存在服务端,切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401(unauthorized)。

Headers

Idempotency-Key
string
required

本次删除请求的标识,必填。用同一个 API 密钥重复发送相同的键和请求,会返回原批次,并重试其中 pending 的文件。将该键用于其他请求,或通过其他 API 密钥使用,会返回 409。使用可打印 ASCII 字符,首尾不得有空白。

Required string length: 8 - 255

Path Parameters

knowledge_base_id
string<uuid>
required

知识库 ID:即知识库 API 访问 对话框中所示服务 API 端点的最后一段(…/knowledge-fs/spaces/<knowledge base ID>),也是地址栏中 /datasets/new/ 之后的那一段。

Body

application/json

规范化后的请求不得超过 1,048,576 个 UTF-8 字节。参见 请求大小限制。

documents
object[]
required

要删除的文件。每个 documentId 只能出现一次。超出上限的批次返回 400,部署也可能设置更低的上限。

Required array length: 1 - 100 elements

Response

批次已记录。results 给出每个文件的处理结果,items 列出已受理的文件。删除在后台进行。从文件的删除请求被受理起,获取文档文件 即返回 404。如需跟踪每个文件直到处理结束,轮询 获取删除批次(即批次的 status_url)。

轮询返回的作业 ID。如需重试仍为 pending 的文件,使用同一个 Idempotency-Key 再次发送相同的请求。

batch_id
string | null

记录本次请求的批次 ID。

items
object[]

每个已受理的文件对应一项。

results
object[]

请求中的每个文件对应一项,包含其处理结果。

status_url
string | null

此批次的 获取删除批次 URL:部署设置了 SERVICE_API_URL 时为绝对 URL,否则为以 /v1/ 开头的路径。批量删除文档文件 也会在 Location 响应头中返回该值。

total
integer

原请求中的文件数。