Harrison/wolfram alpha (#579)

Co-authored-by: Nicolas <nicolascamara29@gmail.com>

docs/ecosystem/wolfram_alpha.md

@@ -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)

docs/modules/agents/tools.md

@@ -43,6 +43,12 @@ Below is a list of all supported tools and relevant information:
 - Notes: Calls the Serp API and then parses results.
 - Requires LLM: No
 
+**wolfram-alpha**
+- Tool Name: Wolfram Alpha
+- Tool Description: A wolfram alpha search engine. Useful for when you need to answer questions about Math, Science, Technology, Culture, Society and Everyday Life. Input should be a search query.
+- Notes: Calls the Wolfram Alpha API and then parses results.
+- Requires LLM: No
+
 **requests**
 - Tool Name: Requests
 - Tool Description: A portal to the internet. Use this when you need to get specific content from a site. Input should be a specific url, and the output will be all the text on that page.

docs/modules/utils/examples/wolfram_alpha.ipynb

@@ -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
+}

docs/reference/integrations.md

@@ -21,6 +21,9 @@ The following use cases require specific installs and api keys:
 - _GoogleSearchAPI_:
   - Install requirements with `pip install google-api-python-client`
   - Get a Google api key and either set it as an environment variable (`GOOGLE_API_KEY`) or pass it to the LLM constructor as `google_api_key`. You will also need to set the `GOOGLE_CSE_ID` environment variable to your custom search engine id. You can pass it to the LLM constructor as `google_cse_id` as well.
+- _WolframAlphaAPI_:
+  - Install requirements with `pip install wolframalpha`
+  - Get a Wolfram Alpha api key and either set it as an environment variable (`WOLFRAM_ALPHA_APPID`) or pass it to the LLM constructor as `wolfram_alpha_appid`.
 - _NatBot_:
   - Install requirements with `pip install playwright`
 - _Wikipedia_: