camel-ai 0.1.5.1__py3-none-any.whl → 0.1.5.3__py3-none-any.whl

camel/agents/embodied_agent.py

@@ -23,8 +23,8 @@ from camel.interpreters import (
     SubprocessInterpreter,
 )
 from camel.messages import BaseMessage
+from camel.models import BaseModelBackend
 from camel.responses import ChatAgentResponse
-from camel.types import ModelType
 from camel.utils import print_text_animated
 
 
@@ -33,10 +33,9 @@ class EmbodiedAgent(ChatAgent):
 
     Args:
         system_message (BaseMessage): The system message for the chat agent.
-        model_type (ModelType, optional): The LLM model to use for generating
-            responses. (default :obj:`ModelType.GPT_4`)
-        model_config (Any, optional): Configuration options for the LLM model.
-            (default: :obj:`None`)
+        model (BaseModelBackend, optional): The model backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
         message_window_size (int, optional): The maximum number of previous
             messages to include in the context window. If `None`, no windowing
             is performed. (default: :obj:`None`)
@@ -55,8 +54,7 @@ class EmbodiedAgent(ChatAgent):
     def __init__(
         self,
         system_message: BaseMessage,
-        model_type: ModelType = ModelType.GPT_4,
-        model_config: Optional[Any] = None,
+        model: Optional[BaseModelBackend] = None,
         message_window_size: Optional[int] = None,
         tool_agents: Optional[List[BaseToolAgent]] = None,
         code_interpreter: Optional[BaseInterpreter] = None,
@@ -78,8 +76,7 @@ class EmbodiedAgent(ChatAgent):
         self.logger_color = logger_color
         super().__init__(
             system_message=system_message,
-            model_type=model_type,
-            model_config=model_config,
+            model=model,
             message_window_size=message_window_size,
         )
 

camel/agents/knowledge_graph_agent.py

@@ -11,52 +11,65 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-from typing import Any, Optional, Union
+from typing import Optional, Union
 
 from unstructured.documents.elements import Element
 
 from camel.agents import ChatAgent
 from camel.messages import BaseMessage
+from camel.models import BaseModelBackend
 from camel.prompts import TextPrompt
 from camel.storages.graph_storages.graph_element import (
     GraphElement,
     Node,
     Relationship,
 )
-from camel.types import ModelType, RoleType
+from camel.types import RoleType
 
 text_prompt = """
-You are tasked with extracting nodes and relationships from given content and structures them into Node and Relationship objects. Here's the outline of what you needs to do:
+You are tasked with extracting nodes and relationships from given content and 
+structures them into Node and Relationship objects. Here's the outline of what 
+you needs to do:
 
 Content Extraction:
-You should be able to process input content and identify entities mentioned within it.
-Entities can be any noun phrases or concepts that represent distinct entities in the context of the given content.
+You should be able to process input content and identify entities mentioned 
+within it.
+Entities can be any noun phrases or concepts that represent distinct entities 
+in the context of the given content.
 
 Node Extraction:
 For each identified entity, you should create a Node object.
 Each Node object should have a unique identifier (id) and a type (type).
-Additional properties associated with the node can also be extracted and stored.
+Additional properties associated with the node can also be extracted and 
+stored.
 
 Relationship Extraction:
 You should identify relationships between entities mentioned in the content.
 For each relationship, create a Relationship object.
-A Relationship object should have a subject (subj) and an object (obj) which are Node objects representing the entities involved in the relationship.
-Each relationship should also have a type (type), and additional properties if applicable.
+A Relationship object should have a subject (subj) and an object (obj) which 
+are Node objects representing the entities involved in the relationship.
+Each relationship should also have a type (type), and additional properties if 
+applicable.
 
 Output Formatting:
-The extracted nodes and relationships should be formatted as instances of the provided Node and Relationship classes.
+The extracted nodes and relationships should be formatted as instances of the 
+provided Node and Relationship classes.
 Ensure that the extracted data adheres to the structure defined by the classes.
-Output the structured data in a format that can be easily validated against the provided code.
+Output the structured data in a format that can be easily validated against 
+the provided code.
 
 Instructions for you:
 Read the provided content thoroughly.
-Identify distinct entities mentioned in the content and categorize them as nodes.
-Determine relationships between these entities and represent them as directed relationships.
+Identify distinct entities mentioned in the content and categorize them as 
+nodes.
+Determine relationships between these entities and represent them as directed 
+relationships.
 Provide the extracted nodes and relationships in the specified format below.
 Example for you:
 
 Example Content:
-"John works at XYZ Corporation. He is a software engineer. The company is located in New York City."
+"John works at XYZ Corporation. He is a software engineer. The company is 
+located in New York City."
 
 Expected Output:
 
@@ -68,18 +81,23 @@ Node(id='New York City', type='Location', properties={'agent_generated'})
 
 Relationships:
 
-Relationship(subj=Node(id='John', type='Person'), obj=Node(id='XYZ Corporation', type='Organization'), type='WorksAt', properties={'agent_generated'})
-Relationship(subj=Node(id='John', type='Person'), obj=Node(id='New York City', type='Location'), type='ResidesIn', properties={'agent_generated'})
+Relationship(subj=Node(id='John', type='Person'), obj=Node(id='XYZ 
+Corporation', type='Organization'), type='WorksAt', properties=
+{'agent_generated'})
+Relationship(subj=Node(id='John', type='Person'), obj=Node(id='New York City', 
+type='Location'), type='ResidesIn', properties={'agent_generated'})
 
 ===== TASK =====
-Please extracts nodes and relationships from given content and structures them into Node and Relationship objects. 
+Please extracts nodes and relationships from given content and structures them 
+into Node and Relationship objects. 
 
 {task}
 """
 
 
 class KnowledgeGraphAgent(ChatAgent):
-    r"""An agent that can extract node and relationship information for different entities from given `Element` content.
+    r"""An agent that can extract node and relationship information for
+    different entities from given `Element` content.
 
     Attributes:
         task_prompt (TextPrompt): A prompt for the agent to extract node and
@@ -88,16 +106,14 @@ class KnowledgeGraphAgent(ChatAgent):
 
     def __init__(
         self,
-        model_type: ModelType = ModelType.GPT_3_5_TURBO,
-        model_config: Optional[Any] = None,
+        model: Optional[BaseModelBackend] = None,
     ) -> None:
         r"""Initialize the `KnowledgeGraphAgent`.
 
         Args:
-            model_type (ModelType, optional): The type of model to use for the
-                agent. Defaults to `ModelType.GPT_3_5_TURBO`.
-            model_config (Any, optional): The configuration for the model.
-                Defaults to `None`.
+        model (BaseModelBackend, optional): The model backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
         """
         system_message = BaseMessage(
             role_name="Graphify",
@@ -106,9 +122,10 @@ class KnowledgeGraphAgent(ChatAgent):
             content="Your mission is to transform unstructured content "
             "intostructured graph data. Extract nodes and relationships with "
             "precision, and let the connections unfold. Your graphs will "
-            "illuminate the hidden connections within the chaos of information.",
+            "illuminate the hidden connections within the chaos of "
+            "information.",
         )
-        super().__init__(system_message, model_type, model_config)
+        super().__init__(system_message, model=model)
 
     def run(
         self,
@@ -124,7 +141,8 @@ class KnowledgeGraphAgent(ChatAgent):
 
         Returns:
             Union[str, GraphElement]: The extracted node and relationship
-                information. If `parse_graph_elements` is `True` then return `GraphElement`, else return `str`.
+                information. If `parse_graph_elements` is `True` then return
+                `GraphElement`, else return `str`.
         """
         self.reset()
         self.element = element
@@ -191,7 +209,11 @@ class KnowledgeGraphAgent(ChatAgent):
 
         # Regular expressions to extract nodes and relationships
         node_pattern = r"Node\(id='(.*?)', type='(.*?)', properties=(.*?)\)"
-        rel_pattern = r"Relationship\(subj=Node\(id='(.*?)', type='(.*?)'\), obj=Node\(id='(.*?)', type='(.*?)'\), type='(.*?)', properties=\{(.*?)\}\)"
+        rel_pattern = (
+            r"Relationship\(subj=Node\(id='(.*?)', type='(.*?)'\), "
+            r"obj=Node\(id='(.*?)', type='(.*?)'\), type='(.*?)', "
+            r"properties=\{(.*?)\}\)"
+        )
 
         nodes = {}
         relationships = []

camel/agents/role_assignment_agent.py

@@ -12,31 +12,31 @@
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 import re
-from typing import Any, Dict, Optional, Union
+from typing import Dict, Optional, Union
 
 from camel.agents.chat_agent import ChatAgent
 from camel.messages import BaseMessage
+from camel.models import BaseModelBackend
 from camel.prompts import TextPrompt
-from camel.types import ModelType, RoleType
+from camel.types import RoleType
 
 
 class RoleAssignmentAgent(ChatAgent):
     r"""An agent that generates role names based on the task prompt.
+
+    Args:
+        model (BaseModelBackend, optional): The model backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
+
     Attributes:
         role_assignment_prompt (TextPrompt): A prompt for the agent to generate
         role names.
-
-    Args:
-        model_type (ModelType, optional): The type of model to use for the
-            agent. (default: :obj:`ModelType.GPT_3_5_TURBO`)
-        model_config (Any, optional): The configuration for the model.
-            (default: :obj:`None`)
     """
 
     def __init__(
         self,
-        model_type: ModelType = ModelType.GPT_3_5_TURBO,
-        model_config: Optional[Any] = None,
+        model: Optional[BaseModelBackend] = None,
     ) -> None:
         system_message = BaseMessage(
             role_name="Role Assigner",
@@ -44,7 +44,7 @@ class RoleAssignmentAgent(ChatAgent):
             meta_dict=None,
             content="You assign roles based on tasks.",
         )
-        super().__init__(system_message, model_type, model_config)
+        super().__init__(system_message, model=model)
 
     def run(
         self,
@@ -115,7 +115,9 @@ class RoleAssignmentAgent(ChatAgent):
         ]
 
         if len(role_names) != num_roles or len(role_descriptions) != num_roles:
-            raise RuntimeError("Got None or insufficient information of roles.")
+            raise RuntimeError(
+                "Got None or insufficient information of roles."
+            )
         if terminated:
             raise RuntimeError("Role assignment failed.")
 

camel/agents/search_agent.py

@@ -0,0 +1,122 @@
+# =========== Copyright 2023 @ 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+from typing import Optional
+
+from camel.agents.chat_agent import ChatAgent
+from camel.messages import BaseMessage
+from camel.models import BaseModelBackend
+from camel.prompts import TextPrompt
+from camel.types import RoleType
+from camel.utils import create_chunks
+
+
+class SearchAgent(ChatAgent):
+    r"""An agent that summarizes text based on a query and evaluates the
+    relevance of an answer.
+
+    Args:
+        model_type (ModelType, optional): The type of model to use for the
+            agent. (default: :obj:`ModelType.GPT_3_5_TURBO`)
+        model_config (Any, optional): The configuration for the model.
+            (default: :obj:`None`)
+    """
+
+    def __init__(
+        self,
+        model: Optional[BaseModelBackend] = None,
+    ) -> None:
+        system_message = BaseMessage(
+            role_name="Assistant",
+            role_type=RoleType.ASSISTANT,
+            meta_dict=None,
+            content="You are a helpful assistant.",
+        )
+        super().__init__(system_message, model=model)
+
+    def summarize_text(self, text: str, query: str) -> str:
+        r"""Summarize the information from the text, base on the query.
+
+        Args:
+            text (str): Text to summarize.
+            query (str): What information you want.
+
+        Returns:
+            str: Strings with information.
+        """
+        self.reset()
+
+        summary_prompt = TextPrompt(
+            '''Gather information from this text that relative to the
+            question, but do not directly answer the question.\nquestion:
+            {query}\ntext '''
+        )
+        summary_prompt = summary_prompt.format(query=query)
+        # Max length of each chunk
+        max_len = 3000
+        results = ""
+        chunks = create_chunks(text, max_len)
+        # Summarize
+        for i, chunk in enumerate(chunks, start=1):
+            prompt = summary_prompt + str(i) + ": " + chunk
+            user_msg = BaseMessage.make_user_message(
+                role_name="User",
+                content=prompt,
+            )
+            result = self.step(user_msg).msg.content
+            results += result + "\n"
+
+        # Final summarise
+        final_prompt = TextPrompt(
+            '''Here are some summarized texts which split from one text. Using
+            the information to answer the question. If can't find the answer,
+            you must answer "I can not find the answer to the query" and
+            explain why.\n Query:\n{query}.\n\nText:\n'''
+        )
+        final_prompt = final_prompt.format(query=query)
+        prompt = final_prompt + results
+
+        user_msg = BaseMessage.make_user_message(
+            role_name="User",
+            content=prompt,
+        )
+        response = self.step(user_msg).msg.content
+
+        return response
+
+    def continue_search(self, query: str, answer: str) -> bool:
+        r"""Ask whether to continue search or not based on the provided answer.
+
+        Args:
+            query (str): The question.
+            answer (str): The answer to the question.
+
+        Returns:
+            bool: `True` if the user want to continue search, `False`
+            otherwise.
+        """
+        prompt = TextPrompt(
+            "Do you think the ANSWER can answer the QUERY? "
+            "Use only 'yes' or 'no' to answer.\n"
+            "===== QUERY =====\n{query}\n\n"
+            "===== ANSWER =====\n{answer}"
+        )
+        prompt = prompt.format(query=query, answer=answer)
+        user_msg = BaseMessage.make_user_message(
+            role_name="User",
+            content=prompt,
+        )
+        response = self.step(user_msg).msg.content
+        if "yes" in str(response).lower():
+            return False
+        return True

camel/agents/task_agent.py

@@ -14,10 +14,10 @@
 from typing import Any, Dict, List, Optional, Union
 
 from camel.agents.chat_agent import ChatAgent
-from camel.configs import ChatGPTConfig
 from camel.messages import BaseMessage
+from camel.models import BaseModelBackend
 from camel.prompts import PromptTemplateGenerator, TextPrompt
-from camel.types import ModelType, RoleType, TaskType
+from camel.types import RoleType, TaskType
 from camel.utils import get_task_list
 
 
@@ -30,27 +30,25 @@ class TaskSpecifyAgent(ChatAgent):
         task_specify_prompt (TextPrompt): The prompt for specifying the task.
 
     Args:
-        model_type (ModelType, optional): The type of model to use for the
-            agent. (default: :obj:`ModelType.GPT_3_5_TURBO`)
+        model (BaseModelBackend, optional): The model backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
         task_type (TaskType, optional): The type of task for which to generate
             a prompt. (default: :obj:`TaskType.AI_SOCIETY`)
-        model_config (Any, optional): The configuration for the model.
-            (default: :obj:`None`)
         task_specify_prompt (Union[str, TextPrompt], optional): The prompt for
             specifying the task. (default: :obj:`None`)
         word_limit (int, optional): The word limit for the task prompt.
             (default: :obj:`50`)
         output_language (str, optional): The language to be output by the
-        agent. (default: :obj:`None`)
+            agent. (default: :obj:`None`)
     """
 
     DEFAULT_WORD_LIMIT = 50
 
     def __init__(
         self,
-        model_type: Optional[ModelType] = None,
+        model: Optional[BaseModelBackend] = None,
         task_type: TaskType = TaskType.AI_SOCIETY,
-        model_config: Optional[Any] = None,
         task_specify_prompt: Optional[Union[str, TextPrompt]] = None,
         word_limit: int = DEFAULT_WORD_LIMIT,
         output_language: Optional[str] = None,
@@ -67,8 +65,6 @@ class TaskSpecifyAgent(ChatAgent):
         else:
             self.task_specify_prompt = TextPrompt(task_specify_prompt)
 
-        model_config = model_config or ChatGPTConfig(temperature=1.0)
-
         system_message = BaseMessage(
             role_name="Task Specifier",
             role_type=RoleType.ASSISTANT,
@@ -78,8 +74,7 @@ class TaskSpecifyAgent(ChatAgent):
 
         super().__init__(
             system_message,
-            model_type=model_type,
-            model_config=model_config,
+            model=model,
             output_language=output_language,
         )
 
@@ -130,18 +125,16 @@ class TaskPlannerAgent(ChatAgent):
             the task into subtasks.
 
     Args:
-        model_type (ModelType, optional): The type of model to use for the
-            agent. (default: :obj:`ModelType.GPT_3_5_TURBO`)
-        model_config (Any, optional): The configuration for the model.
-            (default: :obj:`None`)
+        model (BaseModelBackend, optional): The model backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
         output_language (str, optional): The language to be output by the
-        agent. (default: :obj:`None`)
+            agent. (default: :obj:`None`)
     """
 
     def __init__(
         self,
-        model_type: Optional[ModelType] = None,
-        model_config: Optional[Any] = None,
+        model: Optional[BaseModelBackend] = None,
         output_language: Optional[str] = None,
     ) -> None:
         self.task_planner_prompt = TextPrompt(
@@ -156,8 +149,7 @@ class TaskPlannerAgent(ChatAgent):
 
         super().__init__(
             system_message,
-            model_type,
-            model_config,
+            model=model,
             output_language=output_language,
         )
 
@@ -208,10 +200,9 @@ class TaskCreationAgent(ChatAgent):
         role_name (str): The role name of the Agent to create the task.
         objective (Union[str, TextPrompt]): The objective of the Agent to
             perform the task.
-        model_type (ModelType, optional): The type of model to use for the
-            agent. (default: :obj:`ModelType.GPT_3_5_TURBO`)
-        model_config (Any, optional): The configuration for the model.
-            (default: :obj:`None`)
+        model (BaseModelBackend, optional): The LLM backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
         output_language (str, optional): The language to be output by the
             agent. (default: :obj:`None`)
         message_window_size (int, optional): The maximum number of previous
@@ -225,8 +216,7 @@ class TaskCreationAgent(ChatAgent):
         self,
         role_name: str,
         objective: Union[str, TextPrompt],
-        model_type: Optional[ModelType] = None,
-        model_config: Optional[Any] = None,
+        model: Optional[BaseModelBackend] = None,
         output_language: Optional[str] = None,
         message_window_size: Optional[int] = None,
         max_task_num: Optional[int] = 3,
@@ -266,8 +256,7 @@ Be concrete.
 
         super().__init__(
             system_message,
-            model_type,
-            model_config,
+            model=model,
             output_language=output_language,
             message_window_size=message_window_size,
         )
@@ -282,6 +271,7 @@ Be concrete.
         Args:
             task_list (List[str]): The completed or in-progress
                 tasks which should not overlap with new created tasks.
+
         Returns:
             List[str]: The new task list generated by the Agent.
         """
@@ -321,10 +311,9 @@ class TaskPrioritizationAgent(ChatAgent):
     Args:
         objective (Union[str, TextPrompt]): The objective of the Agent to
             perform the task.
-        model_type (ModelType, optional): The type of model to use for the
-            agent. (default: :obj:`ModelType.GPT_3_5_TURBO`)
-        model_config (Any, optional): The configuration for the model.
-            (default: :obj:`None`)
+        model (BaseModelBackend, optional): The LLM backend to use for
+            generating responses. (default: :obj:`OpenAIModel` with
+            `GPT_3_5_TURBO`)
         output_language (str, optional): The language to be output by the
             agent. (default: :obj:`None`)
         message_window_size (int, optional): The maximum number of previous
@@ -335,8 +324,7 @@ class TaskPrioritizationAgent(ChatAgent):
     def __init__(
         self,
         objective: Union[str, TextPrompt],
-        model_type: Optional[ModelType] = None,
-        model_config: Optional[Any] = None,
+        model: Optional[BaseModelBackend] = None,
         output_language: Optional[str] = None,
         message_window_size: Optional[int] = None,
     ) -> None:
@@ -372,8 +360,7 @@ with any other output."""
 
         super().__init__(
             system_message,
-            model_type,
-            model_config,
+            model=model,
             output_language=output_language,
             message_window_size=message_window_size,
         )
@@ -386,6 +373,7 @@ with any other output."""
 
         Args:
             task_list (List[str]): The unprioritized tasks of agent.
+
         Returns:
             List[str]: The new prioritized task list generated by the Agent.
         """

camel/bots/__init__.py

@@ -0,0 +1,20 @@
+# =========== Copyright 2023 @ 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+from .discord_bot import DiscordBot
+from .telegram_bot import TelegramBot
+
+__all__ = [
+    'DiscordBot',
+    'TelegramBot',
+]