# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
import os
from enum import Enum, EnumMeta
from typing import cast
from camel.types.unified_model_type import UnifiedModelType
[docs]
class RoleType(Enum):
ASSISTANT = "assistant"
USER = "user"
CRITIC = "critic"
EMBODIMENT = "embodiment"
DEFAULT = "default"
class ModelType(UnifiedModelType, Enum):
DEFAULT = os.getenv("DEFAULT_MODEL_TYPE", "gpt-4o-mini")
GPT_3_5_TURBO = "gpt-3.5-turbo"
GPT_4 = "gpt-4"
GPT_4_TURBO = "gpt-4-turbo"
GPT_4O = "gpt-4o"
GPT_4O_MINI = "gpt-4o-mini"
GPT_4_5_PREVIEW = "gpt-4.5-preview"
O1 = "o1"
O1_PREVIEW = "o1-preview"
O1_MINI = "o1-mini"
O3_MINI = "o3-mini"
GLM_4 = "glm-4"
GLM_4V = "glm-4v"
GLM_4V_FLASH = "glm-4v-flash"
GLM_4V_PLUS_0111 = "glm-4v-plus-0111"
GLM_4_PLUS = "glm-4-plus"
GLM_4_AIR = "glm-4-air"
GLM_4_AIR_0111 = "glm-4-air-0111"
GLM_4_AIRX = "glm-4-airx"
GLM_4_LONG = "glm-4-long"
GLM_4_FLASHX = "glm-4-flashx"
GLM_4_FLASH = "glm-4-flash"
GLM_ZERO_PREVIEW = "glm-zero-preview"
GLM_3_TURBO = "glm-3-turbo"
# Groq platform models
GROQ_LLAMA_3_1_8B = "llama-3.1-8b-instant"
GROQ_LLAMA_3_3_70B = "llama-3.3-70b-versatile"
GROQ_LLAMA_3_3_70B_PREVIEW = "llama-3.3-70b-specdec"
GROQ_LLAMA_3_8B = "llama3-8b-8192"
GROQ_LLAMA_3_70B = "llama3-70b-8192"
GROQ_MIXTRAL_8_7B = "mixtral-8x7b-32768"
GROQ_GEMMA_2_9B_IT = "gemma2-9b-it"
# TogetherAI platform models support tool calling
TOGETHER_LLAMA_3_1_8B = "meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo"
TOGETHER_LLAMA_3_1_70B = "meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo"
TOGETHER_LLAMA_3_1_405B = "meta-llama/Meta-Llama-3.1-405B-Instruct-Turbo"
TOGETHER_LLAMA_3_3_70B = "meta-llama/Llama-3.3-70B-Instruct-Turbo"
TOGETHER_MIXTRAL_8_7B = "mistralai/Mixtral-8x7B-Instruct-v0.1"
TOGETHER_MISTRAL_7B = "mistralai/Mistral-7B-Instruct-v0.1"
# SambaNova Cloud platform models support tool calling
SAMBA_LLAMA_3_1_8B = "Meta-Llama-3.1-8B-Instruct"
SAMBA_LLAMA_3_1_70B = "Meta-Llama-3.1-70B-Instruct"
SAMBA_LLAMA_3_1_405B = "Meta-Llama-3.1-405B-Instruct"
# SGLang models support tool calling
SGLANG_LLAMA_3_1_8B = "meta-llama/Meta-Llama-3.1-8B-Instruct"
SGLANG_LLAMA_3_1_70B = "meta-llama/Meta-Llama-3.1-70B-Instruct"
SGLANG_LLAMA_3_1_405B = "meta-llama/Meta-Llama-3.1-405B-Instruct"
SGLANG_LLAMA_3_2_1B = "meta-llama/Llama-3.2-1B-Instruct"
SGLANG_MIXTRAL_NEMO = "mistralai/Mistral-Nemo-Instruct-2407"
SGLANG_MISTRAL_7B = "mistralai/Mistral-7B-Instruct-v0.3"
SGLANG_QWEN_2_5_7B = "Qwen/Qwen2.5-7B-Instruct"
SGLANG_QWEN_2_5_32B = "Qwen/Qwen2.5-32B-Instruct"
SGLANG_QWEN_2_5_72B = "Qwen/Qwen2.5-72B-Instruct"
STUB = "stub"
# Legacy anthropic models
# NOTE: anthropic legacy models only Claude 2.1 has system prompt support
CLAUDE_2_1 = "claude-2.1"
CLAUDE_2_0 = "claude-2.0"
CLAUDE_INSTANT_1_2 = "claude-instant-1.2"
# Claude3 models
CLAUDE_3_OPUS = "claude-3-opus-latest"
CLAUDE_3_SONNET = "claude-3-sonnet-20240229"
CLAUDE_3_HAIKU = "claude-3-haiku-20240307"
CLAUDE_3_5_SONNET = "claude-3-5-sonnet-latest"
CLAUDE_3_5_HAIKU = "claude-3-5-haiku-latest"
CLAUDE_3_7_SONNET = "claude-3-7-sonnet-latest"
# Nvidia models
NVIDIA_NEMOTRON_340B_INSTRUCT = "nvidia/nemotron-4-340b-instruct"
NVIDIA_NEMOTRON_340B_REWARD = "nvidia/nemotron-4-340b-reward"
NVIDIA_YI_LARGE = "01-ai/yi-large"
NVIDIA_MISTRAL_LARGE = "mistralai/mistral-large"
NVIDIA_MIXTRAL_8X7B = "mistralai/mixtral-8x7b-instruct"
NVIDIA_LLAMA3_70B = "meta/llama3-70b"
NVIDIA_LLAMA3_1_8B_INSTRUCT = "meta/llama-3.1-8b-instruct"
NVIDIA_LLAMA3_1_70B_INSTRUCT = "meta/llama-3.1-70b-instruct"
NVIDIA_LLAMA3_1_405B_INSTRUCT = "meta/llama-3.1-405b-instruct"
NVIDIA_LLAMA3_2_1B_INSTRUCT = "meta/llama-3.2-1b-instruct"
NVIDIA_LLAMA3_2_3B_INSTRUCT = "meta/llama-3.2-3b-instruct"
NVIDIA_LLAMA3_3_70B_INSTRUCT = "meta/llama-3.3-70b-instruct"
# Gemini models
GEMINI_2_0_FLASH = "gemini-2.0-flash-exp"
GEMINI_2_0_FLASH_THINKING = "gemini-2.0-flash-thinking-exp"
GEMINI_2_0_PRO_EXP = "gemini-2.0-pro-exp-02-05"
GEMINI_2_0_FLASH_LITE_PREVIEW = "gemini-2.0-flash-lite-preview-02-05"
GEMINI_1_5_FLASH = "gemini-1.5-flash"
GEMINI_1_5_PRO = "gemini-1.5-pro"
# Mistral AI models
MISTRAL_3B = "ministral-3b-latest"
MISTRAL_7B = "open-mistral-7b"
MISTRAL_8B = "ministral-8b-latest"
MISTRAL_CODESTRAL = "codestral-latest"
MISTRAL_CODESTRAL_MAMBA = "open-codestral-mamba"
MISTRAL_LARGE = "mistral-large-latest"
MISTRAL_MIXTRAL_8x7B = "open-mixtral-8x7b"
MISTRAL_MIXTRAL_8x22B = "open-mixtral-8x22b"
MISTRAL_NEMO = "open-mistral-nemo"
MISTRAL_PIXTRAL_12B = "pixtral-12b-2409"
# Reka models
REKA_CORE = "reka-core"
REKA_FLASH = "reka-flash"
REKA_EDGE = "reka-edge"
# Cohere models
COHERE_COMMAND_R_PLUS = "command-r-plus"
COHERE_COMMAND_R = "command-r"
COHERE_COMMAND_LIGHT = "command-light"
COHERE_COMMAND = "command"
COHERE_COMMAND_NIGHTLY = "command-nightly"
# Qwen models (Aliyun)
QWEN_MAX = "qwen-max"
QWEN_PLUS = "qwen-plus"
QWEN_TURBO = "qwen-turbo"
QWEN_LONG = "qwen-long"
QWEN_VL_MAX = "qwen-vl-max"
QWEN_VL_PLUS = "qwen-vl-plus"
QWEN_MATH_PLUS = "qwen-math-plus"
QWEN_MATH_TURBO = "qwen-math-turbo"
QWEN_CODER_TURBO = "qwen-coder-turbo"
QWEN_2_5_CODER_32B = "qwen2.5-coder-32b-instruct"
QWEN_2_5_VL_72B = "qwen2.5-vl-72b-instruct"
QWEN_2_5_72B = "qwen2.5-72b-instruct"
QWEN_2_5_32B = "qwen2.5-32b-instruct"
QWEN_2_5_14B = "qwen2.5-14b-instruct"
QWEN_QWQ_32B = "qwq-32b-preview"
QWEN_QVQ_72B = "qvq-72b-preview"
# Yi models (01-ai)
YI_LIGHTNING = "yi-lightning"
YI_LARGE = "yi-large"
YI_MEDIUM = "yi-medium"
YI_LARGE_TURBO = "yi-large-turbo"
YI_VISION = "yi-vision"
YI_MEDIUM_200K = "yi-medium-200k"
YI_SPARK = "yi-spark"
YI_LARGE_RAG = "yi-large-rag"
YI_LARGE_FC = "yi-large-fc"
# DeepSeek models
DEEPSEEK_CHAT = "deepseek-chat"
DEEPSEEK_REASONER = "deepseek-reasoner"
# InternLM models
INTERNLM3_LATEST = "internlm3-latest"
INTERNLM3_8B_INSTRUCT = "internlm3-8b-instruct"
INTERNLM2_5_LATEST = "internlm2.5-latest"
INTERNLM2_PRO_CHAT = "internlm2-pro-chat"
# Moonshot models
MOONSHOT_V1_8K = "moonshot-v1-8k"
MOONSHOT_V1_32K = "moonshot-v1-32k"
MOONSHOT_V1_128K = "moonshot-v1-128k"
# SiliconFlow models support tool calling
SILICONFLOW_DEEPSEEK_V2_5 = "deepseek-ai/DeepSeek-V2.5"
SILICONFLOW_DEEPSEEK_V3 = "deepseek-ai/DeepSeek-V3"
SILICONFLOW_INTERN_LM2_5_20B_CHAT = "internlm/internlm2_5-20b-chat"
SILICONFLOW_INTERN_LM2_5_7B_CHAT = "internlm/internlm2_5-7b-chat"
SILICONFLOW_PRO_INTERN_LM2_5_7B_CHAT = "Pro/internlm/internlm2_5-7b-chat"
SILICONFLOW_QWEN2_5_72B_INSTRUCT = "Qwen/Qwen2.5-72B-Instruct"
SILICONFLOW_QWEN2_5_32B_INSTRUCT = "Qwen/Qwen2.5-32B-Instruct"
SILICONFLOW_QWEN2_5_14B_INSTRUCT = "Qwen/Qwen2.5-14B-Instruct"
SILICONFLOW_QWEN2_5_7B_INSTRUCT = "Qwen/Qwen2.5-7B-Instruct"
SILICONFLOW_PRO_QWEN2_5_7B_INSTRUCT = "Pro/Qwen/Qwen2.5-7B-Instruct"
SILICONFLOW_THUDM_GLM_4_9B_CHAT = "THUDM/glm-4-9b-chat"
SILICONFLOW_PRO_THUDM_GLM_4_9B_CHAT = "Pro/THUDM/glm-4-9b-chat"
# AIML models support tool calling
AIML_MIXTRAL_8X7B = "mistralai/Mixtral-8x7B-Instruct-v0.1"
AIML_MISTRAL_7B_INSTRUCT = "mistralai/Mistral-7B-Instruct-v0.1"
def __str__(self):
return self.value
def __new__(cls, value) -> "ModelType":
return cast("ModelType", UnifiedModelType.__new__(cls, value))
@property
def value_for_tiktoken(self) -> str:
if self.is_openai:
return self.value
return "gpt-4o-mini"
@property
def support_native_structured_output(self) -> bool:
return any(
[
self.is_openai,
]
)
@property
def support_native_tool_calling(self) -> bool:
return any(
[
self.is_openai,
self.is_gemini,
self.is_mistral,
self.is_qwen,
self.is_deepseek,
self.is_cohere,
self.is_internlm,
self.is_together,
self.is_sambanova,
self.is_groq,
self.is_sglang,
self.is_moonshot,
self.is_siliconflow,
self.is_zhipuai,
self.is_aiml,
self.is_azure_openai,
]
)
@property
def is_openai(self) -> bool:
r"""Returns whether this type of models is an OpenAI-released model."""
return self in {
ModelType.GPT_3_5_TURBO,
ModelType.GPT_4,
ModelType.GPT_4_TURBO,
ModelType.GPT_4O,
ModelType.GPT_4O_MINI,
ModelType.O1,
ModelType.O1_PREVIEW,
ModelType.O1_MINI,
ModelType.O3_MINI,
ModelType.GPT_4_5_PREVIEW,
}
@property
def is_azure_openai(self) -> bool:
r"""Returns whether this type of models is an OpenAI-released model
from Azure.
"""
return self in {
ModelType.GPT_3_5_TURBO,
ModelType.GPT_4,
ModelType.GPT_4_TURBO,
ModelType.GPT_4O,
ModelType.GPT_4O_MINI,
}
@property
def is_zhipuai(self) -> bool:
r"""Returns whether this type of models is an ZhipuAI model."""
return self in {
ModelType.GLM_3_TURBO,
ModelType.GLM_4,
ModelType.GLM_4V,
ModelType.GLM_4V_FLASH,
ModelType.GLM_4V_PLUS_0111,
ModelType.GLM_4_PLUS,
ModelType.GLM_4_AIR,
ModelType.GLM_4_AIR_0111,
ModelType.GLM_4_AIRX,
ModelType.GLM_4_LONG,
ModelType.GLM_4_FLASHX,
ModelType.GLM_4_FLASH,
ModelType.GLM_ZERO_PREVIEW,
}
@property
def is_anthropic(self) -> bool:
r"""Returns whether this type of models is Anthropic-released model.
Returns:
bool: Whether this type of models is anthropic.
"""
return self in {
ModelType.CLAUDE_INSTANT_1_2,
ModelType.CLAUDE_2_0,
ModelType.CLAUDE_2_1,
ModelType.CLAUDE_3_OPUS,
ModelType.CLAUDE_3_SONNET,
ModelType.CLAUDE_3_HAIKU,
ModelType.CLAUDE_3_5_SONNET,
ModelType.CLAUDE_3_5_HAIKU,
ModelType.CLAUDE_3_7_SONNET,
}
@property
def is_groq(self) -> bool:
r"""Returns whether this type of models is served by Groq."""
return self in {
ModelType.GROQ_LLAMA_3_1_8B,
ModelType.GROQ_LLAMA_3_3_70B,
ModelType.GROQ_LLAMA_3_3_70B_PREVIEW,
ModelType.GROQ_LLAMA_3_8B,
ModelType.GROQ_LLAMA_3_70B,
ModelType.GROQ_MIXTRAL_8_7B,
ModelType.GROQ_GEMMA_2_9B_IT,
}
@property
def is_together(self) -> bool:
r"""Returns whether this type of models is served by Together AI."""
return self in {
ModelType.TOGETHER_LLAMA_3_1_405B,
ModelType.TOGETHER_LLAMA_3_1_70B,
ModelType.TOGETHER_LLAMA_3_3_70B,
ModelType.TOGETHER_LLAMA_3_3_70B,
ModelType.TOGETHER_MISTRAL_7B,
ModelType.TOGETHER_MIXTRAL_8_7B,
}
@property
def is_sambanova(self) -> bool:
r"""Returns whether this type of model is served by SambaNova AI."""
return self in {
ModelType.SAMBA_LLAMA_3_1_8B,
ModelType.SAMBA_LLAMA_3_1_70B,
ModelType.SAMBA_LLAMA_3_1_405B,
}
@property
def is_mistral(self) -> bool:
r"""Returns whether this type of models is served by Mistral."""
return self in {
ModelType.MISTRAL_LARGE,
ModelType.MISTRAL_NEMO,
ModelType.MISTRAL_CODESTRAL,
ModelType.MISTRAL_7B,
ModelType.MISTRAL_MIXTRAL_8x7B,
ModelType.MISTRAL_MIXTRAL_8x22B,
ModelType.MISTRAL_CODESTRAL_MAMBA,
ModelType.MISTRAL_PIXTRAL_12B,
ModelType.MISTRAL_8B,
ModelType.MISTRAL_3B,
}
@property
def is_nvidia(self) -> bool:
r"""Returns whether this type of models is a NVIDIA model."""
return self in {
ModelType.NVIDIA_NEMOTRON_340B_INSTRUCT,
ModelType.NVIDIA_NEMOTRON_340B_REWARD,
ModelType.NVIDIA_YI_LARGE,
ModelType.NVIDIA_MISTRAL_LARGE,
ModelType.NVIDIA_LLAMA3_70B,
ModelType.NVIDIA_MIXTRAL_8X7B,
ModelType.NVIDIA_LLAMA3_1_8B_INSTRUCT,
ModelType.NVIDIA_LLAMA3_1_70B_INSTRUCT,
ModelType.NVIDIA_LLAMA3_1_405B_INSTRUCT,
ModelType.NVIDIA_LLAMA3_2_1B_INSTRUCT,
ModelType.NVIDIA_LLAMA3_2_3B_INSTRUCT,
ModelType.NVIDIA_LLAMA3_3_70B_INSTRUCT,
}
@property
def is_gemini(self) -> bool:
r"""Returns whether this type of models is Gemini model.
Returns:
bool: Whether this type of models is gemini.
"""
return self in {
ModelType.GEMINI_2_0_FLASH,
ModelType.GEMINI_1_5_FLASH,
ModelType.GEMINI_1_5_PRO,
ModelType.GEMINI_2_0_FLASH_THINKING,
ModelType.GEMINI_2_0_PRO_EXP,
ModelType.GEMINI_2_0_FLASH_LITE_PREVIEW,
}
@property
def is_reka(self) -> bool:
r"""Returns whether this type of models is Reka model.
Returns:
bool: Whether this type of models is Reka.
"""
return self in {
ModelType.REKA_CORE,
ModelType.REKA_EDGE,
ModelType.REKA_FLASH,
}
@property
def is_cohere(self) -> bool:
r"""Returns whether this type of models is a Cohere model.
Returns:
bool: Whether this type of models is Cohere.
"""
return self in {
ModelType.COHERE_COMMAND_R_PLUS,
ModelType.COHERE_COMMAND_R,
ModelType.COHERE_COMMAND_LIGHT,
ModelType.COHERE_COMMAND,
ModelType.COHERE_COMMAND_NIGHTLY,
}
@property
def is_yi(self) -> bool:
r"""Returns whether this type of models is Yi model.
Returns:
bool: Whether this type of models is Yi.
"""
return self in {
ModelType.YI_LIGHTNING,
ModelType.YI_LARGE,
ModelType.YI_MEDIUM,
ModelType.YI_LARGE_TURBO,
ModelType.YI_VISION,
ModelType.YI_MEDIUM_200K,
ModelType.YI_SPARK,
ModelType.YI_LARGE_RAG,
ModelType.YI_LARGE_FC,
}
@property
def is_qwen(self) -> bool:
return self in {
ModelType.QWEN_MAX,
ModelType.QWEN_PLUS,
ModelType.QWEN_TURBO,
ModelType.QWEN_LONG,
ModelType.QWEN_VL_MAX,
ModelType.QWEN_VL_PLUS,
ModelType.QWEN_MATH_PLUS,
ModelType.QWEN_MATH_TURBO,
ModelType.QWEN_CODER_TURBO,
ModelType.QWEN_2_5_CODER_32B,
ModelType.QWEN_2_5_VL_72B,
ModelType.QWEN_2_5_72B,
ModelType.QWEN_2_5_32B,
ModelType.QWEN_2_5_14B,
ModelType.QWEN_QWQ_32B,
ModelType.QWEN_QVQ_72B,
}
@property
def is_deepseek(self) -> bool:
return self in {
ModelType.DEEPSEEK_CHAT,
ModelType.DEEPSEEK_REASONER,
}
@property
def is_internlm(self) -> bool:
return self in {
ModelType.INTERNLM3_LATEST,
ModelType.INTERNLM3_8B_INSTRUCT,
ModelType.INTERNLM2_5_LATEST,
ModelType.INTERNLM2_PRO_CHAT,
}
@property
def is_moonshot(self) -> bool:
return self in {
ModelType.MOONSHOT_V1_8K,
ModelType.MOONSHOT_V1_32K,
ModelType.MOONSHOT_V1_128K,
}
@property
def is_sglang(self) -> bool:
return self in {
ModelType.SGLANG_LLAMA_3_1_8B,
ModelType.SGLANG_LLAMA_3_1_70B,
ModelType.SGLANG_LLAMA_3_1_405B,
ModelType.SGLANG_LLAMA_3_2_1B,
ModelType.SGLANG_MIXTRAL_NEMO,
ModelType.SGLANG_MISTRAL_7B,
ModelType.SGLANG_QWEN_2_5_7B,
ModelType.SGLANG_QWEN_2_5_32B,
ModelType.SGLANG_QWEN_2_5_72B,
}
@property
def is_siliconflow(self) -> bool:
return self in {
ModelType.SILICONFLOW_DEEPSEEK_V2_5,
ModelType.SILICONFLOW_DEEPSEEK_V3,
ModelType.SILICONFLOW_INTERN_LM2_5_20B_CHAT,
ModelType.SILICONFLOW_INTERN_LM2_5_7B_CHAT,
ModelType.SILICONFLOW_PRO_INTERN_LM2_5_7B_CHAT,
ModelType.SILICONFLOW_QWEN2_5_72B_INSTRUCT,
ModelType.SILICONFLOW_QWEN2_5_32B_INSTRUCT,
ModelType.SILICONFLOW_QWEN2_5_14B_INSTRUCT,
ModelType.SILICONFLOW_QWEN2_5_7B_INSTRUCT,
ModelType.SILICONFLOW_PRO_QWEN2_5_7B_INSTRUCT,
ModelType.SILICONFLOW_THUDM_GLM_4_9B_CHAT,
ModelType.SILICONFLOW_PRO_THUDM_GLM_4_9B_CHAT,
}
@property
def is_aiml(self) -> bool:
return self in {
ModelType.AIML_MIXTRAL_8X7B,
ModelType.AIML_MISTRAL_7B_INSTRUCT,
}
@property
def token_limit(self) -> int:
r"""Returns the maximum token limit for a given model.
Returns:
int: The maximum token limit for the given model.
"""
if self is ModelType.GLM_4V:
return 1024
elif self in {
ModelType.STUB,
ModelType.REKA_CORE,
ModelType.REKA_EDGE,
ModelType.REKA_FLASH,
ModelType.QWEN_MATH_PLUS,
ModelType.QWEN_MATH_TURBO,
ModelType.COHERE_COMMAND,
ModelType.COHERE_COMMAND_LIGHT,
ModelType.NVIDIA_NEMOTRON_340B_INSTRUCT,
ModelType.NVIDIA_NEMOTRON_340B_REWARD,
}:
return 4_096
elif self in {
ModelType.GPT_4,
ModelType.GROQ_LLAMA_3_8B,
ModelType.GROQ_LLAMA_3_70B,
ModelType.GROQ_LLAMA_3_3_70B_PREVIEW,
ModelType.GROQ_GEMMA_2_9B_IT,
ModelType.GLM_3_TURBO,
ModelType.GLM_4,
ModelType.QWEN_VL_PLUS,
ModelType.NVIDIA_LLAMA3_70B,
ModelType.TOGETHER_MISTRAL_7B,
ModelType.MOONSHOT_V1_8K,
ModelType.GLM_4V_FLASH,
ModelType.GLM_4_AIRX,
}:
return 8_192
elif self in {
ModelType.GPT_3_5_TURBO,
ModelType.YI_LIGHTNING,
ModelType.YI_MEDIUM,
ModelType.YI_LARGE_TURBO,
ModelType.YI_VISION,
ModelType.YI_SPARK,
ModelType.YI_LARGE_RAG,
ModelType.SAMBA_LLAMA_3_1_8B,
ModelType.SAMBA_LLAMA_3_1_405B,
ModelType.GLM_4V_PLUS_0111,
ModelType.GLM_ZERO_PREVIEW,
}:
return 16_384
elif self in {
ModelType.MISTRAL_CODESTRAL,
ModelType.MISTRAL_7B,
ModelType.MISTRAL_MIXTRAL_8x7B,
ModelType.GROQ_MIXTRAL_8_7B,
ModelType.YI_LARGE,
ModelType.YI_LARGE_FC,
ModelType.QWEN_MAX,
ModelType.QWEN_VL_MAX,
ModelType.NVIDIA_YI_LARGE,
ModelType.NVIDIA_MISTRAL_LARGE,
ModelType.NVIDIA_MIXTRAL_8X7B,
ModelType.QWEN_QWQ_32B,
ModelType.QWEN_QVQ_72B,
ModelType.INTERNLM3_8B_INSTRUCT,
ModelType.INTERNLM3_LATEST,
ModelType.INTERNLM2_5_LATEST,
ModelType.INTERNLM2_PRO_CHAT,
ModelType.TOGETHER_MIXTRAL_8_7B,
ModelType.SGLANG_MISTRAL_7B,
ModelType.MOONSHOT_V1_32K,
ModelType.AIML_MIXTRAL_8X7B,
ModelType.AIML_MISTRAL_7B_INSTRUCT,
}:
return 32_768
elif self in {
ModelType.MISTRAL_MIXTRAL_8x22B,
ModelType.DEEPSEEK_CHAT,
ModelType.DEEPSEEK_REASONER,
}:
return 64_000
elif self in {
ModelType.CLAUDE_2_0,
ModelType.CLAUDE_INSTANT_1_2,
}:
return 100_000
elif self in {
ModelType.GPT_4O,
ModelType.GPT_4O_MINI,
ModelType.GPT_4_TURBO,
ModelType.O1_PREVIEW,
ModelType.O1_MINI,
ModelType.GPT_4_5_PREVIEW,
ModelType.MISTRAL_LARGE,
ModelType.MISTRAL_NEMO,
ModelType.MISTRAL_PIXTRAL_12B,
ModelType.MISTRAL_8B,
ModelType.MISTRAL_3B,
ModelType.QWEN_2_5_CODER_32B,
ModelType.QWEN_2_5_VL_72B,
ModelType.QWEN_2_5_72B,
ModelType.QWEN_2_5_32B,
ModelType.QWEN_2_5_14B,
ModelType.COHERE_COMMAND_R,
ModelType.COHERE_COMMAND_R_PLUS,
ModelType.COHERE_COMMAND_NIGHTLY,
ModelType.NVIDIA_LLAMA3_1_8B_INSTRUCT,
ModelType.NVIDIA_LLAMA3_1_70B_INSTRUCT,
ModelType.NVIDIA_LLAMA3_1_405B_INSTRUCT,
ModelType.NVIDIA_LLAMA3_2_1B_INSTRUCT,
ModelType.NVIDIA_LLAMA3_2_3B_INSTRUCT,
ModelType.NVIDIA_LLAMA3_3_70B_INSTRUCT,
ModelType.GROQ_LLAMA_3_3_70B,
ModelType.SAMBA_LLAMA_3_1_70B,
ModelType.SGLANG_LLAMA_3_1_8B,
ModelType.SGLANG_LLAMA_3_1_70B,
ModelType.SGLANG_LLAMA_3_1_405B,
ModelType.SGLANG_LLAMA_3_2_1B,
ModelType.SGLANG_MIXTRAL_NEMO,
ModelType.MOONSHOT_V1_128K,
ModelType.GLM_4_PLUS,
ModelType.GLM_4_AIR,
ModelType.GLM_4_AIR_0111,
ModelType.GLM_4_FLASHX,
ModelType.GLM_4_FLASH,
}:
return 128_000
elif self in {
ModelType.GROQ_LLAMA_3_1_8B,
ModelType.QWEN_PLUS,
ModelType.QWEN_TURBO,
ModelType.QWEN_CODER_TURBO,
ModelType.TOGETHER_LLAMA_3_1_8B,
ModelType.TOGETHER_LLAMA_3_1_70B,
ModelType.TOGETHER_LLAMA_3_1_405B,
ModelType.TOGETHER_LLAMA_3_3_70B,
ModelType.SGLANG_QWEN_2_5_7B,
ModelType.SGLANG_QWEN_2_5_32B,
ModelType.SGLANG_QWEN_2_5_72B,
}:
return 131_072
elif self in {
ModelType.O1,
ModelType.O3_MINI,
ModelType.CLAUDE_2_1,
ModelType.CLAUDE_3_OPUS,
ModelType.CLAUDE_3_SONNET,
ModelType.CLAUDE_3_HAIKU,
ModelType.CLAUDE_3_5_SONNET,
ModelType.CLAUDE_3_5_HAIKU,
ModelType.CLAUDE_3_7_SONNET,
ModelType.YI_MEDIUM_200K,
}:
return 200_000
elif self in {
ModelType.MISTRAL_CODESTRAL_MAMBA,
}:
return 256_000
elif self in {
ModelType.GEMINI_2_0_FLASH,
ModelType.GEMINI_1_5_FLASH,
ModelType.GEMINI_1_5_PRO,
ModelType.GEMINI_2_0_FLASH_THINKING,
ModelType.GEMINI_2_0_FLASH_LITE_PREVIEW,
ModelType.GEMINI_2_0_PRO_EXP, # Not given in doc, assume the same
ModelType.GLM_4_LONG,
}:
return 1_048_576
elif self in {
ModelType.QWEN_LONG,
}:
return 10_000_000
else:
raise ValueError("Unknown model type")
[docs]
class EmbeddingModelType(Enum):
TEXT_EMBEDDING_ADA_2 = "text-embedding-ada-002"
TEXT_EMBEDDING_3_SMALL = "text-embedding-3-small"
TEXT_EMBEDDING_3_LARGE = "text-embedding-3-large"
JINA_EMBEDDINGS_V3 = "jina-embeddings-v3"
JINA_CLIP_V2 = "jina-clip-v2"
JINA_COLBERT_V2 = "jina-colbert-v2"
JINA_EMBEDDINGS_V2_BASE_CODE = "jina-embeddings-v2-base-code"
MISTRAL_EMBED = "mistral-embed"
@property
def is_openai(self) -> bool:
r"""Returns whether this type of models is an OpenAI-released model."""
return self in {
EmbeddingModelType.TEXT_EMBEDDING_ADA_2,
EmbeddingModelType.TEXT_EMBEDDING_3_SMALL,
EmbeddingModelType.TEXT_EMBEDDING_3_LARGE,
}
@property
def is_jina(self) -> bool:
r"""Returns whether this type of models is an Jina model."""
return self in {
EmbeddingModelType.JINA_EMBEDDINGS_V3,
EmbeddingModelType.JINA_CLIP_V2,
EmbeddingModelType.JINA_COLBERT_V2,
EmbeddingModelType.JINA_EMBEDDINGS_V2_BASE_CODE,
}
@property
def is_mistral(self) -> bool:
r"""Returns whether this type of models is an Mistral-released
model.
"""
return self in {
EmbeddingModelType.MISTRAL_EMBED,
}
@property
def output_dim(self) -> int:
if self in {
EmbeddingModelType.JINA_COLBERT_V2,
}:
return 128
elif self in {
EmbeddingModelType.JINA_EMBEDDINGS_V2_BASE_CODE,
}:
return 768
elif self in {
EmbeddingModelType.JINA_EMBEDDINGS_V3,
EmbeddingModelType.JINA_CLIP_V2,
}:
return 1024
elif self is EmbeddingModelType.TEXT_EMBEDDING_ADA_2:
return 1536
elif self is EmbeddingModelType.TEXT_EMBEDDING_3_SMALL:
return 1536
elif self is EmbeddingModelType.TEXT_EMBEDDING_3_LARGE:
return 3072
elif self is EmbeddingModelType.MISTRAL_EMBED:
return 1024
else:
raise ValueError(f"Unknown model type {self}.")
[docs]
class TaskType(Enum):
AI_SOCIETY = "ai_society"
CODE = "code"
MISALIGNMENT = "misalignment"
TRANSLATION = "translation"
EVALUATION = "evaluation"
SOLUTION_EXTRACTION = "solution_extraction"
ROLE_DESCRIPTION = "role_description"
GENERATE_TEXT_EMBEDDING_DATA = "generate_text_embedding_data"
OBJECT_RECOGNITION = "object_recognition"
IMAGE_CRAFT = "image_craft"
MULTI_CONDITION_IMAGE_CRAFT = "multi_condition_image_craft"
DEFAULT = "default"
VIDEO_DESCRIPTION = "video_description"
[docs]
class VectorDistance(Enum):
r"""Distance metrics used in a vector database."""
DOT = "dot"
r"""Dot product. https://en.wikipedia.org/wiki/Dot_product"""
COSINE = "cosine"
r"""Cosine similarity. https://en.wikipedia.org/wiki/Cosine_similarity"""
EUCLIDEAN = "euclidean"
r"""Euclidean distance. https://en.wikipedia.org/wiki/Euclidean_distance"""
[docs]
class OpenAIBackendRole(Enum):
ASSISTANT = "assistant"
SYSTEM = "system"
USER = "user"
FUNCTION = "function"
TOOL = "tool"
[docs]
class TerminationMode(Enum):
ANY = "any"
ALL = "all"
[docs]
class OpenAIImageType(Enum, metaclass=OpenAIImageTypeMeta):
r"""Image types supported by OpenAI vision model."""
# https://platform.openai.com/docs/guides/vision
PNG = "png"
JPEG = "jpeg"
JPG = "jpg"
WEBP = "webp"
GIF = "gif"
[docs]
class OpenAIVisionDetailType(Enum):
AUTO = "auto"
LOW = "low"
HIGH = "high"
[docs]
class StorageType(Enum):
MILVUS = "milvus"
QDRANT = "qdrant"
[docs]
class OpenAPIName(Enum):
COURSERA = "coursera"
KLARNA = "klarna"
SPEAK = "speak"
NASA_APOD = "nasa_apod"
BIZTOC = "biztoc"
CREATE_QR_CODE = "create_qr_code"
OUTSCHOOL = "outschool"
WEB_SCRAPER = "web_scraper"
[docs]
class AudioModelType(Enum):
TTS_1 = "tts-1"
TTS_1_HD = "tts-1-hd"
@property
def is_openai(self) -> bool:
r"""Returns whether this type of audio models is an OpenAI-released
model."""
return self in {
AudioModelType.TTS_1,
AudioModelType.TTS_1_HD,
}
[docs]
class VoiceType(Enum):
ALLOY = "alloy"
ECHO = "echo"
FABLE = "fable"
ONYX = "onyx"
NOVA = "nova"
SHIMMER = "shimmer"
@property
def is_openai(self) -> bool:
r"""Returns whether this type of voice is an OpenAI-released voice."""
return self in {
VoiceType.ALLOY,
VoiceType.ECHO,
VoiceType.FABLE,
VoiceType.ONYX,
VoiceType.NOVA,
VoiceType.SHIMMER,
}
[docs]
class HuggingFaceRepoType(str, Enum):
DATASET = "dataset"
MODEL = "model"
SPACE = "space"
