> ## Documentation Index
> Fetch the complete documentation index at: https://enterprise-docs.dify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 一般仕様

> I18nObject、ProviderConfig、ModelConfig、NodeResponse、ToolSelector など、プラグインタイプ間で共有される共通データ構造

このページでは、すべてのプラグインタイプに共通する構造を説明します。全体的なアーキテクチャを把握するには、[プラグイン開発の基本概念](https://enterprise-docs.dify.ai/ja/3.13.x/develop/plugins/getting-started/getting-started-dify-plugin.md) および [開発者チートシート](https://enterprise-docs.dify.ai/ja/3.13.x/develop/plugins/getting-started/cli.md) と併せてお読みください。

## パス仕様

Manifest やその他の YAML ファイルにおけるファイルパスは、ファイルの種類に応じて 2 つのルールに従います。

* 画像や動画などのマルチメディアファイル（例: プラグインの `icon`）は、プラグインのルートディレクトリ下にある `_assets` フォルダに配置します。
* `.py` や `.yaml` などの通常のテキストファイルは、プラグインプロジェクト内の絶対パスで参照します。

## 共通構造

一部のデータ構造は、ツール、モデル、Endpoints の間で共有されます。これらをここで定義します。

### I18nObject

`I18nObject` は [IETF BCP 47](https://tools.ietf.org/html/bcp47) 標準に準拠した国際化構造です。次の 4 つの言語をサポートします。

**en\_US** `string`

英語（米国）。

**zh\_Hans** `string`

簡体字中国語。

**ja\_JP** `string`

日本語。

**pt\_BR** `string`

ポルトガル語（ブラジル）。

### ProviderConfig

`ProviderConfig` は、`Tool` と `Endpoint` の両方で使用される共通のプロバイダーフォーム構造です。

**name** `string`

フォーム項目名。

**label** `I18nObject` *required*

表示ラベル。[IETF BCP 47](https://tools.ietf.org/html/bcp47) 標準に準拠します。

**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](https://tools.ietf.org/html/bcp47) に準拠します。

**url** `string`

ヘルプドキュメントのリンク。

**placeholder** `object`

複数言語のプレースホルダーテキスト。[IETF BCP 47](https://tools.ietf.org/html/bcp47) に準拠します。

### ProviderConfigOption (object)

**value** `string` *required*

オプションの値。

**label** `object` *required*

オプションの表示ラベル。[IETF BCP 47](https://tools.ietf.org/html/bcp47) に準拠します。

### 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`

データセットセレクター（TBD）。

### 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`

Workflow アプリケーションのみ。

**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`

モデルタイプの列挙。[モデル設計ルール](https://enterprise-docs.dify.ai/ja/3.13.x/develop/plugins/features-and-specs/plugin-types/model-designing-rules.md#modeltype) を参照してください。

### 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]`

パラメータで利用可能なオプション。

## 関連リソース

* [プラグイン開発の基本概念](https://enterprise-docs.dify.ai/ja/3.13.x/develop/plugins/getting-started/getting-started-dify-plugin.md)：Dify プラグイン開発の概要
* [開発者チートシート](https://enterprise-docs.dify.ai/ja/3.13.x/develop/plugins/dev-guides-and-walkthroughs/cheatsheet.md)：よく使うコマンドと概念のクイックリファレンス
* [ツールプラグイン開発の詳細](https://enterprise-docs.dify.ai/ja/3.13.x/develop/plugins/dev-guides-and-walkthroughs/tool-plugin.md)：プラグイン情報の定義方法とツールプラグイン開発プロセス
* [モデル設計ルール](https://enterprise-docs.dify.ai/ja/3.13.x/develop/plugins/features-and-specs/plugin-types/model-designing-rules.md)：モデル設定の標準


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.