Skip to main content
このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、英語版 を参照してください。
モデルプラグインは 2 つのエンティティで自身を記述します。認証を処理しサポートするモデルを列挙する Provider と、モデルごとにそのタイプ、機能、パラメータを宣言する AIModelEntity です。
以下のすべてのエンティティは、dify_plugin.entities.model モジュールの Pydantic BaseModel サブクラスです。

簡易判断ガイド

認証のみ:事前定義モデル

ユーザーが API キーを貼り付けると、用意したモデル一覧をすべて利用できます。configurate_methods: [predefined-model] を設定し、各モデルの AIModelEntity を YAML で定義します。

ユーザー指定モデル

ユーザーが独自のモデル名とベース URL(OpenAI 互換エンドポイント、カスタムデプロイなど)を設定します。configurate_methods: [customizable-model] を使用し、カスタマイズ可能モデル を参照してください。

混在

組み込みのカタログに加えて、ユーザーが追加するカスタムモデルにも対応します。両方の configurate_methods の値を組み合わせます。

チュートリアル

エンドツーエンドの例については、新しいモデルプロバイダーの作成 を参照してください。

Provider

provider
string
プロバイダー識別子。例:openai
label
object
プロバイダーの表示名(i18n)。en_US(英語)と zh_Hans(中国語)をサポートします。
zh_Hans
string
中国語ラベル。設定されていない場合は en_US にフォールバックします。
en_US
string
required
英語ラベル
description
object
プロバイダーの説明(i18n)。
zh_Hans
string
中国語の説明。
en_US
string
required
英語の説明。
icon_small
object
プロバイダーの小アイコン。プロバイダー実装ディレクトリ下の _assets ディレクトリに保存します。
zh_Hans
string
中国語アイコン。
en_US
string
required
英語アイコン。
icon_large
object
プロバイダーの大アイコン。プロバイダー実装ディレクトリ下の _assets ディレクトリに保存します。
zh_Hans
string
中国語アイコン。
en_US
string
required
英語アイコン。
background
string
背景色の値。例:#FFFFFF。空の場合はフロントエンドのデフォルト色が使用されます。
help
object
ヘルプ情報。
title
object
ヘルプタイトル(i18n)。
zh_Hans
string
中国語タイトル。
en_US
string
required
英語タイトル。
url
object
ヘルプリンク(i18n)。
zh_Hans
string
中国語リンク。
en_US
string
required
英語リンク。
supported_model_types
array[ModelType]
required
サポートするモデルタイプ。
configurate_methods
array[ConfigurateMethod]
required
設定方法。
provider_credential_schema
ProviderCredentialSchema
required
プロバイダー認証情報の仕様。
model_credential_schema
ModelCredentialSchema
モデル認証情報の仕様。

AIModelEntity

model
string
required
モデル識別子。例:gpt-3.5-turbo
label
object
モデルの表示名(i18n)。en_US(英語)と zh_Hans(中国語)をサポートします。
zh_Hans
string
中国語ラベル。
en_US
string
required
英語ラベル。
model_type
ModelType
required
モデルタイプ。
features
array[ModelFeature]
サポートする機能。
model_properties
object
required
モデルプロパティ。
mode
LLMMode
モード(モデルタイプ llm)。
context_size
integer
コンテキストサイズ(モデルタイプ llm および text-embedding)。
max_chunks
integer
最大チャンク数(モデルタイプ text-embedding および moderation)。
file_upload_limit
integer
最大ファイルアップロードサイズ(単位:MB、モデルタイプ speech2text)。
supported_file_extensions
string
サポートするファイル拡張子。例:mp3,mp4(モデルタイプ speech2text)。
default_voice
string
デフォルト音声。alloyechofableonyxnovashimmer のいずれか(モデルタイプ tts)。
voices
array
利用可能な音声(モデルタイプ tts)。
mode
string
音声モデル。
name
string
音声モデルの表示名。
language
string
音声モデルがサポートする言語。
word_limit
integer
1 回の変換あたりの単語数の上限。デフォルトでは段落単位で分割します(モデルタイプ tts)。
audio_type
string
サポートするオーディオファイル拡張子。例:mp3,wav(モデルタイプ tts)。
max_workers
integer
テキストからオーディオへの変換の同時タスク数(モデルタイプ tts)。
max_characters_per_chunk
integer
チャンクあたりの最大文字数(モデルタイプ moderation)。
parameter_rules
array[ParameterRule]
モデル呼び出しパラメータのルール。
pricing
PriceConfig
価格情報。
deprecated
boolean
モデルが非推奨かどうか。非推奨のモデルはモデル一覧に表示されなくなりますが、既存の設定は引き続き動作します。デフォルトは False です。

ModelType

llm
string
テキスト生成モデル。
text-embedding
string
テキスト埋め込みモデル。
rerank
string
リランクモデル。
speech2text
string
音声からテキスト。
tts
string
テキストから音声。
moderation
string
コンテンツモデレーション。

ConfigurateMethod

predefined-model
string
事前定義モデル。ユーザーは統一されたプロバイダー認証情報を一度設定するだけで、そのプロバイダー下のすべての事前定義モデルを使用できます。
customizable-model
string
カスタマイズ可能モデル。ユーザーはモデルごとに認証情報の設定を追加します。
fetch-from-remote
string
リモートから取得。predefined-model と同様に統一されたプロバイダー認証情報のみが必要ですが、モデル一覧はその認証情報を使用してプロバイダーから取得されます。

ModelFeature

agent-thought
string
Agent 推論。一般的に 70B を超えるモデルは思考連鎖(chain-of-thought)の能力を備えています。
vision
string
ビジョン(画像理解)。
tool-call
string
ツール呼び出し。
multi-tool-call
string
複数ツール呼び出し。
stream-tool-call
string
ストリーミングツール呼び出し。

FetchFrom

predefined-model
string
事前定義モデル。
fetch-from-remote
string
リモートモデル。

LLMMode

completion
string
テキスト補完。
chat
string
チャット。

ParameterRule

name
string
required
モデル呼び出しで使用される実際のパラメータ名。
use_template
string
使用するテンプレート。
5 つのパラメータテンプレートが事前定義されています。
  • temperature
  • top_p
  • frequency_penalty
  • presence_penalty
  • max_tokens
これらの名前のいずれかを use_template に設定すると、entities.defaults.PARAMETER_RULE_TEMPLATE のデフォルト設定を継承します。その場合に必要なのは nameuse_template のみです。追加で設定したパラメータは、テンプレートのデフォルト値を上書きします。openai/llm/gpt-3.5-turbo.yaml新しいモデルプロバイダーの作成 の例を参照してください。
label
object
ラベル(i18n)。
zh_Hans
string
中国語ラベル。
en_US
string
required
英語ラベル。
type
string
パラメータタイプ。
int
string
整数。
float
string
浮動小数点。
string
string
文字列。
boolean
string
ブール値。
help
object
ヘルプ情報(i18n)。
zh_Hans
string
中国語ヘルプテキスト。
en_US
string
required
英語ヘルプテキスト。
required
boolean
パラメータが必須かどうか。デフォルトは False です。
default
int/float/string/boolean
デフォルト値。
min
int/float
最小値。数値タイプのみ。
max
int/float
最大値。数値タイプのみ。
precision
integer
保持する小数桁数。数値タイプのみ。
options
array[string]
ドロップダウンのオプション値。typestring の場合のみ適用されます。設定されていないか null の場合、値は制限されません。

PriceConfig

input
float
入力(プロンプト)の単価。
output
float
出力(返されるコンテンツ)の単価。
unit
float
価格の単位。例えば 100 万トークンあたりの価格設定の場合、単価に対応する単位トークン数は 0.000001 です。
currency
string
通貨単位。

ProviderCredentialSchema

credential_form_schemas
array[CredentialFormSchema]
required
認証情報フォームの仕様。

ModelCredentialSchema

model
object
required
モデル識別子。デフォルトの変数名は model です。
label
object
required
モデルフォーム項目の表示名。
en_US
string
required
英語。
zh_Hans
string
中国語。
placeholder
object
required
モデルフォーム項目のプレースホルダーテキスト。
en_US
string
required
英語。
zh_Hans
string
中国語。
credential_form_schemas
array[CredentialFormSchema]
required
認証情報フォームの仕様。

CredentialFormSchema

variable
string
required
フォーム項目の変数名。
label
object
required
フォーム項目のラベル。
en_US
string
required
英語。
zh_Hans
string
中国語。
type
FormType
required
フォーム項目のタイプ。
required
boolean
フォーム項目が必須かどうか。
default
string
デフォルト値。
options
array[FormOption]
ドロップダウンの内容。select および radio タイプに固有です。
placeholder
object
フォーム項目のプレースホルダー。text-input タイプに固有です。
en_US
string
required
英語。
zh_Hans
string
中国語。
max_length
integer
最大入力長。text-input タイプに固有です。0 は制限なしを意味します。
show_on
array[FormShowOnObject]
他のフォーム項目の値が指定した条件を満たす場合にのみこの項目を表示します。空の場合は常に表示します。

FormType

text-input
string
テキスト入力コンポーネント。
secret-input
string
パスワード入力コンポーネント。
select
string
単一選択ドロップダウン。
radio
string
ラジオコンポーネント。
switch
string
スイッチコンポーネント。truefalse のみサポートします。

FormOption

label
object
required
ラベル。
en_US
string
required
英語。
zh_Hans
string
中国語。
value
string
required
ドロップダウンのオプション値。
show_on
array[FormShowOnObject]
他のフォーム項目の値が指定した条件を満たす場合にのみこのオプションを表示します。空の場合は常に表示します。

FormShowOnObject

variable
string
required
他のフォーム項目の変数名。
value
string
required
他のフォーム項目の変数値。

関連リソース

Last modified on June 25, 2026