Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

chore: adding missing timeout in toolkits (#2171)

JINO ROHIT75aea041c0e3
diff --git a/camel/toolkits/audio_analysis_toolkit.py b/camel/toolkits/audio_analysis_toolkit.py
index 1ed617725..9321dffa2 100644
--- a/camel/toolkits/audio_analysis_toolkit.py
+++ b/camel/toolkits/audio_analysis_toolkit.py
@@ -83,29 +83,33 @@ def download_file(url: str, cache_dir: str) -> str:
@MCPServer()
class AudioAnalysisToolkit(BaseToolkit):
- r"""A toolkit for audio processing and analysis.
-
- This class provides methods for processing, transcribing, and extracting
- information from audio data, including direct question answering about
- audio content.
-
- Args:
- cache_dir (Optional[str]): Directory path for caching downloaded audio
- files. If not provided, 'tmp/' will be used. (default: :obj:`None`)
- transcribe_model (Optional[BaseAudioModel]): Model used for audio
- transcription. If not provided, OpenAIAudioModels will be used.
- (default: :obj:`None`)
- audio_reasoning_model (Optional[BaseModelBackend]): Model used for
- audio reasoning and question answering. If not provided, uses the
- default model from ChatAgent. (default: :obj:`None`)
- """
-
def __init__(
self,
cache_dir: Optional[str] = None,
transcribe_model: Optional[BaseAudioModel] = None,
audio_reasoning_model: Optional[BaseModelBackend] = None,
+ timeout: Optional[float] = None,
):
+ r"""A toolkit for audio processing and analysis. This class provides
+ methods for processing, transcribing, and extracting information from
+ audio data, including direct question answering about audio content.
+
+ Args:
+ cache_dir (Optional[str]): Directory path for caching downloaded
+ audio files. If not provided, 'tmp/' will be used.
+ (default: :obj:`None`)
+ transcribe_model (Optional[BaseAudioModel]): Model used for audio
+ transcription. If not provided, OpenAIAudioModels will be used.
+ (default: :obj:`None`)
+ audio_reasoning_model (Optional[BaseModelBackend]): Model used for
+ audio reasoning and question answering.
+ If not provided, uses the default model from ChatAgent.
+ (default: :obj:`None`)
+ timeout (Optional[float]): The timeout value for API requests
+ in seconds. If None, no timeout is applied.
+ (default: :obj:`None`)
+ """
+ super().__init__(timeout=timeout)
self.cache_dir = 'tmp/'
if cache_dir:
self.cache_dir = cache_dir
diff --git a/camel/toolkits/dalle_toolkit.py b/camel/toolkits/dalle_toolkit.py
index a1c5b8a39..f6fe5c474 100644
--- a/camel/toolkits/dalle_toolkit.py
+++ b/camel/toolkits/dalle_toolkit.py
@@ -22,13 +22,28 @@ from PIL import Image
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
+from camel.utils import MCPServer
+@MCPServer()
class DalleToolkit(BaseToolkit):
r"""A class representing a toolkit for image generation using OpenAI's
DALL-E model.
"""
+ def __init__(
+ self,
+ timeout: Optional[float] = None,
+ ):
+ r"""Initializes a new instance of the DalleToolkit class.
+
+ Args:
+ timeout (Optional[float]): The timeout value for API requests
+ in seconds. If None, no timeout is applied.
+ (default: :obj:`None`)
+ """
+ super().__init__(timeout=timeout)
+
def base64_to_image(self, base64_string: str) -> Optional[Image.Image]:
r"""Converts a base64 encoded string into a PIL Image object.
diff --git a/camel/toolkits/excel_toolkit.py b/camel/toolkits/excel_toolkit.py
index 7b80f6edb..7beb5290a 100644
--- a/camel/toolkits/excel_toolkit.py
+++ b/camel/toolkits/excel_toolkit.py
@@ -12,7 +12,7 @@
# limitations under the License.
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
-from typing import List
+from typing import List, Optional
import pandas as pd
@@ -33,6 +33,19 @@ class ExcelToolkit(BaseToolkit):
process excel files.
"""
+ def __init__(
+ self,
+ timeout: Optional[float] = None,
+ ):
+ r"""Initializes a new instance of the ExcelToolkit class.
+
+ Args:
+ timeout (Optional[float]): The timeout value for API requests
+ in seconds. If None, no timeout is applied.
+ (default: :obj:`None`)
+ """
+ super().__init__(timeout=timeout)
+
def _convert_to_markdown(self, df: pd.DataFrame) -> str:
r"""Convert DataFrame to Markdown format table.
diff --git a/camel/toolkits/image_analysis_toolkit.py b/camel/toolkits/image_analysis_toolkit.py
index 53f193859..58bc80aae 100644
--- a/camel/toolkits/image_analysis_toolkit.py
+++ b/camel/toolkits/image_analysis_toolkit.py
@@ -36,7 +36,11 @@ class ImageAnalysisToolkit(BaseToolkit):
The toolkit uses vision-capable language models to perform these tasks.
"""
- def __init__(self, model: Optional[BaseModelBackend] = None):
+ def __init__(
+ self,
+ model: Optional[BaseModelBackend] = None,
+ timeout: Optional[float] = None,
+ ):
r"""Initialize the ImageAnalysisToolkit.
Args:
@@ -45,7 +49,11 @@ class ImageAnalysisToolkit(BaseToolkit):
images for tasks like image description and visual question
answering. If None, a default model will be created using
ModelFactory. (default: :obj:`None`)
+ timeout (Optional[float]): The timeout value for API requests
+ in seconds. If None, no timeout is applied.
+ (default: :obj:`None`)
"""
+ super().__init__(timeout=timeout)
if model:
self.model = model
else:
diff --git a/camel/toolkits/networkx_toolkit.py b/camel/toolkits/networkx_toolkit.py
index 752e4b337..2a7fa92d7 100644
--- a/camel/toolkits/networkx_toolkit.py
+++ b/camel/toolkits/networkx_toolkit.py
@@ -38,6 +38,7 @@ class NetworkXToolkit(BaseToolkit):
def __init__(
self,
+ timeout: Optional[float] = None,
graph_type: Literal[
'graph', 'digraph', 'multigraph', 'multidigraph'
] = 'graph',
@@ -53,7 +54,11 @@ class NetworkXToolkit(BaseToolkit):
- 'multigraph': Undirected graph with parallel edges
- 'multidigraph': Directed graph with parallel edges
(default: :obj:`'graph'`)
+ timeout (Optional[float]): The timeout value for API requests
+ in seconds. If None, no timeout is applied.
+ (default: :obj:`None`)
"""
+ super().__init__(timeout=timeout)
nx = self._get_nx()
graph_types = {
'graph': nx.Graph,
diff --git a/camel/toolkits/openai_agent_toolkit.py b/camel/toolkits/openai_agent_toolkit.py
index 382e498d2..fe0948a55 100644
--- a/camel/toolkits/openai_agent_toolkit.py
+++ b/camel/toolkits/openai_agent_toolkit.py
@@ -45,6 +45,7 @@ class OpenAIAgentToolkit(BaseToolkit):
self,
model: Optional[BaseModelBackend] = None,
api_key: Optional[str] = None,
+ timeout: Optional[float] = None,
) -> None:
r"""Initialize the OpenAI agent toolkit.
@@ -53,8 +54,11 @@ class OpenAIAgentToolkit(BaseToolkit):
If None, defaults to gpt-4o-mini. (default: :obj:`None`)
api_key (str): OpenAI API key. If not provided, will attempt to
use OPENAI_API_KEY environment variable. (default: :obj:`None`)
+ timeout (Optional[float]): The timeout value for API requests
+ in seconds. If None, no timeout is applied.
+ (default: :obj:`None`)
"""
- super().__init__()
+ super().__init__(timeout=timeout)
self.api_key = api_key or os.getenv("OPENAI_API_KEY")
self.client = OpenAI(api_key=self.api_key)
self.model = model or ModelFactory.create(
diff --git a/camel/toolkits/searxng_toolkit.py b/camel/toolkits/searxng_toolkit.py
index 4c80a5edf..41428d90a 100644
--- a/camel/toolkits/searxng_toolkit.py
+++ b/camel/toolkits/searxng_toolkit.py
@@ -20,10 +20,12 @@ import requests
from camel.logger import get_logger
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
+from camel.utils import MCPServer
logger = get_logger(__name__)
+@MCPServer()
class SearxNGToolkit(BaseToolkit):
r"""A toolkit for performing web searches using SearxNG search engine.
@@ -42,6 +44,9 @@ class SearxNGToolkit(BaseToolkit):
values are "day", "week", "month", "year". (default: :obj:`None`)
safe_search (int, optional): Safe search level (0: None, 1: Moderate,
2: Strict). (default: :obj:`1`)
+ timeout (Optional[float]): The timeout value for API requests
+ in seconds. If None, no timeout is applied.
+ (default: :obj:`None`)
Raises:
ValueError: If searxng_host is not a valid HTTP/HTTPS URL.
@@ -65,7 +70,9 @@ class SearxNGToolkit(BaseToolkit):
categories: Optional[List[str]] = None,
time_range: Optional[str] = None,
safe_search: int = 1,
+ timeout: Optional[float] = None,
) -> None:
+ super().__init__(timeout=timeout)
self._validate_searxng_host(searxng_host)
self._validate_safe_search(safe_search)
if time_range is not None:
diff --git a/camel/toolkits/slack_toolkit.py b/camel/toolkits/slack_toolkit.py
index bca614715..c34c7786a 100644
--- a/camel/toolkits/slack_toolkit.py
+++ b/camel/toolkits/slack_toolkit.py
@@ -15,7 +15,6 @@
from __future__ import annotations
import json
-import logging
import os
from typing import TYPE_CHECKING, List, Optional
@@ -27,9 +26,10 @@ if TYPE_CHECKING:
from slack_sdk import WebClient
+from camel.logger import get_logger
from camel.toolkits import FunctionTool
-logger = logging.getLogger(__name__)
+logger = get_logger(__name__)
@MCPServer()
@@ -40,6 +40,19 @@ class SlackToolkit(BaseToolkit):
channel, joining an existing channel, leaving a channel.
"""
+ def __init__(
+ self,
+ timeout: Optional[float] = None,
+ ):
+ r"""Initializes a new instance of the SlackToolkit class.
+
+ Args:
+ timeout (Optional[float]): The timeout value for API requests
+ in seconds. If None, no timeout is applied.
+ (default: :obj:`None`)
+ """
+ super().__init__(timeout=timeout)
+
def _login_slack(
self,
slack_token: Optional[str] = None,
diff --git a/camel/toolkits/video_analysis_toolkit.py b/camel/toolkits/video_analysis_toolkit.py
index e0ab56411..2ae072311 100644
--- a/camel/toolkits/video_analysis_toolkit.py
+++ b/camel/toolkits/video_analysis_toolkit.py
@@ -92,6 +92,9 @@ class VideoAnalysisToolkit(BaseToolkit):
transcription using OpenAI's audio models. Requires a valid OpenAI
API key. When disabled, video analysis will be based solely on
visual content. (default: :obj:`False`)
+ timeout (Optional[float]): The timeout value for API requests
+ in seconds. If None, no timeout is applied.
+ (default: :obj:`None`)
"""
@dependencies_required("ffmpeg", "scenedetect")
@@ -100,7 +103,9 @@ class VideoAnalysisToolkit(BaseToolkit):
download_directory: Optional[str] = None,
model: Optional[BaseModelBackend] = None,
use_audio_transcription: bool = False,
+ timeout: Optional[float] = None,
) -> None:
+ super().__init__(timeout=timeout)
self._cleanup = download_directory is None
self._temp_files: list[str] = [] # Track temporary files for cleanup
self._use_audio_transcription = use_audio_transcription
diff --git a/camel/toolkits/weather_toolkit.py b/camel/toolkits/weather_toolkit.py
index 66c2ded42..5e296c908 100644
--- a/camel/toolkits/weather_toolkit.py
+++ b/camel/toolkits/weather_toolkit.py
@@ -12,7 +12,7 @@
# limitations under the License.
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
import os
-from typing import List, Literal
+from typing import List, Literal, Optional
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
@@ -27,6 +27,19 @@ class WeatherToolkit(BaseToolkit):
using the OpenWeatherMap API.
"""
+ def __init__(
+ self,
+ timeout: Optional[float] = None,
+ ):
+ r"""Initializes a new instance of the WeatherToolkit class.
+
+ Args:
+ timeout (Optional[float]): The timeout value for API requests
+ in seconds. If None, no timeout is applied.
+ (default: :obj:`None`)
+ """
+ super().__init__(timeout=timeout)
+
def get_openweathermap_api_key(self) -> str:
r"""Retrieve the OpenWeatherMap API key from environment variables.
diff --git a/camel/toolkits/zapier_toolkit.py b/camel/toolkits/zapier_toolkit.py
index a6e9d51fc..668b9b537 100644
--- a/camel/toolkits/zapier_toolkit.py
+++ b/camel/toolkits/zapier_toolkit.py
@@ -13,7 +13,7 @@
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
import os
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
import requests
@@ -33,6 +33,9 @@ class ZapierToolkit(BaseToolkit):
Attributes:
api_key (str): The API key for authenticating with Zapier's API.
base_url (str): The base URL for Zapier's API endpoints.
+ timeout (Optional[float]): The timeout value for API requests
+ in seconds. If None, no timeout is applied.
+ (default: :obj:`None`)
"""
@dependencies_required("requests")
@@ -41,7 +44,8 @@ class ZapierToolkit(BaseToolkit):
(None, "ZAPIER_NLA_API_KEY"),
]
)
- def __init__(self) -> None:
+ def __init__(self, timeout: Optional[float] = None) -> None:
+ super().__init__(timeout=timeout)
r"""Initialize the ZapierToolkit with API client. The API key is
retrieved from environment variables.
"""