Manifest

⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考英文原版。

Manifest 是一个符合 YAML 规范的文件，定义了插件最基本的信息，包括但不限于插件名称、作者、包含的工具、模型等。关于插件的整体架构，请参阅插件开发基本概念和开发者速查表。

如果该文件的格式不正确，插件的解析和打包过程将会失败。

代码示例

以下是一个简单的 Manifest 文件示例。每个数据项的含义和功能将在后面解释。

其他插件的参考代码，请参阅 GitHub 代码仓库。

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.10"
    entrypoint: "main"
privacy: "./privacy.md"

结构

version · version · required

插件的版本。

type · string · required

插件类型，目前仅支持 plugin，未来将支持 bundle。

author · string · required

作者，定义为 Marketplace 中的组织名称。

label · object · required

多语言名称。

created_at · RFC3339 · required

创建时间，Marketplace 要求不能晚于当前时间。

icon · string · required

图标路径。

resource · object

申请的资源。

memory · int64

最大内存使用量，主要与 SaaS 上的 AWS Lambda 资源申请相关，单位为字节。

permission · object

权限申请。

tool · object

工具反向调用权限。

enabled · boolean

是否启用工具权限。

model · object

模型反向调用权限。

enabled · boolean

是否启用模型权限。

llm · boolean

是否启用大语言模型权限。

text_embedding · boolean

是否启用文本嵌入模型权限。

rerank · boolean

是否启用重排序模型权限。

tts · boolean

是否启用文本转语音模型权限。

speech2text · boolean

是否启用语音转文本模型权限。

moderation · boolean

是否启用内容审核模型权限。

node · object

节点反向调用权限。

enabled · boolean

是否启用节点权限。

endpoint · object

注册 endpoint 的权限。

enabled · boolean

是否启用 endpoint 权限。

app · object

app 反向调用权限。

enabled · boolean

是否启用 app 权限。

storage · object

申请持久化存储的权限。

enabled · boolean

是否启用存储权限。

size · int64

允许的最大持久化存储大小，单位为字节。

plugins · object · required

插件扩展的具体能力的 yaml 文件列表。使用插件包内的绝对路径。例如，如果你需要扩展一个模型，你需要定义一个类似 openai.yaml 的文件，在这里填写文件路径，并且该路径下的文件必须实际存在，否则打包将失败。

不允许同时扩展工具和模型。

不允许没有任何扩展。

不允许同时扩展模型和 Endpoints。

目前，每种类型的扩展只支持一个 provider。

tools · array[string]

工具 provider 的插件扩展。

models · array[string]

模型 provider 的插件扩展。

endpoints · array[string]

Endpoints provider 的插件扩展。

agent_strategies · array[string]

智能体策略 provider 的插件扩展。

meta · object · required

插件的元数据。

version · version · required

manifest 格式版本，初始版本为 0.0.1。

arch · array[string] · required

支持的架构，目前仅支持 amd64 和 arm64。

runner · object · required

运行时配置。

language · string · required

编程语言。目前仅支持 Python。

version · string · required

语言版本，目前仅支持 3.12。

entrypoint · string · required

程序入口点，在 Python 下应为 main。

privacy · string

指定插件隐私政策文件的相对路径或 URL，例如 "./privacy.md" 或 "https://your-web/privacy"。如果你计划在 Dify Marketplace 上架插件，此字段为必填，以提供清晰的用户数据使用和隐私声明。详细填写指南请参阅插件隐私数据保护指南。

---

编辑此页面 | 报告问题