camel-ai 0.2.3__py3-none-any.whl → 0.2.3a0__py3-none-any.whl

camel/toolkits/linkedin_toolkit.py

@@ -19,7 +19,7 @@ from typing import List
 
 import requests
 
-from camel.toolkits import FunctionTool
+from camel.toolkits import OpenAIFunction
 from camel.toolkits.base import BaseToolkit
 from camel.utils import handle_http_error
 
@@ -194,18 +194,18 @@ class LinkedInToolkit(BaseToolkit):
 
         return profile_report
 
-    def get_tools(self) -> List[FunctionTool]:
-        r"""Returns a list of FunctionTool objects representing the
+    def get_tools(self) -> List[OpenAIFunction]:
+        r"""Returns a list of OpenAIFunction objects representing the
         functions in the toolkit.
 
         Returns:
-            List[FunctionTool]: A list of FunctionTool objects
+            List[OpenAIFunction]: A list of OpenAIFunction objects
                 representing the functions in the toolkit.
         """
         return [
-            FunctionTool(self.create_post),
-            FunctionTool(self.delete_post),
-            FunctionTool(self.get_profile),
+            OpenAIFunction(self.create_post),
+            OpenAIFunction(self.delete_post),
+            OpenAIFunction(self.get_profile),
         ]
 
     def _get_access_token(self) -> str:

camel/toolkits/math_toolkit.py

@@ -15,7 +15,7 @@
 from typing import List
 
 from camel.toolkits.base import BaseToolkit
-from camel.toolkits.function_tool import FunctionTool
+from camel.toolkits.openai_function import OpenAIFunction
 
 
 class MathToolkit(BaseToolkit):
@@ -61,19 +61,19 @@ class MathToolkit(BaseToolkit):
         """
         return a * b
 
-    def get_tools(self) -> List[FunctionTool]:
-        r"""Returns a list of FunctionTool objects representing the
+    def get_tools(self) -> List[OpenAIFunction]:
+        r"""Returns a list of OpenAIFunction objects representing the
         functions in the toolkit.
 
         Returns:
-            List[FunctionTool]: A list of FunctionTool objects
+            List[OpenAIFunction]: A list of OpenAIFunction objects
                 representing the functions in the toolkit.
         """
         return [
-            FunctionTool(self.add),
-            FunctionTool(self.sub),
-            FunctionTool(self.mul),
+            OpenAIFunction(self.add),
+            OpenAIFunction(self.sub),
+            OpenAIFunction(self.mul),
         ]
 
 
-MATH_FUNCS: List[FunctionTool] = MathToolkit().get_tools()
+MATH_FUNCS: List[OpenAIFunction] = MathToolkit().get_tools()

camel/toolkits/open_api_toolkit.py

@@ -17,7 +17,7 @@ from typing import Any, Callable, Dict, List, Optional, Tuple
 
 import requests
 
-from camel.toolkits import FunctionTool, openapi_security_config
+from camel.toolkits import OpenAIFunction, openapi_security_config
 from camel.types import OpenAPIName
 
 
@@ -526,12 +526,12 @@ class OpenAPIToolkit:
             apinames_filepaths.append((api_name.value, file_path))
         return apinames_filepaths
 
-    def get_tools(self) -> List[FunctionTool]:
-        r"""Returns a list of FunctionTool objects representing the
+    def get_tools(self) -> List[OpenAIFunction]:
+        r"""Returns a list of OpenAIFunction objects representing the
         functions in the toolkit.
 
         Returns:
-            List[FunctionTool]: A list of FunctionTool objects
+            List[OpenAIFunction]: A list of OpenAIFunction objects
                 representing the functions in the toolkit.
         """
         apinames_filepaths = self.generate_apinames_filepaths()
@@ -539,6 +539,6 @@ class OpenAPIToolkit:
             self.apinames_filepaths_to_funs_schemas(apinames_filepaths)
         )
         return [
-            FunctionTool(a_func, a_schema)
+            OpenAIFunction(a_func, a_schema)
             for a_func, a_schema in zip(all_funcs_lst, all_schemas_lst)
         ]

camel/toolkits/{function_tool.py → openai_function.py}

@@ -11,7 +11,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
-import warnings
 from inspect import Parameter, signature
 from typing import Any, Callable, Dict, Mapping, Optional, Tuple
 
@@ -143,7 +142,7 @@ def get_openai_tool_schema(func: Callable) -> Dict[str, Any]:
     return openai_tool_schema
 
 
-class FunctionTool:
+class OpenAIFunction:
     r"""An abstraction of a function that OpenAI chat models can call. See
     https://platform.openai.com/docs/api-reference/chat/create.
 
@@ -185,18 +184,17 @@ class FunctionTool:
         Raises:
             ValidationError: If the schema does not comply with the
                 specifications.
+            ValueError: If the function description or parameter descriptions
+                are missing in the schema.
             SchemaError: If the parameters do not meet JSON Schema reference
                 specifications.
         """
         # Check the type
         if not openai_tool_schema["type"]:
-            raise ValueError("miss `type` in tool schema.")
-
-        # Check the function description, if no description then raise warming
-        if not openai_tool_schema["function"].get("description"):
-            warnings.warn(f"""Function description is missing for 
-                          {openai_tool_schema['function']['name']}. This may 
-                          affect the quality of tool calling.""")
+            raise ValueError("miss type")
+        # Check the function description
+        if not openai_tool_schema["function"]["description"]:
+            raise ValueError("miss function description")
 
         # Validate whether parameters
         # meet the JSON Schema reference specifications.
@@ -209,15 +207,14 @@ class FunctionTool:
             JSONValidator.check_schema(parameters)
         except SchemaError as e:
             raise e
-
-        # Check the parameter description, if no description then raise warming
+        # Check the parameter description
         properties: Dict[str, Any] = parameters["properties"]
         for param_name in properties.keys():
             param_dict = properties[param_name]
             if "description" not in param_dict:
-                warnings.warn(f"""Parameter description is missing for 
-                            {param_dict}. This may affect the quality of tool 
-                            calling.""")
+                raise ValueError(
+                    f'miss description of parameter "{param_name}"'
+                )
 
     def get_openai_tool_schema(self) -> Dict[str, Any]:
         r"""Gets the OpenAI tool schema for this function.
@@ -390,23 +387,3 @@ class FunctionTool:
         except SchemaError as e:
             raise e
         self.openai_tool_schema["function"]["parameters"]["properties"] = value
-
-
-warnings.simplefilter('always', DeprecationWarning)
-
-
-# Alias for backwards compatibility
-class OpenAIFunction(FunctionTool):
-    def __init__(self, *args, **kwargs):
-        PURPLE = '\033[95m'
-        RESET = '\033[0m'
-
-        def purple_warning(msg):
-            warnings.warn(
-                PURPLE + msg + RESET, DeprecationWarning, stacklevel=2
-            )
-
-        purple_warning(
-            "OpenAIFunction is deprecated, please use FunctionTool instead."
-        )
-        super().__init__(*args, **kwargs)

camel/toolkits/reddit_toolkit.py

@@ -18,7 +18,7 @@ from typing import Any, Dict, List, Union
 
 from requests.exceptions import RequestException
 
-from camel.toolkits import FunctionTool
+from camel.toolkits import OpenAIFunction
 from camel.toolkits.base import BaseToolkit
 
 
@@ -219,16 +219,16 @@ class RedditToolkit(BaseToolkit):
             data = self.perform_sentiment_analysis(data)
         return data
 
-    def get_tools(self) -> List[FunctionTool]:
-        r"""Returns a list of FunctionTool objects representing the
+    def get_tools(self) -> List[OpenAIFunction]:
+        r"""Returns a list of OpenAIFunction objects representing the
         functions in the toolkit.
 
         Returns:
-            List[FunctionTool]: A list of FunctionTool objects for the
+            List[OpenAIFunction]: A list of OpenAIFunction objects for the
                 toolkit methods.
         """
         return [
-            FunctionTool(self.collect_top_posts),
-            FunctionTool(self.perform_sentiment_analysis),
-            FunctionTool(self.track_keyword_discussions),
+            OpenAIFunction(self.collect_top_posts),
+            OpenAIFunction(self.perform_sentiment_analysis),
+            OpenAIFunction(self.track_keyword_discussions),
         ]

camel/toolkits/retrieval_toolkit.py

@@ -14,7 +14,7 @@
 from typing import List, Optional, Union
 
 from camel.retrievers import AutoRetriever
-from camel.toolkits import FunctionTool
+from camel.toolkits import OpenAIFunction
 from camel.toolkits.base import BaseToolkit
 from camel.types import StorageType
 from camel.utils import Constants
@@ -75,14 +75,14 @@ class RetrievalToolkit(BaseToolkit):
         )
         return str(retrieved_info)
 
-    def get_tools(self) -> List[FunctionTool]:
-        r"""Returns a list of FunctionTool objects representing the
+    def get_tools(self) -> List[OpenAIFunction]:
+        r"""Returns a list of OpenAIFunction objects representing the
         functions in the toolkit.
 
         Returns:
-            List[FunctionTool]: A list of FunctionTool objects
+            List[OpenAIFunction]: A list of OpenAIFunction objects
                 representing the functions in the toolkit.
         """
         return [
-            FunctionTool(self.information_retrieval),
+            OpenAIFunction(self.information_retrieval),
         ]

camel/toolkits/search_toolkit.py

@@ -15,7 +15,7 @@ import os
 from typing import Any, Dict, List
 
 from camel.toolkits.base import BaseToolkit
-from camel.toolkits.function_tool import FunctionTool
+from camel.toolkits.openai_function import OpenAIFunction
 
 
 class SearchToolkit(BaseToolkit):
@@ -307,20 +307,20 @@ class SearchToolkit(BaseToolkit):
 
         return result.rstrip()  # Remove trailing whitespace
 
-    def get_tools(self) -> List[FunctionTool]:
-        r"""Returns a list of FunctionTool objects representing the
+    def get_tools(self) -> List[OpenAIFunction]:
+        r"""Returns a list of OpenAIFunction objects representing the
         functions in the toolkit.
 
         Returns:
-            List[FunctionTool]: A list of FunctionTool objects
+            List[OpenAIFunction]: A list of OpenAIFunction objects
                 representing the functions in the toolkit.
         """
         return [
-            FunctionTool(self.search_wiki),
-            FunctionTool(self.search_google),
-            FunctionTool(self.search_duckduckgo),
-            FunctionTool(self.query_wolfram_alpha),
+            OpenAIFunction(self.search_wiki),
+            OpenAIFunction(self.search_google),
+            OpenAIFunction(self.search_duckduckgo),
+            OpenAIFunction(self.query_wolfram_alpha),
         ]
 
 
-SEARCH_FUNCS: List[FunctionTool] = SearchToolkit().get_tools()
+SEARCH_FUNCS: List[OpenAIFunction] = SearchToolkit().get_tools()

camel/toolkits/slack_toolkit.py

@@ -26,7 +26,7 @@ if TYPE_CHECKING:
 
     from slack_sdk import WebClient
 
-from camel.toolkits import FunctionTool
+from camel.toolkits import OpenAIFunction
 
 logger = logging.getLogger(__name__)
 
@@ -286,20 +286,20 @@ class SlackToolkit(BaseToolkit):
         except SlackApiError as e:
             return f"Error creating conversation: {e.response['error']}"
 
-    def get_tools(self) -> List[FunctionTool]:
-        r"""Returns a list of FunctionTool objects representing the
+    def get_tools(self) -> List[OpenAIFunction]:
+        r"""Returns a list of OpenAIFunction objects representing the
         functions in the toolkit.
 
         Returns:
-            List[FunctionTool]: A list of FunctionTool objects
+            List[OpenAIFunction]: A list of OpenAIFunction objects
                 representing the functions in the toolkit.
         """
         return [
-            FunctionTool(self.create_slack_channel),
-            FunctionTool(self.join_slack_channel),
-            FunctionTool(self.leave_slack_channel),
-            FunctionTool(self.get_slack_channel_information),
-            FunctionTool(self.get_slack_channel_message),
-            FunctionTool(self.send_slack_message),
-            FunctionTool(self.delete_slack_message),
+            OpenAIFunction(self.create_slack_channel),
+            OpenAIFunction(self.join_slack_channel),
+            OpenAIFunction(self.leave_slack_channel),
+            OpenAIFunction(self.get_slack_channel_information),
+            OpenAIFunction(self.get_slack_channel_message),
+            OpenAIFunction(self.send_slack_message),
+            OpenAIFunction(self.delete_slack_message),
         ]