camel-ai 0.2.75a6__py3-none-any.whl → 0.2.76a0__py3-none-any.whl

camel/interpreters/microsandbox_interpreter.py

@@ -0,0 +1,395 @@
+# ========= 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 asyncio
+from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union
+
+from camel.interpreters.base import BaseInterpreter
+from camel.interpreters.interpreter_error import InterpreterError
+from camel.logger import get_logger
+
+logger = get_logger(__name__)
+
+
+class MicrosandboxInterpreter(BaseInterpreter):
+    r"""Microsandbox Code Interpreter implementation.
+
+    This interpreter provides secure code execution using microsandbox,
+    a self-hosted platform for secure execution of untrusted user/AI code.
+    It supports Python code execution via PythonSandbox, JavaScript/Node.js
+    code execution via NodeSandbox, and shell commands via the command
+    interface.
+
+    Args:
+        require_confirm (bool, optional): If True, prompt user before running
+            code strings for security. (default: :obj:`True`)
+        server_url (str, optional): URL of the microsandbox server. If not
+            provided, will use MSB_SERVER_URL environment variable, then
+            fall back to http://127.0.0.1:5555. (default: :obj:`None`)
+        api_key (str, optional): API key for microsandbox authentication.
+            If not provided, will use MSB_API_KEY environment variable.
+            (default: :obj:`None`)
+        namespace (str, optional): Namespace for the sandbox.
+            (default: :obj:`"default"`)
+        sandbox_name (str, optional): Name of the sandbox instance. If not
+            provided, a random name will be generated by the SDK.
+            (default: :obj:`None`)
+        timeout (int, optional): Default timeout for code execution in seconds.
+            (default: :obj:`30`)
+
+    Environment Variables:
+        MSB_SERVER_URL: URL of the microsandbox server.
+        MSB_API_KEY: API key for microsandbox authentication.
+
+    Note:
+        The SDK handles parameter priority as: user parameter > environment
+            variable > default value.
+    """
+
+    _CODE_TYPE_MAPPING: ClassVar[Dict[str, str]] = {
+        # Python code - uses PythonSandbox
+        "python": "python_sandbox",
+        "py3": "python_sandbox",
+        "python3": "python_sandbox",
+        "py": "python_sandbox",
+        # JavaScript/Node.js code - uses NodeSandbox
+        "javascript": "node_sandbox",
+        "js": "node_sandbox",
+        "node": "node_sandbox",
+        "typescript": "node_sandbox",
+        "ts": "node_sandbox",
+        # Shell commands - uses command.run()
+        "bash": "shell_command",
+        "shell": "shell_command",
+        "sh": "shell_command",
+    }
+
+    def __init__(
+        self,
+        require_confirm: bool = True,
+        server_url: Optional[str] = None,
+        api_key: Optional[str] = None,
+        namespace: str = "default",
+        sandbox_name: Optional[str] = None,
+        timeout: int = 30,
+    ) -> None:
+        from microsandbox import (
+            NodeSandbox,
+            PythonSandbox,
+        )
+
+        # Store parameters, let SDK handle defaults and environment variables
+        self.require_confirm = require_confirm
+        self.server_url = server_url  # None means use SDK default logic
+        self.api_key = api_key  # None means use SDK default logic
+        self.namespace = namespace
+        self.sandbox_name = (
+            sandbox_name  # None means SDK generates random name
+        )
+        self.timeout = timeout
+
+        # Store sandbox configuration
+        self._sandbox_config = {
+            "server_url": self.server_url,
+            "namespace": self.namespace,
+            "name": self.sandbox_name,
+            "api_key": self.api_key,
+        }
+
+        # Store sandbox classes for reuse
+        self._PythonSandbox = PythonSandbox
+        self._NodeSandbox = NodeSandbox
+
+        # Log initialization info
+        logger.info("Initialized MicrosandboxInterpreter")
+        logger.info(f"Namespace: {self.namespace}")
+        if self.sandbox_name:
+            logger.info(f"Sandbox name: {self.sandbox_name}")
+        else:
+            logger.info("Sandbox name: will be auto-generated by SDK")
+
+    def run(
+        self,
+        code: str,
+        code_type: str = "python",
+    ) -> str:
+        r"""Executes the given code in the microsandbox.
+
+        Args:
+            code (str): The code string to execute.
+            code_type (str): The type of code to execute. Supported types:
+                'python', 'javascript', 'bash'. (default: :obj:`python`)
+
+        Returns:
+            str: The string representation of the output of the executed code.
+
+        Raises:
+            InterpreterError: If the `code_type` is not supported or if any
+                runtime error occurs during the execution of the code.
+        """
+        if code_type not in self._CODE_TYPE_MAPPING:
+            raise InterpreterError(
+                f"Unsupported code type {code_type}. "
+                f"`{self.__class__.__name__}` only supports "
+                f"{', '.join(list(self._CODE_TYPE_MAPPING.keys()))}."
+            )
+
+        # Print code for security checking
+        if self.require_confirm:
+            logger.info(
+                f"The following {code_type} code will run on "
+                f"microsandbox: {code}"
+            )
+            self._confirm_execution("code")
+
+        # Run the code asynchronously
+        return asyncio.run(self._run_async(code, code_type))
+
+    async def _run_async(self, code: str, code_type: str) -> str:
+        r"""Asynchronously executes code in microsandbox.
+
+        Args:
+            code (str): The code to execute.
+            code_type (str): The type of code to execute.
+
+        Returns:
+            str: The output of the executed code.
+
+        Raises:
+            InterpreterError: If execution fails.
+        """
+        try:
+            execution_method = self._CODE_TYPE_MAPPING[code_type]
+
+            if execution_method == "python_sandbox":
+                return await self._run_python_code(code)
+            elif execution_method == "node_sandbox":
+                return await self._run_node_code(code)
+            elif execution_method == "shell_command":
+                return await self._run_shell_command(code)
+            else:
+                raise InterpreterError(
+                    f"Unsupported execution method: {execution_method}"
+                )
+
+        except Exception as e:
+            raise InterpreterError(
+                f"Error executing code in microsandbox: {e}"
+            )
+
+    async def _run_python_code(self, code: str) -> str:
+        r"""Execute Python code using PythonSandbox.
+
+        Args:
+            code (str): Python code to execute.
+
+        Returns:
+            str: Execution output.
+        """
+        async with self._PythonSandbox.create(
+            **self._sandbox_config
+        ) as sandbox:
+            execution = await asyncio.wait_for(
+                sandbox.run(code), timeout=self.timeout
+            )
+            return await self._get_execution_output(execution)
+
+    async def _run_node_code(self, code: str) -> str:
+        r"""Execute JavaScript/Node.js code using NodeSandbox.
+
+        Args:
+            code (str): JavaScript/Node.js code to execute.
+
+        Returns:
+            str: Execution output.
+        """
+        async with self._NodeSandbox.create(**self._sandbox_config) as sandbox:
+            execution = await asyncio.wait_for(
+                sandbox.run(code), timeout=self.timeout
+            )
+            return await self._get_execution_output(execution)
+
+    async def _run_shell_command(self, code: str) -> str:
+        r"""Execute shell commands directly.
+
+        Args:
+            code (str): Shell command to execute.
+
+        Returns:
+            str: Command execution output.
+        """
+        # Use any sandbox for shell commands
+        async with self._PythonSandbox.create(
+            **self._sandbox_config
+        ) as sandbox:
+            execution = await asyncio.wait_for(
+                sandbox.command.run("bash", ["-c", code]), timeout=self.timeout
+            )
+            return await self._get_command_output(execution)
+
+    async def _get_execution_output(self, execution) -> str:
+        r"""Get output from code execution.
+
+        Args:
+            execution: Execution object from sandbox.run().
+
+        Returns:
+            str: Formatted execution output.
+        """
+        output = await execution.output()
+        error = await execution.error()
+
+        result_parts = []
+        if output and output.strip():
+            result_parts.append(output.strip())
+        if error and error.strip():
+            result_parts.append(f"STDERR: {error.strip()}")
+
+        return (
+            "\n".join(result_parts)
+            if result_parts
+            else "Code executed successfully (no output)"
+        )
+
+    async def _get_command_output(self, execution) -> str:
+        r"""Get output from command execution.
+
+        Args:
+            execution: CommandExecution object from sandbox.command.run().
+
+        Returns:
+            str: Formatted command output.
+        """
+        output = await execution.output()
+        error = await execution.error()
+
+        result_parts = []
+        if output and output.strip():
+            result_parts.append(output.strip())
+        if error and error.strip():
+            result_parts.append(f"STDERR: {error.strip()}")
+        if hasattr(execution, 'exit_code') and execution.exit_code != 0:
+            result_parts.append(f"Exit code: {execution.exit_code}")
+
+        return (
+            "\n".join(result_parts)
+            if result_parts
+            else "Command executed successfully (no output)"
+        )
+
+    def _confirm_execution(self, execution_type: str) -> None:
+        r"""Prompt user for confirmation before executing code or commands.
+
+        Args:
+            execution_type (str): Type of execution ('code' or 'command').
+
+        Raises:
+            InterpreterError: If user declines to run the code/command.
+        """
+        while True:
+            choice = input(f"Running {execution_type}? [Y/n]:").lower()
+            if choice in ["y", "yes", "ye"]:
+                break
+            elif choice not in ["no", "n"]:
+                continue
+            raise InterpreterError(
+                f"Execution halted: User opted not to run the "
+                f"{execution_type}. "
+                f"This choice stops the current operation and any "
+                f"further {execution_type} execution."
+            )
+
+    def supported_code_types(self) -> List[str]:
+        r"""Provides supported code types by the interpreter."""
+        return list(self._CODE_TYPE_MAPPING.keys())
+
+    def update_action_space(self, action_space: Dict[str, Any]) -> None:
+        r"""Updates action space for interpreter.
+
+        Args:
+            action_space: Action space dictionary (unused in microsandbox).
+
+        Note:
+            Microsandbox doesn't support action space updates as it runs
+            in isolated environments for each execution.
+        """
+        # Explicitly acknowledge the parameter to avoid linting warnings
+        _ = action_space
+        logger.warning(
+            "Microsandbox doesn't support action space updates. "
+            "Code runs in isolated environments for each execution."
+        )
+
+    def execute_command(self, command: str) -> Union[str, Tuple[str, str]]:
+        r"""Execute a shell command in the microsandbox.
+
+        This method is designed for package management and system
+        administration tasks. It executes shell commands directly
+        using the microsandbox command interface.
+
+        Args:
+            command (str): The shell command to execute (e.g.,
+            "pip install numpy", "ls -la", "apt-get update").
+
+        Returns:
+            Union[str, Tuple[str, str]]: The output of the command.
+
+        Examples:
+            >>> interpreter.execute_command("pip install numpy")
+            >>> interpreter.execute_command("npm install express")
+            >>> interpreter.execute_command("ls -la /tmp")
+        """
+        # Print command for security checking
+        if self.require_confirm:
+            logger.info(
+                f"The following shell command will run on "
+                f"microsandbox: {command}"
+            )
+            self._confirm_execution("command")
+
+        return asyncio.run(self._execute_command_async(command))
+
+    async def _execute_command_async(self, command: str) -> str:
+        r"""Asynchronously executes a shell command in microsandbox.
+
+        Args:
+            command (str): The shell command to execute.
+
+        Returns:
+            str: The output of the command execution.
+
+        Raises:
+            InterpreterError: If execution fails.
+        """
+        try:
+            async with self._PythonSandbox.create(
+                **self._sandbox_config
+            ) as sandbox:
+                execution = await asyncio.wait_for(
+                    sandbox.command.run("bash", ["-c", command]),
+                    timeout=self.timeout,
+                )
+                return await self._get_command_output(execution)
+
+        except Exception as e:
+            raise InterpreterError(
+                f"Error executing command in microsandbox: {e}"
+            )
+
+    def __del__(self) -> None:
+        r"""Destructor for the MicrosandboxInterpreter class.
+
+        Microsandbox uses context managers for resource management,
+        so no explicit cleanup is needed.
+        """
+        logger.debug("MicrosandboxInterpreter cleaned up")

camel/models/__init__.py

@@ -12,6 +12,7 @@
 # limitations under the License.
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 from .aiml_model import AIMLModel
+from .amd_model import AMDModel
 from .anthropic_model import AnthropicModel
 from .aws_bedrock_model import AWSBedrockModel
 from .azure_openai_model import AzureOpenAIModel
@@ -62,6 +63,7 @@ __all__ = [
     'OpenRouterModel',
     'AzureOpenAIModel',
     'AnthropicModel',
+    'AMDModel',
     'MistralModel',
     'GroqModel',
     'StubModel',

camel/models/amd_model.py

@@ -0,0 +1,101 @@
+# ========= 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, Optional, Union
+
+from camel.configs import AMD_API_PARAMS, AMDConfig
+from camel.models.openai_compatible_model import OpenAICompatibleModel
+from camel.types import ModelType
+from camel.utils import BaseTokenCounter, api_keys_required
+
+
+class AMDModel(OpenAICompatibleModel):
+    r"""AMD API in a unified OpenAICompatibleModel interface.
+
+    Args:
+        model_type (Union[ModelType, str]): Model for which a backend is
+            created, one of AMD series.
+        model_config_dict (Optional[Dict[str, Any]], optional): A dictionary
+            that will be fed into:obj:`openai.ChatCompletion.create()`. If
+            :obj:`None`, :obj:`AMDConfig().as_dict()` will be used.
+            (default: :obj:`None`)
+        api_key (Optional[str], optional): The API key for authenticating with
+            the AMD service. (default: :obj:`None`)
+        url (Optional[str], optional): The url to the AMD service.
+            (default: :obj:`None`)
+        token_counter (Optional[BaseTokenCounter], optional): Token counter to
+            use for the model. If not provided, :obj:`OpenAITokenCounter(
+            ModelType.GPT_4)` will be used.
+            (default: :obj:`None`)
+        timeout (Optional[float], optional): The timeout value in seconds for
+            API calls. If not provided, will fall back to the MODEL_TIMEOUT
+            environment variable or default to 180 seconds.
+            (default: :obj:`None`)
+        max_retries (int, optional): Maximum number of retries for API calls.
+            (default: :obj:`3`)
+        **kwargs (Any): Additional arguments to pass to the client
+            initialization.
+    """
+
+    @api_keys_required(
+        [
+            ("api_key", "AMD_API_KEY"),
+        ]
+    )
+    def __init__(
+        self,
+        model_type: Union[ModelType, str],
+        model_config_dict: Optional[Dict[str, Any]] = None,
+        api_key: Optional[str] = None,
+        url: Optional[str] = None,
+        token_counter: Optional[BaseTokenCounter] = None,
+        timeout: Optional[float] = None,
+        max_retries: int = 3,
+        **kwargs: Any,
+    ) -> None:
+        if model_config_dict is None:
+            model_config_dict = AMDConfig().as_dict()
+        api_key = api_key or os.environ.get("AMD_API_KEY")
+        url = url or os.environ.get(
+            "AMD_API_BASE_URL", "https://llm-api.amd.com"
+        )
+        headers = {'Ocp-Apim-Subscription-Key': api_key}
+        kwargs["default_headers"] = headers
+        timeout = timeout or float(os.environ.get("MODEL_TIMEOUT", 180))
+        super().__init__(
+            model_type=model_type,
+            model_config_dict=model_config_dict,
+            api_key=api_key,
+            url=url,
+            token_counter=token_counter,
+            timeout=timeout,
+            max_retries=max_retries,
+            **kwargs,
+        )
+
+    def check_model_config(self):
+        r"""Check whether the model configuration contains any
+        unexpected arguments to AMD API.
+
+        Raises:
+            ValueError: If the model configuration dictionary contains any
+                unexpected arguments to AMD API.
+        """
+        for param in self.model_config_dict:
+            if param not in AMD_API_PARAMS:
+                raise ValueError(
+                    f"Unexpected argument `{param}` is "
+                    "input into AMD model backend."
+                )

camel/models/model_factory.py

@@ -16,6 +16,7 @@ import os
 from typing import ClassVar, Dict, Optional, Type, Union
 
 from camel.models.aiml_model import AIMLModel
+from camel.models.amd_model import AMDModel
 from camel.models.anthropic_model import AnthropicModel
 from camel.models.aws_bedrock_model import AWSBedrockModel
 from camel.models.azure_openai_model import AzureOpenAIModel
@@ -77,6 +78,7 @@ class ModelFactory:
         ModelPlatformType.AWS_BEDROCK: AWSBedrockModel,
         ModelPlatformType.NVIDIA: NvidiaModel,
         ModelPlatformType.SILICONFLOW: SiliconFlowModel,
+        ModelPlatformType.AMD: AMDModel,
         ModelPlatformType.AIML: AIMLModel,
         ModelPlatformType.VOLCANO: VolcanoModel,
         ModelPlatformType.NETMIND: NetmindModel,

camel/models/openai_model.py

@@ -303,9 +303,6 @@ class OpenAIModel(BaseModelBackend):
         is_streaming = self.model_config_dict.get("stream", False)
 
         if response_format:
-            result: Union[ChatCompletion, Stream[ChatCompletionChunk]] = (
-                self._request_parse(messages, response_format, tools)
-            )
             if is_streaming:
                 # Use streaming parse for structured output
                 return self._request_stream_parse(
@@ -377,9 +374,6 @@ class OpenAIModel(BaseModelBackend):
         is_streaming = self.model_config_dict.get("stream", False)
 
         if response_format:
-            result: Union[
-                ChatCompletion, AsyncStream[ChatCompletionChunk]
-            ] = await self._arequest_parse(messages, response_format, tools)
             if is_streaming:
                 # Use streaming parse for structured output
                 return await self._arequest_stream_parse(

camel/runtimes/daytona_runtime.py

@@ -16,7 +16,7 @@ import inspect
 import json
 import os
 from functools import wraps
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Callable, Dict, List, Optional, Union
 
 from pydantic import BaseModel
 
@@ -49,7 +49,7 @@ class DaytonaRuntime(BaseRuntime):
         api_url: Optional[str] = None,
         language: Optional[str] = "python",
     ):
-        from daytona_sdk import Daytona, DaytonaConfig
+        from daytona_sdk import Daytona, DaytonaConfig, Sandbox
 
         super().__init__()
         self.api_key = api_key or os.environ.get('DAYTONA_API_KEY')
@@ -57,7 +57,7 @@ class DaytonaRuntime(BaseRuntime):
         self.language = language
         self.config = DaytonaConfig(api_key=self.api_key, api_url=self.api_url)
         self.daytona = Daytona(self.config)
-        self.sandbox = None
+        self.sandbox: Optional[Sandbox] = None
         self.entrypoint: Dict[str, str] = dict()
 
     def build(self) -> "DaytonaRuntime":
@@ -66,10 +66,10 @@ class DaytonaRuntime(BaseRuntime):
         Returns:
             DaytonaRuntime: The current runtime.
         """
-        from daytona_sdk import CreateSandboxParams
+        from daytona_sdk import CreateSandboxBaseParams
 
         try:
-            params = CreateSandboxParams(language=self.language)
+            params = CreateSandboxBaseParams(language=self.language)
             self.sandbox = self.daytona.create(params)
             if self.sandbox is None:
                 raise RuntimeError("Failed to create sandbox.")
@@ -83,7 +83,7 @@ class DaytonaRuntime(BaseRuntime):
         r"""Clean up the sandbox when exiting."""
         if self.sandbox:
             try:
-                self.daytona.remove(self.sandbox)
+                self.daytona.delete(self.sandbox)
                 logger.info(f"Sandbox {self.sandbox.id} removed")
                 self.sandbox = None
             except Exception as e:
@@ -112,7 +112,7 @@ class DaytonaRuntime(BaseRuntime):
         if arguments is not None:
             entrypoint += json.dumps(arguments, ensure_ascii=False)
 
-        def make_wrapper(inner_func, func_name, func_code):
+        def make_wrapper(inner_func: Callable, func_name: str, func_code: str):
             r"""Creates a wrapper for a function to execute it in the
             Daytona sandbox.
 
@@ -208,12 +208,11 @@ class DaytonaRuntime(BaseRuntime):
             RuntimeError: If the sandbox is not initialized.
         """
         if self.sandbox is None:
-            raise RuntimeError("Failed to create sandbox.")
-        info = self.sandbox.info()
+            raise RuntimeError("Sandbox not initialized.")
         return (
-            f"Sandbox {info.name}:\n"
-            f"State: {info.state}\n"
-            f"Resources: {info.resources.cpu} CPU, {info.resources.memory} RAM"
+            f"Sandbox {self.sandbox.id}:\n"
+            f"State: {self.sandbox.state}\n"
+            f"Resources: {self.sandbox.cpu} CPU, {self.sandbox.memory} RAM"
         )
 
     def __del__(self):

camel/toolkits/__init__.py

@@ -23,7 +23,7 @@ from .open_api_specs.security_config import openapi_security_config
 from .math_toolkit import MathToolkit
 from .search_toolkit import SearchToolkit
 from .weather_toolkit import WeatherToolkit
-from .openai_image_toolkit import OpenAIImageToolkit
+from .image_generation_toolkit import ImageGenToolkit, OpenAIImageToolkit
 from .ask_news_toolkit import AskNewsToolkit, AsyncAskNewsToolkit
 from .linkedin_toolkit import LinkedInToolkit
 from .reddit_toolkit import RedditToolkit
@@ -88,6 +88,7 @@ from .web_deploy_toolkit import WebDeployToolkit
 from .screenshot_toolkit import ScreenshotToolkit
 from .message_integration import ToolkitMessageIntegration
 from .notion_mcp_toolkit import NotionMCPToolkit
+from .minimax_mcp_toolkit import MinimaxMCPToolkit
 
 __all__ = [
     'BaseToolkit',
@@ -102,7 +103,7 @@ __all__ = [
     'SearchToolkit',
     'SlackToolkit',
     'WhatsAppToolkit',
-    'OpenAIImageToolkit',
+    'ImageGenToolkit',
     'TwitterToolkit',
     'WeatherToolkit',
     'RetrievalToolkit',
@@ -151,7 +152,7 @@ __all__ = [
     'PlaywrightMCPToolkit',
     'WolframAlphaToolkit',
     'BohriumToolkit',
-    'OpenAIImageToolkit',
+    'OpenAIImageToolkit',  # Backward compatibility
     'TaskPlanningToolkit',
     'HybridBrowserToolkit',
     'EdgeOnePagesMCPToolkit',
@@ -165,4 +166,5 @@ __all__ = [
     'RegisteredAgentToolkit',
     'ToolkitMessageIntegration',
     'NotionMCPToolkit',
+    'MinimaxMCPToolkit',
 ]