forked from Archives/langchain
Harrison/wolfram alpha (#579)
Co-authored-by: Nicolas <nicolascamara29@gmail.com>harrison/sql-agent
Harrison Chase
1 year ago
committed by
GitHub
parent
94765e7487
commit
ffc7e04d44
@ -0,0 +1,34 @@
|
||||
# Wolfram Alpha Wrapper
|
||||
|
||||
This page covers how to use the Wolfram Alpha API within LangChain.
|
||||
It is broken into two parts: installation and setup, and then references to specific Wolfram Alpha wrappers.
|
||||
|
||||
## Installation and Setup
|
||||
- Install requirements with `pip install wolframalpha`
|
||||
- Go to wolfram alpha and sign up for a developer account [here](https://developer.wolframalpha.com/)
|
||||
- Create an app and get your APP ID
|
||||
- Set your APP ID as an environment variable `WOLFRAM_ALPHA_APPID`
|
||||
|
||||
|
||||
## Wrappers
|
||||
|
||||
### Utility
|
||||
|
||||
There exists a WolframAlphaAPIWrapper utility which wraps this API. To import this utility:
|
||||
|
||||
```python
|
||||
from langchain.utilities.wolfram_alpha import WolframAlphaAPIWrapper
|
||||
```
|
||||
|
||||
For a more detailed walkthrough of this wrapper, see [this notebook](../modules/utils/examples/wolfram_alpha.ipynb).
|
||||
|
||||
### Tool
|
||||
|
||||
You can also easily load this wrapper as a Tool (to use with an Agent).
|
||||
You can do this with:
|
||||
```python
|
||||
from langchain.agents import load_tools
|
||||
tools = load_tools(["wolfram-alpha"])
|
||||
```
|
||||
|
||||
For more information on this, see [this page](../modules/agents/tools.md)
|
||||
@ -0,0 +1,124 @@
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"attachments": {},
|
||||
"cell_type": "markdown",
|
||||
"id": "245a954a",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Wolfram Alpha\n",
|
||||
"\n",
|
||||
"This notebook goes over how to use the wolfram alpha component.\n",
|
||||
"\n",
|
||||
"First, you need to set up your Wolfram Alpha developer account and get your APP ID:\n",
|
||||
"\n",
|
||||
"1. Go to wolfram alpha and sign up for a developer account [here](https://developer.wolframalpha.com/)\n",
|
||||
"2. Create an app and get your APP ID\n",
|
||||
"3. pip install wolframalpha\n",
|
||||
"\n",
|
||||
"Then we will need to set some environment variables:\n",
|
||||
"1. Save your APP ID into WOLFRAM_ALPHA_APPID env variable"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": null,
|
||||
"id": "961b3689",
|
||||
"metadata": {
|
||||
"vscode": {
|
||||
"languageId": "shellscript"
|
||||
}
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"pip install wolframalpha"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 6,
|
||||
"id": "34bb5968",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"import os\n",
|
||||
"os.environ[\"WOLFRAM_ALPHA_APPID\"] = \"\"\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 9,
|
||||
"id": "ac4910f8",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"from langchain.utilities.wolfram_alpha import WolframAlphaAPIWrapper"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 10,
|
||||
"id": "84b8f773",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"wolfram = WolframAlphaAPIWrapper()"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 11,
|
||||
"id": "068991a6",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"data": {
|
||||
"text/plain": [
|
||||
"'x = 2/5'"
|
||||
]
|
||||
},
|
||||
"execution_count": 11,
|
||||
"metadata": {},
|
||||
"output_type": "execute_result"
|
||||
}
|
||||
],
|
||||
"source": [
|
||||
"wolfram.run(\"What is 2x+5 = -3x + 7?\")"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": null,
|
||||
"id": "028f4cba",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"source": []
|
||||
}
|
||||
],
|
||||
"metadata": {
|
||||
"kernelspec": {
|
||||
"display_name": ".venv",
|
||||
"language": "python",
|
||||
"name": "python3"
|
||||
},
|
||||
"language_info": {
|
||||
"codemirror_mode": {
|
||||
"name": "ipython",
|
||||
"version": 3
|
||||
},
|
||||
"file_extension": ".py",
|
||||
"mimetype": "text/x-python",
|
||||
"name": "python",
|
||||
"nbconvert_exporter": "python",
|
||||
"pygments_lexer": "ipython3",
|
||||
"version": "3.9.7"
|
||||
},
|
||||
"vscode": {
|
||||
"interpreter": {
|
||||
"hash": "53f3bc57609c7a84333bb558594977aa5b4026b1d6070b93987956689e367341"
|
||||
}
|
||||
}
|
||||
},
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 5
|
||||
}
|
||||
@ -0,0 +1,59 @@
|
||||
"""Util that calls WolframAlpha."""
|
||||
from typing import Any, Dict, Optional
|
||||
|
||||
from pydantic import BaseModel, Extra, root_validator
|
||||
|
||||
from langchain.utils import get_from_dict_or_env
|
||||
|
||||
|
||||
class WolframAlphaAPIWrapper(BaseModel):
|
||||
"""Wrapper for Wolfram Alpha.
|
||||
|
||||
Docs for using:
|
||||
|
||||
1. Go to wolfram alpha and sign up for a developer account
|
||||
2. Create an app and get your APP ID
|
||||
3. Save your APP ID into WOLFRAM_ALPHA_APPID env variable
|
||||
4. pip install wolframalpha
|
||||
|
||||
"""
|
||||
|
||||
wolfram_client: Any #: :meta private:
|
||||
wolfram_alpha_appid: Optional[str] = None
|
||||
|
||||
class Config:
|
||||
"""Configuration for this pydantic object."""
|
||||
|
||||
extra = Extra.forbid
|
||||
|
||||
@root_validator()
|
||||
def validate_environment(cls, values: Dict) -> Dict:
|
||||
"""Validate that api key and python package exists in environment."""
|
||||
wolfram_alpha_appid = get_from_dict_or_env(
|
||||
values, "wolfram_alpha_appid", "WOLFRAM_ALPHA_APPID"
|
||||
)
|
||||
values["wolfram_alpha_appid"] = wolfram_alpha_appid
|
||||
|
||||
try:
|
||||
import wolframalpha
|
||||
|
||||
except ImportError:
|
||||
raise ImportError(
|
||||
"wolframalpha is not installed. "
|
||||
"Please install it with `pip install wolframalpha`"
|
||||
)
|
||||
client = wolframalpha.Client(wolfram_alpha_appid)
|
||||
|
||||
values["wolfram_client"] = client
|
||||
|
||||
# TODO: Add error handling if keys are missing
|
||||
return values
|
||||
|
||||
def run(self, query: str) -> str:
|
||||
"""Run query through WolframAlpha and parse result."""
|
||||
res = self.wolfram_client.query(query)
|
||||
# Includes only text from the response
|
||||
answer = next(res.results).text
|
||||
if answer is None or answer == "":
|
||||
return "No good Wolfram Alpha Result was found"
|
||||
return answer
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,9 @@
|
||||
"""Integration test for Wolfram Alpha API Wrapper."""
|
||||
from langchain.utilities.wolfram_alpha import WolframAlphaAPIWrapper
|
||||
|
||||
|
||||
def test_call() -> None:
|
||||
"""Test that call gives the correct answer."""
|
||||
search = WolframAlphaAPIWrapper()
|
||||
output = search.run("what is 2x+18=x+5?")
|
||||
assert "x = -13" in output
|
||||
Loading…
Reference in New Issue