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 密钥重复发送相同的键和请求,会以 202 返回原作业。将该键用于其他请求,或通过其他 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/ 之后的那一段。

document_file_id
string<uuid>
required

文档文件 ID。从 获取文档文件列表 获取。

Body

application/json

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

expectedRevision
integer
required

文档文件当前的 version,从 获取文档文件列表 或 获取文档文件 获取。文档文件的 version 始终为 1。不是 获取文档修订版本列表 返回的修订版本号。值已过时则返回 409,不会删除任何内容。

Required range: x >= 1

Response

删除请求已受理,在后台进行。从删除请求被受理起,获取文档文件 即返回 404。如需确认删除已结束,轮询 获取删除作业(即 status_url),直到 run_state 为 completed 或 failed。

document_title
string | null

删除文档文件时始终为 null。

job
object
status_url
string

此作业的 获取删除作业 URL:部署设置了 SERVICE_API_URL 时为绝对 URL,否则为以 /v1/ 开头的路径。Location 响应头中返回相同的值。