mirror of https://github.com/hwchase17/langchain synced 2024-11-06 03:20:49 +00:00

Samuli Rauatmaa 66828ad231

add the existing OpenWeatherMap tool to the public api (#4292 )

[OpenWeatherMapAPIWrapper](f70e18a5b3/docs/modules/agents/tools/examples/openweathermap.ipynb)
works wonderfully, but the _tool_ itself can't be used in master branch.

- added OpenWeatherMap **tool** to the public api, to be loadable with
`load_tools` by using "openweathermap-api" tool name (that name is used
in the existing
[docs](aff33d52c5/docs/modules/agents/tools/getting_started.md),
at the bottom of the page)
- updated OpenWeatherMap tool's **description** to make the input format
match what the API expects (e.g. `London,GB` instead of `'London,GB'`)
- added [ecosystem documentation page for
OpenWeatherMap](f9c41594fe/docs/ecosystem/openweathermap.md)
- added tool usage example to [OpenWeatherMap's
notebook](f9c41594fe/docs/modules/agents/tools/examples/openweathermap.ipynb)

Let me know if there's something I missed or something needs to be
updated! Or feel free to make edits yourself if that makes it easier for
you 🙂

2023-05-14 18:50:45 -07:00

1.1 KiB

Raw Blame History

OpenWeatherMap API

This page covers how to use the OpenWeatherMap API within LangChain. It is broken into two parts: installation and setup, and then references to specific OpenWeatherMap API wrappers.

Installation and Setup

Install requirements with pip install pyowm
Go to OpenWeatherMap and sign up for an account to get your API key here
Set your API key as OPENWEATHERMAP_API_KEY environment variable

Wrappers

Utility

There exists a OpenWeatherMapAPIWrapper utility which wraps this API. To import this utility:

from langchain.utilities.openweathermap import OpenWeatherMapAPIWrapper

For a more detailed walkthrough of this wrapper, see this notebook.

Tool

You can also easily load this wrapper as a Tool (to use with an Agent). You can do this with:

from langchain.agents import load_tools
tools = load_tools(["openweathermap-api"])

For more information on this, see this page

1.1 KiB Raw Blame History