chore: Rename tool call instances

camel/agents/chat_agent.py

@@ -86,18 +86,18 @@
     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 @@ def __str__(self) -> str:
         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 @@ def get_info(
         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 @@ def get_info(
             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):
@@ -645,7 +645,7 @@ def _handle_step(
             )
 
         # Record function calls made during the session
-        tool_call_records: List[FunctionCallingRecord] = []
+        tool_call_records: List[ToolCallingRecord] = []
 
         external_tool_request = None
 
@@ -885,7 +885,7 @@ async def step_async(
 
         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 +970,7 @@ async def step_async(
 
     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 +980,7 @@ def _step_tool_call_and_update(
                 completion.
 
         Returns:
-            FunctionCallingRecord: The record of calling the function.
+            ToolCallingRecord: The record of calling the function.
         """
 
         # Perform function calling
@@ -996,7 +996,7 @@ def _step_tool_call_and_update(
 
     async def _step_tool_call_and_update_async(
         self, response: ChatCompletion
-    ) -> FunctionCallingRecord:
+    ) -> ToolCallingRecord:
         (
             func_assistant_msg,
             func_result_msg,
@@ -1015,7 +1015,7 @@ def _structure_output_with_function(
         List[str],
         Dict[str, int],
         str,
-        FunctionCallingRecord,
+        ToolCallingRecord,
         int,
     ]:
         r"""Internal function of structuring the output of the agent based on
@@ -1027,7 +1027,7 @@ def _structure_output_with_function(
 
         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 +1141,7 @@ def _step_get_info(
         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 +1160,7 @@ def _step_get_info(
             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,15 +1335,15 @@ def handle_stream_response(
     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
         of called functions when the number of tokens exceeds.
 
         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 +1372,7 @@ def _step_tool_call(
         self,
         response: ChatCompletion,
     ) -> Tuple[
-        FunctionCallingMessage, FunctionCallingMessage, FunctionCallingRecord
+        FunctionCallingMessage, FunctionCallingMessage, ToolCallingRecord
     ]:
         r"""Execute the function with arguments following the model's response.
 
@@ -1389,12 +1389,12 @@ def _step_tool_call(
         choice = response.choices[0]
         if choice.message.tool_calls is None:
             raise RuntimeError("Tool call is None")
-        func_name = choice.message.tool_calls[0].function.name
+        tool_name = choice.message.tool_calls[0].function.name
 
         arguments_str = choice.message.tool_calls[0].function.arguments
         args = self._safe_json_loads(arguments_str)
 
-        tool = self.tool_dict[func_name]
+        tool = self.tool_dict[tool_name]
         result = tool(**args)
         tool_call_id = choice.message.tool_calls[0].id
 
@@ -1403,7 +1403,7 @@ def _step_tool_call(
             role_type=self.role_type,
             meta_dict=None,
             content="",
-            func_name=func_name,
+            func_name=tool_name,
             args=args,
             tool_call_id=tool_call_id,
         )
@@ -1412,14 +1412,14 @@ def _step_tool_call(
             role_type=self.role_type,
             meta_dict=None,
             content="",
-            func_name=func_name,
+            func_name=tool_name,
             result=result,
             tool_call_id=tool_call_id,
         )
 
         # Record information about this function call
-        func_record = FunctionCallingRecord(
-            func_name=func_name,
+        func_record = ToolCallingRecord(
+            tool_name=tool_name,
             args=args,
             result=result,
             tool_call_id=tool_call_id,
@@ -1442,7 +1442,7 @@ async def step_tool_call_async(
         self,
         response: ChatCompletion,
     ) -> Tuple[
-        FunctionCallingMessage, FunctionCallingMessage, FunctionCallingRecord
+        FunctionCallingMessage, FunctionCallingMessage, ToolCallingRecord
     ]:
         r"""Execute the async function with arguments following the model's
         response.
@@ -1461,10 +1461,10 @@ async def step_tool_call_async(
         choice = response.choices[0]
         if choice.message.tool_calls is None:
             raise RuntimeError("Tool call is None")
-        func_name = choice.message.tool_calls[0].function.name
+        tool_name = choice.message.tool_calls[0].function.name
 
         args = json.loads(choice.message.tool_calls[0].function.arguments)
-        tool = self.tool_dict[func_name]
+        tool = self.tool_dict[tool_name]
         result = await tool(**args)
         tool_call_id = choice.message.tool_calls[0].id
 
@@ -1473,7 +1473,7 @@ async def step_tool_call_async(
             role_type=self.role_type,
             meta_dict=None,
             content="",
-            func_name=func_name,
+            func_name=tool_name,
             args=args,
             tool_call_id=tool_call_id,
         )
@@ -1482,14 +1482,14 @@ async def step_tool_call_async(
             role_type=self.role_type,
             meta_dict=None,
             content="",
-            func_name=func_name,
+            func_name=tool_name,
             result=result,
             tool_call_id=tool_call_id,
         )
 
         # Record information about this function call
-        func_record = FunctionCallingRecord(
-            func_name=func_name,
+        func_record = ToolCallingRecord(
+            tool_name=tool_name,
             args=args,
             result=result,
             tool_call_id=tool_call_id,

docs/cookbooks/advanced_features/agents_tracking.ipynb

@@ -356,7 +356,7 @@
         "\n",
         "from colorama import Fore\n",
         "\n",
-        "from camel.agents.chat_agent import FunctionCallingRecord\n",
+        "from camel.agents.chat_agent import ToolCallingRecord\n",
         "from camel.configs import ChatGPTConfig\n",
         "from camel.models import ModelFactory\n",
         "from camel.societies import RolePlaying\n",
@@ -765,7 +765,7 @@
         "    # Print output from the assistant, including any function\n",
         "    # execution information\n",
         "    print_text_animated(Fore.GREEN + \"AI Assistant:\")\n",
-        "    tool_calls: List[FunctionCallingRecord] = assistant_response.info[\n",
+        "    tool_calls: List[ToolCallingRecord] = assistant_response.info[\n",
         "        'tool_calls'\n",
         "    ]\n",
         "    for func_record in tool_calls:\n",

docs/cookbooks/advanced_features/agents_with_rag.ipynb

@@ -474,7 +474,7 @@
         "from typing import List\n",
         "from colorama import Fore\n",
         "\n",
-        "from camel.agents.chat_agent import FunctionCallingRecord\n",
+        "from camel.agents.chat_agent import ToolCallingRecord\n",
         "from camel.configs import ChatGPTConfig\n",
         "from camel.toolkits import (\n",
         "    MathToolkit,\n",
@@ -568,8 +568,8 @@
         "        # Print output from the assistant, including any function\n",
         "        # execution information\n",
         "        print_text_animated(Fore.GREEN + \"AI Assistant:\")\n",
-        "        tool_calls: List[FunctionCallingRecord] = [\n",
-        "            FunctionCallingRecord(**call.as_dict())\n",
+        "        tool_calls: List[ToolCallingRecord] = [\n",
+        "            ToolCallingRecord(**call.as_dict())\n",
         "            for call in assistant_response.info['tool_calls']\n",
         "        ]\n",
         "        for func_record in tool_calls:\n",

docs/cookbooks/advanced_features/agents_with_tools.ipynb

@@ -378,7 +378,7 @@
       "outputs": [],
       "source": [
         "from camel.societies import RolePlaying\n",
-        "from camel.agents.chat_agent import FunctionCallingRecord\n",
+        "from camel.agents.chat_agent import ToolCallingRecord\n",
         "from camel.utils import print_text_animated\n",
         "from colorama import Fore"
       ]
@@ -566,7 +566,7 @@
         "    # Print output from the assistant, including any function\n",
         "    # execution information\n",
         "    print_text_animated(Fore.GREEN + \"AI Assistant:\")\n",
-        "    tool_calls: list[FunctionCallingRecord] = assistant_response.info[\n",
+        "    tool_calls: list[ToolCallingRecord] = assistant_response.info[\n",
         "        'tool_calls'\n",
         "    ]\n",
         "    for func_record in tool_calls:\n",

docs/cookbooks/advanced_features/agents_with_tools_from_Composio.ipynb

@@ -235,7 +235,7 @@
     "from colorama import Fore\n",
     "from composio_camel import Action, ComposioToolSet\n",
     "\n",
-    "from camel.agents.chat_agent import FunctionCallingRecord\n",
+    "from camel.agents.chat_agent import ToolCallingRecord\n",
     "from camel.configs import ChatGPTConfig\n",
     "from camel.models import ModelFactory\n",
     "from camel.societies import RolePlaying\n",
@@ -486,7 +486,7 @@
     "    # Print output from the assistant, including any function\n",
     "    # execution information\n",
     "    print_text_animated(Fore.GREEN + \"AI Assistant:\")\n",
-    "    tool_calls: List[FunctionCallingRecord] = assistant_response.info[\n",
+    "    tool_calls: List[ToolCallingRecord] = assistant_response.info[\n",
     "        'tool_calls'\n",
     "    ]\n",
     "    for func_record in tool_calls:\n",

docs/cookbooks/applications/dynamic_travel_planner.ipynb

@@ -379,7 +379,7 @@
         "\n",
         "from colorama import Fore\n",
         "\n",
-        "from camel.agents.chat_agent import FunctionCallingRecord\n",
+        "from camel.agents.chat_agent import ToolCallingRecord\n",
         "from camel.societies import RolePlaying\n",
         "from camel.toolkits import FunctionTool\n",
         "from camel.utils import print_text_animated"
@@ -896,8 +896,8 @@
         "    # Print output from the assistant, including any function\n",
         "    # execution information\n",
         "    print_text_animated(Fore.GREEN + \"AI Assistant:\", 0.01)\n",
-        "    tool_calls: List[FunctionCallingRecord] = [\n",
-        "        FunctionCallingRecord(**call.as_dict())\n",
+        "    tool_calls: List[ToolCallingRecord] = [\n",
+        "        ToolCallingRecord(**call.as_dict())\n",
         "        for call in assistant_response.info['tool_calls']\n",
         "    ]\n",
         "    for func_record in tool_calls:\n",

docs/cookbooks/applications/roleplaying_scraper.ipynb

@@ -840,7 +840,7 @@
         "\n",
         "from colorama import Fore\n",
         "\n",
-        "from camel.agents.chat_agent import FunctionCallingRecord\n",
+        "from camel.agents.chat_agent import ToolCallingRecord\n",
         "from camel.societies import RolePlaying\n",
         "from camel.utils import print_text_animated"
       ]
@@ -1288,8 +1288,8 @@
         "    # Print output from the assistant, including any function\n",
         "    # execution information\n",
         "    print_text_animated(Fore.GREEN + \"AI Assistant:\", 0.01)\n",
-        "    tool_calls: List[FunctionCallingRecord] = [\n",
-        "        FunctionCallingRecord(**call.as_dict())\n",
+        "    tool_calls: List[ToolCallingRecord] = [\n",
+        "        ToolCallingRecord(**call.as_dict())\n",
         "        for call in assistant_response.info['tool_calls']\n",
         "    ]\n",
         "    for func_record in tool_calls:\n",

examples/models/role_playing_with_cohere.py

@@ -15,7 +15,7 @@
 
 from colorama import Fore
 
-from camel.agents.chat_agent import FunctionCallingRecord
+from camel.agents.chat_agent import ToolCallingRecord
 from camel.configs import CohereConfig
 from camel.models import ModelFactory
 from camel.societies import RolePlaying
@@ -120,8 +120,8 @@ def main(
         # Print output from the assistant, including any function
         # execution information
         print_text_animated(Fore.GREEN + "AI Assistant:")
-        tool_calls: List[FunctionCallingRecord] = [
-            FunctionCallingRecord(**call.as_dict())
+        tool_calls: List[ToolCallingRecord] = [
+            ToolCallingRecord(**call.as_dict())
             for call in assistant_response.info['tool_calls']
         ]
         for func_record in tool_calls: