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

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

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

需提供非空白的 query。

query
string
required

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

Maximum string length: 16000
Pattern: \S
budgetUsd
number | null

用于与成本估算比较的花费上限(USD)。决定响应中的 budget.exceeds_budget 和 budget.remaining_budget_usd。

Required range: x >= 0
mode
enum<string> | null

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

Available options:
fast,
deep,
research,
null
topK
integer | null

检索结果合并并重排序后最多保留的分段数。显式传入的值必须在 1~50 之间。省略时使用知识库已发布的 Top K 设置,该设置最高可达 100。值越大,模型获得的上下文越多,干扰也越多;值越小,结果越集中,但可能漏掉相关分段。

Required range: 1 <= x <= 50

Response

规划结果及其估算。

budget
object

成本估算与请求中 budgetUsd 的比较结果。

estimates
object

任务的工作量、成本和延迟估算。可与你打算发送给 创建研究任务 的 limits 对比。

knowledge_space_id
string

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

query
string

去除首尾空白后的问题。

retrieval_plan
object

检索将如何执行。

steps
object[]

各步骤的估算,按执行顺序排列。

strategy_version
string

估算器的版本。