camel-ai 0.2.21__py3-none-any.whl → 0.2.23__py3-none-any.whl

camel/toolkits/whatsapp_toolkit.py

@@ -13,7 +13,7 @@
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 import os
-from typing import Any, Dict, List, Union
+from typing import Any, Dict, List, Optional, Union
 
 import requests
 
@@ -36,8 +36,9 @@ class WhatsAppToolkit(BaseToolkit):
         version (str): API version.
     """
 
-    def __init__(self):
+    def __init__(self, timeout: Optional[float] = None):
         r"""Initializes the WhatsAppToolkit."""
+        super().__init__(timeout=timeout)
         self.base_url = "https://graph.facebook.com"
         self.version = "v17.0"
 

camel/toolkits/zapier_toolkit.py

@@ -0,0 +1,191 @@
+# ========= 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 os
+from typing import Any, Dict, List
+
+import requests
+
+from camel.toolkits.base import BaseToolkit
+from camel.toolkits.function_tool import FunctionTool
+from camel.utils import api_keys_required, dependencies_required
+
+
+class ZapierToolkit(BaseToolkit):
+    r"""A class representing a toolkit for interacting with Zapier's NLA API.
+
+    This class provides methods for executing Zapier actions through natural
+    language commands, allowing integration with various web services and
+    automation of workflows through the Zapier platform.
+
+    Attributes:
+        api_key (str): The API key for authenticating with Zapier's API.
+        base_url (str): The base URL for Zapier's API endpoints.
+    """
+
+    @dependencies_required("requests")
+    @api_keys_required(
+        [
+            (None, "ZAPIER_NLA_API_KEY"),
+        ]
+    )
+    def __init__(self) -> None:
+        r"""Initialize the ZapierToolkit with API client. The API key is
+        retrieved from environment variables.
+        """
+        self.api_key = os.environ.get("ZAPIER_NLA_API_KEY")
+        self.base_url = "https://actions.zapier.com/api/v1/"
+
+    def list_actions(self) -> Dict[str, Any]:
+        r"""List all available Zapier actions.
+
+        Returns:
+            Dict[str, Any]: A dictionary containing the list of available
+                actions.
+        """
+        headers = {
+            'accept': 'application/json',
+            'x-api-key': self.api_key,
+        }
+        response = requests.get(
+            f"{self.base_url}exposed/",
+            params={'api_key': self.api_key},
+            headers=headers,
+        )
+        response.raise_for_status()
+        return response.json()
+
+    def execute_action(
+        self,
+        action_id: str,
+        instructions: str,
+    ) -> Dict[str, Any]:
+        r"""Execute a specific Zapier action using natural language
+        instructions.
+
+        Args:
+            action_id (str): The ID of the Zapier action to execute.
+            instructions (str): Natural language instructions for executing
+                the action. For example: "Send an email to john@example.com
+                with subject 'Hello' and body 'How are you?'"
+
+        Returns:
+            Dict[str, Any]: The result of the action execution, including
+                status and any output data.
+        """
+        try:
+            headers = {
+                'accept': 'application/json',
+                'x-api-key': self.api_key,
+                'Content-Type': 'application/json',
+            }
+            data = {
+                "instructions": instructions,
+                "preview_only": False,
+            }
+            response = requests.post(
+                f"{self.base_url}exposed/{action_id}/execute/",
+                params={'api_key': self.api_key},
+                headers=headers,
+                json=data,
+            )
+            response.raise_for_status()
+            return response.json()
+        except requests.exceptions.RequestException as e:
+            return {"error": f"Request failed: {e!s}"}
+        except ValueError:
+            return {"error": "Response is not valid JSON"}
+
+    def preview_action(
+        self,
+        action_id: str,
+        instructions: str,
+    ) -> Dict[str, Any]:
+        r"""Preview a specific Zapier action using natural language
+        instructions.
+
+        Args:
+            action_id (str): The ID of the Zapier action to preview.
+            instructions (str): Natural language instructions for previewing
+                the action. For example: "Send an email to john@example.com
+                with subject 'Hello' and body 'How are you?'"
+
+        Returns:
+            Dict[str, Any]: The preview result showing what parameters would
+                be used if the action were executed.
+        """
+        try:
+            headers = {
+                'accept': 'application/json',
+                'x-api-key': self.api_key,
+                'Content-Type': 'application/json',
+            }
+            data = {
+                "instructions": instructions,
+                "preview_only": True,
+            }
+            response = requests.post(
+                f"{self.base_url}exposed/{action_id}/execute/",
+                params={'api_key': self.api_key},
+                headers=headers,
+                json=data,
+            )
+            response.raise_for_status()
+            return response.json()
+        except requests.exceptions.RequestException as e:
+            return {"error": f"Request failed: {e!s}"}
+        except ValueError:
+            return {"error": "Response is not valid JSON"}
+
+    def get_execution_result(self, execution_id: str) -> Dict[str, Any]:
+        r"""Get the execution result of a Zapier action.
+
+        Args:
+            execution_id (str): The execution ID returned from execute_action.
+
+        Returns:
+            Dict[str, Any]: The execution result containing status, logs,
+                and any output data from the action execution.
+        """
+        try:
+            headers = {
+                'accept': 'application/json',
+                'x-api-key': self.api_key,
+            }
+            response = requests.get(
+                f"{self.base_url}execution-log/{execution_id}/",
+                params={'api_key': self.api_key},
+                headers=headers,
+            )
+            response.raise_for_status()
+            return response.json()
+        except requests.exceptions.RequestException as e:
+            return {"error": f"Request failed: {e!s}"}
+        except ValueError:
+            return {"error": "Response is not valid JSON"}
+
+    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.list_actions),
+            FunctionTool(self.execute_action),
+            FunctionTool(self.preview_action),
+            FunctionTool(self.get_execution_result),
+        ]

camel/types/__init__.py

@@ -73,8 +73,8 @@ __all__ = [
     'AudioModelType',
     'VoiceType',
     'UnifiedModelType',
-    'NOT_GIVEN',
-    'NotGiven',
     'ParsedChatCompletion',
     'HuggingFaceRepoType',
+    'NOT_GIVEN',
+    'NotGiven',
 ]

camel/types/agents/__init__.py

@@ -0,0 +1,16 @@
+# ========= 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 .tool_calling_record import ToolCallingRecord
+
+__all__ = ["ToolCallingRecord"]

camel/types/agents/tool_calling_record.py

@@ -0,0 +1,52 @@
+# ========= 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 typing import Any, Dict
+
+from pydantic import BaseModel
+
+
+class ToolCallingRecord(BaseModel):
+    r"""Historical records of tools called in the conversation.
+
+    Attributes:
+        func_name (str): The name of the tool being called.
+        args (Dict[str, Any]): The dictionary of arguments passed to the tool.
+        result (Any): The execution result of calling this tool.
+        tool_call_id (str): The ID of the tool call, if available.
+    """
+
+    tool_name: str
+    args: Dict[str, Any]
+    result: Any
+    tool_call_id: str
+
+    def __str__(self) -> str:
+        r"""Overridden version of the string function.
+
+        Returns:
+            str: Modified string to represent the tool calling.
+        """
+        return (
+            f"Tool Execution: {self.tool_name}\n"
+            f"\tArgs: {self.args}\n"
+            f"\tResult: {self.result}\n"
+        )
+
+    def as_dict(self) -> dict[str, Any]:
+        r"""Returns the tool calling record as a dictionary.
+
+        Returns:
+            dict[str, Any]: The tool calling record as a dictionary.
+        """
+        return self.model_dump()

camel/types/enums.py

@@ -34,6 +34,7 @@ class ModelType(UnifiedModelType, Enum):
     GPT_4_TURBO = "gpt-4-turbo"
     GPT_4O = "gpt-4o"
     GPT_4O_MINI = "gpt-4o-mini"
+    GPT_4_5_PREVIEW = "gpt-4.5-preview"
     O1 = "o1"
     O1_PREVIEW = "o1-preview"
     O1_MINI = "o1-mini"
@@ -263,6 +264,7 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.O1_PREVIEW,
             ModelType.O1_MINI,
             ModelType.O3_MINI,
+            ModelType.GPT_4_5_PREVIEW,
         }
 
     @property
@@ -623,6 +625,7 @@ class ModelType(UnifiedModelType, Enum):
             ModelType.GPT_4_TURBO,
             ModelType.O1_PREVIEW,
             ModelType.O1_MINI,
+            ModelType.GPT_4_5_PREVIEW,
             ModelType.MISTRAL_LARGE,
             ModelType.MISTRAL_NEMO,
             ModelType.MISTRAL_PIXTRAL_12B,

camel/types/openai_types.py

@@ -35,17 +35,19 @@ from openai.types.chat import ParsedChatCompletion
 from openai._types import NOT_GIVEN, NotGiven
 from openai.types.chat import ChatCompletionMessageToolCall
 
-Choice = Choice
-ChatCompletion = ChatCompletion
-ChatCompletionChunk = ChatCompletionChunk
-ChatCompletionMessage = ChatCompletionMessage
-ChatCompletionMessageParam = ChatCompletionMessageParam
-ChatCompletionSystemMessageParam = ChatCompletionSystemMessageParam
-ChatCompletionUserMessageParam = ChatCompletionUserMessageParam
-ChatCompletionAssistantMessageParam = ChatCompletionAssistantMessageParam
-ChatCompletionToolMessageParam = ChatCompletionToolMessageParam
-ChatCompletionMessageToolCall = ChatCompletionMessageToolCall
-CompletionUsage = CompletionUsage
-NOT_GIVEN = NOT_GIVEN
-NotGiven = NotGiven
-ParsedChatCompletion = ParsedChatCompletion
+__all__ = [
+    "Choice",
+    "ChatCompletion",
+    "ChatCompletionChunk",
+    "ChatCompletionMessage",
+    "ChatCompletionMessageParam",
+    "ChatCompletionSystemMessageParam",
+    "ChatCompletionUserMessageParam",
+    "ChatCompletionAssistantMessageParam",
+    "ChatCompletionToolMessageParam",
+    "ChatCompletionMessageToolCall",
+    "CompletionUsage",
+    "ParsedChatCompletion",
+    "NOT_GIVEN",
+    "NotGiven",
+]

camel/utils/__init__.py

@@ -23,7 +23,6 @@ from .commons import (
     download_github_subdirectory,
     download_tasks,
     func_string_to_callable,
-    generate_prompt_for_structured_output,
     get_first_int,
     get_prompt_template_key_words,
     get_pydantic_major_version,
@@ -38,6 +37,7 @@ from .commons import (
     text_extract_from_web,
     to_pascal,
     track_agent,
+    with_timeout,
 )
 from .constants import Constants
 from .deduplication import DeduplicationResult, deduplicate_internally
@@ -87,4 +87,5 @@ __all__ = [
     "DeduplicationResult",
     "retry_on_error",
     "BatchProcessor",
+    "with_timeout",
 ]

camel/utils/async_func.py

@@ -33,8 +33,8 @@ def sync_funcs_to_async(funcs: list[FunctionTool]) -> list[FunctionTool]:
     for func in funcs:
         sync_func = func.func
 
-        def async_callable(*args, **kwargs):
-            return asyncio.to_thread(sync_func, *args, **kwargs)  # noqa: B023
+        async def async_callable(*args, **kwargs):
+            return await asyncio.to_thread(sync_func, *args, **kwargs)  # noqa: B023
 
         async_funcs.append(
             FunctionTool(async_callable, deepcopy(func.openai_tool_schema))

camel/utils/commons.py

@@ -19,6 +19,7 @@ import platform
 import re
 import socket
 import subprocess
+import threading
 import time
 import zipfile
 from functools import wraps
@@ -306,10 +307,55 @@ def api_keys_required(
                 if not value or value.strip() == "":
                     missing_keys.append(env_var_name)
 
+            key_way = "the official website"
+            if env_var_name == 'ANTHROPIC_API_KEY':
+                key_way = (
+                    "https://docs.anthropic.com/zh-CN/api/getting-started"
+                )
+            elif env_var_name == 'AIML_API_KEY':
+                key_way = "https://aimlapi.com/"
+            elif env_var_name == 'COHERE_API_KEY':
+                key_way = "https://cohere.com/"
+            elif env_var_name == 'DEEPSEEK_API_KEY':
+                key_way = "https://www.deepseek.com/"
+            elif env_var_name == 'AZURE_OPENAI_API_KEY':
+                key_way = "https://portal.azure.com/"
+            elif env_var_name == 'OPENAI_API_KEY':
+                key_way = "https://platform.openai.com/docs/overview"
+            elif env_var_name == 'FISHAUDIO_API_KEY':
+                key_way = "https://fish.audio/"
+            elif env_var_name == 'GEMINI_API_KEY':
+                key_way = "https://gemini.google.com/"
+            elif env_var_name == 'INTERNLM_API_KEY':
+                key_way = "https://internlm-chat.intern-ai.org.cn/puyu/api/v1"
+            elif env_var_name == 'GROQ_API_KEY':
+                key_way = "https://api.groq.com/openai/v1"
+            elif env_var_name == 'MISTRAL_API_KEY':
+                key_way = "https://mistral.ai/"
+            elif env_var_name == 'MOONSHOT_API_KEY':
+                key_way = "https://api.moonshot.cn/v1"
+            elif env_var_name == 'NVIDIA_API_KEY':
+                key_way = "https://integrate.api.nvidia.com/"
+            elif env_var_name == 'OPENAI_COMPATIBILIY_API_KEY':
+                key_way = "https://platform.openai.com/docs/overview"
+            elif env_var_name == 'QWEN_API_KEY':
+                key_way = "https://tongyi.aliyun.com/"
+            elif env_var_name == 'REKA_API_KEY':
+                key_way = "https://docs.reka.ai/quick-start"
+            elif env_var_name == 'SAMBA_API_KEY':
+                key_way = "https://community.sambanova.ai/t/looking-for-api-key-and-url-for-sambanova/576"
+            elif env_var_name == 'TOGETHER_API_KEY':
+                key_way = "https://docs.together.ai/docs/quickstart"
+            elif env_var_name == 'YI_API_KEY':
+                key_way = "https://platform.lingyiwanwu.com/docs"
+            elif env_var_name == 'ZHIPUAI_API_KEY':
+                key_way = "https://www.zhipuai.cn/"
+
             if missing_keys:
                 raise ValueError(
                     "Missing or empty required API keys in "
-                    f"environment variables: {', '.join(missing_keys)}"
+                    f"environment variables: {', '.join(missing_keys)}.\n"
+                    f"You can obtain the API key from {key_way}"
                 )
             return func(*args, **kwargs)
 
@@ -905,3 +951,70 @@ def generate_prompt_for_structured_output(
     {user_prompt}
     """
     return final_prompt
+
+
+def with_timeout(timeout=None):
+    r"""Decorator that adds timeout functionality to functions.
+
+    Executes functions with a specified timeout value. Returns a timeout
+    message if execution time is exceeded.
+
+    Args:
+        timeout (float, optional): The timeout duration in seconds. If None,
+            will try to get timeout from the instance's timeout attribute.
+            (default: :obj:`None`)
+
+    Example:
+        >>> @with_timeout(5)
+        ... def my_function():
+        ...     return "Success"
+        >>> my_function()
+
+        >>> class MyClass:
+        ...     timeout = 5
+        ...     @with_timeout()
+        ...     def my_method(self):
+        ...         return "Success"
+    """
+
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            # Determine the effective timeout value
+            effective_timeout = timeout
+            if effective_timeout is None and args:
+                effective_timeout = getattr(args[0], 'timeout', None)
+
+            # If no timeout value is provided, execute function normally
+            if effective_timeout is None:
+                return func(*args, **kwargs)
+
+            # Container to hold the result of the function call
+            result_container = []
+
+            def target():
+                result_container.append(func(*args, **kwargs))
+
+            # Start the function in a new thread
+            thread = threading.Thread(target=target)
+            thread.start()
+            thread.join(effective_timeout)
+
+            # Check if the thread is still alive after the timeout
+            if thread.is_alive():
+                return (
+                    f"Function `{func.__name__}` execution timed out, "
+                    f"exceeded {effective_timeout} seconds."
+                )
+            else:
+                return result_container[0]
+
+        return wrapper
+
+    # Handle both @with_timeout and @with_timeout() usage
+    if callable(timeout):
+        # If timeout is passed as a function, apply it to the decorator
+        func, timeout = timeout, None
+        return decorator(func)
+
+    return decorator

camel/verifiers/__init__.py

@@ -0,0 +1,23 @@
+# ========= 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 .base import BaseVerifier
+from .models import VerificationOutcome, VerifierInput
+from .python_verifier import PythonVerifier
+
+__all__ = [
+    "BaseVerifier",
+    "VerificationOutcome",
+    "VerifierInput",
+    "PythonVerifier",
+]