feat: Refactor OpenAIFunction to FunctionTool (#966)

Co-authored-by: Wendong <w3ndong.fan@gmail.com>
Co-authored-by: Wendong-Fan <133094783+Wendong-Fan@users.noreply.github.com>

Author: tom-doerr

camel/agents/chat_agent.py

@@ -63,7 +63,7 @@
     from openai import Stream
 
     from camel.terminators import ResponseTerminator
-    from camel.toolkits import OpenAIFunction
+    from camel.toolkits import FunctionTool
 
 
 logger = logging.getLogger(__name__)
@@ -131,10 +131,10 @@ class ChatAgent(BaseAgent):
             (default: :obj:`None`)
         output_language (str, optional): The language to be output by the
             agent. (default: :obj:`None`)
-        tools (List[OpenAIFunction], optional): List of available
-            :obj:`OpenAIFunction`. (default: :obj:`None`)
-        external_tools (List[OpenAIFunction], optional): List of external tools
-            (:obj:`OpenAIFunction`) bind to one chat agent. When these tools
+        tools (List[FunctionTool], optional): List of available
+            :obj:`FunctionTool`. (default: :obj:`None`)
+        external_tools (List[FunctionTool], optional): List of external tools
+            (:obj:`FunctionTool`) bind to one chat agent. When these tools
             are called, the agent will directly return the request instead of
             processing it. (default: :obj:`None`)
         response_terminators (List[ResponseTerminator], optional): List of
@@ -150,8 +150,8 @@ def __init__(
         message_window_size: Optional[int] = None,
         token_limit: Optional[int] = None,
         output_language: Optional[str] = None,
-        tools: Optional[List[OpenAIFunction]] = None,
-        external_tools: Optional[List[OpenAIFunction]] = None,
+        tools: Optional[List[FunctionTool]] = None,
+        external_tools: Optional[List[FunctionTool]] = None,
         response_terminators: Optional[List[ResponseTerminator]] = None,
     ) -> None:
         self.orig_sys_message: BaseMessage = system_message
@@ -795,12 +795,12 @@ def _structure_output_with_function(
         r"""Internal function of structuring the output of the agent based on
         the given output schema.
         """
-        from camel.toolkits import OpenAIFunction
+        from camel.toolkits import FunctionTool
 
         schema_json = get_pydantic_object_schema(output_schema)
         func_str = json_to_function_code(schema_json)
         func_callable = func_string_to_callable(func_str)
-        func = OpenAIFunction(func_callable)
+        func = FunctionTool(func_callable)
 
         original_func_dict = self.func_dict
         original_model_dict = self.model_backend.model_config_dict

camel/configs/base_config.py

@@ -39,13 +39,13 @@ class BaseConfig(ABC, BaseModel):
     @classmethod
     def fields_type_checking(cls, tools):
         if tools is not None:
-            from camel.toolkits import OpenAIFunction
+            from camel.toolkits import FunctionTool
 
             for tool in tools:
-                if not isinstance(tool, OpenAIFunction):
+                if not isinstance(tool, FunctionTool):
                     raise ValueError(
                         f"The tool {tool} should "
-                        "be an instance of `OpenAIFunction`."
+                        "be an instance of `FunctionTool`."
                     )
         return tools
 
@@ -54,14 +54,14 @@ def as_dict(self) -> dict[str, Any]:
 
         tools_schema = None
         if self.tools:
-            from camel.toolkits import OpenAIFunction
+            from camel.toolkits import FunctionTool
 
             tools_schema = []
             for tool in self.tools:
-                if not isinstance(tool, OpenAIFunction):
+                if not isinstance(tool, FunctionTool):
                     raise ValueError(
                         f"The tool {tool} should "
-                        "be an instance of `OpenAIFunction`."
+                        "be an instance of `FunctionTool`."
                     )
                 tools_schema.append(tool.get_openai_tool_schema())
         config_dict["tools"] = tools_schema

camel/configs/groq_config.py

@@ -73,7 +73,7 @@ class GroqConfig(BaseConfig):
         user (str, optional): A unique identifier representing your end-user,
             which can help OpenAI to monitor and detect abuse.
             (default: :obj:`""`)
-        tools (list[OpenAIFunction], optional): A list of tools the model may
+        tools (list[FunctionTool], optional): A list of tools the model may
             call. Currently, only functions are supported as a tool. Use this
             to provide a list of functions the model may generate JSON inputs
             for. A max of 128 functions are supported.

camel/configs/openai_config.py

@@ -81,7 +81,7 @@ class ChatGPTConfig(BaseConfig):
         user (str, optional): A unique identifier representing your end-user,
             which can help OpenAI to monitor and detect abuse.
             (default: :obj:`""`)
-        tools (list[OpenAIFunction], optional): A list of tools the model may
+        tools (list[FunctionTool], optional): A list of tools the model may
             call. Currently, only functions are supported as a tool. Use this
             to provide a list of functions the model may generate JSON inputs
             for. A max of 128 functions are supported.

camel/configs/samba_config.py

@@ -172,7 +172,7 @@ class SambaCloudAPIConfig(BaseConfig):
         user (str, optional): A unique identifier representing your end-user,
             which can help OpenAI to monitor and detect abuse.
             (default: :obj:`""`)
-        tools (list[OpenAIFunction], optional): A list of tools the model may
+        tools (list[FunctionTool], optional): A list of tools the model may
             call. Currently, only functions are supported as a tool. Use this
             to provide a list of functions the model may generate JSON inputs
             for. A max of 128 functions are supported.

camel/configs/zhipuai_config.py

@@ -45,7 +45,7 @@ class ZhipuAIConfig(BaseConfig):
             in the chat completion. The total length of input tokens and
             generated tokens is limited by the model's context length.
             (default: :obj:`None`)
-        tools (list[OpenAIFunction], optional): A list of tools the model may
+        tools (list[FunctionTool], optional): A list of tools the model may
             call. Currently, only functions are supported as a tool. Use this
             to provide a list of functions the model may generate JSON inputs
             for. A max of 128 functions are supported.

camel/messages/__init__.py

@@ -32,6 +32,7 @@
     'OpenAISystemMessage',
     'OpenAIAssistantMessage',
     'OpenAIUserMessage',
+    'OpenAIFunctionMessage',
     'OpenAIMessage',
     'BaseMessage',
     'FunctionCallingMessage',

camel/toolkits/__init__.py

@@ -12,7 +12,8 @@
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 # ruff: noqa: I001
-from .openai_function import (
+from .function_tool import (
+    FunctionTool,
     OpenAIFunction,
     get_openai_function_schema,
     get_openai_tool_schema,
@@ -35,6 +36,7 @@
 from .github_toolkit import GithubToolkit
 
 __all__ = [
+    'FunctionTool',
     'OpenAIFunction',
     'get_openai_function_schema',
     'get_openai_tool_schema',

camel/toolkits/base.py

@@ -16,9 +16,9 @@
 
 from camel.utils import AgentOpsMeta
 
-from .openai_function import OpenAIFunction
+from .function_tool import FunctionTool
 
 
 class BaseToolkit(metaclass=AgentOpsMeta):
-    def get_tools(self) -> List[OpenAIFunction]:
+    def get_tools(self) -> List[FunctionTool]:
         raise NotImplementedError("Subclasses must implement this method.")

camel/toolkits/code_execution.py

@@ -14,7 +14,7 @@
 from typing import List, Literal
 
 from camel.interpreters import InternalPythonInterpreter
-from camel.toolkits import OpenAIFunction
+from camel.toolkits import FunctionTool
 
 from .base import BaseToolkit
 
@@ -58,12 +58,12 @@ def execute_code(self, code: str) -> str:
             print(content)
         return content
 
-    def get_tools(self) -> List[OpenAIFunction]:
-        r"""Returns a list of OpenAIFunction objects representing the
+    def get_tools(self) -> List[FunctionTool]:
+        r"""Returns a list of FunctionTool objects representing the
         functions in the toolkit.
 
         Returns:
-            List[OpenAIFunction]: A list of OpenAIFunction objects
+            List[FunctionTool]: A list of FunctionTool objects
                 representing the functions in the toolkit.
         """
-        return [OpenAIFunction(self.execute_code)]
+        return [FunctionTool(self.execute_code)]