メインコンテンツへスキップ
⚠️ このドキュメントはAIによって自動翻訳されています。不正確な部分がある場合は、英語版を参照してください。
  • モデルプロバイダールールは Provider エンティティに基づいています。
  • モデルルールは AIModelEntity エンティティに基づいています。
以下のすべてのエンティティは Pydantic BaseModel に基づいており、entities モジュールで確認できます。

​
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
デフォルト音声、必須：alloy,echo,fable,onyx,nova,shimmer（モデルタイプ tts で利用可能）
​
voices
array
利用可能な音声のリスト（モデルタイプ tts で利用可能）
​
mode
string
音声モデル
​
name
string
音声モデルの表示名
​
language
string
音声モデルでサポートされる言語
​
word_limit
integer
単一変換の単語制限、デフォルトは段落分割（モデルタイプ 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
エージェント推論、一般的に70B以上のモデルには思考連鎖機能があります。
​
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 のデフォルト設定を使用します。name と use_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
ヘルプ情報
​
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]
ドロップダウンオプション値、type が string の場合のみ適用、設定されていないか null の場合、オプション値は制限されません

​
PriceConfig

​
input
float
入力単価、すなわちプロンプト単価
​
output
float
出力単価、すなわち返されるコンテンツの単価
​
unit
float
価格単位、例えば1Mトークンあたりの価格の場合、単価に対応する単位トークン数は 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
スイッチコンポーネント、true と false のみサポート

​
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
他のフォーム項目変数値

​
関連リソース

Edit this page | Report an issue