从知识库检索分段 / 测试检索

对知识库执行搜索查询，检索最相关的分段。此接口可用于生产环境检索和测试检索。

POST /datasets/{dataset_id}/retrieve

Error

A valid request URL is required to generate request examples

200

success

{ "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 } ] }

授权

Authorization · string · header · 必填

API Key 认证。对于所有 API 请求，请在 Authorization HTTP 头中包含您的 API Key，并加上 Bearer 前缀。示例：Authorization: Bearer {API_KEY}。强烈建议将 API Key 存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。

路径参数

dataset_id · string<uuid> · 必填

知识库 ID。

请求体

application/json

query · string · 必填

搜索查询文本。

Maximum string length: 250

retrieval_model · object

检索模型配置。控制查询此知识库时如何搜索和排序分段。

Show child attributes

external_retrieval_model · object

外部知识库的检索设置。

Show child attributes

attachment_ids · string[] | null

要包含在检索上下文中的附件 ID 列表。

响应

200

application/json

检索结果。

query · object

原始查询对象。

Show child attributes

records · object[]

匹配的检索记录列表。

Show child attributes