Skip to main content
POST
リサーチタスクを計画

Authorizations

Authorization
string
header
required

すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは 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 は省略と同じ扱いになります。

正規化後のリクエストは、UTF-8 で 65,536 バイト以内に収める必要があります。リクエストサイズの制限 を参照してください。

空白のみではない query を指定してください。

query
string
required

質問です。空白のみではないクエリを指定してください。また、UTF-8 で 16,384 バイトまでに制限されます。

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 の値にしてください。省略すると、ナレッジベースで公開されている トップ 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

見積もりロジックのバージョンです。