camel-ai 0.2.3a1__py3-none-any.whl → 0.2.4__py3-none-any.whl

camel/toolkits/dalle_toolkit.py

@@ -20,7 +20,7 @@ from typing import List, Optional
 from openai import OpenAI
 from PIL import Image
 
-from camel.toolkits import OpenAIFunction
+from camel.toolkits import FunctionTool
 from camel.toolkits.base import BaseToolkit
 
 
@@ -132,15 +132,15 @@ class DalleToolkit(BaseToolkit):
 
         return image_path
 
-    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.get_dalle_img)]
+        return [FunctionTool(self.get_dalle_img)]
 
 
-DALLE_FUNCS: List[OpenAIFunction] = DalleToolkit().get_tools()
+DALLE_FUNCS: List[FunctionTool] = DalleToolkit().get_tools()

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

@@ -11,6 +11,7 @@
 # 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
 
@@ -142,7 +143,7 @@ def get_openai_tool_schema(func: Callable) -> Dict[str, Any]:
     return openai_tool_schema
 
 
-class OpenAIFunction:
+class FunctionTool:
     r"""An abstraction of a function that OpenAI chat models can call. See
     https://platform.openai.com/docs/api-reference/chat/create.
 
@@ -184,17 +185,18 @@ class OpenAIFunction:
         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")
-        # Check the function description
-        if not openai_tool_schema["function"]["description"]:
-            raise ValueError("miss function description")
+            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.""")
 
         # Validate whether parameters
         # meet the JSON Schema reference specifications.
@@ -207,14 +209,15 @@ class OpenAIFunction:
             JSONValidator.check_schema(parameters)
         except SchemaError as e:
             raise e
-        # Check the parameter description
+
+        # Check the parameter description, if no description then raise warming
         properties: Dict[str, Any] = parameters["properties"]
         for param_name in properties.keys():
             param_dict = properties[param_name]
             if "description" not in param_dict:
-                raise ValueError(
-                    f'miss description of parameter "{param_name}"'
-                )
+                warnings.warn(f"""Parameter description is missing for 
+                            {param_dict}. This may affect the quality of tool 
+                            calling.""")
 
     def get_openai_tool_schema(self) -> Dict[str, Any]:
         r"""Gets the OpenAI tool schema for this function.
@@ -387,3 +390,23 @@ class OpenAIFunction:
         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/github_toolkit.py

@@ -18,11 +18,10 @@ from typing import List, Optional
 
 from pydantic import BaseModel
 
+from camel.toolkits import FunctionTool
+from camel.toolkits.base import BaseToolkit
 from camel.utils import dependencies_required
 
-from .base import BaseToolkit
-from .openai_function import OpenAIFunction
-
 
 class GithubIssue(BaseModel):
     r"""Represents a GitHub issue.
@@ -131,19 +130,19 @@ class GithubToolkit(BaseToolkit):
         self.github = Github(auth=Auth.Token(access_token))
         self.repo = self.github.get_repo(repo_name)
 
-    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.retrieve_issue_list),
-            OpenAIFunction(self.retrieve_issue),
-            OpenAIFunction(self.create_pull_request),
-            OpenAIFunction(self.retrieve_pull_requests),
+            FunctionTool(self.retrieve_issue_list),
+            FunctionTool(self.retrieve_issue),
+            FunctionTool(self.create_pull_request),
+            FunctionTool(self.retrieve_pull_requests),
         ]
 
     def get_github_access_token(self) -> str:

camel/toolkits/google_maps_toolkit.py

@@ -16,7 +16,7 @@ from functools import wraps
 from typing import Any, Callable, List, Optional, Union
 
 from camel.toolkits.base import BaseToolkit
-from camel.toolkits.openai_function import OpenAIFunction
+from camel.toolkits.function_tool import FunctionTool
 from camel.utils import dependencies_required
 
 
@@ -287,16 +287,16 @@ class GoogleMapsToolkit(BaseToolkit):
 
         return description
 
-    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.get_address_description),
-            OpenAIFunction(self.get_elevation),
-            OpenAIFunction(self.get_timezone),
+            FunctionTool(self.get_address_description),
+            FunctionTool(self.get_elevation),
+            FunctionTool(self.get_timezone),
         ]

camel/toolkits/google_scholar_toolkit.py

@@ -0,0 +1,146 @@
+# =========== 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. ===========
+import re
+from typing import List, Optional
+
+from camel.toolkits import FunctionTool
+from camel.toolkits.base import BaseToolkit
+
+
+class GoogleScholarToolkit(BaseToolkit):
+    r"""A toolkit for retrieving information about authors and their
+    publications from Google Scholar.
+
+    Attributes:
+        author_identifier (Union[str, None]): The author's Google Scholar URL
+            or name of the author to search for.
+        is_author_name (bool): Flag to indicate if the identifier is a name.
+            (default: :obj:`False`)
+        scholarly (module): The scholarly module for querying Google Scholar.
+    """
+
+    def __init__(
+        self, author_identifier: str, is_author_name: bool = False
+    ) -> None:
+        r"""Initializes the GoogleScholarToolkit with the author's identifier.
+
+        Args:
+            author_identifier (str): The author's Google Scholar URL or name
+                of the author to search for.
+            is_author_name (bool): Flag to indicate if the identifier is a
+                name. (default: :obj:`False`)
+        """
+        from scholarly import scholarly
+
+        self.scholarly = scholarly
+        self.author_identifier = author_identifier
+        self.is_author_name = is_author_name
+
+    def _extract_author_id(self) -> Optional[str]:
+        r"""Extracts the author ID from a Google Scholar URL if provided.
+
+        Returns:
+            Optional[str]: The extracted author ID, or None if not found.
+        """
+        match = re.search(r'user=([A-Za-z0-9-]+)', self.author_identifier)
+        return match.group(1) if match else None
+
+    def get_author_detailed_info(
+        self,
+    ) -> dict:
+        r"""Retrieves detailed information about the author.
+
+        Returns:
+            dict: A dictionary containing detailed information about the
+                author.
+        """
+        if self.is_author_name:
+            search_query = self.scholarly.search_author(self.author_identifier)
+            # Retrieve the first result from the iterator
+            first_author_result = next(search_query)
+        else:
+            author_id = self._extract_author_id()
+            first_author_result = self.scholarly.search_author_id(id=author_id)
+
+        author = self.scholarly.fill(first_author_result)
+        return author
+
+    def get_author_publications(
+        self,
+    ) -> List[str]:
+        r"""Retrieves the titles of the author's publications.
+
+        Returns:
+            List[str]: A list of publication titles authored by the author.
+        """
+        author = self.get_author_detailed_info()
+        publication_titles = [
+            pub['bib']['title'] for pub in author['publications']
+        ]
+        return publication_titles
+
+    def get_publication_by_title(
+        self, publication_title: str
+    ) -> Optional[dict]:
+        r"""Retrieves detailed information about a specific publication by its
+        title. Note that this method cannot retrieve the full content of the
+        paper.
+
+        Args:
+            publication_title (str): The title of the publication to search
+                for.
+
+        Returns:
+            Optional[dict]: A dictionary containing detailed information about
+                the publication if found; otherwise, `None`.
+        """
+        author = self.get_author_detailed_info()
+        publications = author['publications']
+        for publication in publications:
+            if publication['bib']['title'] == publication_title:
+                return self.scholarly.fill(publication)
+        return None  # Return None if not found
+
+    def get_full_paper_content_by_link(self, pdf_url: str) -> Optional[str]:
+        r"""Retrieves the full paper content from a given PDF URL using the
+        arxiv2text tool.
+
+        Args:
+            pdf_url (str): The URL of the PDF file.
+
+        Returns:
+            Optional[str]: The full text extracted from the PDF, or `None` if
+                an error occurs.
+        """
+        from arxiv2text import arxiv_to_text
+
+        try:
+            return arxiv_to_text(pdf_url)
+        except Exception:
+            return None  # Return None in case of any error
+
+    def get_tools(self) -> List[FunctionTool]:
+        r"""Returns a list of FunctionTool objects representing the
+        functions in the toolkit.
+
+        Returns:
+            List[FunctionTool]: A list of FunctionTool objects
+                representing the functions in the toolkit.
+        """
+        return [
+            FunctionTool(self.get_author_detailed_info),
+            FunctionTool(self.get_author_publications),
+            FunctionTool(self.get_publication_by_title),
+            FunctionTool(self.get_full_paper_content_by_link),
+        ]

camel/toolkits/linkedin_toolkit.py

@@ -19,7 +19,7 @@ from typing import List
 
 import requests
 
-from camel.toolkits import OpenAIFunction
+from camel.toolkits import FunctionTool
 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[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.create_post),
-            OpenAIFunction(self.delete_post),
-            OpenAIFunction(self.get_profile),
+            FunctionTool(self.create_post),
+            FunctionTool(self.delete_post),
+            FunctionTool(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.openai_function import OpenAIFunction
+from camel.toolkits.function_tool import FunctionTool
 
 
 class MathToolkit(BaseToolkit):
@@ -61,19 +61,19 @@ class MathToolkit(BaseToolkit):
         """
         return a * b
 
-    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.add),
-            OpenAIFunction(self.sub),
-            OpenAIFunction(self.mul),
+            FunctionTool(self.add),
+            FunctionTool(self.sub),
+            FunctionTool(self.mul),
         ]
 
 
-MATH_FUNCS: List[OpenAIFunction] = MathToolkit().get_tools()
+MATH_FUNCS: List[FunctionTool] = 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 OpenAIFunction, openapi_security_config
+from camel.toolkits import FunctionTool, 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[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.
         """
         apinames_filepaths = self.generate_apinames_filepaths()
@@ -539,6 +539,6 @@ class OpenAPIToolkit:
             self.apinames_filepaths_to_funs_schemas(apinames_filepaths)
         )
         return [
-            OpenAIFunction(a_func, a_schema)
+            FunctionTool(a_func, a_schema)
             for a_func, a_schema in zip(all_funcs_lst, all_schemas_lst)
         ]

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 OpenAIFunction
+from camel.toolkits import FunctionTool
 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[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 for the
+            List[FunctionTool]: A list of FunctionTool objects for the
                 toolkit methods.
         """
         return [
-            OpenAIFunction(self.collect_top_posts),
-            OpenAIFunction(self.perform_sentiment_analysis),
-            OpenAIFunction(self.track_keyword_discussions),
+            FunctionTool(self.collect_top_posts),
+            FunctionTool(self.perform_sentiment_analysis),
+            FunctionTool(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 OpenAIFunction
+from camel.toolkits import FunctionTool
 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[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.information_retrieval),
+            FunctionTool(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.openai_function import OpenAIFunction
+from camel.toolkits.function_tool import FunctionTool
 
 
 class SearchToolkit(BaseToolkit):
@@ -307,20 +307,20 @@ class SearchToolkit(BaseToolkit):
 
         return result.rstrip()  # Remove trailing whitespace
 
-    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.search_wiki),
-            OpenAIFunction(self.search_google),
-            OpenAIFunction(self.search_duckduckgo),
-            OpenAIFunction(self.query_wolfram_alpha),
+            FunctionTool(self.search_wiki),
+            FunctionTool(self.search_google),
+            FunctionTool(self.search_duckduckgo),
+            FunctionTool(self.query_wolfram_alpha),
         ]
 
 
-SEARCH_FUNCS: List[OpenAIFunction] = SearchToolkit().get_tools()
+SEARCH_FUNCS: List[FunctionTool] = SearchToolkit().get_tools()

camel/toolkits/slack_toolkit.py

@@ -26,7 +26,7 @@ if TYPE_CHECKING:
 
     from slack_sdk import WebClient
 
-from camel.toolkits import OpenAIFunction
+from camel.toolkits import FunctionTool
 
 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[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.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),
+            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),
         ]