Update weather function API by using pyowm (camel-ai#334)

Co-authored-by: Tianqi Xu <[email protected]>
Co-authored-by: lig <[email protected]>

Author: 3 people

.github/workflows/pytest_package.yml

@@ -27,6 +27,7 @@ jobs:
         OPENAI_API_KEY: "${{ secrets.OPENAI_API_KEY }}"
         GOOGLE_API_KEY: "${{ secrets.GOOGLE_API_KEY }}"
         SEARCH_ENGINE_ID: "${{ secrets.SEARCH_ENGINE_ID }}"
+        OPENWEATHERMAP_API_KEY: "${{ secrets.OPENWEATHERMAP_API_KEY }}"
       run: poetry run pytest --fast-test-mode test/
 
   pytest_package_llm_test:
@@ -42,6 +43,7 @@ jobs:
         OPENAI_API_KEY: "${{ secrets.OPENAI_API_KEY }}"
         GOOGLE_API_KEY: "${{ secrets.GOOGLE_API_KEY }}"
         SEARCH_ENGINE_ID: "${{ secrets.SEARCH_ENGINE_ID }}"
+        OPENWEATHERMAP_API_KEY: "${{ secrets.OPENWEATHERMAP_API_KEY }}"
       run: poetry run pytest --llm-test-only test/
 
   pytest_package_very_slow_test:
@@ -57,4 +59,5 @@ jobs:
         OPENAI_API_KEY: "${{ secrets.OPENAI_API_KEY }}"
         GOOGLE_API_KEY: "${{ secrets.GOOGLE_API_KEY }}"
         SEARCH_ENGINE_ID: "${{ secrets.SEARCH_ENGINE_ID }}"
+        OPENWEATHERMAP_API_KEY: "${{ secrets.OPENWEATHERMAP_API_KEY }}"
       run: poetry run pytest --very-slow-test-only test/

camel/functions/__init__.py

@@ -12,12 +12,14 @@
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 
-from .openai_function import OpenAIFunction
 from .math_functions import MATH_FUNCS
+from .openai_function import OpenAIFunction
 from .search_functions import SEARCH_FUNCS
+from .weather_functions import WEATHER_FUNCS
 
 __all__ = [
     'OpenAIFunction',
     'MATH_FUNCS',
     'SEARCH_FUNCS',
+    'WEATHER_FUNCS',
 ]

camel/functions/data_io_functions.py

@@ -19,10 +19,6 @@
 from io import BytesIO
 from typing import Any, Dict, List, Optional
 
-import docx2txt
-import fitz
-from bs4 import BeautifulSoup
-
 
 class File(ABC):
     r"""Represents an uploaded file comprised of Documents"""
@@ -107,6 +103,12 @@ def from_bytes(cls, file: BytesIO) -> "DocxFile":
             DocxFile: A DocxFile object.
         """
         # Use docx2txt to extract text from docx files
+        try:
+            import docx2txt
+        except ImportError:
+            raise ImportError("Please install `docx2txt` first. "
+                              "You can install it by running "
+                              "`pip install docx2txt`.")
         text = docx2txt.process(file)
         text = strip_consecutive_newlines(text)
         # Create a dictionary with the extracted text
@@ -132,6 +134,12 @@ def from_bytes(cls, file: BytesIO) -> "PdfFile":
             PdfFile: A PdfFile object.
         """
         # Use fitz to extract text from pdf files
+        try:
+            import fitz
+        except ImportError:
+            raise ImportError("Please install `PyMuPDF` first. "
+                              "You can install it by running "
+                              "`pip install PyMuPDF`.")
         pdf = fitz.open(stream=file.read(), filetype="pdf")
         docs = []
         for i, page in enumerate(pdf):
@@ -210,6 +218,12 @@ def from_bytes(cls, file: BytesIO) -> "HtmlFile":
             HtmlFile: A HtmlFile object.
         """
         # Parse the HTML data from the file
+        try:
+            from bs4 import BeautifulSoup
+        except ImportError:
+            raise ImportError("Please install `beautifulsoup4` first. "
+                              "You can install it by running "
+                              "`pip install beautifulsoup4`.")
         soup = BeautifulSoup(file, "html.parser")
         text = soup.get_text()
         text = strip_consecutive_newlines(text)

camel/functions/search_functions.py

@@ -31,7 +31,13 @@ def search_wiki(entity: str) -> str:
         string: The search result. If the page corresponding to the entity
             exists, return the summary of this entity in a string.
     """
-    import wikipedia
+    try:
+        import wikipedia
+    except ImportError:
+        raise ImportError(
+            "Please install `wikipedia` first. You can install it by running "
+            "`pip install wikipedia`.")
+
     result: str
 
     try:

camel/functions/weather_functions.py

@@ -0,0 +1,136 @@
+# =========== 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 os
+from typing import List
+
+from camel.functions import OpenAIFunction
+
+
+def get_openweathermap_api_key() -> str:
+    r"""Retrieve the OpenWeatherMap API key from environment variables.
+
+    Returns:
+        str: The OpenWeatherMap API key.
+
+    Raises:
+        ValueError: If the API key is not found in the environment variables.
+    """
+    # Get `OPENWEATHERMAP_API_KEY` here: https://openweathermap.org
+    OPENWEATHERMAP_API_KEY = os.environ.get('OPENWEATHERMAP_API_KEY')
+    if not OPENWEATHERMAP_API_KEY:
+        raise ValueError("`OPENWEATHERMAP_API_KEY` not found in environment "
+                         "variables. Get `OPENWEATHERMAP_API_KEY` here: "
+                         "`https://openweathermap.org`.")
+    return OPENWEATHERMAP_API_KEY
+
+
+def get_weather_data(city: str, temp_units: str = 'kelvin',
+                     wind_units: str = 'meters_sec',
+                     visibility_units: str = 'meters',
+                     time_units: str = 'unix') -> str:
+    r"""Fetch and return a comprehensive weather report for a given city as a
+    string. The report includes current weather conditions, temperature,
+    wind details, visibility, and sunrise/sunset times, all formatted as
+
+    The function interacts with the OpenWeatherMap API to retrieve the data.
+
+    Args:
+        city (string): The name of the city for which the weather information
+            is desired. Format "City, CountryCode" (e.g., "Paris, FR"
+            for Paris, France). If the country code is not provided,
+            the API will search for the city in all countries, which
+            may yield incorrect results if multiple cities with the
+            same name exist.
+        temp_units (string): Units for temperature. Options: 'kelvin',
+            'celsius', 'fahrenheit'. (default: :obj:`kelvin`)
+        wind_units (string): Units for wind speed. Options: 'meters_sec',
+            'miles_hour', 'knots', 'beaufort'. (default: :obj:`meters_sec`)
+        visibility_units (string): Units for visibility distance. Options:
+            'meters', 'miles'. (default: :obj:`meters`)
+        time_units (string): Format for sunrise and sunset times. Options:
+            'unix', 'iso', 'date'. (default: :obj:`unix`)
+
+    Returns:
+        str: A string containing the fetched weather data, formatted in a
+            readable manner. If an error occurs, a message indicating the
+            error will be returned instead.
+
+    Example of return string:
+        "Weather in Paris, FR: 15°C, feels like 13°C. Max temp: 17°C, Min temp
+            : 12°C.
+        Wind: 5 m/s at 270 degrees. Visibility: 10 kilometers.
+        Sunrise at 05:46:05 (UTC), Sunset at 18:42:20 (UTC)."
+
+    Note:
+        Please ensure that the API key is valid and has permissions to access
+            the weather data.
+    """
+    # NOTE: This tool may not work as expected since the input arguments like
+    # `time_units` should be enum types which are not supported yet.
+
+    try:
+        import pyowm
+    except ImportError:
+        raise ImportError(
+            "Please install `pyowm` first. You can install it by running "
+            "`pip install pyowm`.")
+
+    OPENWEATHERMAP_API_KEY = get_openweathermap_api_key()
+    owm = pyowm.OWM(OPENWEATHERMAP_API_KEY)
+    mgr = owm.weather_manager()
+
+    try:
+        observation = mgr.weather_at_place(city)
+        weather = observation.weather
+
+        # Temperature
+        temperature = weather.temperature(temp_units)
+
+        # Wind
+        wind_data = observation.weather.wind(unit=wind_units)
+        wind_speed = wind_data.get('speed')
+        # 'N/A' if the degree is not available
+        wind_deg = wind_data.get('deg', 'N/A')
+
+        # Visibility
+        visibility_distance = observation.weather.visibility_distance
+        visibility = (str(visibility_distance) if visibility_units == 'meters'
+                      else str(observation.weather.visibility(unit='miles')))
+
+        # Sunrise and Sunset
+        sunrise_time = str(weather.sunrise_time(timeformat=time_units))
+        sunset_time = str(weather.sunset_time(timeformat=time_units))
+
+        # Compile all the weather details into a report string
+        weather_report = (
+            f"Weather in {city}: {temperature['temp']}°{temp_units.title()}, "
+            f"feels like {temperature['feels_like']}°{temp_units.title()}. "
+            f"Max temp: {temperature['temp_max']}°{temp_units.title()}, "
+            f"Min temp: {temperature['temp_min']}°{temp_units.title()}. "
+            f"Wind: {wind_speed} {wind_units} at {wind_deg} degrees. "
+            f"Visibility: {visibility} {visibility_units}. "
+            f"Sunrise at {sunrise_time}, Sunset at {sunset_time}.")
+
+        return weather_report
+
+    except Exception as e:
+        error_message = (
+            f"An error occurred while fetching weather data for {city}: "
+            f"{str(e)}.")
+        return error_message
+
+
+WEATHER_FUNCS: List[OpenAIFunction] = [
+    OpenAIFunction(func) for func in [get_weather_data]
+]

examples/function_call/role_playing_with_function.py

@@ -17,19 +17,21 @@
 
 from camel.agents.chat_agent import FunctionCallingRecord
 from camel.configs import ChatGPTConfig, FunctionCallingConfig
-from camel.functions import MATH_FUNCS, SEARCH_FUNCS
+from camel.functions import MATH_FUNCS, SEARCH_FUNCS, WEATHER_FUNCS
 from camel.societies import RolePlaying
 from camel.types import ModelType
 from camel.utils import print_text_animated
 
 
 def main(model_type=ModelType.GPT_4) -> None:
     task_prompt = ("Assuming the current year is 2023, estimate KAUST's "
-                   "current age and then add 10 more years to this age.")
+                   "current age and then add 10 more years to this age, "
+                   "and get the current weather of the city where KAUST "
+                   "is located.")
 
     user_model_config = ChatGPTConfig(temperature=0.0)
 
-    function_list = [*MATH_FUNCS, *SEARCH_FUNCS]
+    function_list = [*MATH_FUNCS, *SEARCH_FUNCS, *WEATHER_FUNCS]
     assistant_model_config = FunctionCallingConfig.from_openai_function_list(
         function_list=function_list,
         kwargs=dict(temperature=0.0),