大模型工具Dify进阶-开发tools

作者

在当今迅速发展的人工智能领域，Dify 作为开源的大语言模型（LLM）应用开发平台，为开发者提供了丰富的工具和插件支持，使得构建强大的 AI 应用变得更加高效。通过为 Dify 开发工具插件，您可以扩展 LLM 的能力，例如实现联网搜索、科学计算或绘制图片等功能，从而增强 AI 应用与外部世界的交互性。

在接下来的内容中，我们将深入探讨如何为 Dify 开发工具插件，帮助您充分利用平台的潜力，构建出色的 AI 应用。

开发 Dify 插件需要进行以下准备。

Dify 插件脚手架工具

Python 环境，版本号 ≥ 3.12

开发 Dify 插件需要进行以下准备。

Dify 插件脚手架工具

Python 环境，版本号 ≥ 3.12

Dify 插件开发脚手架工具又称为 dify-plugin-daemon，可以被视作插件开发 SDK。

安装Dify插件开发脚手架工具

访问 Dify Plugin CLI(https://github.com/langgenius/dify-plugin-daemon/releases) 项目地址，下载并安装最新版本号和对应操作系统的工具。

本文以装载 M 系列芯片的 macOS 为例。下载 dify-plugin-darwin-arm64 文件后，赋予其执行权限。

chmod +x dify-plugin-darwin-arm64 运行以下命令检查安装是否成功。

./dify-plugin-darwin-arm64 version

若提示 “Apple 无法验证” 错误，请前往 “设置 → 隐私与安全性 → 安全性”，轻点 “仍要打开” 按钮。


若提示 “Apple 无法验证” 错误，请前往 “设置 → 隐私与安全性 → 安全性”，轻点 “仍要打开” 按钮。


初始化 Python 环境

详细说明请参考Python安装教程，或询问 LLM 安装版本号 ≥ 3.12 的 Python 环境

创建新项目

运行脚手架命令行工具，创建一个新的 dify 插件项目。

./dify-plugin-darwin-arm64 plugin init 如果你已将该二进制文件重命名为 dify 并拷贝至 /usr/local/bin 路径下，可以运行以下命令创建新的插件项目：

dify plugin init 下文将使用 dify 作为命令行示例。如遇到问题，请将 dify 命令替换为命令行工具的所在路径。

选择插件类型和模板

脚手架工具内的所有模板均已提供完整的代码项目。在本文实例中，选择 Tool 插件。

插件类型：工具

配置插件权限

插件还需读取 Dify 平台的权限，为该示例插件授予以下权限：

  • Tools
  • Apps
  • 启用持久化存储 Storage，分配默认大小存储
  • 允许注册 Endpoint

在终端内使用方向键选择权限，使用 “Tab” 按钮授予权限。 勾选所有权限项后，轻点回车完成插件的创建。系统将自动生成插件项目代码。

创建完成后会生成如下工程文件

开发插件

在生成的项目文件中有两个比较重要的文件夹

  • provider 插件供应商，在一个项目中可以有多个
  • tools 供应商对应的工具

这两个的表现稍后会在dify工具中能体现

provider配置

dify-plugin-example.yaml

  1. identity:
  2.   author: xxxx
  3.   name: dify-plugin-example
  4.   label:
  5.     en_US: dify-plugin-example
  6.     zh_Hans: dify-plugin-example
  7.     pt_BR: dify-plugin-example
  8.   description:
  9.     en_US: "Use this plugin to fetch the URL content(provider)."
  10.     zh_Hans: "使用此插件获取URL内容(provider)"
  11.     pt_BR: "Use este plugin para buscar o conteúdo do URL(provider)"
  12.   icon: icon.png
  13. tools:
  14.   - tools/dify-plugin-example.yaml
  15. extra:
  16.   python:
  17.     source: provider/dify-plugin-example.py

provider代码

dify-plugin-example.py

  1. from typing import Any
  3. from dify_plugin import ToolProvider
  4. from dify_plugin.errors.tool import ToolProviderCredentialValidationError
  7. class DifyPluginExampleProvider(ToolProvider):
  8.     def _validate_credentials(self, credentials: dict[str, Any]) -> None:
  9.         try:
  10.             """
  11.             IMPLEMENT YOUR VALIDATION HERE
  12.             """
  13.         except Exception as e:
  14.             raise ToolProviderCredentialValidationError(str(e))

DifyPluginExampleProvider 里面实现的主要是一些验证功能，比如你的工具需要API Key就可以在这里实现

tools配置

dify-plugin-example.yaml

  1. identity:
  2.   name: dify-plugin-example
  3.   author: fakzhao
  4.   label:
  5.     en_US: dify-plugin-example
  6.     zh_Hans: dify-plugin-example
  7.     pt_BR: dify-plugin-example
  8. description:
  9.   human:
  10.     en_US: The URL to fetch content from.
  11.     zh_Hans: 要获取内容的URL
  12.     pt_BR: O URL para buscar conteúdo.
  13.   llm: Convert a web page into well structured Markdown.
  14. parameters:
  15.   - name: url
  16.     type: string
  17.     required: true
  18.     label:
  19.       en_US: URL
  20.       zh_Hans: URL
  21.       pt_BR: URL
  22.     human_description:
  23.       en_US: "The URL to fetch content from."
  24.       zh_Hans: "要获取内容的URL"
  25.       pt_BR: "O URL para buscar conteúdo."
  26.     llm_description: llm
  27.     form: llm
  28. extra:
  29.   python:
  30.     source: tools/dify-plugin-example.py

tools代码

dify-plugin-example.py

  1. import json
  2. import requests
  3. from collections.abc import Generator
  4. from typing import Any
  6. from dify_plugin import Tool
  7. from dify_plugin.entities.tool import ToolInvokeMessage
  10. class DifyPluginExampleTool(Tool):
  11.     def _invoke(self, tool_parameters: dict[str, Any]) -> Generator[ToolInvokeMessage]:
  12.         print(json.dumps(tool_parameters, indent=4))
  13.         url = tool_parameters["url"]
  14.         print(f"fetching {url}")
  15.         try:
  16.             j_url = f"https://r.jina.ai/{url}"
  17.             print(f"jina url {j_url}")
  18.             response = requests.get(j_url)
  19.             response.raise_for_status()
  20.             content = response.text
  21.         except requests.RequestException as e:
  22.             content = str(e)
  23.         yield self.create_json_message({
  24.             "result": content
  25.         })

可以看出，这个工具作用是提供一个url，返回一个markdown给其他节点使用(https://r.jina.ai是一个将网页转markdown的网页，可以在浏览器试试https://r.jina.ai/https://example.com)


调试

插件开发完成后，接下来需要测试插件是否可以正常运行。Dify 提供便捷地远程调试方式，帮助你快速在测试环境中验证插件功能。 前往“插件管理”页获取远程服务器地址和调试 Key。


回到插件项目，拷贝 .env.example 文件并重命名为 .env，将获取的远程服务器地址和调试 Key 等信息填入其中。 .env 文件：

  1. INSTALL_METHOD=remote
  2. REMOTE_INSTALL_HOST=remote
  3. REMOTE_INSTALL_PORT=5003
  4. REMOTE_INSTALL_KEY=****-****-****-****-****

运行 python -m main 命令启动插件。在插件页即可看到该插件已被安装至 Workspace 内，团队中的其他成员也可以访问该插件。

到这里你的插件已经成功运行，并可以进行debug.



测试

在工作流中添加你自己的插件

最终的workflow


查看运行结果

已经成功到运行🚀


打包插件

确认插件能够正常运行后，可以通过以下命令行工具打包并命名插件。运行以后你可以在当前文件夹发现 dify-plugin-example.difypkg 文件，该文件为最终的插件包。 将 ./dify-plugin-example 替换为插件项目的实际路径

dify plugin package ./dify-plugin-example

恭喜，你已完成一个工具类型插件的完整开发、调试与打包过程！


发布插件

如果想要将插件发布至 Dify Marketplace，请确保你的插件遵循了插件发布规范。审核通过后，代码将合并至主分支并自动上线至 Dify Marketplace。


总结

通过为 Dify 开发工具插件，我们不仅能够扩展 AI 应用的能力，还能提升系统的灵活性和可扩展性。无论是接入外部 API、执行复杂计算，还是增强交互体验，插件都能让 Dify 更加强大。希望这篇内容能为你提供清晰的思路，如果在开发过程中遇到问题，欢迎交流探讨！我们也会持续更新相关内容，帮助你更高效地构建属于自己的 AI 工具。🚀


（文：PyTorch研习社）

欢迎分享

发表评论