ここでは、サプライヤーと各モデルタイプが実装する必要があるインターフェース方法とそのパラメータについて説明します。
サプライヤー
__base.model_provider.ModelProvider基本クラスを継承し、以下のインターフェースを実装する必要があります：
def validate_provider_credentials(self, credentials: dict) -> None:
"""
Validate provider credentials
You can choose any validate_credentials method of model type or implement validate method by yourself,
such as: get model list api
if validate failed, raise exception
:param credentials: provider credentials, credentials form defined in `provider_credential_schema`.
"""
検証に失敗した場合は、errors.validate.CredentialsValidateFailedErrorエラーをスローします。
注：事前定義されたモデルはこのインターフェースを完全に実装する必要がありますが、カスタムモデルサプライヤーは以下の簡単な実装のみが必要です
class XinferenceProvider(Provider):
def validate_provider_credentials(self, credentials: dict) -> None:
pass
モデル
モデルには5つの異なるモデルタイプがあり、異なる基底クラスを継承し、実装する必要があるメソッドも異なります。
一般インターフェース
すべてのモデルには以下の2つのメソッドを実装する必要があります：
-
モデルの資格情報を検証する
サプライヤーの資格情報検証と同様に、ここでは個々のモデルに対して検証を行います。
def validate_credentials(self, model: str, credentials: dict) -> None:
"""
Validate model credentials
:param model: model name
:param credentials: model credentials
:return:
"""
パラメータ：
検証に失敗した場合は、errors.validate.CredentialsValidateFailedError エラーをスローします。
-
例外エラーマッピングの呼び出し
モデルの呼び出しが例外をスローした場合、Runtimeが指定する InvokeError タイプにマッピングする必要があり、異なるエラーに対して異なる後続処理を行うためのDifyにとって便利です。
Runtime Errors:
InvokeConnectionError コール接続エラーInvokeServerUnavailableError コールサービスが利用できないInvokeRateLimitError コールが制限に達したInvokeAuthorizationError コール認証エラーInvokeBadRequestError コールパラメータが誤っています
@property
def _invoke_error_mapping(self) -> dict[type[InvokeError], list[type[Exception]]]:
"""
Map model invoke error to unified error
The key is the error type thrown to the caller
The value is the error type thrown by the model,
which needs to be converted into a unified error type for the caller.
:return: Invoke error mapping
"""
または、対応するエラーを直接スローし、以下のように定義することもできます。これにより、後続の呼び出しで InvokeConnectionError などの例外を直接スローできます。
@property
def _invoke_error_mapping(self) -> dict[type[InvokeError], list[type[Exception]]]:
return {
InvokeConnectionError: [
InvokeConnectionError
],
InvokeServerUnavailableError: [
InvokeServerUnavailableError
],
InvokeRateLimitError: [
InvokeRateLimitError
],
InvokeAuthorizationError: [
InvokeAuthorizationError
],
InvokeBadRequestError: [
InvokeBadRequestError
],
}
OpenAIの _invoke_error_mapping をご参照ください。
LLM
__base.large_language_model.LargeLanguageModel 基本クラスを継承し、以下のインターフェースを実装します：
-
LLMの呼び出し
LLM呼び出しの核心メソッドを実装し、ストリーミングと同期応答の両方をサポートします。
def _invoke(self, model: str, credentials: dict,
prompt_messages: list[PromptMessage], model_parameters: dict,
tools: Optional[list[PromptMessageTool]] = None, stop: Optional[list[str]] = None,
stream: bool = True, user: Optional[str] = None) \
-> Union[LLMResult, Generator]:
"""
Invoke large language model
:param model: model name
:param credentials: model credentials
:param prompt_messages: prompt messages
:param model_parameters: model parameters
:param tools: tools for tool calling
:param stop: stop words
:param stream: is stream response
:param user: unique user id
:return: full response or stream response chunk generator result
"""
-
入力tokenの事前計算
モデルがtokenの事前計算インターフェースを提供していない場合、直接0を返すことができます。
def get_num_tokens(self, model: str, credentials: dict, prompt_messages: list[PromptMessage],
tools: Optional[list[PromptMessageTool]] = None) -> int:
"""
Get number of tokens for given prompt messages
:param model: model name
:param credentials: model credentials
:param prompt_messages: prompt messages
:param tools: tools for tool calling
:return:
"""
パラメータの説明は上記の LLMの呼び出し を参照してください。
このインターフェースは、対応するmodelに基づいて適切なtokenizerを選択して計算する必要があります。対応するモデルがtokenizerを提供していない場合は、AIModelベースクラスの_get_num_tokens_by_gpt2(text: str)メソッドを使用して計算できます。
-
カスタムモデルスキーマの取得 [オプション]
def get_customizable_model_schema(self, model: str, credentials: dict) -> Optional[AIModelEntity]:
"""
Get customizable model schema
:param model: model name
:param credentials: model credentials
:return: model schema
"""
供給業者がカスタムLLMを追加することをサポートしている場合、このメソッドを実装してカスタムモデルがモデル規則を取得できるようにすることができます。デフォルトではNoneを返します。
ほとんどの微調整モデルはOpenAI供給業者の下で、微調整モデル名を使用してベースモデルを取得できます。例えば、gpt-3.5-turbo-1106のような微調整モデル名を使用して、基本モデルの事前定義されたパラメータルールを取得できます。具体的な実装については、openaiを参照してください。
TextEmbedding
__base.text_embedding_model.TextEmbeddingModelベースクラスを継承し、次のインターフェースを実装します：
-
Embeddingの呼び出し
def _invoke(self, model: str, credentials: dict,
texts: list[str], user: Optional[str] = None) \
-> TextEmbeddingResult:
"""
Invoke large language model
:param model: model name
:param credentials: model credentials
:param texts: texts to embed
:param user: unique user id
:return: embeddings result
"""
-
tokensの事前計算
def get_num_tokens(self, model: str, credentials: dict, texts: list[str]) -> int:
"""
Get number of tokens for given prompt messages
:param model: model name
:param credentials: model credentials
:param texts: texts to embed
:return:
"""
パラメータの説明は上記の Embeddingの呼び出し を参照してください。
上記のLargeLanguageModelと同様に、このインターフェースは、対応するmodelに基づいて適切なtokenizerを選択して計算する必要があります。対応するモデルがtokenizerを提供していない場合は、AIModelベースクラスの_get_num_tokens_by_gpt2(text: str)メソッドを使用して計算できます。
Rerank
`__base.rerank_model.RerankModelベースクラスを継承し、次のインターフェースを実装します：
-
rerankの呼び出し
def _invoke(self, model: str, credentials: dict,
query: str, docs: list[str], score_threshold: Optional[float] = None, top_n: Optional[int] = None,
user: Optional[str] = None) \
-> RerankResult:
"""
Invoke rerank model
:param model: model name
:param credentials: model credentials
:param query: search query
:param docs: docs for reranking
:param score_threshold: score threshold
:param top_n: top n
:param user: unique user id
:return: rerank result
"""
-
パラメータ：
-
model (string) モデル名
-
credentials (object) 資格情報
資格情報のパラメータは、供給業者の YAML 構成ファイルの provider_credential_schema または model_credential_schema で定義されており、api_key などの詳細が含まれます。
-
query (string) リクエスト内容をチェックする
-
docs (array[string]) 並べ替えが必要なセクションリスト
-
score_threshold (float) [optional] Scoreの閾値
-
top_n (int) [optional] トップのnセクションを取得します
-
user (string) [optional] ユーザーの一意の識別子
供給業者が不正行為を監視および検出するのに役立ちます。
-
返り値：
RerankResult エンティティ。
Speech2text
__base.speech2text_model.Speech2TextModel基底クラスを継承し、以下のインターフェースを実装します：
-
Invokeの呼び出し
def _invoke(self, model: str, credentials: dict,
file: IO[bytes], user: Optional[str] = None) \
-> str:
"""
Invoke large language model
:param model: model name
:param credentials: model credentials
:param file: audio file
:param user: unique user id
:return: text for given audio file
"""
-
パラメータ：
-
model (string) モデル名
-
credentials (object) 資格情報
資格情報のパラメータは、供給業者の YAML 構成ファイルの provider_credential_schema または model_credential_schema で定義されており、api_key などの詳細が含まれます。
-
file (File) ファイルストリーム
-
user (string) [optional] ユーザーの一意の識別子
供給業者が不正行為を監視および検出するのに役立ちます。
-
返り値：
音声をテキストに変換した結果を返します。
Text2speech
__base.text2speech_model.Text2SpeechModel基底クラスを継承し、以下のインターフェースを実装します：
-
Invokeの呼び出し
def _invoke(self, model: str, credentials: dict, content_text: str, streaming: bool, user: Optional[str] = None):
"""
Invoke large language model
:param model: model name
:param credentials: model credentials
:param content_text: text content to be translated
:param streaming: output is streaming
:param user: unique user id
:return: translated audio file
"""
-
パラメータ：
-
model (string) モデル名
-
credentials (object) 資格情報
資格情報のパラメータは、供給業者の YAML 構成ファイルの provider_credential_schema または model_credential_schema で定義されており、api_key などの詳細が含まれます。
-
content_text (string) 変換すべきテキストコンテンツ
-
streaming (bool) ストリーミング出力かどうか
-
user (string) [optional] ユーザーの一意の識別子
供給業者が不正行為を監視および検出するのに役立ちます。
-
返り値：
テキストを音声に変換した結果を返します。
Moderation
__base.moderation_model.ModerationModel基底クラスを継承し、以下のインターフェースを実装します：
-
Invokeの呼び出し
def _invoke(self, model: str, credentials: dict,
text: str, user: Optional[str] = None) \
-> bool:
"""
Invoke large language model
:param model: model name
:param credentials: model credentials
:param text: text to moderate
:param user: unique user id
:return: false if text is safe, true otherwise
"""
エンティティ
PromptMessageRole
メッセージロールを定義する列挙型。
class PromptMessageRole(Enum):
"""
Enum class for prompt message.
"""
SYSTEM = "system"
USER = "user"
ASSISTANT = "assistant"
TOOL = "tool"
PromptMessageContentType
メッセージコンテンツのタイプを定義し、テキストと画像の2種類がある。
class PromptMessageContentType(Enum):
"""
Enum class for prompt message content type.
"""
TEXT = 'text'
IMAGE = 'image'
PromptMessageContent
メッセージコンテンツの基底クラスであり、パラメータのみを宣言するため初期化は行えない。
class PromptMessageContent(BaseModel):
"""
Model class for prompt message content.
"""
type: PromptMessageContentType
data: str # コンテンツデータ
現在、テキストと画像の2つのタイプがサポートされており、テキストと複数の画像を同時に渡すことができる。
テキストと画像を同時に渡す場合は、TextPromptMessageContent と ImagePromptMessageContent をそれぞれ初期化する必要がある。
TextPromptMessageContent
class TextPromptMessageContent(PromptMessageContent):
"""
Model class for text prompt message content.
"""
type: PromptMessageContentType = PromptMessageContentType.TEXT
画像とテキストを一緒に渡す場合、テキストは content リストの一部としてこのエンティティを構築する必要がある。
ImagePromptMessageContent
class ImagePromptMessageContent(PromptMessageContent):
"""
Model class for image prompt message content.
"""
class DETAIL(Enum):
LOW = 'low'
HIGH = 'high'
type: PromptMessageContentType = PromptMessageContentType.IMAGE
detail: DETAIL = DETAIL.LOW # 解像度
画像とテキストを一緒に渡す場合、画像は content リストの一部としてこのエンティティを構築する必要がある。
data には url または画像の base64 でエンコードされた文字列を指定することができる。
PromptMessage
すべてのロールメッセージの基底クラスであり、パラメータのみを宣言するため初期化はできません。
class PromptMessage(ABC, BaseModel):
"""
Model class for prompt message.
"""
role: PromptMessageRole # メッセージロール
content: Optional[str | list[PromptMessageContent]] = None # 2つのタイプ、文字列とコンテンツリストをサポート。コンテンツリストはマルチモーダルのニーズを満たすために使用されます。PromptMessageContentの説明を参照してください。
name: Optional[str] = None # 名前、オプション
UserPromptMessage
UserMessage ユーザーメッセージを表すクラス。
class UserPromptMessage(PromptMessage):
"""
Model class for user prompt message.
"""
role: PromptMessageRole = PromptMessageRole.USER
AssistantPromptMessage
モデルの返信メッセージを表し、通常は few-shots やチャット履歴が入力として使用されます。
class AssistantPromptMessage(PromptMessage):
"""
Model class for assistant prompt message.
"""
class ToolCall(BaseModel):
"""
Model class for assistant prompt message tool call.
"""
class ToolCallFunction(BaseModel):
"""
Model class for assistant prompt message tool call function.
"""
name: str # ツール名
arguments: str # ツールパラメータ
id: str # ツールID。OpenAI tool callの場合のみ有効で、ツール呼び出しのユニークIDです。同じツールを複数回呼び出すことができます。
type: str # デフォルト function
function: ToolCallFunction # ツール呼び出し情報
role: PromptMessageRole = PromptMessageRole.ASSISTANT
tool_calls: list[ToolCall] = [] # モデルの返信としてのツール呼び出し結果（`tools`を渡した場合のみ、モデルがツール呼び出しが必要と判断した場合に返されます）
tool_calls は、モデルに tools を渡した後、モデルが返す tool call のリストです。
SystemPromptMessage
システムメッセージを表し、通常はモデルに与えられるシステム命令に使用されます。
class SystemPromptMessage(PromptMessage):
"""
Model class for system prompt message.
"""
role: PromptMessageRole = PromptMessageRole.SYSTEM
ツールメッセージを表し、ツールの実行結果をモデルに渡して次のステップの計画を行います。
class ToolPromptMessage(PromptMessage):
"""
Model class for tool prompt message.
"""
role: PromptMessageRole = PromptMessageRole.TOOL
tool_call_id: str # ツール呼び出しID。OpenAI tool callをサポートしない場合、ツール名を渡すこともできます。
基类的 content 传入工具执行结果。
class PromptMessageTool(BaseModel):
"""
Model class for prompt message tool.
"""
name: str # ツール名
description: str # ツールの説明
parameters: dict # ツールパラメータ dict
LLMResult
class LLMResult(BaseModel):
"""
Model class for llm result.
"""
model: str # 使用された実際のモデル
prompt_messages: list[PromptMessage] # プロンプトメッセージのリスト
message: AssistantPromptMessage # 返信メッセージ
usage: LLMUsage # 使用したtokenとコスト情報
system_fingerprint: Optional[str] = None # リクエスト指紋。OpenAIのこのパラメータの定義を参照。
LLMResultChunkDelta
ストリーム化された各イテレーション内の delta エンティティ。
class LLMResultChunkDelta(BaseModel):
"""
Model class for llm result chunk delta.
"""
index: int # インデックス
message: AssistantPromptMessage # 返信メッセージ
usage: Optional[LLMUsage] = None # 使用したトークンとコスト情報（最後の1つのみ）
finish_reason: Optional[str] = None # 終了理由（最後の1つのみ）
LLMResultChunk
ストリーム化された各イテレーションのエンティティ。
class LLMResultChunk(BaseModel):
"""
Model class for llm result chunk.
"""
model: str # 実際に使用したモデル
prompt_messages: list[PromptMessage] # プロンプトメッセージのリスト
system_fingerprint: Optional[str] = None # リクエスト指紋。OpenAIのこのパラメータの定義を参照。
delta: LLMResultChunkDelta # 各イテレーションの変更が存在する内容
LLMUsage
class LLMUsage(ModelUsage):
"""
Model class for llm usage.
"""
prompt_tokens: int # プロンプトで使用したトークン数
prompt_unit_price: Decimal # プロンプトの単価
prompt_price_unit: Decimal # プロンプト料金の単位（単価が基づいているトークンの量）
prompt_price: Decimal # プロンプトの料金
completion_tokens: int # 返答で使用したトークン数
completion_unit_price: Decimal # 返答の単価
completion_price_unit: Decimal # 返答料金の単位（単価が基づいているトークンの量）
completion_price: Decimal # 返答の料金
total_tokens: int # 総使用トークン数
total_price: Decimal # 総料金
currency: str # 通貨単位
latency: float # リクエスト処理時間（秒）
TextEmbeddingResult
class TextEmbeddingResult(BaseModel):
"""
Model class for text embedding result.
"""
model: str # 実際に使用したモデル
embeddings: list[list[float]] # テキストリストに対応するembeddingベクトルのリスト
usage: EmbeddingUsage # 使用した情報
EmbeddingUsage
class EmbeddingUsage(ModelUsage):
"""
Model class for embedding usage.
"""
tokens: int # 使用した token 数
total_tokens: int # 総使用 token 数
unit_price: Decimal # 単価
price_unit: Decimal # 価格の単位（単価が基づいているトークンの量）
total_price: Decimal # 総料金
currency: str # 通貨単位
latency: float # リクエスト処理時間(s)
RerankResult
class RerankResult(BaseModel):
"""
Model class for rerank result.
"""
model: str # 実際に使用したモデル
docs: list[RerankDocument] # Rerankされたセグメントリスト
RerankDocument
class RerankDocument(BaseModel):
"""
Model class for rerank document.
"""
index: int # 元の文書の順番
text: str # 文書のテキスト内容
score: float # スコア
