メインコンテンツへスキップ
POST
ナレッジベースからチャンクを取得 / テスト検索

承認

Authorization
string
header
必須

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

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401unauthorized)で失敗します。

パスパラメータ

dataset_id
string<uuid>
必須

ナレッジベース ID です。ナレッジベースリストを取得 から取得します。

ボディ

application/json
query
string
必須

検索クエリテキストです。

Maximum string length: 250
retrieval_model
object

検索モデルの設定です。このナレッジベースをクエリする際のチャンクの検索方法とランキング方法を制御します。

attachment_ids
string[] | null

検索コンテキストに含める添付ファイル ID のリストです。

external_retrieval_model
object

外部ナレッジベースの検索設定です。

レスポンス

検索結果です。

query
object

元のクエリオブジェクトです。

records
object[]

一致した検索レコードのリスト。