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/ 之后的那一段。

source_id
string<uuid>
required

数据源 ID,通过 获取数据源列表 获取。

Query Parameters

documents
enum<string>
default:cascade

cascade 会同时删除该数据源生成的文档。keep 保留这些文档:删除作业运行期间会隐藏它们,作业完成后重新显示,此时 source_id 为 null,且不再刷新。

用 keep 删除前,先从 获取文档文件列表 保存 source_id 为此数据源的文件 ID:删除完成后,这些文件的 source_id 会变为 null。

Available options:
cascade,
keep

Body

application/json

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

expectedRevision
integer
required

数据源当前的 version,取自 获取数据源列表 或 获取数据源。值已过时则返回 409,不做任何更改。

Required range: x >= 1

Response

已受理删除请求。job 描述后台删除过程。

从删除请求被受理起,获取数据源 即返回 404。如需确认删除已结束,轮询 获取删除作业(即 status_url),直到 run_state 为 completed 或 failed。

document_title
string | null

删除数据源时始终为 null。

job
object

删除作业。target_type 为 source,mode 回显传入的 documents。

status_url
string

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