Skip to main content
GET
获取删除作业

Authorizations

Authorization
string
header
required

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

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

Path Parameters

knowledge_base_id
string<uuid>
required

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

deletion_job_id
string<uuid>
required

删除作业 ID:即 删除文档文件 或 删除数据源 返回的 job.id,或 批量删除文档文件、获取删除批次 中某个已受理文件的 job.id。这些响应中的 status_url 指向此接口。

Response

删除作业。

checkpoint
string

删除进行到哪一步:从 requested(刚受理)开始,依次经过 quiescing、deleting_objects、deleting_derived_data、deleting_primary_data,直到 completed。

completed_at
string | null

作业完成时间,ISO 8601 格式。完成前以及作业为 failed 时为 null。

created_at
string

作业的受理时间,ISO 8601 格式。

error
object | null

最近一次错误,没有错误时为 null。run_state 为 retry_wait 时也会设置此字段,因此判断作业是否失败应看 run_state,而不是 error。

id
string

删除作业 ID。

knowledge_space_id
string

知识库的内部 ID,并非路径中的知识库 ID。

mode
string | null

删除数据源时如何处理其文档:cascade 一并删除,keep 保留。删除文档文件时,该值不表示删除会移除哪些内容。

progress
object | null

多项删除的项数统计。此 API 不填充该字段,始终为 null。

retry_at
string | null

下次自动重试的时间,ISO 8601 格式。未安排重试时为 null。

run_state
string

调度状态:

  • dispatch_pending(刚受理)、queued、running:进行中。
  • retry_wait:已安排在 retry_at 自动重试。
  • completed:已全部移除。
  • failed:清理已停止,删除目标仍保持隐藏,且无法重试。
target_id
string

删除目标的 ID:document 时为文档文件 ID,source 时为数据源 ID。

target_type
string

作业删除的对象:document 表示文档文件,source 表示数据源。

updated_at
string

作业最后变更时间,ISO 8601 格式。