「Mac畅玩AIGC与多模态35」开发篇30 - 将知识库搜索能力封装为 Dify 插件并注册使用

一、概述

本篇基于前一章已完成的知识库搜索服务，介绍如何将该服务封装为符合 OpenAPI 3.0 的插件描述文档，并注册到 Dify 工具平台中，从而支持在智能体和工作流中以插件方式调用该知识搜索能力。

二、目标说明

• 编写标准的 OpenAPI 插件 Schema 文档
• 注册为 Dify 的自定义插件
• 验证插件在工具管理与测试界面可用

三、在 Dify 中添加自定义插件

1. 新建插件

• 登录 Dify 后台
• 点击「工具」栏目，选择「自定义」，点击「创建自定义工具」
• 填写基本信息：
  • 插件名称：本地知识库搜索插件
  • 简介：用于本地文档内容的关键词搜索能力

2. 输入插件 Schema

粘贴以下 OpenAPI Schema 内容：

{
  "openapi": "3.0.0",
  "info": {
    "title": "Local KnowledgeBase Search",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "http://192.168.1.103:5002"
    }
  ],
  "paths": {
    "/kb_search": {
      "get": {
        "summary": "查询知识库内容",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "用户提出的问题或关键词"
          }
        ],
        "responses": {
          "200": {
            "description": "检索结果",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "results": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "title": { "type": "string" },
                          "content": { "type": "string" },
                          "url": { "type": "string" }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

3. 测试插件接口

• 输入测试参数：
  • q: HarmonyOS
• 点击「测试」按钮，返回结果如下：

{
  "results": [
    {
      "title": "HarmonyOS 系统概览",
      "content": "HarmonyOS 是一个面向全场景的分布式操作系统...",
      "url": "https://example.com/harmonyos-overview"
    },
    {
      "title": "HarmonyOS 的微内核架构",
      "content": "HarmonyOS 使用微内核架构...",
      "url": "https://example.com/harmonyos-kernel"
    },
    ...
  ]
}

• 若接口测试成功，点击「保存」按钮完成注册

四、总结

本篇将本地知识库服务以 OpenAPI Schema 形式封装，并成功接入 Dify 插件系统，为后续在智能体与工作流中组合调用奠定基础。下一篇将介绍如何将该插件接入智能体应用，实现文档增强型问答。