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

camel/configs/amd_config.py

@@ -0,0 +1,70 @@
+# ========= 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 __future__ import annotations
+
+from typing import List, Optional, Union
+
+from pydantic import Field
+
+from camel.configs.base_config import BaseConfig
+from camel.types import NotGiven
+
+
+class AMDConfig(BaseConfig):
+    r"""Configuration class for AMD API models.
+
+    This class defines the configuration parameters for AMD's language
+    models, including temperature, sampling parameters, and response format
+    settings.
+
+    Args:
+        stream (bool, optional): Whether to stream the response.
+            (default: :obj:`None`)
+        temperature (float, optional): Controls randomness in the response.
+            Higher values make output more random, lower values make it more
+            deterministic. Range: [0.0, 2.0]. (default: :obj:`None`)
+        top_p (float, optional): Controls diversity via nucleus sampling.
+            Range: [0.0, 1.0]. (default: :obj:`None`)
+        presence_penalty (float, optional): Penalizes new tokens based on
+            whether they appear in the text so far. Range: [-2.0, 2.0].
+            (default: :obj:`None`)
+        frequency_penalty (float, optional): Penalizes new tokens based on
+            their frequency in the text so far. Range: [-2.0, 2.0].
+            (default: :obj:`None`)
+        max_tokens (Union[int, NotGiven], optional): Maximum number of tokens
+            to generate. If not provided, model will use its default maximum.
+            (default: :obj:`None`)
+        seed (Optional[int], optional): Random seed for deterministic sampling.
+            (default: :obj:`None`)
+        tools (Optional[List[Dict]], optional): List of tools available to the
+            model. This includes tools such as a text editor, a calculator, or
+            a search engine. (default: :obj:`None`)
+        tool_choice (Optional[str], optional): Tool choice configuration.
+            (default: :obj:`None`)
+        stop (Optional[List[str]], optional): List of stop sequences.
+            (default: :obj:`None`)
+    """
+
+    stream: Optional[bool] = Field(default=None)
+    temperature: Optional[float] = Field(default=None)
+    top_p: Optional[float] = Field(default=None)
+    presence_penalty: Optional[float] = Field(default=None)
+    frequency_penalty: Optional[float] = Field(default=None)
+    max_tokens: Optional[Union[int, NotGiven]] = Field(default=None)
+    seed: Optional[int] = Field(default=None)
+    tool_choice: Optional[str] = Field(default=None)
+    stop: Optional[List[str]] = Field(default=None)
+
+
+AMD_API_PARAMS = {param for param in AMDConfig.model_fields.keys()}

camel/configs/nebius_config.py

@@ -0,0 +1,103 @@
+# ========= 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 __future__ import annotations
+
+from typing import Optional, Sequence, Union
+
+from camel.configs.base_config import BaseConfig
+
+
+class NebiusConfig(BaseConfig):
+    r"""Defines the parameters for generating chat completions using OpenAI
+    compatibility with Nebius AI Studio.
+
+    Reference: https://nebius.com/docs/ai-studio/api
+
+    Args:
+        temperature (float, optional): Sampling temperature to use, between
+            :obj:`0` and :obj:`2`. Higher values make the output more random,
+            while lower values make it more focused and deterministic.
+            (default: :obj:`None`)
+        top_p (float, optional): An alternative to sampling with temperature,
+            called nucleus sampling, where the model considers the results of
+            the tokens with top_p probability mass. So :obj:`0.1` means only
+            the tokens comprising the top 10% probability mass are considered.
+            (default: :obj:`None`)
+        n (int, optional): How many chat completion choices to generate for
+            each input message. (default: :obj:`None`)
+        response_format (object, optional): An object specifying the format
+            that the model must output. Compatible with GPT-4 Turbo and all
+            GPT-3.5 Turbo models newer than gpt-3.5-turbo-1106. Setting to
+            {"type": "json_object"} enables JSON mode, which guarantees the
+            message the model generates is valid JSON. Important: when using
+            JSON mode, you must also instruct the model to produce JSON
+            yourself via a system or user message. Without this, the model
+            may generate an unending stream of whitespace until the generation
+            reaches the token limit, resulting in a long-running and seemingly
+            "stuck" request. Also note that the message content may be
+            partially cut off if finish_reason="length", which indicates the
+            generation exceeded max_tokens or the conversation exceeded the
+            max context length.
+        stream (bool, optional): If True, partial message deltas will be sent
+            as data-only server-sent events as they become available.
+            (default: :obj:`None`)
+        stop (str or list, optional): Up to :obj:`4` sequences where the API
+            will stop generating further tokens. (default: :obj:`None`)
+        max_tokens (int, optional): The maximum number of tokens to generate
+            in the chat completion. The total length of input tokens and
+            generated tokens is limited by the model's context length.
+            (default: :obj:`None`)
+        presence_penalty (float, optional): Number between :obj:`-2.0` and
+            :obj:`2.0`. Positive values penalize new tokens based on whether
+            they appear in the text so far, increasing the model's likelihood
+            to talk about new topics. See more information about frequency and
+            presence penalties. (default: :obj:`None`)
+        frequency_penalty (float, optional): Number between :obj:`-2.0` and
+            :obj:`2.0`. Positive values penalize new tokens based on their
+            existing frequency in the text so far, decreasing the model's
+            likelihood to repeat the same line verbatim. See more information
+            about frequency and presence penalties. (default: :obj:`None`)
+        user (str, optional): A unique identifier representing your end-user,
+            which can help OpenAI to monitor and detect abuse.
+            (default: :obj:`None`)
+        tools (list[FunctionTool], optional): A list of tools the model may
+            call. Currently, only functions are supported as a tool. Use this
+            to provide a list of functions the model may generate JSON inputs
+            for. A max of 128 functions are supported.
+        tool_choice (Union[dict[str, str], str], optional): Controls which (if
+            any) tool is called by the model. :obj:`"none"` means the model
+            will not call any tool and instead generates a message.
+            :obj:`"auto"` means the model can pick between generating a
+            message or calling one or more tools.  :obj:`"required"` means the
+            model must call one or more tools. Specifying a particular tool
+            via {"type": "function", "function": {"name": "my_function"}}
+            forces the model to call that tool. :obj:`"none"` is the default
+            when no tools are present. :obj:`"auto"` is the default if tools
+            are present.
+    """
+
+    temperature: Optional[float] = None
+    top_p: Optional[float] = None
+    n: Optional[int] = None
+    stream: Optional[bool] = None
+    stop: Optional[Union[str, Sequence[str]]] = None
+    max_tokens: Optional[int] = None
+    presence_penalty: Optional[float] = None
+    response_format: Optional[dict] = None
+    frequency_penalty: Optional[float] = None
+    user: Optional[str] = None
+    tool_choice: Optional[Union[dict[str, str], str]] = None
+
+
+NEBIUS_API_PARAMS = {param for param in NebiusConfig.model_fields.keys()}

camel/interpreters/__init__.py

@@ -18,6 +18,7 @@ from .e2b_interpreter import E2BInterpreter
 from .internal_python_interpreter import InternalPythonInterpreter
 from .interpreter_error import InterpreterError
 from .ipython_interpreter import JupyterKernelInterpreter
+from .microsandbox_interpreter import MicrosandboxInterpreter
 from .subprocess_interpreter import SubprocessInterpreter
 
 __all__ = [
@@ -28,4 +29,5 @@ __all__ = [
     'DockerInterpreter',
     'JupyterKernelInterpreter',
     'E2BInterpreter',
+    'MicrosandboxInterpreter',
 ]

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
@@ -31,6 +32,7 @@ from .model_factory import ModelFactory
 from .model_manager import ModelManager, ModelProcessingError
 from .modelscope_model import ModelScopeModel
 from .moonshot_model import MoonshotModel
+from .nebius_model import NebiusModel
 from .nemotron_model import NemotronModel
 from .netmind_model import NetmindModel
 from .novita_model import NovitaModel
@@ -61,6 +63,7 @@ __all__ = [
     'OpenRouterModel',
     'AzureOpenAIModel',
     'AnthropicModel',
+    'AMDModel',
     'MistralModel',
     'GroqModel',
     'StubModel',
@@ -87,6 +90,7 @@ __all__ = [
     'QwenModel',
     'AWSBedrockModel',
     'ModelProcessingError',
+    'NebiusModel',
     'DeepSeekModel',
     'FishAudioModel',
     'InternLMModel',