插件开发指南

​

1. 插件价值和独特性

• 聚焦生成式 AI：确保您的插件核心功能专注于生成式 AI 领域，并为 Dify 用户提供独特且显著的价值。这可能包括：
  • 集成新的模型、工具或服务。
  • 提供独特的数据源或处理能力以增强 AI 应用。
  • 简化或自动化 Dify 平台上的 AI 相关工作流。
  • 为 AI 应用开发提供创新的支持功能。
• 避免功能重复：提交的插件不得与 Marketplace 中现有插件重复或高度相似。每个发布的插件必须是独特且独立的，以确保用户获得最佳体验。
• 有意义的更新：对于插件更新，确保引入新功能或服务，这些功能或服务在当前版本中尚不可用。
• PR 提交建议：我们建议在您的 pull request 中包含简要说明，解释为什么需要这个新插件。

​

2. 插件功能检查清单

• 唯一名称：提前搜索插件目录，确保您的插件名称是唯一的。
• 品牌一致性：插件名称必须与插件的品牌一致。
• 功能验证：在提交前彻底测试插件，确认其按预期工作。详情请参阅远程调试插件。插件必须达到生产就绪状态。
• README 要求：
  • 设置说明和使用指南。
  • 连接插件所需的任何必要代码、API、凭证或信息。
  • 不要包含无关内容或链接。
  • 不要使用夸大的、促销性的语言或无法验证的声明。
  • 不要包含任何形式的广告（包括自我推广或展示广告）。
  • 不要包含误导性、攻击性或诽谤性内容。
  • 不要在截图中暴露真实用户名或数据。
  • 不要链接到 404 页面或返回错误的页面。
  • 避免过多的拼写或标点错误。
• 用户数据使用：仅将收集的数据用于连接服务和改进插件功能。
• 错误清晰度：标记必填字段并提供清晰的错误消息，帮助用户理解问题。
• 认证设置：如果需要认证，包含完整的配置步骤——不要省略。
• 隐私政策：根据隐私保护指南准备隐私政策文档或在线 URL。
• 性能：插件必须高效运行，不得降低 Dify 或用户系统的性能。
• 凭证安全：API 密钥或其他凭证必须安全存储和传输。避免硬编码或将其暴露给未经授权的各方。

​

3. 语言要求

• 英语为主要语言：由于 Dify Marketplace 服务全球用户，所有面向用户的文本（插件名称、描述、字段名称、标签、帮助文本、错误消息）必须以英语为主要语言。
• 鼓励多语言支持：鼓励支持多种语言。

​

4. 禁止和限制的插件

• 禁止：误导或恶意行为
  插件不得误导用户。不要创建用于垃圾邮件、网络钓鱼或发送未经请求消息的插件。试图欺骗审核流程、窃取用户数据或冒充用户将导致移除，并可能被禁止未来提交。
• 禁止：攻击性内容
  插件不得包含暴力内容、仇恨言论、歧视或对全球文化、宗教或用户的不尊重。
• 禁止：金融交易
  插件不得促进任何金融交易、资产转移或支付处理。这包括区块链/加密应用中的令牌或资产所有权转移。
• 限制：频繁缺陷的插件
  彻底测试您的插件以避免关键错误。重复提交有缺陷的版本可能导致延迟或处罚。
• 限制：不必要的插件拆分
  不要为共享相同 API 和认证的功能创建多个插件，除非每个都明确是独立的产品或服务。优先将功能集成到一个高级插件中。
• 限制：重复提交
  避免重复提交本质上相同的插件。这样做可能会延迟审核或导致拒绝。

​

5. 插件货币化

• Dify Marketplace 目前仅支持免费**插件。
• 未来政策：货币化和定价模型的政策将在未来公布。

​

6. 商标和知识产权

• 需要授权：确保您有权使用任何提交的标志或商标。
• 验证权利：如果使用第三方标志，我们可能会要求您证明您有许可——特别是如果它们明显属于知名品牌。
• 违规后果：如发现未经授权使用，Dify 保留要求更改或移除插件的权利。权利人的投诉也可能导致移除。
• 禁止使用 Dify 标志：您不得使用 Dify 自己的标志。
• 图片标准：不要提交低质量、扭曲或裁剪不当的图片。审核团队可能要求替换。
• 图标限制：图标不得包含误导性、攻击性或恶意的视觉效果。

​

7. 插件更新和版本管理

• 负责任的更新：在描述中或通过外部渠道（如 GitHub Release Notes）清楚地传达破坏性更改。
• 鼓励维护：定期更新以修复错误、匹配 Dify 平台变化或响应第三方服务的更新——特别是安全方面。
• 弃用通知：如果停止维护插件，请提前通知用户（例如，在插件描述中说明时间表和计划），并在可能的情况下建议替代方案。

​

8. 插件维护和支持

• 所有者责任：插件所有者负责技术支持和维护。
• 需要支持渠道：所有者必须提供至少一个支持渠道（GitHub 仓库或电子邮件）用于审核和发布期间的反馈。
• 处理未维护的插件：如果插件缺乏维护且所有者在合理通知后不响应，Dify 可能会：
  • 添加”缺乏维护”或”潜在风险”标签。
  • 限制新安装。
  • 最终取消发布该插件。

​

9. 隐私和数据合规

• 需要披露：您必须声明您的插件是否收集任何用户个人数据。请参阅隐私保护指南。
• 简单数据列表：如果收集数据，请简要列出类型（例如，用户名、电子邮件、设备 ID、位置）。无需详尽说明。
• 隐私政策：您必须提供隐私政策链接，说明：
  • 收集哪些信息。
  • 如何使用这些信息。
  • 与第三方共享哪些内容（如适用，需提供其隐私链接）。
• 审核重点：
  • 形式检查：确保您声明了收集的数据。
  • 敏感数据扫描：收集敏感数据（如健康、财务、儿童信息）的插件需要额外审查。
  • 恶意行为扫描：插件不得在未经同意的情况下收集或上传用户数据。

​

10. 审核和自由裁量权

• 拒绝/移除权利：如果不满足要求、隐私标准或相关政策，Dify 可能会拒绝或移除您的插件。这包括滥用审核流程或数据滥用。
• 及时审核：Dify 审核团队将根据数量和复杂性，在合理时间内审核插件。
• 沟通：我们可能会通过您提供的支持渠道联系您——请确保它处于活跃状态。

​

相关资源

• 插件开发基础概念 - 学习插件开发基础知识
• 发布插件 - 插件发布流程概述
• 插件隐私数据保护指南 - 隐私政策编写指南
• 发布到 Dify Marketplace - 在官方市场发布插件
• 远程调试插件 - 插件调试指南