General Specification Definitions

​

Path Specifications

• If the target file is a multimedia file such as an image or video, for example when filling in the plugin’s icon, you should place these files in the _assets folder under the plugin’s root directory.
• If the target file is a regular text file, such as .py or .yaml code files, you should fill in the absolute path of the file within the plugin project.

​

Common Structures

​

I18nObject

• en_US
• zh_Hans
• ja_JP
• pt_BR

​

ProviderConfig

• name (string): Form item name
• label (I18nObject, required): Following IETF BCP 47
• type (provider_config_type, required): Form type
• scope (provider_config_scope): Optional range, varies based on type
• required (bool): Cannot be empty
• default (any): Default value, only supports basic types float int string
• options (list[provider_config_option]): Options, only used when type is select
• helper (object): Help document link label, following IETF BCP 47
• url (string): Help document link
• placeholder (object): Following IETF BCP 47

​

ProviderConfigOption(object)

• value (string, required): Value
• label (object, required): Following IETF BCP 47

​

ProviderConfigType(string)

• secret-input (string): Configuration information will be encrypted
• text-input (string): Plain text
• select (string): Dropdown
• boolean (bool): Switch
• model-selector (object): Model configuration information, including provider name, model name, model parameters, etc.
• app-selector (object): app id
• tool-selector (object): Tool configuration information, including tool provider, name, parameters, etc.
• dataset-selector (string): TBD

​

ProviderConfigScope(string)

• When type is model-selector
  • all
  • llm
  • text-embedding
  • rerank
  • tts
  • speech2text
  • moderation
  • vision
• When type is app-selector
  • all
  • chat
  • workflow
  • completion
• When type is tool-selector
  • all
  • plugin
  • api
  • workflow

​

ModelConfig

• provider (string): Model provider name containing plugin_id, in the form of langgenius/openai/openai.
• model (string): Specific model name.
• model_type (enum): Enumeration of model types, refer to the Model Design Rules document.

​

NodeResponse

• inputs (dict): Variables that are finally input to the node.
• outputs (dict): Output results of the node.
• process_data (dict): Data generated during node execution.

​

ToolSelector

• provider_id (string): Tool provider name
• tool_name (string): Tool name
• tool_description (string): Tool description
• tool_configuration (dict[str, Any]): Tool configuration information
• tool_parameters (dict[str, dict]): Parameters that need LLM reasoning
  • name (string): Parameter name
  • type (string): Parameter type
  • required (bool): Whether required
  • description (string): Parameter description
  • default (any): Default
  • options (list[string]): Options

​

Related Resources

• Basic Concepts of Plugin Development - Comprehensive understanding of Dify plugin development
• Developer Cheatsheet - Quick reference for common commands and concepts in plugin development
• Tool Plugin Development Details - Understanding how to define plugin information and the tool plugin development process
• Model Design Rules - Understanding the standards for model configuration