manifest 是一个定义插件基本信息的 YAML 文件,包括名称、作者、包含的工具和模型等。如果文件格式不正确,插件的解析和打包会失败。
关于插件的整体架构,详见 插件开发基本概念 和 开发者速查表。
代码示例
下面是一个简单的 manifest 文件,每个字段都会在后续的「结构」一节中说明。实际示例可参考 Google 工具插件 manifest。
version: 0.0.1
type: "plugin"
author: "Yeuoly"
name: "neko"
label:
en_US: "Neko"
created_at: "2024-07-12T08:03:44.658609186Z"
icon: "icon.svg"
resource:
memory: 1048576
permission:
tool:
enabled: true
model:
enabled: true
llm: true
endpoint:
enabled: true
app:
enabled: true
storage:
enabled: true
size: 1048576
plugins:
endpoints:
- "provider/neko.yaml"
meta:
version: 0.0.1
arch:
- "amd64"
- "arm64"
runner:
language: "python"
version: "3.12"
entrypoint: "main"
privacy: "./privacy.md"
插件类型。目前仅支持 plugin,未来将支持 bundle。
插件申请的资源。最大内存使用量,单位为字节。主要与 SaaS 上的 AWS Lambda 资源分配相关。
列出插件所扩展能力对应的 YAML 文件,使用插件包内的绝对路径。例如,要扩展一个模型,需定义一个类似 openai.yaml 的文件并在此列出其路径。该路径下必须存在对应文件,否则打包会失败。以下组合不被允许:
- 同时扩展工具和模型。
- 同时扩展模型和 Endpoints。
- 没有任何扩展。
目前,每种扩展类型仅支持一个 provider。
插件的元数据。manifest 格式版本。初始版本为 0.0.1。
支持的架构。目前仅支持 amd64 和 arm64。
插件隐私政策的相对路径或 URL,例如 "./privacy.md" 或 "https://your-web/privacy"。在 Dify 市场上架时必填,插件须明确说明如何使用用户数据。详见 插件隐私数据保护指南。
编辑此页面 | 报告问题