camel-ai 0.2.9__py3-none-any.whl → 0.2.11__py3-none-any.whl

camel/types/enums.py

@@ -1,16 +1,17 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+import os
 from enum import Enum, EnumMeta
 from typing import cast
 
@@ -26,7 +27,7 @@ class RoleType(Enum):
 
 
 class ModelType(UnifiedModelType, Enum):
-    DEFAULT = "gpt-4o-mini"
+    DEFAULT = os.getenv("DEFAULT_MODEL_TYPE", "gpt-4o-mini")
 
     GPT_3_5_TURBO = "gpt-3.5-turbo"
     GPT_4 = "gpt-4"
@@ -64,11 +65,22 @@ class ModelType(UnifiedModelType, Enum):
     CLAUDE_3_5_SONNET = "claude-3-5-sonnet-20240620"
 
     # Nvidia models
-    NEMOTRON_4_REWARD = "nvidia/nemotron-4-340b-reward"
+    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"
 
     # Gemini models
     GEMINI_1_5_FLASH = "gemini-1.5-flash"
     GEMINI_1_5_PRO = "gemini-1.5-pro"
+    GEMINI_EXP_1114 = "gemini-exp-1114"
 
     # Mistral AI models
     MISTRAL_3B = "ministral-3b-latest"
@@ -87,6 +99,13 @@ class ModelType(UnifiedModelType, Enum):
     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"
@@ -97,6 +116,11 @@ class ModelType(UnifiedModelType, Enum):
     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_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"
 
     # Yi models (01-ai)
     YI_LIGHTNING = "yi-lightning"
@@ -109,6 +133,9 @@ class ModelType(UnifiedModelType, Enum):
     YI_LARGE_RAG = "yi-large-rag"
     YI_LARGE_FC = "yi-large-fc"
 
+    # DeepSeek models
+    DEEPSEEK_CHAT = "deepseek-chat"
+
     def __str__(self):
         return self.value
 
@@ -148,6 +175,7 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.GPT_4,
             ModelType.GPT_4_TURBO,
             ModelType.GPT_4O,
+            ModelType.GPT_4O_MINI,
         }
 
     @property
@@ -208,13 +236,19 @@ class ModelType(UnifiedModelType, Enum):
 
     @property
     def is_nvidia(self) -> bool:
-        r"""Returns whether this type of models is Nvidia-released model.
-
-        Returns:
-            bool: Whether this type of models is nvidia.
-        """
+        r"""Returns whether this type of models is a NVIDIA model."""
         return self in {
-            ModelType.NEMOTRON_4_REWARD,
+            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,
         }
 
     @property
@@ -227,6 +261,7 @@ class ModelType(UnifiedModelType, Enum):
         return self in {
             ModelType.GEMINI_1_5_FLASH,
             ModelType.GEMINI_1_5_PRO,
+            ModelType.GEMINI_EXP_1114,
         }
 
     @property
@@ -242,6 +277,21 @@ class ModelType(UnifiedModelType, Enum):
             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.
@@ -273,6 +323,17 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.QWEN_MATH_PLUS,
             ModelType.QWEN_MATH_TURBO,
             ModelType.QWEN_CODER_TURBO,
+            ModelType.QWEN_2_5_CODER_32B,
+            ModelType.QWEN_2_5_72B,
+            ModelType.QWEN_2_5_32B,
+            ModelType.QWEN_2_5_14B,
+            ModelType.QWEN_QWQ_32B,
+        }
+
+    @property
+    def is_deepseek(self) -> bool:
+        return self in {
+            ModelType.DEEPSEEK_CHAT,
         }
 
     @property
@@ -285,13 +346,16 @@ class ModelType(UnifiedModelType, Enum):
         if self is ModelType.GLM_4V:
             return 1024
         elif self in {
-            ModelType.NEMOTRON_4_REWARD,
             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 {
@@ -303,6 +367,7 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.GLM_3_TURBO,
             ModelType.GLM_4,
             ModelType.QWEN_VL_PLUS,
+            ModelType.NVIDIA_LLAMA3_70B,
         }:
             return 8_192
         elif self in {
@@ -324,9 +389,16 @@ class ModelType(UnifiedModelType, Enum):
             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,
         }:
             return 32_768
-        elif self in {ModelType.MISTRAL_MIXTRAL_8x22B}:
+        elif self in {
+            ModelType.MISTRAL_MIXTRAL_8x22B,
+            ModelType.DEEPSEEK_CHAT,
+        }:
             return 64_000
         elif self in {
             ModelType.CLAUDE_2_0,
@@ -344,6 +416,18 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.MISTRAL_PIXTRAL_12B,
             ModelType.MISTRAL_8B,
             ModelType.MISTRAL_3B,
+            ModelType.QWEN_2_5_CODER_32B,
+            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,
         }:
             return 128_000
         elif self in {
@@ -371,6 +455,7 @@ class ModelType(UnifiedModelType, Enum):
         elif self in {
             ModelType.GEMINI_1_5_FLASH,
             ModelType.GEMINI_1_5_PRO,
+            ModelType.GEMINI_EXP_1114,  # Not given in docs, assuming the same
         }:
             return 1_048_576
         elif self in {
@@ -505,7 +590,7 @@ class OpenAPIName(Enum):
 
 
 class ModelPlatformType(Enum):
-    DEFAULT = "openai"
+    DEFAULT = os.getenv("DEFAULT_MODEL_PLATFORM_TYPE", "openai")
 
     OPENAI = "openai"
     AZURE = "azure"
@@ -521,8 +606,11 @@ class ModelPlatformType(Enum):
     TOGETHER = "together"
     OPENAI_COMPATIBLE_MODEL = "openai-compatible-model"
     SAMBA = "samba-nova"
+    COHERE = "cohere"
     YI = "lingyiwanwu"
     QWEN = "tongyi-qianwen"
+    NVIDIA = "nvidia"
+    DEEPSEEK = "deepseek"
 
     @property
     def is_openai(self) -> bool:
@@ -595,6 +683,11 @@ class ModelPlatformType(Enum):
         r"""Returns whether this platform is Samba Nova."""
         return self is ModelPlatformType.SAMBA
 
+    @property
+    def is_cohere(self) -> bool:
+        r"""Returns whether this platform is Cohere."""
+        return self is ModelPlatformType.COHERE
+
     @property
     def is_yi(self) -> bool:
         r"""Returns whether this platform is Yi."""
@@ -605,6 +698,16 @@ class ModelPlatformType(Enum):
         r"""Returns whether this platform is Qwen."""
         return self is ModelPlatformType.QWEN
 
+    @property
+    def is_nvidia(self) -> bool:
+        r"""Returns whether this platform is Nvidia."""
+        return self is ModelPlatformType.NVIDIA
+
+    @property
+    def is_deepseek(self) -> bool:
+        r"""Returns whether this platform is DeepSeek."""
+        return self is ModelPlatformType.DEEPSEEK
+
 
 class AudioModelType(Enum):
     TTS_1 = "tts-1"

camel/types/openai_types.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 # isort: skip_file
 from openai.types.chat.chat_completion import ChatCompletion, Choice
 from openai.types.chat.chat_completion_assistant_message_param import (
@@ -31,6 +31,7 @@ from openai.types.chat.chat_completion_user_message_param import (
     ChatCompletionUserMessageParam,
 )
 from openai.types.completion_usage import CompletionUsage
+from openai.types.chat import ParsedChatCompletion
 from openai._types import NOT_GIVEN, NotGiven
 
 Choice = Choice
@@ -45,3 +46,4 @@ ChatCompletionFunctionMessageParam = ChatCompletionFunctionMessageParam
 CompletionUsage = CompletionUsage
 NOT_GIVEN = NOT_GIVEN
 NotGiven = NotGiven
+ParsedChatCompletion = ParsedChatCompletion

camel/types/unified_model_type.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import logging
 from threading import Lock
 from typing import TYPE_CHECKING, ClassVar, Dict, Union, cast
@@ -98,6 +98,11 @@ class UnifiedModelType(str):
         r"""Returns whether the model is a Reka model."""
         return True
 
+    @property
+    def is_cohere(self) -> bool:
+        r"""Returns whether the model is a Cohere model."""
+        return True
+
     @property
     def is_yi(self) -> bool:
         r"""Returns whether the model is a Yi model."""

camel/utils/__init__.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 from .commons import (
     AgentOpsMeta,
@@ -36,6 +36,7 @@ from .commons import (
     track_agent,
 )
 from .constants import Constants
+from .response_format import get_pydantic_model
 from .token_counting import (
     AnthropicTokenCounter,
     BaseTokenCounter,
@@ -47,33 +48,34 @@ from .token_counting import (
 )
 
 __all__ = [
-    'print_text_animated',
-    'get_prompt_template_key_words',
-    'get_first_int',
-    'download_tasks',
-    'get_task_list',
-    'check_server_running',
-    'AnthropicTokenCounter',
-    'get_system_information',
-    'to_pascal',
-    'get_model_encoding',
-    'BaseTokenCounter',
-    'OpenAITokenCounter',
-    'LiteLLMTokenCounter',
-    'Constants',
-    'text_extract_from_web',
-    'create_chunks',
-    'dependencies_required',
-    'api_keys_required',
-    'is_docker_running',
-    'GeminiTokenCounter',
-    'MistralTokenCounter',
-    'get_pydantic_major_version',
-    'get_pydantic_object_schema',
-    'func_string_to_callable',
-    'json_to_function_code',
-    'agentops_decorator',
-    'AgentOpsMeta',
-    'track_agent',
-    'handle_http_error',
+    "print_text_animated",
+    "get_prompt_template_key_words",
+    "get_first_int",
+    "download_tasks",
+    "get_task_list",
+    "check_server_running",
+    "AnthropicTokenCounter",
+    "get_system_information",
+    "to_pascal",
+    "get_model_encoding",
+    "BaseTokenCounter",
+    "OpenAITokenCounter",
+    "LiteLLMTokenCounter",
+    "Constants",
+    "text_extract_from_web",
+    "create_chunks",
+    "dependencies_required",
+    "api_keys_required",
+    "is_docker_running",
+    "GeminiTokenCounter",
+    "MistralTokenCounter",
+    "get_pydantic_major_version",
+    "get_pydantic_object_schema",
+    "func_string_to_callable",
+    "json_to_function_code",
+    "agentops_decorator",
+    "AgentOpsMeta",
+    "track_agent",
+    "handle_http_error",
+    "get_pydantic_model",
 ]

camel/utils/async_func.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import asyncio
 from copy import deepcopy
 

camel/utils/commons.py

@@ -1,17 +1,18 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import importlib
+import logging
 import os
 import platform
 import re
@@ -39,14 +40,19 @@ import pydantic
 import requests
 from pydantic import BaseModel
 
+from camel.logger import get_logger
 from camel.types import TaskType
 
 from .constants import Constants
 
 F = TypeVar('F', bound=Callable[..., Any])
 
+logger = get_logger(__name__)
 
-def print_text_animated(text, delay: float = 0.02, end: str = ""):
+
+def print_text_animated(
+    text, delay: float = 0.02, end: str = "", log_level: int = logging.INFO
+):
     r"""Prints the given text with an animated effect.
 
     Args:
@@ -55,11 +61,22 @@ def print_text_animated(text, delay: float = 0.02, end: str = ""):
             (default: :obj:`0.02`)
         end (str, optional): The end character to print after each
             character of text. (default: :obj:`""`)
+        log_level (int, optional): The log level to use.
+            See https://docs.python.org/3/library/logging.html#levels
+            (default: :obj:`logging.INFO`)
     """
-    for char in text:
-        print(char, end=end, flush=True)
-        time.sleep(delay)
-    print('\n')
+    if logger.isEnabledFor(log_level):
+        # timestamp and other prefixes
+        logger.log(log_level, '')
+
+        for char in text:
+            print(char, end=end, flush=True)
+            time.sleep(delay)
+        # Close the log entry
+        logger.log(log_level, '')
+    else:
+        # This may be relevant for logging frameworks
+        logger.log(log_level, text)
 
 
 def get_prompt_template_key_words(template: str) -> Set[str]:

camel/utils/constants.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 
 class Constants:

camel/utils/response_format.py

@@ -0,0 +1,63 @@
+# ========= 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. =========
+
+from __future__ import annotations
+
+import inspect
+import json
+from typing import Callable, Type, Union
+
+from pydantic import BaseModel, create_model
+
+
+def get_pydantic_model(
+    input_data: Union[str, Type[BaseModel], Callable],
+) -> Type[BaseModel]:
+    r"""A multi-purpose function that can be used as a normal function,
+        a class decorator, or a function decorator.
+
+    Args:
+    input_data (Union[str, type, Callable]):
+        - If a string is provided, it should be a JSON-encoded string
+            that will be converted into a BaseModel.
+        - If a function is provided, it will be decorated such that
+            its arguments are converted into a BaseModel.
+        - If a BaseModel class is provided, it will be returned directly.
+
+    Returns:
+        Type[BaseModel]: The BaseModel class that will be used to
+            structure the input data.
+    """
+    if isinstance(input_data, str):
+        data_dict = json.loads(input_data)
+        TemporaryModel = create_model(  # type: ignore[call-overload]
+            "TemporaryModel",
+            **{key: (type(value), None) for key, value in data_dict.items()},
+        )
+        return TemporaryModel(**data_dict).__class__
+
+    elif callable(input_data):
+        WrapperClass = create_model(  # type: ignore[call-overload]
+            f"{input_data.__name__.capitalize()}Model",
+            **{
+                name: (param.annotation, ...)
+                for name, param in inspect.signature(
+                    input_data
+                ).parameters.items()
+            },
+        )
+        return WrapperClass
+    if issubclass(input_data, BaseModel):
+        return input_data
+    raise ValueError("Invalid input data provided.")

camel/utils/token_counting.py

@@ -1,16 +1,16 @@
-# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-# Licensed under the Apache License, Version 2.0 (the “License”);
+# ========= 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,
+# 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 from __future__ import annotations
 
@@ -22,6 +22,7 @@ from typing import TYPE_CHECKING, List, Optional
 
 from PIL import Image
 
+from camel.logger import get_logger
 from camel.types import (
     ModelType,
     OpenAIImageType,
@@ -44,6 +45,8 @@ SQUARE_PIXELS = 512
 SQUARE_TOKENS = 170
 EXTRA_TOKENS = 85
 
+logger = get_logger(__name__)
+
 
 def get_model_encoding(value_for_tiktoken: str):
     r"""Get model encoding from tiktoken.
@@ -65,7 +68,7 @@ def get_model_encoding(value_for_tiktoken: str):
         ]:
             encoding = tiktoken.get_encoding("o200k_base")
         else:
-            print("Model not found. Using cl100k_base encoding.")
+            logger.info("Model not found. Using cl100k_base encoding.")
             encoding = tiktoken.get_encoding("cl100k_base")
     return encoding