ナレッジベースからチャンクを取得 / テスト検索

curl --request POST \ --url https://{api_base_url}/datasets/{dataset_id}/retrieve \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "query": "<string>", "external_retrieval_model": { "top_k": 123, "score_threshold": 123, "score_threshold_enabled": true }, "attachment_ids": [ "<string>" ] } '

{ "query": { "content": "What is Dify?" }, "records": [ { "segment": { "id": "f3d1c7be-9f3a-40d8-8eb8-3a1ef9c3f2c1", "position": 1, "document_id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac", "content": "Dify is an open-source LLM app development platform.", "sign_content": "", "answer": "", "word_count": 9, "tokens": 12, "keywords": [ "dify", "platform", "llm" ], "index_node_id": "a1b2c3d4-e5f6-7890-abcd-000000000001", "index_node_hash": "abc123def456", "hit_count": 1, "enabled": true, "disabled_at": null, "disabled_by": null, "status": "completed", "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4", "created_at": 1741267200, "indexing_at": 1741267200, "completed_at": 1741267200, "error": null, "stopped_at": null, "document": { "id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac", "data_source_type": "upload_file", "name": "guide.txt", "doc_type": null, "doc_metadata": null } }, "child_chunks": [], "score": 0.92, "tsne_position": null, "files": [], "summary": null } ] }

Authorizations

Authorization

string

header

required

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

Path Parameters

dataset_id

string<uuid>

required

ナレッジベース ID です。

Body

application/json

query

string

required

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

Maximum string length: 250

retrieval_model

object

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

Show child attributes

external_retrieval_model

object

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

Show child attributes

attachment_ids

string[] | null

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

Response

検索結果です。

query

object

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

Show child attributes

records

object[]

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

Show child attributes