camel-ai 0.2.3__py3-none-any.whl → 0.2.3a0__py3-none-any.whl

camel/toolkits/weather_toolkit.py

@@ -15,7 +15,7 @@ import os
 from typing import List, Literal
 
 from camel.toolkits.base import BaseToolkit
-from camel.toolkits.function_tool import FunctionTool
+from camel.toolkits.openai_function import OpenAIFunction
 
 
 class WeatherToolkit(BaseToolkit):
@@ -157,17 +157,17 @@ class WeatherToolkit(BaseToolkit):
             )
             return error_message
 
-    def get_tools(self) -> List[FunctionTool]:
-        r"""Returns a list of FunctionTool objects representing the
+    def get_tools(self) -> List[OpenAIFunction]:
+        r"""Returns a list of OpenAIFunction objects representing the
         functions in the toolkit.
 
         Returns:
-            List[FunctionTool]: A list of FunctionTool objects
+            List[OpenAIFunction]: A list of OpenAIFunction objects
                 representing the functions in the toolkit.
         """
         return [
-            FunctionTool(self.get_weather_data),
+            OpenAIFunction(self.get_weather_data),
         ]
 
 
-WEATHER_FUNCS: List[FunctionTool] = WeatherToolkit().get_tools()
+WEATHER_FUNCS: List[OpenAIFunction] = WeatherToolkit().get_tools()

camel/types/__init__.py

@@ -28,7 +28,6 @@ from .enums import (
     VoiceType,
 )
 from .openai_types import (
-    NOT_GIVEN,
     ChatCompletion,
     ChatCompletionAssistantMessageParam,
     ChatCompletionChunk,
@@ -39,9 +38,7 @@ from .openai_types import (
     ChatCompletionUserMessageParam,
     Choice,
     CompletionUsage,
-    NotGiven,
 )
-from .unified_model_type import UnifiedModelType
 
 __all__ = [
     'RoleType',
@@ -62,13 +59,11 @@ __all__ = [
     'ChatCompletionAssistantMessageParam',
     'ChatCompletionFunctionMessageParam',
     'CompletionUsage',
+    'OpenAIVideoType',
     'OpenAIImageType',
     'OpenAIVisionDetailType',
     'OpenAPIName',
     'ModelPlatformType',
     'AudioModelType',
     'VoiceType',
-    'UnifiedModelType',
-    'NOT_GIVEN',
-    'NotGiven',
 ]

camel/types/enums.py

@@ -11,10 +11,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+import re
 from enum import Enum, EnumMeta
-from typing import cast
-
-from camel.types.unified_model_type import UnifiedModelType
 
 
 class RoleType(Enum):
@@ -25,9 +23,7 @@ class RoleType(Enum):
     DEFAULT = "default"
 
 
-class ModelType(UnifiedModelType, Enum):
-    DEFAULT = "gpt-4o-mini"
-
+class ModelType(Enum):
     GPT_3_5_TURBO = "gpt-3.5-turbo"
     GPT_4 = "gpt-4"
     GPT_4_TURBO = "gpt-4-turbo"
@@ -37,6 +33,7 @@ class ModelType(UnifiedModelType, Enum):
     O1_MINI = "o1-mini"
 
     GLM_4 = "glm-4"
+    GLM_4_OPEN_SOURCE = "glm-4-open-source"
     GLM_4V = 'glm-4v'
     GLM_3_TURBO = "glm-3-turbo"
 
@@ -51,6 +48,13 @@ class ModelType(UnifiedModelType, Enum):
 
     STUB = "stub"
 
+    LLAMA_2 = "llama-2"
+    LLAMA_3 = "llama-3"
+    VICUNA = "vicuna"
+    VICUNA_16K = "vicuna-16k"
+
+    QWEN_2 = "qwen-2"
+
     # Legacy anthropic models
     # NOTE: anthropic legacy models only Claude 2.1 has system prompt support
     CLAUDE_2_1 = "claude-2.1"
@@ -71,15 +75,13 @@ class ModelType(UnifiedModelType, Enum):
     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_NEMO = "open-mistral-nemo"
+    MISTRAL_CODESTRAL = "codestral-latest"
+    MISTRAL_7B = "open-mistral-7b"
     MISTRAL_MIXTRAL_8x7B = "open-mixtral-8x7b"
     MISTRAL_MIXTRAL_8x22B = "open-mixtral-8x22b"
-    MISTRAL_NEMO = "open-mistral-nemo"
+    MISTRAL_CODESTRAL_MAMBA = "open-codestral-mamba"
     MISTRAL_PIXTRAL_12B = "pixtral-12b-2409"
 
     # Reka models
@@ -87,12 +89,6 @@ class ModelType(UnifiedModelType, Enum):
     REKA_FLASH = "reka-flash"
     REKA_EDGE = "reka-edge"
 
-    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:
@@ -100,7 +96,7 @@ class ModelType(UnifiedModelType, Enum):
         return "gpt-4o-mini"
 
     @property
-    def support_native_tool_calling(self) -> bool:
+    def supports_tool_calling(self) -> bool:
         return any([self.is_openai, self.is_gemini, self.is_mistral])
 
     @property
@@ -137,6 +133,18 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.GLM_4V,
         }
 
+    @property
+    def is_open_source(self) -> bool:
+        r"""Returns whether this type of models is open-source."""
+        return self in {
+            ModelType.LLAMA_2,
+            ModelType.LLAMA_3,
+            ModelType.QWEN_2,
+            ModelType.GLM_4_OPEN_SOURCE,
+            ModelType.VICUNA,
+            ModelType.VICUNA_16K,
+        }
+
     @property
     def is_anthropic(self) -> bool:
         r"""Returns whether this type of models is Anthropic-released model.
@@ -180,8 +188,6 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.MISTRAL_MIXTRAL_8x22B,
             ModelType.MISTRAL_CODESTRAL_MAMBA,
             ModelType.MISTRAL_PIXTRAL_12B,
-            ModelType.MISTRAL_8B,
-            ModelType.MISTRAL_3B,
         }
 
     @property
@@ -202,10 +208,7 @@ class ModelType(UnifiedModelType, Enum):
         Returns:
             bool: Whether this type of models is gemini.
         """
-        return self in {
-            ModelType.GEMINI_1_5_FLASH,
-            ModelType.GEMINI_1_5_PRO,
-        }
+        return self in {ModelType.GEMINI_1_5_FLASH, ModelType.GEMINI_1_5_PRO}
 
     @property
     def is_reka(self) -> bool:
@@ -229,7 +232,11 @@ class ModelType(UnifiedModelType, Enum):
         """
         if self is ModelType.GLM_4V:
             return 1024
+        elif self is ModelType.VICUNA:
+            # reference: https://lmsys.org/blog/2023-03-30-vicuna/
+            return 2048
         elif self in {
+            ModelType.LLAMA_2,
             ModelType.NEMOTRON_4_REWARD,
             ModelType.STUB,
             ModelType.REKA_CORE,
@@ -243,12 +250,15 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.GROQ_LLAMA_3_70B,
             ModelType.GROQ_GEMMA_7B_IT,
             ModelType.GROQ_GEMMA_2_9B_IT,
+            ModelType.LLAMA_3,
             ModelType.GLM_3_TURBO,
             ModelType.GLM_4,
+            ModelType.GLM_4_OPEN_SOURCE,
         }:
             return 8_192
         elif self in {
             ModelType.GPT_3_5_TURBO,
+            ModelType.VICUNA_16K,
         }:
             return 16_384
         elif self in {
@@ -260,10 +270,7 @@ class ModelType(UnifiedModelType, Enum):
             return 32_768
         elif self in {ModelType.MISTRAL_MIXTRAL_8x22B}:
             return 64_000
-        elif self in {
-            ModelType.CLAUDE_2_0,
-            ModelType.CLAUDE_INSTANT_1_2,
-        }:
+        elif self in {ModelType.CLAUDE_2_0, ModelType.CLAUDE_INSTANT_1_2}:
             return 100_000
         elif self in {
             ModelType.GPT_4O,
@@ -274,8 +281,7 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.MISTRAL_LARGE,
             ModelType.MISTRAL_NEMO,
             ModelType.MISTRAL_PIXTRAL_12B,
-            ModelType.MISTRAL_8B,
-            ModelType.MISTRAL_3B,
+            ModelType.QWEN_2,
         }:
             return 128_000
         elif self in {
@@ -296,14 +302,48 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.MISTRAL_CODESTRAL_MAMBA,
         }:
             return 256_000
-        elif self in {
-            ModelType.GEMINI_1_5_FLASH,
-            ModelType.GEMINI_1_5_PRO,
-        }:
+        elif self in {ModelType.GEMINI_1_5_FLASH, ModelType.GEMINI_1_5_PRO}:
             return 1_048_576
         else:
             raise ValueError("Unknown model type")
 
+    def validate_model_name(self, model_name: str) -> bool:
+        r"""Checks whether the model type and the model name matches.
+
+        Args:
+            model_name (str): The name of the model, e.g. "vicuna-7b-v1.5".
+
+        Returns:
+            bool: Whether the model type matches the model name.
+        """
+        if self is ModelType.VICUNA:
+            pattern = r'^vicuna-\d+b-v\d+\.\d+$'
+            return bool(re.match(pattern, model_name))
+        elif self is ModelType.VICUNA_16K:
+            pattern = r'^vicuna-\d+b-v\d+\.\d+-16k$'
+            return bool(re.match(pattern, model_name))
+        elif self is ModelType.LLAMA_2:
+            return (
+                self.value in model_name.lower()
+                or "llama2" in model_name.lower()
+            )
+        elif self is ModelType.LLAMA_3:
+            return (
+                self.value in model_name.lower()
+                or "llama3" in model_name.lower()
+            )
+        elif self is ModelType.QWEN_2:
+            return (
+                self.value in model_name.lower()
+                or "qwen2" in model_name.lower()
+            )
+        elif self is ModelType.GLM_4_OPEN_SOURCE:
+            return (
+                'glm-4' in model_name.lower() or "glm4" in model_name.lower()
+            )
+        else:
+            return self.value in model_name.lower()
+
 
 class EmbeddingModelType(Enum):
     TEXT_EMBEDDING_ADA_2 = "text-embedding-ada-002"
@@ -429,21 +469,21 @@ class OpenAPIName(Enum):
 
 
 class ModelPlatformType(Enum):
-    DEFAULT = "openai"
-
     OPENAI = "openai"
     AZURE = "azure"
     ANTHROPIC = "anthropic"
     GROQ = "groq"
+    OPEN_SOURCE = "open-source"
     OLLAMA = "ollama"
     LITELLM = "litellm"
     ZHIPU = "zhipuai"
+    DEFAULT = "default"
     GEMINI = "gemini"
     VLLM = "vllm"
     MISTRAL = "mistral"
     REKA = "reka"
     TOGETHER = "together"
-    OPENAI_COMPATIBLE_MODEL = "openai-compatible-model"
+    OPENAI_COMPATIBILITY_MODEL = "openai-compatibility-model"
     SAMBA = "samba-nova"
 
     @property
@@ -497,10 +537,15 @@ class ModelPlatformType(Enum):
         return self is ModelPlatformType.MISTRAL
 
     @property
-    def is_openai_compatible_model(self) -> bool:
+    def is_open_source(self) -> bool:
+        r"""Returns whether this platform is opensource."""
+        return self is ModelPlatformType.OPEN_SOURCE
+
+    @property
+    def is_openai_compatibility_model(self) -> bool:
         r"""Returns whether this is a platform supporting openai
         compatibility"""
-        return self is ModelPlatformType.OPENAI_COMPATIBLE_MODEL
+        return self is ModelPlatformType.OPENAI_COMPATIBILITY_MODEL
 
     @property
     def is_gemini(self) -> bool:

camel/types/openai_types.py

@@ -31,7 +31,6 @@ from openai.types.chat.chat_completion_user_message_param import (
     ChatCompletionUserMessageParam,
 )
 from openai.types.completion_usage import CompletionUsage
-from openai._types import NOT_GIVEN, NotGiven
 
 Choice = Choice
 ChatCompletion = ChatCompletion
@@ -43,5 +42,3 @@ ChatCompletionUserMessageParam = ChatCompletionUserMessageParam
 ChatCompletionAssistantMessageParam = ChatCompletionAssistantMessageParam
 ChatCompletionFunctionMessageParam = ChatCompletionFunctionMessageParam
 CompletionUsage = CompletionUsage
-NOT_GIVEN = NOT_GIVEN
-NotGiven = NotGiven

camel/utils/__init__.py

@@ -43,6 +43,7 @@ from .token_counting import (
     LiteLLMTokenCounter,
     MistralTokenCounter,
     OpenAITokenCounter,
+    OpenSourceTokenCounter,
     get_model_encoding,
 )
 
@@ -59,6 +60,7 @@ __all__ = [
     'get_model_encoding',
     'BaseTokenCounter',
     'OpenAITokenCounter',
+    'OpenSourceTokenCounter',
     'LiteLLMTokenCounter',
     'Constants',
     'text_extract_from_web',

camel/utils/async_func.py

@@ -14,20 +14,20 @@
 import asyncio
 from copy import deepcopy
 
-from camel.toolkits import FunctionTool
+from camel.toolkits import OpenAIFunction
 
 
-def sync_funcs_to_async(funcs: list[FunctionTool]) -> list[FunctionTool]:
+def sync_funcs_to_async(funcs: list[OpenAIFunction]) -> list[OpenAIFunction]:
     r"""Convert a list of Python synchronous functions to Python
     asynchronous functions.
 
     Args:
-        funcs (list[FunctionTool]): List of Python synchronous
-            functions in the :obj:`FunctionTool` format.
+        funcs (list[OpenAIFunction]): List of Python synchronous
+            functions in the :obj:`OpenAIFunction` format.
 
     Returns:
-        list[FunctionTool]: List of Python asynchronous functions
-            in the :obj:`FunctionTool` format.
+        list[OpenAIFunction]: List of Python asynchronous functions
+            in the :obj:`OpenAIFunction` format.
     """
     async_funcs = []
     for func in funcs:
@@ -37,6 +37,6 @@ def sync_funcs_to_async(funcs: list[FunctionTool]) -> list[FunctionTool]:
             return asyncio.to_thread(sync_func, *args, **kwargs)  # noqa: B023
 
         async_funcs.append(
-            FunctionTool(async_callable, deepcopy(func.openai_tool_schema))
+            OpenAIFunction(async_callable, deepcopy(func.openai_tool_schema))
         )
     return async_funcs

camel/utils/commons.py

@@ -257,18 +257,18 @@ def api_keys_required(*required_keys: str) -> Callable[[F], F]:
 
     def decorator(func: F) -> F:
         @wraps(func)
-        def wrapper(*args: Any, **kwargs: Any) -> Any:
+        def wrapper(self, *args: Any, **kwargs: Any) -> Any:
             missing_environment_keys = [
                 k for k in required_keys if k not in os.environ
             ]
             if (
-                not (args and getattr(args[0], '_api_key', None))
+                not getattr(self, '_api_key', None)
                 and missing_environment_keys
             ):
                 raise ValueError(
                     f"Missing API keys: {', '.join(missing_environment_keys)}"
                 )
-            return func(*args, **kwargs)
+            return func(self, *args, **kwargs)
 
         return cast(F, wrapper)
 
@@ -577,32 +577,3 @@ def handle_http_error(response: requests.Response) -> str:
         return "Too Many Requests. You have hit the rate limit."
     else:
         return "HTTP Error"
-
-
-def retry_request(
-    func: Callable, retries: int = 3, delay: int = 1, *args: Any, **kwargs: Any
-) -> Any:
-    r"""Retries a function in case of any errors.
-
-    Args:
-        func (Callable): The function to be retried.
-        retries (int): Number of retry attempts. (default: :obj:`3`)
-        delay (int): Delay between retries in seconds. (default: :obj:`1`)
-        *args: Arguments to pass to the function.
-        **kwargs: Keyword arguments to pass to the function.
-
-    Returns:
-        Any: The result of the function call if successful.
-
-    Raises:
-        Exception: If all retry attempts fail.
-    """
-    for attempt in range(retries):
-        try:
-            return func(*args, **kwargs)
-        except Exception as e:
-            print(f"Attempt {attempt + 1}/{retries} failed: {e}")
-            if attempt < retries - 1:
-                time.sleep(delay)
-            else:
-                raise