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)。

Path Parameters

knowledge_base_id
string<uuid>
required

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

Body

application/json

包含未知字段时返回 400。

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

需提供非空白的 query。

query
string
required

要查询的问题。不能为空白,且不超过 16,384 个 UTF-8 字节。

Maximum string length: 16000
Pattern: \S
activeDocumentIds
string[]

这些 ID 不会对检索到的内容进行筛选或排序。留空即可。

Maximum array length: 100
activeEntityIds
string[]

这些 ID 不会对检索到的内容进行筛选或排序。留空即可。

Maximum array length: 100
mode
enum<string> | null

检索深度:fast、deep 或 research(参见 检索深度)。省略(或传 null)时使用知识库的默认深度,即 获取知识库设置 中的 retrieval.default_mode。

Available options:
fast,
deep,
research,
null
sessionId
string | null

查询会话 ID,格式为 UUID。省略则开启新会话。运行查询 会在 x-session-id 响应头中返回会话 ID。

一个会话保存最近 20 次查询,但不会把它们带入之后的回答。30 分钟内没有查询,会话即过期。

传入已过期或未知的 ID 时,会以该 ID 开启一个新会话,因此你自行生成的 UUID 始终可以用作该会话的 ID。

Response

查询令牌已签发。

expires_at
string

令牌的过期时间,为 UTC 时区的 ISO 8601 时间戳。最晚为签发后 60 秒,部署方可缩短这一有效期。

operation_id
string

始终为 createQuery,即该令牌适用的操作。调用方可忽略此字段。

request
object

运行查询 的请求体,需原样发送。

token
string

用于对该知识库调用 运行查询 的查询令牌,在 expires_at 之前有效。以 Authorization: Bearer <token> 的形式发送。

每次调用都要创建新令牌,重试也不例外。

令牌是签名的 JWT。X-Trace-ID 请求头的值直接从本响应的 trace_id 读取,无需解码令牌。

trace_id
string

调用 运行查询 时作为 X-Trace-ID 请求头发送的值,与令牌中的 trace_id 声明相同。它不是查询记录 ID。

url
string

运行查询 的请求地址。部署设置了 SERVICE_API_URL 时为绝对 URL;否则为路径 /v1/knowledge-fs/query-stream,其中已包含 /v1 前缀。这种情况下,基于端点的协议和主机解析该路径,不要基于端点的路径解析。