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

camel/toolkits/video_toolkit.py

@@ -0,0 +1,211 @@
+# ========= 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 io
+import logging
+import re
+import tempfile
+from pathlib import Path
+from typing import List, Optional
+
+from PIL import Image
+
+from camel.toolkits.base import BaseToolkit
+from camel.toolkits.function_tool import FunctionTool
+from camel.utils import dependencies_required
+
+logger = logging.getLogger(__name__)
+
+
+def _standardize_url(url: str) -> str:
+    r"""Standardize the given URL."""
+    # Special case for YouTube embed URLs
+    if "youtube.com/embed/" in url:
+        match = re.search(r"embed/([a-zA-Z0-9_-]+)", url)
+        if match:
+            return f"https://www.youtube.com/watch?v={match.group(1)}"
+        else:
+            raise ValueError(f"Invalid YouTube URL: {url}")
+
+    return url
+
+
+def _capture_screenshot(video_file: str, timestamp: float) -> Image.Image:
+    r"""Capture a screenshot from a video file at a specific timestamp.
+
+    Args:
+        video_file (str): The path to the video file.
+        timestamp (float): The time in seconds from which to capture the
+          screenshot.
+
+    Returns:
+        Image.Image: The captured screenshot in the form of Image.Image.
+    """
+    import ffmpeg
+
+    try:
+        out, _ = (
+            ffmpeg.input(video_file, ss=timestamp)
+            .filter('scale', 320, -1)
+            .output('pipe:', vframes=1, format='image2', vcodec='png')
+            .run(capture_stdout=True, capture_stderr=True)
+        )
+    except ffmpeg.Error as e:
+        raise RuntimeError(f"Failed to capture screenshot: {e.stderr}")
+
+    return Image.open(io.BytesIO(out))
+
+
+class VideoDownloaderToolkit(BaseToolkit):
+    r"""A class for downloading videos and optionally splitting them into
+    chunks.
+
+    Args:
+        download_directory (Optional[str], optional): The directory where the
+            video will be downloaded to. If not provided, video will be stored
+            in a temporary directory and will be cleaned up after use.
+            (default: :obj:`None`)
+        cookies_path (Optional[str], optional): The path to the cookies file
+            for the video service in Netscape format. (default: :obj:`None`)
+    """
+
+    @dependencies_required("yt_dlp", "ffmpeg")
+    def __init__(
+        self,
+        download_directory: Optional[str] = None,
+        cookies_path: Optional[str] = None,
+    ) -> None:
+        self._cleanup = download_directory is None
+        self._cookies_path = cookies_path
+
+        self._download_directory = Path(
+            download_directory or tempfile.mkdtemp()
+        ).resolve()
+
+        try:
+            self._download_directory.mkdir(parents=True, exist_ok=True)
+        except FileExistsError:
+            raise ValueError(
+                f"{self._download_directory} is not a valid directory."
+            )
+        except OSError as e:
+            raise ValueError(
+                f"Error creating directory {self._download_directory}: {e}"
+            )
+
+        logger.info(f"Video will be downloaded to {self._download_directory}")
+
+    def __del__(self) -> None:
+        r"""Deconstructor for the VideoDownloaderToolkit class.
+
+        Cleans up the downloaded video if they are stored in a temporary
+        directory.
+        """
+        import shutil
+
+        if self._cleanup:
+            shutil.rmtree(self._download_directory, ignore_errors=True)
+
+    def _download_video(self, url: str) -> str:
+        r"""Download the video and optionally split it into chunks.
+
+        yt-dlp will detect if the video is downloaded automatically so there
+        is no need to check if the video exists.
+
+        Returns:
+            str: The path to the downloaded video file.
+        """
+        import yt_dlp
+
+        video_template = self._download_directory / "%(title)s.%(ext)s"
+        ydl_opts = {
+            'format': 'bestvideo+bestaudio/best',
+            'outtmpl': str(video_template),
+            'force_generic_extractor': True,
+            'cookiefile': self._cookies_path,
+        }
+
+        try:
+            with yt_dlp.YoutubeDL(ydl_opts) as ydl:
+                # Download the video and get the filename
+                logger.info(f"Downloading video from {url}...")
+                info = ydl.extract_info(url, download=True)
+                return ydl.prepare_filename(info)
+        except yt_dlp.utils.DownloadError as e:
+            raise RuntimeError(f"Failed to download video from {url}: {e}")
+
+    def get_video_bytes(
+        self,
+        video_url: str,
+    ) -> bytes:
+        r"""Download video by the URL, and return the content in bytes.
+
+        Args:
+            video_url (str): The URL of the video to download.
+
+        Returns:
+            bytes: The video file content in bytes.
+        """
+        url = _standardize_url(video_url)
+        video_file = self._download_video(url)
+
+        with open(video_file, 'rb') as f:
+            video_bytes = f.read()
+
+        return video_bytes
+
+    def get_video_screenshots(
+        self, video_url: str, amount: int
+    ) -> List[Image.Image]:
+        r"""Capture screenshots from the video at specified timestamps or by
+        dividing the video into equal parts if an integer is provided.
+
+        Args:
+            video_url (str): The URL of the video to take screenshots.
+            amount (int): the amount of evenly split screenshots to capture.
+
+        Returns:
+            List[Image.Image]: A list of screenshots as Image.Image.
+        """
+        import ffmpeg
+
+        url = _standardize_url(video_url)
+        video_file = self._download_video(url)
+
+        # Get the video length
+        try:
+            probe = ffmpeg.probe(video_file)
+            video_length = float(probe['format']['duration'])
+        except ffmpeg.Error as e:
+            raise RuntimeError(f"Failed to determine video length: {e.stderr}")
+
+        interval = video_length / (amount + 1)
+        timestamps = [i * interval for i in range(1, amount + 1)]
+
+        images = [_capture_screenshot(video_file, ts) for ts in timestamps]
+
+        return images
+
+    def get_tools(self) -> List[FunctionTool]:
+        r"""Returns a list of FunctionTool objects representing the
+        functions in the toolkit.
+
+        Returns:
+            List[FunctionTool]: A list of FunctionTool objects representing
+                the functions in the toolkit.
+        """
+        return [
+            FunctionTool(self.get_video_bytes),
+            FunctionTool(self.get_video_screenshots),
+        ]

camel/toolkits/weather_toolkit.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 os
 from typing import List, Literal
 
@@ -168,6 +168,3 @@ class WeatherToolkit(BaseToolkit):
         return [
             FunctionTool(self.get_weather_data),
         ]
-
-
-WEATHER_FUNCS: List[FunctionTool] = WeatherToolkit().get_tools()

camel/toolkits/whatsapp_toolkit.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 os
 from typing import Any, Dict, List, Union
@@ -163,11 +163,11 @@ class WhatsAppToolkit(BaseToolkit):
             return f"Failed to retrieve business profile: {e!s}"
 
     def get_tools(self) -> List[FunctionTool]:
-        r"""Returns a list of OpenAIFunction objects representing the
+        r"""Returns a list of FunctionTool objects representing the
         functions in the toolkit.
 
         Returns:
-            List[OpenAIFunction]: A list of OpenAIFunction objects for the
+            List[FunctionTool]: A list of FunctionTool objects for the
                 toolkit methods.
         """
         return [

camel/types/__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 .enums import (
     AudioModelType,
     EmbeddingModelType,
@@ -40,6 +40,7 @@ from .openai_types import (
     Choice,
     CompletionUsage,
     NotGiven,
+    ParsedChatCompletion,
 )
 from .unified_model_type import UnifiedModelType
 
@@ -71,4 +72,5 @@ __all__ = [
     'UnifiedModelType',
     'NOT_GIVEN',
     'NotGiven',
+    'ParsedChatCompletion',
 ]

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"
@@ -69,6 +70,7 @@ class ModelType(UnifiedModelType, Enum):
     # 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 +89,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 +106,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 +123,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
 
@@ -227,6 +244,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 +260,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 +306,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
@@ -292,6 +336,8 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.REKA_FLASH,
             ModelType.QWEN_MATH_PLUS,
             ModelType.QWEN_MATH_TURBO,
+            ModelType.COHERE_COMMAND,
+            ModelType.COHERE_COMMAND_LIGHT,
         }:
             return 4_096
         elif self in {
@@ -324,9 +370,13 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.YI_LARGE_FC,
             ModelType.QWEN_MAX,
             ModelType.QWEN_VL_MAX,
+            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 +394,13 @@ 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,
         }:
             return 128_000
         elif self in {
@@ -371,6 +428,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 +563,7 @@ class OpenAPIName(Enum):
 
 
 class ModelPlatformType(Enum):
-    DEFAULT = "openai"
+    DEFAULT = os.getenv("DEFAULT_MODEL_PLATFORM_TYPE", "openai")
 
     OPENAI = "openai"
     AZURE = "azure"
@@ -521,8 +579,10 @@ class ModelPlatformType(Enum):
     TOGETHER = "together"
     OPENAI_COMPATIBLE_MODEL = "openai-compatible-model"
     SAMBA = "samba-nova"
+    COHERE = "cohere"
     YI = "lingyiwanwu"
     QWEN = "tongyi-qianwen"
+    DEEPSEEK = "deepseek"
 
     @property
     def is_openai(self) -> bool:
@@ -595,6 +655,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 +670,11 @@ class ModelPlatformType(Enum):
         r"""Returns whether this platform is Qwen."""
         return self is ModelPlatformType.QWEN
 
+    @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",
 ]