mcpField
D
dify-knowledge-base-search

dify-knowledge-base-search

github.com/tiangong-ai数据与数据库11113 次安装1 周前更新
代码仓库

关于 dify-knowledge-base-search

dify-knowledge-base-search 是一项用于通过 Dify 检索数据集内容的技能,面向需要在查询中调用知识库检索的工作流。它说明了请求配置、响应解读及常见故障排查。

主要功能

  1. 01调用 Dify 数据集检索接口
  2. 02支持设置查询与 top_k
  3. 03解析检索响应记录
  4. 04提供认证与路由排查建议

适用场景

  1. 01按查询检索 Dify 数据集
  2. 02调整 top_k 获取更多记录
  3. 03排查 API 认证或路由错误

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/tiangong-ai/agent-skills --skill dify-knowledge-base-search

安装后在 Claude Code 中输入/dify-knowledge-base-search确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

agents/
openai.yaml
assets/
example-request.json
references/
env.md
request-response.md
testing.md

详细介绍

Dify 知识库搜索

准备必需的输入

  • 提供 data,其内容为包含 query 和可选 retrieval_model.top_k 的 JSON。
  • 读取这些环境变量:
    • DIFY_API_BASE_URL:基础 API URL,需包含 /v1(示例:https://api.dify.ai/v1)。
    • DIFY_DATASET_ID:目标数据集 ID。
    • DIFY_API_KEY:以 Authorization: Bearer <DIFY_API_KEY> 的形式发送。

发送请求

  • 端点:${DIFY_API_BASE_URL}/datasets/${DIFY_DATASET_ID}/retrieve
  • 请求头:
    • Content-Type: application/json
    • Authorization: Bearer <DIFY_API_KEY>
  • 使用 assets/example-request.json 作为请求载荷模板。
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。

参考

  • references/env.md
  • references/request-response.md
  • references/testing.md

资源文件

  • assets/example-request.json

评论

支持 Markdown