Update weather function API by using pyowm #334

yiyiyi0817 · 2023-10-29T14:19:42Z

Description

This PR introduces a new API function, and a set of test cases to validate its functionality. This feature enhancement enhances the CAMEL project by providing access to current weather data based on city name.
This update integrates features related to the OpenWeatherMap API, enabling new weather-related functionality. It is a new edition of #328 .

In order to use these new features, an API key from OpenWeatherMap is required. Contributors and users who want to run this code will need to:

Obtain an API key from OpenWeatherMap by signing up at https://openweathermap.org/api （free API is enough to this function）.
Once you have the key, it should be stored securely in the environment variables as 'OPENWEATHERMAP_API_KEY'. This is critical to ensure the security and privacy of your API key. Please do not hardcode the key into your codebase.

Please ensure the 'OPENWEATHER_API_KEY' is correctly configured in the environment before running the application. Incorrect handling of the API key may lead to errors or unexpected behavior.

Thank you for your attention to this requirement as we integrate these exciting new weather features.

Motivation and Context

Motivation:
Weather data is a valuable resource for a wide range of applications, from optimizing energy consumption to improving travel safety. Users of the CAMEL project have expressed the need for a reliable and easy-to-use way to access current weather information based on geographical coordinates. This addition of the 'get_current_weather', 'get_current_wind', 'get_current_visibility_distance', 'get_sunrise_sunset' API fulfills that need, providing real-time weather data to CAMEL users, enhancing their experience, and enabling new possibilities for data analysis.

Context:
Prior to this change, users had to rely on external services or implement custom solutions to obtain weather data. 'get_current_weather', 'get_current_wind', 'get_current_visibility_distance', 'get_sunrise_sunset' API simplifies this process, making it more accessible and integrated within the CAMEL framework. This addition aligns with our project's goal of providing comprehensive and user-friendly AI capabilities. It leverages the OpenWeatherMap API to retrieve accurate and up-to-date weather information, which complements the existing functionality of CAMEL.

An issue has been raised to propose this change (#57)

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds core functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation (update in the documentation)
Example (update in the folder of example)

Implemented Tasks

Current Weather(Temperature and weather status)
Current Wind(speed and direction)
Current Visibility Distance
Sunrise&Sunset Time
Air Pollution
Weather Forecast(need to subscribe plan "One Call by Call" and pay for it)

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

I have read the CONTRIBUTION guide. (required)
My change requires a change to the documentation.
I have updated the tests accordingly. (required for a bug fix or a new feature)
I have updated the documentation accordingly.

dandansamax

Excellent code! The tests coverage is high enough. Leave some tiny suggestions.

pyproject.toml

examples/function_call/role_playing_with_function.py

camel/functions/weather_functions.py

dandansamax · 2023-10-30T16:02:15Z

Hi @yiyiyi0817. Sorry, I cannot see your updates. Did you push the changes?

yiyiyi0817 · 2023-10-30T16:11:06Z

Hi @yiyiyi0817. Sorry, I cannot see your updates. Did you push the changes?

@dandansamax Sorry if my previous response was unclear. What I meant is that I will push my updates later.

yiyiyi0817 · 2023-10-31T07:03:16Z

Hello@dandansamax, I have pushed my updates and would appreciate it if you could review them and consider merging them into the master branch. Thank you!

dandansamax

LGTM. Please wait @lightaime to have a look.

lightaime · 2023-11-02T13:46:24Z

Thanks @yiyiyi0817! It looks awesome. Some small comments:

I am thinking should we merge all functions into one? Because all of them are just a call to mgr.weather_at_place.
Also, It could be great to just return a str typed content which is more friendly for LLMs.
It would be great to have an example with function calling. Like: https://github.com/camel-ai/camel/blob/master/examples/function_call/role_playing_with_function.py. We can change the task to
"Assuming the current year is 2023, estimate KAUST's current age and then add 10 more years to this age, and get the current weather of the city where KAUST is located."

yiyiyi0817 · 2023-11-03T05:56:46Z

Thanks @yiyiyi0817! It looks awesome. Some small comments:

I am thinking should we merge all functions into one? Because all of them are just a call to mgr.weather_at_place.

Also, It could be great to just return a str typed content which is more friendly for LLMs.

It would be great to have an example with function calling. Like: https://github.com/camel-ai/camel/blob/master/examples/function_call/role_playing_with_function.py. We can change the task to
"Assuming the current year is 2023, estimate KAUST's current age and then add 10 more years to this age, and get the current weather of the city where KAUST is located."

Hi Guohao@lightaime, Thank you for your suggestion.

I will convert the output to a string type and include the enhancement in role_playing_with_function.py to add "and get the current weather of the city where KAUST is located."

I've separated the weather module into four distinct functions because the required units for temperature, wind, visibility distance, and sunrise/sunset are different, potentially leading to a function with numerous parameters. Moreover, there might be instances where the LLM would only need information on one of those aspects at a time, not all together.

Hence, I'm contemplating whether combining them would indeed streamline the process or if it's more practical to maintain them as separate functions to cater to specific needs efficiently. I’m open to further discussion on this matter if needed.

lightaime · 2023-11-05T07:04:27Z

Hi @yiyiyi0817. Thanks for your explanation. It makes sense to separate them since the units. However, it will also increase the difficulty for function calling because more functions need to be considered in the function calling process. How about we introduce temp_units, wind_units, ... and combine them into a single function? WDYT?

yiyiyi0817 · 2023-11-05T09:05:34Z

Hi @yiyiyi0817. Thanks for your explanation. It makes sense to separate them since the units. However, it will also increase the difficulty for function calling because more functions need to be considered in the function calling process. How about we introduce temp_units, wind_units, ... and combine them into a single function? WDYT?

Given the convenience it brings to function calling, I agree with the proposal to merge these functions into one. I'll push the updated version soon. Thank you for the feedback! @lightaime

dandansamax · 2023-11-05T09:47:49Z

Hi. Sorry to modify your code. But I added the OPENWEATHERMAP_API_KEY to the github workflow so that pytest doesn't fail.

yiyiyi0817 · 2023-11-06T10:49:26Z

Hello, I have submitted new code and look forward to your review and merging. @lightaime @dandansamax

lightaime

Thanks @yiyiyi0817. It looks great!! Just some last picky comments.

lightaime · 2023-11-06T15:00:38Z

camel/functions/weather_functions.py

+        raise ValueError("OPENWEATHERMAP_API_KEY not found in environment \
+                          variables. Get OPENWEATHERMAP_API_KEY here: \
+                         https://openweathermap.org/")


Suggested change

raise ValueError("OPENWEATHERMAP_API_KEY not found in environment \

variables. Get OPENWEATHERMAP_API_KEY here: \

https://openweathermap.org/")

raise ValueError("`OPENWEATHERMAP_API_KEY` not found in environment \

variables. Get `OPENWEATHERMAP_API_KEY` here: \

`https://openweathermap.org`.")

lightaime · 2023-11-06T15:01:38Z

camel/functions/weather_functions.py

+    """
+    Retrieve the OpenWeatherMap API key from environment variables.


We usually use r-string for docstrings.

Suggested change

"""

Retrieve the OpenWeatherMap API key from environment variables.

r"""Retrieve the OpenWeatherMap API key from environment variables.

lightaime · 2023-11-06T15:03:37Z

camel/functions/weather_functions.py

+    Raises:
+        ValueError: If the API key is not found in the environment variables.
+    """
+    # Get OPENWEATHERMAP_API_KEY here: https://openweathermap.org/


Suggested change

# Get OPENWEATHERMAP_API_KEY here: https://openweathermap.org/

# Get `OPENWEATHERMAP_API_KEY` here: https://openweathermap.org

lightaime · 2023-11-06T15:04:43Z

camel/functions/weather_functions.py

+    """
+    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 \


Suggested change

"""

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 \

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

lightaime · 2023-11-06T15:07:46Z

camel/functions/weather_functions.py

+        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 is 'kelvin'.
+        wind_units (string): Units for wind speed. Options: 'meters_sec',
+                          'miles_hour', 'knots', 'beaufort'.
+                          Default is 'meters_sec'.
+        visibility_units (string): Units for visibility distance. Options:
+                          'meters', 'miles'. Default is 'meters'.
+        time_units (string): Format for sunrise and sunset times. Options:
+                          'unix', 'iso', 'date'. Default is 'unix'.


The indentation of the docstring is a bit weird here. We use 4 spaces for indentation usually.

lightaime · 2023-11-06T15:19:09Z

test/functions/test_weather_function.py

+        assert visibility is not None, \
+            "Visibility information is missing from the report"
+        assert visibility_min <= visibility <= visibility_max, \
+            f"Visibility {visibility} not in range for {visibility_units}"


Same here. Can we use brackets instead of back slash for formatting?

lightaime · 2023-11-06T15:19:15Z

test/functions/test_weather_function.py

+        assert match, f"Sunrise and sunset information in {time_units} \
+            format is missing from the report."


Same here. Can we use brackets instead of back slash for formatting?

lightaime · 2023-11-06T15:19:55Z

test/functions/test_weather_function.py

+        assert sunrise_time < sunset_time, "Sunrise time is not before \
+            sunset time in the report."


Same here. Can we use brackets instead of a back slash for formatting?

lightaime · 2023-11-06T15:21:44Z

test/functions/test_weather_function.py

+    return key
+
+
+def test_temperature(api_key):


We can also do all the 4 tests in one function. What do you think?

lightaime · 2023-11-06T15:23:18Z

examples/function_call/role_playing_with_function.py

Let's add WEATHER_FUNCS to the function_list and test it.

yiyiyi0817 · 2023-11-09T15:07:29Z

Thanks @yiyiyi0817. It looks great!! Just some last picky comments.

Hello @lightaime, I’ve updated my code format based on the previous suggestions and pushed the new version. If there are still any other details that need attention, please let me know. Thank you!

lightaime · 2023-11-09T19:10:59Z

Thanks @yiyiyi0817!!

Co-authored-by: Tianqi Xu <tianqi.xu@kaust.edu.sa> Co-authored-by: lig <guohao.li@kaust.edu.sa>

update weather function API by using pyowm

e26eecb

yiyiyi0817 changed the title ~~update weather function API by using pyowm~~ Update weather function API by using pyowm Oct 29, 2023

yiyiyi0817 self-assigned this Oct 29, 2023

yiyiyi0817 requested review from lightaime and dandansamax October 29, 2023 14:27

yiyiyi0817 added API Modifies the API New Feature labels Oct 30, 2023

dandansamax requested changes Oct 30, 2023

View reviewed changes

pyproject.toml Show resolved Hide resolved

examples/function_call/role_playing_with_function.py Outdated Show resolved Hide resolved

camel/functions/weather_functions.py Outdated Show resolved Hide resolved

camel/functions/weather_functions.py Outdated Show resolved Hide resolved

yiyiyi0817 requested a review from dandansamax October 30, 2023 15:20

Fixed tiny problems in weather function API using pyowm

fe5d332

Partial revert to the old version.

b82c321

dandansamax approved these changes Oct 31, 2023

View reviewed changes

dandansamax mentioned this pull request Nov 1, 2023

Add new weather API function to fetch additional open weather data #328

Closed

15 tasks

Add OPENWEATHERMAP_API_KEY secret

9198da8

Merged function output into a single string and added weather example.

7a79582

lightaime reviewed Nov 6, 2023

View reviewed changes

fix some format problems

52b2d53

lightaime added 2 commits November 9, 2023 21:45

update imports

6cf3c0c

merge conflicts

f8e8aae

lightaime merged commit a8639ac into master Nov 9, 2023
7 checks passed

lightaime deleted the weather_function_pyowm branch November 9, 2023 19:13

lightaime mentioned this pull request Nov 9, 2023

[Feature Request] Support Enum type in function calling #360

Closed

2 tasks

FUYICC pushed a commit to FUYICC/camel that referenced this pull request Nov 13, 2023

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

2e75402

Co-authored-by: Tianqi Xu <tianqi.xu@kaust.edu.sa> Co-authored-by: lig <guohao.li@kaust.edu.sa>

FUYICC pushed a commit to FUYICC/camel that referenced this pull request Nov 13, 2023

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

8128091

Co-authored-by: Tianqi Xu <tianqi.xu@kaust.edu.sa> Co-authored-by: lig <guohao.li@kaust.edu.sa>

forever-ly mentioned this pull request Nov 28, 2023

Improve function call (#279) #393

Merged

9 tasks

yiyiyi0817 mentioned this pull request Apr 26, 2024

feat: Enable Twitter API Function Calls for Social Media Interactions #517

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update weather function API by using pyowm #334

Update weather function API by using pyowm #334

yiyiyi0817 commented Oct 29, 2023 •

edited

Loading

dandansamax left a comment

dandansamax commented Oct 30, 2023

yiyiyi0817 commented Oct 30, 2023 •

edited

Loading

yiyiyi0817 commented Oct 31, 2023

dandansamax left a comment

lightaime commented Nov 2, 2023

yiyiyi0817 commented Nov 3, 2023

lightaime commented Nov 5, 2023

yiyiyi0817 commented Nov 5, 2023

dandansamax commented Nov 5, 2023

yiyiyi0817 commented Nov 6, 2023

lightaime left a comment

lightaime Nov 6, 2023

lightaime Nov 6, 2023

lightaime Nov 6, 2023

lightaime Nov 6, 2023

lightaime Nov 6, 2023

lightaime Nov 6, 2023

lightaime Nov 6, 2023

lightaime Nov 6, 2023

lightaime Nov 6, 2023

lightaime Nov 6, 2023

yiyiyi0817 commented Nov 9, 2023 •

edited

Loading

lightaime commented Nov 9, 2023

		"""
		Retrieve the OpenWeatherMap API key from environment variables.

	"""
	Retrieve the OpenWeatherMap API key from environment variables.
	r"""Retrieve the OpenWeatherMap API key from environment variables.

	# Get OPENWEATHERMAP_API_KEY here: https://openweathermap.org/
	# Get `OPENWEATHERMAP_API_KEY` here: https://openweathermap.org

		assert match, f"Sunrise and sunset information in {time_units} \
		format is missing from the report."

		assert sunrise_time < sunset_time, "Sunrise time is not before \
		sunset time in the report."

Update weather function API by using pyowm #334

Update weather function API by using pyowm #334

Conversation

yiyiyi0817 commented Oct 29, 2023 • edited Loading

Description

Motivation and Context

Types of changes

Implemented Tasks

Checklist

dandansamax left a comment

Choose a reason for hiding this comment

dandansamax commented Oct 30, 2023

yiyiyi0817 commented Oct 30, 2023 • edited Loading

yiyiyi0817 commented Oct 31, 2023

dandansamax left a comment

Choose a reason for hiding this comment

lightaime commented Nov 2, 2023

yiyiyi0817 commented Nov 3, 2023

lightaime commented Nov 5, 2023

yiyiyi0817 commented Nov 5, 2023

dandansamax commented Nov 5, 2023

yiyiyi0817 commented Nov 6, 2023

lightaime left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yiyiyi0817 commented Nov 9, 2023 • edited Loading

lightaime commented Nov 9, 2023

yiyiyi0817 commented Oct 29, 2023 •

edited

Loading

yiyiyi0817 commented Oct 30, 2023 •

edited

Loading

yiyiyi0817 commented Nov 9, 2023 •

edited

Loading