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

camel/toolkits/search_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
 import xml.etree.ElementTree as ET
 from typing import Any, Dict, List, Union
@@ -274,7 +274,7 @@ class SearchToolkit(BaseToolkit):
         """
         import wolframalpha
 
-        WOLFRAMALPHA_APP_ID = os.environ.get('WOLFRAMALPHA_APP_ID')
+        WOLFRAMALPHA_APP_ID = os.environ.get("WOLFRAMALPHA_APP_ID")
         if not WOLFRAMALPHA_APP_ID:
             raise ValueError(
                 "`WOLFRAMALPHA_APP_ID` not found in environment "
@@ -315,27 +315,42 @@ class SearchToolkit(BaseToolkit):
         """
 
         # Extract the original query
-        query = result.get('@inputstring', '')
+        query = result.get("@inputstring", "")
 
         # Initialize a dictionary to hold structured output
         output = {"query": query, "pod_info": [], "final_answer": None}
 
         # Loop through each pod to extract the details
-        for pod in result.get('pod', []):
+        for pod in result.get("pod", []):
+            # Handle the case where subpod might be a list
+            subpod_data = pod.get("subpod", {})
+            if isinstance(subpod_data, list):
+                # If it's a list, get the first item for 'plaintext' and 'img'
+                description, image_url = next(
+                    (
+                        (data["plaintext"], data["img"])
+                        for data in subpod_data
+                        if "plaintext" in data and "img" in data
+                    ),
+                    ("", ""),
+                )
+            else:
+                # Otherwise, handle it as a dictionary
+                description = subpod_data.get("plaintext", "")
+                image_url = subpod_data.get("img", {}).get("@src", "")
+
             pod_info = {
-                "title": pod.get('@title', ''),
-                "description": pod.get('subpod', {}).get('plaintext', ''),
-                "image_url": pod.get('subpod', {})
-                .get('img', {})
-                .get('@src', ''),
+                "title": pod.get("@title", ""),
+                "description": description,
+                "image_url": image_url,
             }
 
             # Add to steps list
             output["pod_info"].append(pod_info)
 
             # Get final answer
-            if pod.get('@primary', False):
-                output["final_answer"] = pod_info["description"]
+            if pod.get("@primary", False):
+                output["final_answer"] = description
 
         return output
 
@@ -358,25 +373,33 @@ class SearchToolkit(BaseToolkit):
 
         # Set up the query parameters
         params = {
-            'appid': app_id,
-            'input': query,
-            'podstate': ['Result__Step-by-step solution', 'Show all steps'],
-            'format': 'plaintext',
+            "appid": app_id,
+            "input": query,
+            "podstate": ["Result__Step-by-step solution", "Show all steps"],
+            "format": "plaintext",
         }
 
         # Send the request
         response = requests.get(url, params=params)
         root = ET.fromstring(response.text)
 
-        # Extracting step-by-step hints and removing 'Hint: |'
+        # Extracting step-by-step steps, including 'SBSStep' and 'SBSHintStep'
         steps = []
-        for subpod in root.findall(
-            ".//pod[@title='Results']//subpod[stepbystepcontenttype='SBSHintStep']//plaintext"
-        ):
-            if subpod.text:
-                step_text = subpod.text.strip()
-                cleaned_step = step_text.replace('Hint: |', '').strip()
-                steps.append(cleaned_step)
+        # Find all subpods within the 'Results' pod
+        for subpod in root.findall(".//pod[@title='Results']//subpod"):
+            # Check if the subpod has the desired stepbystepcontenttype
+            content_type = subpod.find("stepbystepcontenttype")
+            if content_type is not None and content_type.text in [
+                "SBSStep",
+                "SBSHintStep",
+            ]:
+                plaintext = subpod.find("plaintext")
+                if plaintext is not None and plaintext.text:
+                    step_text = plaintext.text.strip()
+                    cleaned_step = step_text.replace(
+                        "Hint: |", ""
+                    ).strip()  # Remove 'Hint: |' if present
+                    steps.append(cleaned_step)
 
         # Structuring the steps into a dictionary
         structured_steps = {}
@@ -449,6 +472,3 @@ class SearchToolkit(BaseToolkit):
             FunctionTool(self.query_wolfram_alpha),
             FunctionTool(self.tavily_search),
         ]
-
-
-SEARCH_FUNCS: List[FunctionTool] = SearchToolkit().get_tools()

camel/toolkits/slack_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. =========
 
 from __future__ import annotations
 

camel/toolkits/twitter_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 datetime
 import os
 from http import HTTPStatus
@@ -20,12 +20,15 @@ from typing import Any, Dict, List, Optional, Union
 import requests
 from requests_oauthlib import OAuth1
 
+from camel.logger import get_logger
 from camel.toolkits import FunctionTool
 from camel.toolkits.base import BaseToolkit
 from camel.utils import api_keys_required
 
 TWEET_TEXT_LIMIT = 280
 
+logger = get_logger(__name__)
+
 
 @api_keys_required(
     "TWITTER_CONSUMER_KEY",
@@ -407,14 +410,6 @@ def _handle_http_error(response: requests.Response) -> str:
         return "Unexpected Exception"
 
 
-TWITTER_FUNCS = [
-    FunctionTool(create_tweet),
-    FunctionTool(delete_tweet),
-    FunctionTool(get_my_user_profile),
-    FunctionTool(get_user_by_username),
-]
-
-
 class TwitterToolkit(BaseToolkit):
     r"""A class representing a toolkit for Twitter operations.
 
@@ -442,4 +437,9 @@ class TwitterToolkit(BaseToolkit):
             List[FunctionTool]: A list of FunctionTool objects
                 representing the functions in the toolkit.
         """
-        return TWITTER_FUNCS
+        return [
+            FunctionTool(create_tweet),
+            FunctionTool(delete_tweet),
+            FunctionTool(get_my_user_profile),
+            FunctionTool(get_user_by_username),
+        ]

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',
 ]