camel-ai 0.2.18__tar.gz → 0.2.20__tar.gz

{camel_ai-0.2.18 → camel_ai-0.2.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: camel-ai
-Version: 0.2.18
+Version: 0.2.20
 Summary: Communicative Agents for AI Society Study
 License: Apache-2.0
 Keywords: communicative-ai,ai-societies,artificial-intelligence,deep-learning,multi-agent-systems,cooperative-ai,natural-language-processing,large-language-models
@@ -37,7 +37,7 @@ Requires-Dist: azure-storage-blob (>=12.21.0,<13.0.0) ; extra == "storage" or ex
 Requires-Dist: beautifulsoup4 (>=4,<5) ; extra == "document-tools" or extra == "all"
 Requires-Dist: botocore (>=1.35.3,<2.0.0) ; extra == "storage" or extra == "all"
 Requires-Dist: cohere (>=5.11.0,<6.0.0) ; extra == "rag" or extra == "model-platforms" or extra == "all"
-Requires-Dist: colorama (>=0,<1)
+Requires-Dist: colorama (>=0.4.6,<0.5.0)
 Requires-Dist: curl_cffi (==0.6.2)
 Requires-Dist: dappier (>=0.3.3,<0.4.0) ; extra == "web-tools" or extra == "all"
 Requires-Dist: datacommons (>=1.4.3,<2.0.0) ; extra == "data-tools" or extra == "all"
@@ -55,7 +55,6 @@ Requires-Dist: ffmpeg-python (>=0.2.0,<0.3.0) ; extra == "media-tools" or extra
 Requires-Dist: firecrawl-py (>=1.0.0,<2.0.0) ; extra == "web-tools" or extra == "all"
 Requires-Dist: fish-audio-sdk (>=2024.12.5,<2025.0.0) ; extra == "model-platforms" or extra == "all"
 Requires-Dist: google-cloud-storage (>=2.18.0,<3.0.0) ; extra == "storage" or extra == "all"
-Requires-Dist: google-generativeai (>=0.6.0,<0.7.0) ; extra == "model-platforms" or extra == "all"
 Requires-Dist: googlemaps (>=4.10.0,<5.0.0) ; extra == "web-tools" or extra == "all"
 Requires-Dist: httpx (>=0.23.0,<0.27.3)
 Requires-Dist: imageio[pyav] (>=2.34.2,<3.0.0) ; extra == "media-tools" or extra == "all"
@@ -70,21 +69,21 @@ Requires-Dist: nebula3-python (==3.8.2) ; extra == "rag" or extra == "storage" o
 Requires-Dist: neo4j (>=5.18.0,<6.0.0) ; extra == "rag" or extra == "storage" or extra == "all"
 Requires-Dist: newspaper3k (>=0.2.8,<0.3.0) ; extra == "web-tools" or extra == "all"
 Requires-Dist: notion-client (>=2.2.1,<3.0.0) ; extra == "communication-tools" or extra == "all"
-Requires-Dist: numpy (>=1,<2)
-Requires-Dist: openai (>=1.58.1,<2.0.0)
+Requires-Dist: numpy (>=1.26,<2.0)
+Requires-Dist: openai (>=1.59.7,<2.0.0)
 Requires-Dist: openapi-spec-validator (>=0.7.1,<0.8.0) ; extra == "document-tools" or extra == "all"
 Requires-Dist: openbb (>=4.3.5,<5.0.0) ; extra == "data-tools" or extra == "all"
 Requires-Dist: opencv-python (>=4,<5) ; extra == "huggingface" or extra == "all"
 Requires-Dist: outlines (>=0.1.7,<0.2.0) ; extra == "all"
 Requires-Dist: pandas (>=1.5.3,<2.0.0) ; extra == "data-tools" or extra == "all"
 Requires-Dist: pandasai (>=2.3.0,<3.0.0) ; extra == "rag" or extra == "document-tools" or extra == "all"
-Requires-Dist: pandoc
-Requires-Dist: pathlib (>=1.0.1,<2.0.0)
+Requires-Dist: pandoc (>=2.4,<3.0)
 Requires-Dist: pdfplumber (>=0.11.0,<0.12.0) ; extra == "document-tools" or extra == "all"
 Requires-Dist: pillow (>=10.1.0,<11.0.0) ; extra == "media-tools" or extra == "all"
 Requires-Dist: prance (>=23.6.21.0,<24.0.0.0) ; extra == "document-tools" or extra == "all"
 Requires-Dist: praw (>=7.7.1,<8.0.0) ; extra == "communication-tools" or extra == "all"
-Requires-Dist: protobuf (>=4,<5)
+Requires-Dist: protobuf (>=5,<6)
+Requires-Dist: psutil (>=5.9.8,<6.0.0)
 Requires-Dist: pyTelegramBotAPI (>=4.18.0,<5.0.0) ; extra == "communication-tools" or extra == "all"
 Requires-Dist: pydantic (>=1.9,<2.10)
 Requires-Dist: pydub (>=0.25.1,<0.26.0) ; extra == "media-tools" or extra == "all"
@@ -95,7 +94,6 @@ Requires-Dist: pytest (>=7,<8) ; extra == "test"
 Requires-Dist: pytest-asyncio (>=0.23.0,<0.24.0) ; extra == "test"
 Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
 Requires-Dist: qdrant-client (>=1.9.0,<2.0.0) ; extra == "rag" or extra == "storage" or extra == "all"
-Requires-Dist: ragas (<=0.1.6) ; extra == "all"
 Requires-Dist: rank-bm25 (>=0.2.2,<0.3.0) ; extra == "rag" or extra == "all"
 Requires-Dist: redis (>=5.0.6,<6.0.0) ; extra == "storage" or extra == "all"
 Requires-Dist: reka-api (>=3.0.8,<4.0.0) ; extra == "model-platforms" or extra == "all"
@@ -103,12 +101,13 @@ Requires-Dist: requests_oauthlib (>=1.3.1,<2.0.0) ; extra == "web-tools" or extr
 Requires-Dist: rouge (>=1.0.1,<2.0.0) ; extra == "data-tools" or extra == "all"
 Requires-Dist: scholarly[tor] (==1.7.11) ; extra == "research-tools" or extra == "all"
 Requires-Dist: sentence-transformers (>=3.0.1,<4.0.0) ; extra == "rag" or extra == "all"
-Requires-Dist: sentencepiece (>=0,<1) ; extra == "huggingface" or extra == "all"
+Requires-Dist: sentencepiece (>=0.2,<0.3) ; extra == "huggingface" or extra == "all"
 Requires-Dist: sglang (>=0.4.0,<0.5.0) ; extra == "model-platforms" or extra == "all"
 Requires-Dist: slack-bolt (>=1.20.1,<2.0.0) ; extra == "communication-tools" or extra == "all"
 Requires-Dist: slack-sdk (>=3.27.2,<4.0.0) ; extra == "communication-tools" or extra == "all"
-Requires-Dist: soundfile (>=0,<1) ; extra == "huggingface" or extra == "all"
+Requires-Dist: soundfile (>=0.13,<0.14) ; extra == "huggingface" or extra == "all"
 Requires-Dist: stripe (>=11.3.0,<12.0.0) ; extra == "data-tools" or extra == "all"
+Requires-Dist: sympy (>=1.13.3,<2.0.0) ; extra == "web-tools" or extra == "all"
 Requires-Dist: tavily-python (>=0.5.0,<0.6.0) ; extra == "web-tools" or extra == "all"
 Requires-Dist: textblob (>=0.17.1,<0.18.0) ; extra == "data-tools" or extra == "all"
 Requires-Dist: tiktoken (>=0.7.0,<0.8.0)
@@ -408,7 +407,8 @@ Practical guides and tutorials for implementing specific functionalities in CAME
 | **[CoT Data Generation and SFT Qwen with Unsolth](https://docs.camel-ai.org/cookbooks/data_generation/cot_data_gen_sft_qwen_unsolth_upload_huggingface.html)** | Discover how to generate CoT data using CAMEL and SFT Qwen with Unsolth, and seamlessly upload your data and model to Huggingface. |
 | **[Agentic Data Generation, Evaluation & Filtering with Reward Models](https://docs.camel-ai.org/cookbooks/data_generation/synthetic_dataevaluation&filter_with_reward_model.html)** | Discover methods for generating, evaluating, and filtering agentic data using reward models to enhance the quality and efficiency of your synthetic data pipelines. |
 | **[Data Model Generation and Structured Output with Qwen Model](https://docs.camel-ai.org/cookbooks/data_generation/data_model_generation_and_structured_output_with_qwen.html)** |Learn how to generate data models and structured outputs using the Qwen Model for improved data representation.|
-
+| **[Distill Math Reasoning Data from DeepSeek R1](https://docs.camel-ai.org/cookbooks/data_generation/distill_math_reasoning_data_from_deepseek_r1.html)** |Learn  how to set up and leverage CAMEL's data distillation pipline for distilling high-quality maths reasoning data with thought process (Long CoT data)from deepseek R1, and uploading the results to Hugging Face.|
+| **[Self-Improving Math Reasoning Data Distillation from DeepSeek R1](https://docs.camel-ai.org/cookbooks/data_generation/self_improving_math_reasoning_data_distillation_from_deepSeek_r1.html)** |Learn how to set up and leverage CAMEL's data distillation pipline for self-improving math reasoning data distillation from deepseek R1, and uploading the results to Hugging Face.|
 
 ### Multi-Agent Systems & Applications
 | Cookbook | Description |
@@ -418,6 +418,7 @@ Practical guides and tutorials for implementing specific functionalities in CAME
 | **[Dynamic Travel Planner Role-Playing: Multi-Agent System with Real-Time Insights Powered by Dappier](https://docs.camel-ai.org/cookbooks/applications/dynamic_travel_planner.html)** | Explore an innovative approach to travel planning, blending AI-driven role-playing and real-time data for seamless experiences. |
 | **[Customer Service Discord Bot with Agentic RAG](https://docs.camel-ai.org/cookbooks/applications/customer_service_Discord_bot_using_SambaNova_with_agentic_RAG.html)** | Learn how to build a robust customer service bot for Discord using Agentic RAG. |
 | **[Customer Service Discord Bot with Local Model](https://docs.camel-ai.org/cookbooks/applications/customer_service_Discord_bot_using_local_model_with_agentic_RAG.html)** | Learn how to build a robust customer service bot for Discord using Agentic RAG which supports local deployment. |
+| **[Customer Service Discord Bot for Finance with OpenBB](https://docs.camel-ai.org/cookbooks/applications/finance_discord_bot.html)**| Learn how to build a sipmle yet powerful financial data assistant Discord bot using OpenBB tools. |
 
 ### Data Processing
 | Cookbook | Description |
@@ -456,6 +457,10 @@ We implemented amazing research ideas from other works for you to build, compare
 
 - `Self-Instruct` from *Yizhong Wang et al.*: [SELF-INSTRUCT: Aligning Language Models with Self-Generated Instructions](https://arxiv.org/pdf/2212.10560). [[Example](https://github.com/camel-ai/camel/blob/master/examples/datagen/self_instruct/self_instruct.py)]
 
+- `Source2Synth` from *Alisia Lupidi et al.*: [Source2Synth: Synthetic Data Generation and Curation Grounded in Real Data Sources](https://arxiv.org/abs/2409.08239). [[Example](https://github.com/camel-ai/camel/blob/master/examples/datagen/source2synth.py)]
+
+- `STaR` from *Eric Zelikman et al.*: [STaR: Bootstrapping Reasoning With Reasoning](https://arxiv.org/abs/2203.14465). [[Example](https://github.com/camel-ai/camel/blob/master/examples/datagen/star)]
+
 ## Other Research Works Based on Camel
 - [Agent Trust](http://agent-trust.camel-ai.org/): Can Large Language Model Agents Simulate Human Trust Behavior?
 

{camel_ai-0.2.18 → camel_ai-0.2.20}/README.md

@@ -280,7 +280,8 @@ Practical guides and tutorials for implementing specific functionalities in CAME
 | **[CoT Data Generation and SFT Qwen with Unsolth](https://docs.camel-ai.org/cookbooks/data_generation/cot_data_gen_sft_qwen_unsolth_upload_huggingface.html)** | Discover how to generate CoT data using CAMEL and SFT Qwen with Unsolth, and seamlessly upload your data and model to Huggingface. |
 | **[Agentic Data Generation, Evaluation & Filtering with Reward Models](https://docs.camel-ai.org/cookbooks/data_generation/synthetic_dataevaluation&filter_with_reward_model.html)** | Discover methods for generating, evaluating, and filtering agentic data using reward models to enhance the quality and efficiency of your synthetic data pipelines. |
 | **[Data Model Generation and Structured Output with Qwen Model](https://docs.camel-ai.org/cookbooks/data_generation/data_model_generation_and_structured_output_with_qwen.html)** |Learn how to generate data models and structured outputs using the Qwen Model for improved data representation.|
-
+| **[Distill Math Reasoning Data from DeepSeek R1](https://docs.camel-ai.org/cookbooks/data_generation/distill_math_reasoning_data_from_deepseek_r1.html)** |Learn  how to set up and leverage CAMEL's data distillation pipline for distilling high-quality maths reasoning data with thought process (Long CoT data)from deepseek R1, and uploading the results to Hugging Face.|
+| **[Self-Improving Math Reasoning Data Distillation from DeepSeek R1](https://docs.camel-ai.org/cookbooks/data_generation/self_improving_math_reasoning_data_distillation_from_deepSeek_r1.html)** |Learn how to set up and leverage CAMEL's data distillation pipline for self-improving math reasoning data distillation from deepseek R1, and uploading the results to Hugging Face.|
 
 ### Multi-Agent Systems & Applications
 | Cookbook | Description |
@@ -290,6 +291,7 @@ Practical guides and tutorials for implementing specific functionalities in CAME
 | **[Dynamic Travel Planner Role-Playing: Multi-Agent System with Real-Time Insights Powered by Dappier](https://docs.camel-ai.org/cookbooks/applications/dynamic_travel_planner.html)** | Explore an innovative approach to travel planning, blending AI-driven role-playing and real-time data for seamless experiences. |
 | **[Customer Service Discord Bot with Agentic RAG](https://docs.camel-ai.org/cookbooks/applications/customer_service_Discord_bot_using_SambaNova_with_agentic_RAG.html)** | Learn how to build a robust customer service bot for Discord using Agentic RAG. |
 | **[Customer Service Discord Bot with Local Model](https://docs.camel-ai.org/cookbooks/applications/customer_service_Discord_bot_using_local_model_with_agentic_RAG.html)** | Learn how to build a robust customer service bot for Discord using Agentic RAG which supports local deployment. |
+| **[Customer Service Discord Bot for Finance with OpenBB](https://docs.camel-ai.org/cookbooks/applications/finance_discord_bot.html)**| Learn how to build a sipmle yet powerful financial data assistant Discord bot using OpenBB tools. |
 
 ### Data Processing
 | Cookbook | Description |
@@ -328,6 +330,10 @@ We implemented amazing research ideas from other works for you to build, compare
 
 - `Self-Instruct` from *Yizhong Wang et al.*: [SELF-INSTRUCT: Aligning Language Models with Self-Generated Instructions](https://arxiv.org/pdf/2212.10560). [[Example](https://github.com/camel-ai/camel/blob/master/examples/datagen/self_instruct/self_instruct.py)]
 
+- `Source2Synth` from *Alisia Lupidi et al.*: [Source2Synth: Synthetic Data Generation and Curation Grounded in Real Data Sources](https://arxiv.org/abs/2409.08239). [[Example](https://github.com/camel-ai/camel/blob/master/examples/datagen/source2synth.py)]
+
+- `STaR` from *Eric Zelikman et al.*: [STaR: Bootstrapping Reasoning With Reasoning](https://arxiv.org/abs/2203.14465). [[Example](https://github.com/camel-ai/camel/blob/master/examples/datagen/star)]
+
 ## Other Research Works Based on Camel
 - [Agent Trust](http://agent-trust.camel-ai.org/): Can Large Language Model Agents Simulate Human Trust Behavior?
 

{camel_ai-0.2.18 → camel_ai-0.2.20}/camel/__init__.py

@@ -14,7 +14,7 @@
 
 from camel.logger import disable_logging, enable_logging, set_log_level
 
-__version__ = '0.2.18'
+__version__ = '0.2.20'
 
 __all__ = [
     '__version__',

{camel_ai-0.2.18 → camel_ai-0.2.20}/camel/agents/chat_agent.py

@@ -86,18 +86,18 @@ except (ImportError, AttributeError):
     from camel.utils import track_agent
 
 
-class FunctionCallingRecord(BaseModel):
-    r"""Historical records of functions called in the conversation.
+class ToolCallingRecord(BaseModel):
+    r"""Historical records of tools called in the conversation.
 
     Attributes:
-        func_name (str): The name of the function being called.
+        tool_name (str): The name of the tool being called.
         args (Dict[str, Any]): The dictionary of arguments passed to
-            the function.
-        result (Any): The execution result of calling this function.
+            the tools.
+        result (Any): The execution result of calling this tool.
         tool_call_id (str): The ID of the tool call, if available.
     """
 
-    func_name: str
+    tool_name: str
     args: Dict[str, Any]
     result: Any
     tool_call_id: str
@@ -106,10 +106,10 @@ class FunctionCallingRecord(BaseModel):
         r"""Overridden version of the string function.
 
         Returns:
-            str: Modified string to represent the function calling.
+            str: Modified string to represent the tool calling.
         """
         return (
-            f"Function Execution: {self.func_name}\n"
+            f"Tool Execution: {self.tool_name}\n"
             f"\tArgs: {self.args}\n"
             f"\tResult: {self.result}\n"
         )
@@ -489,7 +489,7 @@ class ChatAgent(BaseAgent):
         usage: Optional[Dict[str, int]],
         termination_reasons: List[str],
         num_tokens: int,
-        tool_calls: List[FunctionCallingRecord],
+        tool_calls: List[ToolCallingRecord],
         external_tool_request: Optional[ChatCompletionMessageToolCall] = None,
     ) -> Dict[str, Any]:
         r"""Returns a dictionary containing information about the chat session.
@@ -501,7 +501,7 @@ class ChatAgent(BaseAgent):
             termination_reasons (List[str]): The reasons for the termination
                 of the chat session.
             num_tokens (int): The number of tokens used in the chat session.
-            tool_calls (List[FunctionCallingRecord]): The list of function
+            tool_calls (List[ToolCallingRecord]): The list of function
                 calling records, containing the information of called tools.
             external_tool_request
                 (Optional[ChatCompletionMessageToolCall], optional):
@@ -573,9 +573,8 @@ class ChatAgent(BaseAgent):
             self.model_backend.model_config_dict.get("response_format")
             and response_format
         ):
-            raise ValueError(
-                "The `response_format` parameter cannot be set both in "
-                "the model configuration and in the ChatAgent step."
+            logger.warning(
+                f"Overriding the response format with {response_format}."
             )
 
         self.original_model_dict = self.model_backend.model_config_dict
@@ -645,7 +644,7 @@ class ChatAgent(BaseAgent):
             )
 
         # Record function calls made during the session
-        tool_call_records: List[FunctionCallingRecord] = []
+        tool_call_records: List[ToolCallingRecord] = []
 
         external_tool_request = None
 
@@ -885,7 +884,7 @@ class ChatAgent(BaseAgent):
 
         self.update_memory(input_message, OpenAIBackendRole.USER)
 
-        tool_call_records: List[FunctionCallingRecord] = []
+        tool_call_records: List[ToolCallingRecord] = []
         while True:
             try:
                 openai_messages, num_tokens = self.memory.get_context()
@@ -970,7 +969,7 @@ class ChatAgent(BaseAgent):
 
     def _step_tool_call_and_update(
         self, response: ChatCompletion
-    ) -> FunctionCallingRecord:
+    ) -> ToolCallingRecord:
         r"""Processes a function call within the chat completion response,
         records the function call in the provided list of tool calls and
         updates the memory of the current agent.
@@ -980,7 +979,7 @@ class ChatAgent(BaseAgent):
                 completion.
 
         Returns:
-            FunctionCallingRecord: The record of calling the function.
+            ToolCallingRecord: The record of calling the function.
         """
 
         # Perform function calling
@@ -996,7 +995,7 @@ class ChatAgent(BaseAgent):
 
     async def _step_tool_call_and_update_async(
         self, response: ChatCompletion
-    ) -> FunctionCallingRecord:
+    ) -> ToolCallingRecord:
         (
             func_assistant_msg,
             func_result_msg,
@@ -1015,7 +1014,7 @@ class ChatAgent(BaseAgent):
         List[str],
         Dict[str, int],
         str,
-        FunctionCallingRecord,
+        ToolCallingRecord,
         int,
     ]:
         r"""Internal function of structuring the output of the agent based on
@@ -1027,7 +1026,7 @@ class ChatAgent(BaseAgent):
 
         Returns:
             Tuple[List[BaseMessage], List[str], Dict[str, int], str,
-                FunctionCallingRecord, int]:
+                ToolCallingRecord, int]:
                 A tuple containing the output messages, finish reasons, usage
                 dictionary, response ID, function calling record, and number of
                 tokens.
@@ -1141,7 +1140,7 @@ class ChatAgent(BaseAgent):
         finish_reasons: List[str],
         usage_dict: Dict[str, int],
         response_id: str,
-        tool_calls: List[FunctionCallingRecord],
+        tool_calls: List[ToolCallingRecord],
         num_tokens: int,
         external_tool_request: Optional[ChatCompletionMessageToolCall] = None,
     ) -> Dict[str, Any]:
@@ -1160,7 +1159,7 @@ class ChatAgent(BaseAgent):
             usage_dict (Dict[str, int]): Dictionary containing token usage
                 information.
             response_id (str): The ID of the response from the model.
-            tool_calls (List[FunctionCallingRecord]): Records of function calls
+            tool_calls (List[ToolCallingRecord]): Records of function calls
                 made during this step.
             num_tokens (int): The number of tokens used in this step.
             external_tool_request (Optional[ChatCompletionMessageToolCall]):
@@ -1335,7 +1334,7 @@ class ChatAgent(BaseAgent):
     def _step_token_exceed(
         self,
         num_tokens: int,
-        tool_calls: List[FunctionCallingRecord],
+        tool_calls: List[ToolCallingRecord],
         termination_reason: str,
     ) -> ChatAgentResponse:
         r"""Return trivial response containing number of tokens and information
@@ -1343,7 +1342,7 @@ class ChatAgent(BaseAgent):
 
         Args:
             num_tokens (int): Number of tokens in the messages.
-            tool_calls (List[FunctionCallingRecord]): List of information
+            tool_calls (List[ToolCallingRecord]): List of information
                 objects of functions called in the current step.
             termination_reason (str): String of termination reason.
 
@@ -1372,7 +1371,7 @@ class ChatAgent(BaseAgent):
         self,
         response: ChatCompletion,
     ) -> Tuple[
-        FunctionCallingMessage, FunctionCallingMessage, FunctionCallingRecord
+        FunctionCallingMessage, FunctionCallingMessage, ToolCallingRecord
     ]:
         r"""Execute the function with arguments following the model's response.
 
@@ -1418,8 +1417,8 @@ class ChatAgent(BaseAgent):
         )
 
         # Record information about this function call
-        func_record = FunctionCallingRecord(
-            func_name=func_name,
+        func_record = ToolCallingRecord(
+            tool_name=func_name,
             args=args,
             result=result,
             tool_call_id=tool_call_id,
@@ -1442,7 +1441,7 @@ class ChatAgent(BaseAgent):
         self,
         response: ChatCompletion,
     ) -> Tuple[
-        FunctionCallingMessage, FunctionCallingMessage, FunctionCallingRecord
+        FunctionCallingMessage, FunctionCallingMessage, ToolCallingRecord
     ]:
         r"""Execute the async function with arguments following the model's
         response.
@@ -1488,8 +1487,8 @@ class ChatAgent(BaseAgent):
         )
 
         # Record information about this function call
-        func_record = FunctionCallingRecord(
-            func_name=func_name,
+        func_record = ToolCallingRecord(
+            tool_name=func_name,
             args=args,
             result=result,
             tool_call_id=tool_call_id,

{camel_ai-0.2.18 → camel_ai-0.2.20}/camel/agents/knowledge_graph_agent.py

@@ -165,11 +165,7 @@ class KnowledgeGraphAgent(ChatAgent):
             task=str(element)
         )
 
-        knowledge_graph_generation_msg = BaseMessage.make_user_message(
-            role_name="Graphify", content=knowledge_graph_generation
-        )
-
-        response = self.step(input_message=knowledge_graph_generation_msg)
+        response = self.step(input_message=knowledge_graph_generation)
 
         content = response.msg.content
 

{camel_ai-0.2.18 → camel_ai-0.2.20}/camel/agents/multi_hop_generator_agent.py

@@ -22,17 +22,36 @@ from camel.agents.programmed_agent_instruction import (
     ProgrammedAgentInstructionResult,
     programmable_capability,
 )
-from camel.messages import BaseMessage
-from camel.synthetic_datagen.source2synth.models import (
+from camel.datagen.source2synth.models import (
     ContextPrompt,
     MultiHopQA,
 )
+from camel.messages import BaseMessage
 
 
 class MultiHopGeneratorAgent(ProgrammableChatAgent):
+    r"""An agent specialized in generating multi-hop question-answer pairs.
+
+    This agent is designed to create complex questions that require multiple
+    steps of reasoning to answer. It analyzes context to identify related
+    facts and generates questions that require connecting these facts
+    logically.
+
+    Attributes:
+        model_config (ConfigDict): Configuration for model behavior.
+        system_message (BaseMessage): System message defining agent's role and
+            instructions.
+    """
+
     model_config = ConfigDict(arbitrary_types_allowed=True)
 
-    def __init__(self, **kwargs: Any):
+    def __init__(self, **kwargs: Any) -> None:
+        r"""Initialize the MultiHopGeneratorAgent.
+
+        Args:
+            **kwargs (Any): Additional keyword arguments to pass to parent
+                class.
+        """
         super().__init__(**kwargs)
 
         system_text: str = textwrap.dedent(
@@ -64,6 +83,19 @@ class MultiHopGeneratorAgent(ProgrammableChatAgent):
     def generate_multi_hop_qa(
         self, context: str
     ) -> ProgrammedAgentInstructionResult[MultiHopQA]:
+        r"""Generate a multi-hop question-answer pair from given context.
+
+        Args:
+            context (str): The input text context to generate QA from.
+
+        Returns:
+            ProgrammedAgentInstructionResult[MultiHopQA]: Result containing the
+                generated question, reasoning steps, answer, and supporting
+                facts.
+
+        Raises:
+            RuntimeError: If the agent fails to generate a response.
+        """
         context_prompt = ContextPrompt(
             main_context=context, related_contexts=None
         )

{camel_ai-0.2.18 → camel_ai-0.2.20}/camel/agents/programmed_agent_instruction.py

@@ -26,6 +26,16 @@ T = TypeVar('T')
 
 
 class ProgrammableAgentRequirement(Enum):
+    r"""Requirements for programmable agent state.
+
+    Defines the possible requirements that can be used to repair the state
+    of a programmable agent.
+
+    Attributes:
+        LAST_MESSAGE_NOT_USER (str): Requires that the last message in the
+            conversation was not from the user.
+    """
+
     LAST_MESSAGE_NOT_USER = "LAST_MESSAGE_NOT_USER"
 
 
@@ -34,6 +44,11 @@ class ProgrammedAgentInstructionResult(BaseModel, Generic[T]):
 
     Contains the messages exchanged during execution and the computed value.
     The value type is specified by the generic type parameter T.
+
+    Attributes:
+        user_message (BaseMessage): The message sent by the user.
+        agent_message (BaseMessage): The message sent by the agent.
+        value (T): The computed result value of type T.
     """
 
     user_message: BaseMessage
@@ -48,8 +63,7 @@ class AbstractProgrammableAgent(abc.ABC):
 
     A programmable agent is an agent that can be programmed to perform a
     specific function or task. This class defines the interface for a
-    programmable
-    agent.
+    programmable agent.
 
     These methods should be implemented in order to ensure the agent supports
     the necessary guarantees to enable a programming interface while
@@ -68,16 +82,15 @@ class AbstractProgrammableAgent(abc.ABC):
         An atomic operation is an operation that is guaranteed to
         be executed without interruption by any other operation.
 
-        If the operation fails or times out the agents state should be
-        unchanged.
+        Args:
+            callback (Callable[[], ProgrammedAgentInstructionResult[T]]): The
+                operation to execute atomically.
 
-        If an operation is already in progress, this method should throw an
-        exception. (It is up to the caller to do any queuing)
+        Returns:
+            ProgrammedAgentInstructionResult[T]: The result of the operation.
 
-        If the agent is in a state where it can perform the operation,
-        it must leave the agent in a state where it can perform the
-        operation again. Though if state changes in successful operation
-        improve its ability to perform the operation, it should keep them.
+        Raises:
+            RuntimeError: If an operation is already in progress.
         """
         raise NotImplementedError
 
@@ -86,10 +99,13 @@ class AbstractProgrammableAgent(abc.ABC):
         r"""Repair the state of the agent.
 
         Agents may have other non-atomic interfaces, such as a user interface,
-        or chat between other agents.
+        or chat between other agents. This method should restore the agent to
+        a state where it can perform operations according to the specified
+        requirement.
 
-        This method should restore the agent to a state where it can perform
-        operations according to the specified requirement.
+        Args:
+            requirement (ProgrammableAgentRequirement): The requirement to
+                repair the state for.
         """
         raise NotImplementedError
 
@@ -99,10 +115,16 @@ def programmable_capability(
 ) -> Callable[..., ProgrammedAgentInstructionResult[T]]:
     r"""Decorator for programmable agent capabilities.
 
-    Wraps a method to ensure it is executed atomically via the agent's
-    run_atomic interface.
-    The decorated method must return a ProgrammedAgentInstructionResult with
-    appropriate type parameter.
+    This decorator ensures that the decorated method is executed atomically
+    and maintains the agent's state guarantees.
+
+    Args:
+        func (Callable[..., ProgrammedAgentInstructionResult[T]]): The method
+            to decorate.
+
+    Returns:
+        Callable[..., ProgrammedAgentInstructionResult[T]]: The decorated
+            method that ensures atomic execution.
     """
 
     @wraps(func)
@@ -120,9 +142,20 @@ class ProgrammableChatAgent(ChatAgent, AbstractProgrammableAgent):
     Provides a default implementation of atomic execution using threading locks
     and basic state tracking for message roles. Implementing classes need to
     provide specific repair logic for their use cases.
+
+    Attributes:
+        _operation_lock (threading.Lock): Lock for ensuring atomic operations.
+        _last_message_role (Optional[str]): Role of the last message in the
+            conversation.
     """
 
-    def __init__(self, **kwargs: Any):
+    def __init__(self, **kwargs: Any) -> None:
+        r"""Initialize the ProgrammableChatAgent.
+
+        Args:
+            **kwargs (Any): Additional keyword arguments to pass to parent
+                class.
+        """
         super().__init__(**kwargs)
         self._operation_lock = threading.Lock()
         self._last_message_role: Optional[str] = None
@@ -130,6 +163,20 @@ class ProgrammableChatAgent(ChatAgent, AbstractProgrammableAgent):
     def run_atomic(
         self, callback: Callable[[], ProgrammedAgentInstructionResult[T]]
     ) -> ProgrammedAgentInstructionResult[T]:
+        r"""Run an atomic operation on the agent.
+
+        Ensures thread-safe execution of the callback function by using a lock.
+
+        Args:
+            callback (Callable[[], ProgrammedAgentInstructionResult[T]]): The
+                operation to execute atomically.
+
+        Returns:
+            ProgrammedAgentInstructionResult[T]: The result of the operation.
+
+        Raises:
+            RuntimeError: If an operation is already in progress.
+        """
         if not self._operation_lock.acquire(blocking=False):
             raise RuntimeError("Operation already in progress")
 
@@ -141,6 +188,14 @@ class ProgrammableChatAgent(ChatAgent, AbstractProgrammableAgent):
             self._operation_lock.release()
 
     def repair_state(self, requirement: ProgrammableAgentRequirement) -> None:
+        r"""Repair the state of the agent.
+
+        Implements basic state repair for message role requirements.
+
+        Args:
+            requirement (ProgrammableAgentRequirement): The requirement to
+                repair the state for.
+        """
         if requirement == ProgrammableAgentRequirement.LAST_MESSAGE_NOT_USER:
             if self._last_message_role == "user":
                 raise NotImplementedError(

{camel_ai-0.2.18 → camel_ai-0.2.20}/camel/benchmarks/apibench.py

@@ -24,7 +24,6 @@ from tree_sitter import Language, Parser
 
 from camel.agents import ChatAgent
 from camel.benchmarks.base import BaseBenchmark
-from camel.messages import BaseMessage
 from camel.utils import download_github_subdirectory
 
 logger = logging.getLogger(__name__)
@@ -281,12 +280,9 @@ class APIBenchBenchmark(BaseBenchmark):
         with open(self.save_to, "w") as f:
             for question in tqdm(datas, desc="Running"):
                 prompt = encode_question(question["text"], dataset_name)
-                msg = BaseMessage.make_user_message(
-                    role_name="User", content=prompt
-                )
                 try:
                     # Generate response
-                    responses = agent.step(msg)
+                    responses = agent.step(prompt)
                     response = responses.msgs[0].content
                     api_database = self._data['api']
                     qa_pairs = self._data['eval']

{camel_ai-0.2.18 → camel_ai-0.2.20}/camel/benchmarks/nexus.py

@@ -28,7 +28,6 @@ from tqdm import tqdm
 
 from camel.agents import ChatAgent
 from camel.benchmarks.base import BaseBenchmark
-from camel.messages import BaseMessage
 
 logger = logging.getLogger(__name__)
 
@@ -309,13 +308,10 @@ class NexusBenchmark(BaseBenchmark):
         with open(self.save_to, "w") as f:
             for sample in tqdm(datas, desc="Running"):
                 prompt = construct_prompt(input=sample.input, tools=tools)
-                msg = BaseMessage.make_user_message(
-                    role_name="User", content=prompt
-                )
                 ground_truth_call = sample.output
                 try:
                     # Generate response
-                    response = agent.step(msg)
+                    response = agent.step(prompt)
                     agent_call = response.msgs[0].content
 
                     # Evaluate response

{camel_ai-0.2.18 → camel_ai-0.2.20}/camel/benchmarks/ragbench.py

@@ -188,8 +188,8 @@ def ragas_evaluate_dataset(
     Returns:
         Dataset: Dataset with added evaluation metrics.
     """
-    from ragas import evaluate
-    from ragas.metrics import (  # type: ignore[import-untyped]
+    from ragas import evaluate  # type: ignore[import]
+    from ragas.metrics import (  # type: ignore[import]
         context_relevancy,
         faithfulness,
     )

{camel_ai-0.2.18 → camel_ai-0.2.20}/camel/bots/telegram_bot.py

@@ -15,7 +15,6 @@ import os
 from typing import TYPE_CHECKING, Optional
 
 from camel.agents import ChatAgent
-from camel.messages import BaseMessage
 from camel.utils import dependencies_required
 
 # Conditionally import telebot types only for type checking
@@ -74,9 +73,6 @@ class TelegramBot:
         if not message.text:
             return
 
-        user_msg = BaseMessage.make_user_message(
-            role_name="User", content=message.text
-        )
-        assistant_response = self.chat_agent.step(user_msg)
+        assistant_response = self.chat_agent.step(message.text)
 
         self.bot.reply_to(message, assistant_response.msg.content)