用途:集成或调试 Dify 知识库检索请求,调用 Dify 的 dataset retrieve API 完成知识库分块搜索与测试。
主要能力:向指定数据集发送查询,返回匹配的知识库记录;支持通过 retrieval_model.top_k 控制返回数量,便于调试与测试检索效果。
必要配置:需准备三个环境变量。DIFY_API_BASE_URL 为基础 API 地址且需包含 /v1(示例:https://api.dify.ai/v1);DIFY_DATASET_ID 为目标数据集 ID;DIFY_API_KEY 以 Authorization: Bearer <DIFY_API_KEY> 形式发送。请求数据为 JSON,包含 query 和可选的 retrieval_model.top_k,可参考 assets/example-request.json 作为载荷模板。
使用方式:请求端点为 ${DIFY_API_BASE_URL}/datasets/${DIFY_DATASET_ID}/retrieve,请求头为 Content-Type: application/json 与 Authorization: Bearer <DIFY_API_KEY>。示例命令:
curl -sS --location --request POST "$DIFY_API_BASE_URL/datasets/$DIFY_DATASET_ID/retrieve"
--header 'Content-Type: application/json'
--header "Authorization: Bearer $DIFY_API_KEY"
--data @assets/example-request.json
响应与调试:请求体形状为 { "query": string, "retrieval_model"?: { "top_k": number } };成功返回 200 与 { query, records: [...] }。若 records 为空,可适度提高 retrieval_model.top_k 后重试。鉴权失败时检查 DIFY_API_KEY 与 Authorization 头格式;路由失败时确认 DIFY_API_BASE_URL 包含 /v1;结果质量不佳时优化 query 并调整 top_k。
适用场景:Dify 知识库检索功能的接入、联调与检索测试。限制:需具备有效的 Dify API 凭据与数据集 ID;其余细节暂未提供,参考资料见 references/env.md、references/request-response.md、references/testing.md。