通用规范

本文将简要介绍插件开发中的常见结构。在开发过程中，强烈建议结合插件开发基本概念和开发者速查表一起阅读，以便更好地理解整体架构。

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

路径规范

在 Manifest 或任何 yaml 文件中填写文件路径时，根据文件类型遵循以下两种规范：

• 如果目标文件是多媒体文件（如图片或视频），例如填写插件的 icon 时，应将这些文件放在插件根目录下的 _assets 文件夹中。
• 如果目标文件是普通文本文件，如 .py 或 .yaml 代码文件，应填写该文件在插件项目中的绝对路径。

通用结构

在定义插件时，有一些数据结构可以在工具、模型和 Endpoints 之间共享。这些共享结构在此处定义。

I18nObject

I18nObject 是符合 IETF BCP 47 标准的国际化结构。目前支持四种语言：

en_US · string

英语（美国）

zh_Hans · string

简体中文

ja_JP · string

日语

pt_BR · string

葡萄牙语（巴西）

ProviderConfig

ProviderConfig 是通用的提供者表单结构，适用于 Tool 和 Endpoint

name · string

表单项名称

label · I18nObject · required

遵循 IETF BCP 47 标准的显示标签

type · provider_config_type · required

表单字段类型 - 决定字段在 UI 中的渲染方式

scope · provider_config_scope

可选范围规范，根据 type 的值而变化

required · boolean

字段是否不能为空

default · any

默认值，仅支持基本类型：float、int、string

options · array[provider_config_option]

可用选项，仅在 type 为 select 时使用

helper · object

帮助文档链接标签，遵循 IETF BCP 47

url · string

帮助文档链接

placeholder · object

多语言占位符文本，遵循 IETF BCP 47

ProviderConfigOption(object)

value · string · required

选项的值

label · object · required

选项的显示标签，遵循 IETF BCP 47

ProviderConfigType(string)

secret-input · string

将被加密的配置信息

text-input · string

纯文本输入字段

select · string

下拉选择字段

boolean · boolean

开关/切换控件

model-selector · object

模型配置选择器，包括提供者名称、模型名称、模型参数等

app-selector · object

应用 ID 选择器

tool-selector · object

工具配置选择器，包括工具提供者、名称、参数等

dataset-selector · string

数据集选择器（待定）

ProviderConfigScope(string)

当 type 为 model-selector 时：

all · string

所有模型类型

llm · string

仅大型语言模型

text-embedding · string

仅文本嵌入模型

rerank · string

仅重排序模型

tts · string

仅文本转语音模型

speech2text · string

仅语音转文本模型

moderation · string

仅内容审核模型

vision · string

仅视觉模型

当 type 为 app-selector 时：

all · string

所有应用类型

chat · string

仅聊天应用

workflow · string

仅工作流应用

completion · string

仅补全应用

当 type 为 tool-selector 时：

all · string

所有工具类型

plugin · string

仅插件工具

api · string

仅 API 工具

workflow · string

仅工作流工具

ModelConfig

provider · string

包含 plugin_id 的模型提供者名称，格式为 langgenius/openai/openai

model · string

具体模型名称

model_type · enum

模型类型枚举，参考模型设计规则文档

NodeResponse

inputs · dict

最终输入到节点的变量

outputs · dict

节点的输出结果

process_data · dict

节点执行期间生成的数据

ToolSelector

provider_id · string

工具提供者名称

tool_name · string

工具名称

tool_description · string

工具描述

tool_configuration · dict[string, any]

工具配置信息

tool_parameters · dict[string, dict]

需要 LLM 推理的参数

name · string

参数名称

type · string

参数类型

required · boolean

参数是否必填

description · string

参数描述

default · any

默认值

options · array[string]

参数的可用选项

相关资源

• 插件开发基本概念 - 全面了解 Dify 插件开发
• 开发者速查表 - 插件开发中常用命令和概念的快速参考
• 工具插件开发详解 - 了解如何定义插件信息和工具插件开发流程
• 模型设计规则 - 了解模型配置的标准

---

Edit this page | Report an issue