ナレッジベース
ナレッジベースからチャンクを取得 / テスト検索
ナレッジベースを検索し、クエリに最も関連性の高いチャンクを返します。本番環境の検索とテスト検索の両方に使用できます。
インデックス方法が economy のナレッジベースでは、常にキーワード検索を使用し、retrieval_model.search_method は無視されます。
POST
/
datasets
/
{dataset_id}
/
retrieve
ナレッジベースからチャンクを取得 / テスト検索
curl --request POST \
--url https://{api_base_url}/datasets/{dataset_id}/retrieve \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"attachment_ids": [
"<string>"
],
"external_retrieval_model": {
"score_threshold": 123,
"score_threshold_enabled": true,
"top_k": 123
}
}
'import requests
url = "https://{api_base_url}/datasets/{dataset_id}/retrieve"
payload = {
"query": "<string>",
"attachment_ids": ["<string>"],
"external_retrieval_model": {
"score_threshold": 123,
"score_threshold_enabled": True,
"top_k": 123
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
attachment_ids: ['<string>'],
external_retrieval_model: {score_threshold: 123, score_threshold_enabled: true, top_k: 123}
})
};
fetch('https://{api_base_url}/datasets/{dataset_id}/retrieve', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_base_url}/datasets/{dataset_id}/retrieve",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'attachment_ids' => [
'<string>'
],
'external_retrieval_model' => [
'score_threshold' => 123,
'score_threshold_enabled' => true,
'top_k' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{api_base_url}/datasets/{dataset_id}/retrieve"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"attachment_ids\": [\n \"<string>\"\n ],\n \"external_retrieval_model\": {\n \"score_threshold\": 123,\n \"score_threshold_enabled\": true,\n \"top_k\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{api_base_url}/datasets/{dataset_id}/retrieve")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"attachment_ids\": [\n \"<string>\"\n ],\n \"external_retrieval_model\": {\n \"score_threshold\": 123,\n \"score_threshold_enabled\": true,\n \"top_k\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/datasets/{dataset_id}/retrieve")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"attachment_ids\": [\n \"<string>\"\n ],\n \"external_retrieval_model\": {\n \"score_threshold\": 123,\n \"score_threshold_enabled\": true,\n \"top_k\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"query": {
"content": "What is Dify?"
},
"records": [
{
"child_chunks": [],
"files": [],
"score": 0.92,
"segment": {
"answer": "",
"completed_at": 1741267200,
"content": "Dify is an open-source LLM app development platform.",
"created_at": 1741267200,
"created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
"disabled_at": null,
"disabled_by": null,
"document": {
"data_source_type": "upload_file",
"doc_metadata": null,
"doc_type": null,
"id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
"name": "guide.txt"
},
"document_id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
"enabled": true,
"error": null,
"hit_count": 1,
"id": "f3d1c7be-9f3a-40d8-8eb8-3a1ef9c3f2c1",
"index_node_hash": "abc123def456",
"index_node_id": "a1b2c3d4-e5f6-7890-abcd-000000000001",
"indexing_at": 1741267200,
"keywords": [
"dify",
"platform",
"llm"
],
"position": 1,
"sign_content": "",
"status": "completed",
"stopped_at": null,
"tokens": 12,
"word_count": 9
},
"summary": null,
"tsne_position": null
}
]
}Authorizations
すべてのリクエストは、Authorization: Bearer {API_KEY} ヘッダーに指定した API キーで認証します。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーがない、または無効な場合は HTTP 401（unauthorized）が返ります。
Path Parameters
ナレッジベース ID。ナレッジベースリストを取得 で取得します。スコープを限定したキーでは、Dify の URL から ID をコピー してください。
Body
application/json
Was this page helpful?
⌘I
ナレッジベースからチャンクを取得 / テスト検索
curl --request POST \
--url https://{api_base_url}/datasets/{dataset_id}/retrieve \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"attachment_ids": [
"<string>"
],
"external_retrieval_model": {
"score_threshold": 123,
"score_threshold_enabled": true,
"top_k": 123
}
}
'import requests
url = "https://{api_base_url}/datasets/{dataset_id}/retrieve"
payload = {
"query": "<string>",
"attachment_ids": ["<string>"],
"external_retrieval_model": {
"score_threshold": 123,
"score_threshold_enabled": True,
"top_k": 123
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
attachment_ids: ['<string>'],
external_retrieval_model: {score_threshold: 123, score_threshold_enabled: true, top_k: 123}
})
};
fetch('https://{api_base_url}/datasets/{dataset_id}/retrieve', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_base_url}/datasets/{dataset_id}/retrieve",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'attachment_ids' => [
'<string>'
],
'external_retrieval_model' => [
'score_threshold' => 123,
'score_threshold_enabled' => true,
'top_k' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{api_base_url}/datasets/{dataset_id}/retrieve"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"attachment_ids\": [\n \"<string>\"\n ],\n \"external_retrieval_model\": {\n \"score_threshold\": 123,\n \"score_threshold_enabled\": true,\n \"top_k\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{api_base_url}/datasets/{dataset_id}/retrieve")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"attachment_ids\": [\n \"<string>\"\n ],\n \"external_retrieval_model\": {\n \"score_threshold\": 123,\n \"score_threshold_enabled\": true,\n \"top_k\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/datasets/{dataset_id}/retrieve")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"attachment_ids\": [\n \"<string>\"\n ],\n \"external_retrieval_model\": {\n \"score_threshold\": 123,\n \"score_threshold_enabled\": true,\n \"top_k\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"query": {
"content": "What is Dify?"
},
"records": [
{
"child_chunks": [],
"files": [],
"score": 0.92,
"segment": {
"answer": "",
"completed_at": 1741267200,
"content": "Dify is an open-source LLM app development platform.",
"created_at": 1741267200,
"created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
"disabled_at": null,
"disabled_by": null,
"document": {
"data_source_type": "upload_file",
"doc_metadata": null,
"doc_type": null,
"id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
"name": "guide.txt"
},
"document_id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
"enabled": true,
"error": null,
"hit_count": 1,
"id": "f3d1c7be-9f3a-40d8-8eb8-3a1ef9c3f2c1",
"index_node_hash": "abc123def456",
"index_node_id": "a1b2c3d4-e5f6-7890-abcd-000000000001",
"indexing_at": 1741267200,
"keywords": [
"dify",
"platform",
"llm"
],
"position": 1,
"sign_content": "",
"status": "completed",
"stopped_at": null,
"tokens": 12,
"word_count": 9
},
"summary": null,
"tsne_position": null
}
]
}