Skip to main content
POST

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

每次调用都应发送幂等键,这样重试才安全。使用 8~255 个可打印 ASCII 字符,首尾不得有空白;格式不正确的键返回 400。

重复发送相同的键和请求体,会返回原批量任务,不会启动新的索引任务。以不同的请求体、通过其他 API 密钥、在其他知识库中或为其他操作复用该键,会返回 409。

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

标记为 nullable 的可选字段,传 null 等同于省略。

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

发送 all: true 或非空的 documentIds 数组,二者不可同时发送。使用 documentIds 时,all 可省略,也可为 false 或 null。使用 all: true 时,documentIds 可省略或为 null;空数组会被拒绝。

all
enum<boolean>
required

设为 true 时,重新索引该密钥可读取的所有文档文件。文件数超过上限(默认 100)时,调用返回 400,且不会重新索引任何内容。

Available options:
true
documentIds
string<uuid>[] | null

要重新索引的文档,可传文档 ID(从 获取文档列表 获取)或文档文件 ID(从 获取文档文件列表 获取)。部署可能设置更低的上限。重复的 ID 会合并,因此 total 可能小于发送的数量。每个 ID 只发送一次,items 就会按顺序与请求逐项对应。

Required array length: 1 - 100 elements

Response

索引任务已排入队列。

bulk_job_id
string

批量任务 ID。通过 获取批量任务 轮询。

items
object[]

发送的每个不同 ID 对应一个条目,按请求顺序排列;all 为 true 时,其后是每个选中文件对应的条目。解析为同一文档文件的多个 ID 共用一个条目。

total
integer

items 中的条目数。