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

camel/prompts/task_prompt_template.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 typing import Any, Dict
 
 from camel.prompts.ai_society import (

camel/prompts/translation.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 typing import Any
 
 from camel.prompts.base import TextPrompt, TextPromptDict

camel/prompts/video_description_prompt.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 typing import Any
 
 from camel.prompts.base import TextPrompt, TextPromptDict

camel/responses/__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 .agent_responses import ChatAgentResponse
 
 __all__ = [

camel/responses/agent_responses.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 typing import Any, Dict, List
 
 from pydantic import BaseModel, ConfigDict

camel/retrievers/__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 .auto_retriever import AutoRetriever
 from .base import BaseRetriever
 from .bm25_retriever import BM25Retriever

camel/retrievers/auto_retriever.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 re
 import uuid
 from typing import (

camel/retrievers/base.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 abc import ABC, abstractmethod
 from typing import Any, Callable
 

camel/retrievers/bm25_retriever.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 typing import Any, Dict, List
 
 import numpy as np

camel/retrievers/cohere_rerank_retriever.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, Optional
 
@@ -98,10 +98,8 @@ class CohereRerankRetriever(BaseRetriever):
             model=self.model_name,
         )
         formatted_results = []
-        for i in range(0, len(rerank_results.results)):
-            selected_chunk = retrieved_result[rerank_results[i].index]
-            selected_chunk['similarity score'] = rerank_results[
-                i
-            ].relevance_score
+        for result in rerank_results.results:
+            selected_chunk = retrieved_result[result.index]
+            selected_chunk['similarity score'] = result.relevance_score
             formatted_results.append(selected_chunk)
         return formatted_results

camel/retrievers/vector_retriever.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 warnings
 from io import IOBase
@@ -77,6 +77,7 @@ class VectorRetriever(BaseRetriever):
         embed_batch: int = 50,
         should_chunk: bool = True,
         extra_info: Optional[dict] = None,
+        metadata_filename: Optional[str] = None,
         **kwargs: Any,
     ) -> None:
         r"""Processes content from local file path, remote URL, string
@@ -96,6 +97,8 @@ class VectorRetriever(BaseRetriever):
                 otherwise skip chunking. Defaults to True.
             extra_info (Optional[dict]): Extra information to be added
                 to the payload. Defaults to None.
+            metadata_filename (Optional[str]): The metadata filename to be
+                used for storing metadata. Defaults to None.
             **kwargs (Any): Additional keyword arguments for content parsing.
         """
         from unstructured.documents.elements import Element
@@ -103,18 +106,32 @@ class VectorRetriever(BaseRetriever):
         if isinstance(content, Element):
             elements = [content]
         elif isinstance(content, IOBase):
-            elements = self.uio.parse_bytes(file=content, **kwargs) or []
+            elements = (
+                self.uio.parse_bytes(
+                    file=content, metadata_filename=metadata_filename, **kwargs
+                )
+                or []
+            )
         elif isinstance(content, str):
             # Check if the content is URL
             parsed_url = urlparse(content)
             is_url = all([parsed_url.scheme, parsed_url.netloc])
             if is_url or os.path.exists(content):
                 elements = (
-                    self.uio.parse_file_or_url(input_path=content, **kwargs)
+                    self.uio.parse_file_or_url(
+                        input_path=content,
+                        metadata_filename=metadata_filename,
+                        **kwargs,
+                    )
                     or []
                 )
             else:
-                elements = [self.uio.create_element_from_text(text=content)]
+                elements = [
+                    self.uio.create_element_from_text(
+                        text=content,
+                        filename=metadata_filename,
+                    )
+                ]
 
         if not elements:
             warnings.warn(
@@ -156,13 +173,12 @@ class VectorRetriever(BaseRetriever):
                     chunk_metadata = {"metadata": chunk.metadata.to_dict()}
                     # Remove the 'orig_elements' key if it exists
                     chunk_metadata["metadata"].pop("orig_elements", "")
-                    extra_info = extra_info or {}
+                    chunk_metadata["extra_info"] = extra_info or {}
                     chunk_text = {"text": str(chunk)}
                     combined_dict = {
                         **content_path_info,
                         **chunk_metadata,
                         **chunk_text,
-                        **extra_info,
                     }
 
                     records.append(
@@ -233,6 +249,7 @@ class VectorRetriever(BaseRetriever):
                         'content path', ''
                     ),
                     'metadata': result.record.payload.get('metadata', {}),
+                    'extra_info': result.record.payload.get('extra_info', {}),
                     'text': result.record.payload.get('text', ''),
                 }
                 formatted_results.append(result_dict)

camel/runtime/__init__.py

@@ -0,0 +1,29 @@
+# ========= 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 BaseRuntime
+from .configs import TaskConfig
+from .docker_runtime import DockerRuntime
+from .llm_guard_runtime import LLMGuardRuntime
+from .remote_http_runtime import RemoteHttpRuntime
+
+# TODO: Add Celery Runtime to support distributed computing,
+# Rate Limiting, Load Balancing, etc.
+
+__all__ = [
+    "BaseRuntime",
+    "DockerRuntime",
+    "RemoteHttpRuntime",
+    "LLMGuardRuntime",
+    "TaskConfig",
+]

camel/runtime/api.py

@@ -0,0 +1,93 @@
+# ========= 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 importlib
+import io
+import json
+import logging
+import os
+import sys
+from typing import Dict
+
+import uvicorn
+from fastapi import FastAPI, Request
+from fastapi.responses import JSONResponse
+
+from camel.toolkits import BaseToolkit
+
+logger = logging.getLogger(__name__)
+
+sys.path.append(os.getcwd())
+
+modules_functions = sys.argv[1:]
+
+logger.info(f"Modules and functions: {modules_functions}")
+
+app = FastAPI()
+
+
+@app.exception_handler(Exception)
+async def general_exception_handler(request: Request, exc: Exception):
+    return JSONResponse(
+        status_code=500,
+        content={
+            "detail": "Internal Server Error",
+            "error_message": str(exc),
+        },
+    )
+
+
+for module_function in modules_functions:
+    try:
+        init_params = dict()
+        if "{" in module_function:
+            module_function, params = module_function.split("{")
+            params = "{" + params
+            init_params = json.loads(params)
+
+        module_name, function_name = module_function.rsplit(".", 1)
+
+        logger.info(f"Importing {module_name} and function {function_name}")
+
+        module = importlib.import_module(module_name)
+        function = getattr(module, function_name)
+        if isinstance(function, type) and issubclass(function, BaseToolkit):
+            function = function(**init_params).get_tools()
+
+        if not isinstance(function, list):
+            function = [function]
+
+        for func in function:
+
+            @app.post(f"/{func.get_function_name()}")
+            async def dynamic_function(data: Dict, func=func):
+                redirect_stdout = data.get('redirect_stdout', False)
+                if redirect_stdout:
+                    sys.stdout = io.StringIO()
+                response_data = func.func(*data['args'], **data['kwargs'])
+                if redirect_stdout:
+                    sys.stdout.seek(0)
+                    output = sys.stdout.read()
+                    sys.stdout = sys.__stdout__
+                    return {
+                        "output": json.dumps(response_data),
+                        "stdout": output,
+                    }
+                return {"output": json.dumps(response_data)}
+
+    except (ImportError, AttributeError) as e:
+        logger.error(f"Error importing {module_function}: {e}")
+
+
+if __name__ == "__main__":
+    uvicorn.run("__main__:app", host="0.0.0.0", port=8000, reload=True)

camel/runtime/base.py

@@ -0,0 +1,45 @@
+# ========= 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 abc import ABC, abstractmethod
+from typing import Any, List, Union
+
+from camel.toolkits import FunctionTool
+
+
+class BaseRuntime(ABC):
+    r"""An abstract base class for all CAMEL runtimes."""
+
+    def __init__(self):
+        super().__init__()
+
+        self.tools_map = dict()
+
+    @abstractmethod
+    def add(
+        self,
+        funcs: Union[FunctionTool, List[FunctionTool]],
+        *args: Any,
+        **kwargs: Any,
+    ) -> "BaseRuntime":
+        r"""Adds a new tool to the runtime."""
+        pass
+
+    @abstractmethod
+    def reset(self, *args: Any, **kwargs: Any) -> Any:
+        r"""Resets the runtime to its initial state."""
+        pass
+
+    def get_tools(self) -> List[FunctionTool]:
+        r"""Returns a list of all tools in the runtime."""
+        return list(self.tools_map.values())

camel/runtime/configs.py

@@ -0,0 +1,56 @@
+# ========= 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 Dict, List, Optional, Union
+
+from pydantic import BaseModel
+
+
+class TaskConfig(BaseModel):
+    r"""A configuration for a task to run a command inside the container.
+
+    Arttributes:
+        cmd (str or list): Command to be executed
+        stdout (bool): Attach to stdout. (default::obj: `True`)
+        stderr (bool): Attach to stderr. (default::obj: `True`)
+        stdin (bool): Attach to stdin. (default::obj: `False`)
+        tty (bool): Allocate a pseudo-TTY. (default::obj: `False`)
+        privileged (bool): Run as privileged. (default::obj: `False`)
+        user (str): User to execute command as. (default::obj: `""`)
+        detach (bool): If true, detach from the exec command.
+            (default::obj: `False`)
+        stream (bool): Stream response data. (default::obj: `False`)
+        socket (bool): Return the connection socket to allow custom
+            read/write operations. (default::obj: `False`)
+        environment (dict or list): A dictionary or a list of strings in
+            the following format ``["PASSWORD=xxx"]`` or
+            ``{"PASSWORD": "xxx"}``. (default::obj: `None`)
+        workdir (str): Path to working directory for this exec session.
+            (default::obj: `None`)
+        demux (bool): Return stdout and stderr separately. (default::obj:
+            `False`)
+    """
+
+    cmd: Union[str, List[str]]
+    stdout: bool = True
+    stderr: bool = True
+    stdin: bool = False
+    tty: bool = False
+    privileged: bool = False
+    user: str = ""
+    detach: bool = False
+    stream: bool = False
+    socket: bool = False
+    environment: Optional[Union[Dict[str, str], List[str]]] = None
+    workdir: Optional[str] = None
+    demux: bool = False