diff --git a/docs/docs/integrations/toolkits/steam.ipynb b/docs/docs/integrations/toolkits/steam.ipynb index 365ce8639bd..879e1a08c2a 100644 --- a/docs/docs/integrations/toolkits/steam.ipynb +++ b/docs/docs/integrations/toolkits/steam.ipynb @@ -4,7 +4,19 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "# Steam Game Recommendation & Game Details Tool" + "# Steam Game Recommendation & Game Details\n", + "\n", + ">[Steam (Wikipedia)](https://en.wikipedia.org/wiki/Steam_(service)) is a video game digital distribution service and storefront developed by `Valve Corporation`. It provides game updates automatically for Valve's games, and expanded to distributing third-party titles. `Steam` offers various features, like game server matchmaking with Valve Anti-Cheat measures, social networking, and game streaming services.\n", + "\n", + ">[Steam](https://store.steampowered.com/about/) is the ultimate destination for playing, discussing, and creating games.\n", + "\n", + "Steam toolkit has two tools:\n", + "- `Game Details`\n", + "- `Recommended Games`\n", + "\n", + "## Setting up\n", + "\n", + "We have to install two python libraries." ] }, { @@ -13,12 +25,14 @@ "metadata": {}, "outputs": [], "source": [ - "import os\n", - "\n", - "from langchain.agents import AgentType, initialize_agent\n", - "from langchain.agents.agent_toolkits.steam.toolkit import SteamToolkit\n", - "from langchain.llms import OpenAI\n", - "from langchain.utilities.steam import SteamWebAPIWrapper" + "!pip install python-steam-api, decouple" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Then we have to get the `STEAM_KEY` and `STEAM_ID` from [Steam](https://store.steampowered.com/about/) site." ] }, { @@ -27,11 +41,32 @@ "metadata": {}, "outputs": [], "source": [ + "import os\n", + "\n", "os.environ[\"STEAM_KEY\"] = \"xyz\"\n", "os.environ[\"STEAM_ID\"] = \"123\"\n", "os.environ[\"OPENAI_API_KEY\"] = \"abc\"" ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Example" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "from langchain.agents import AgentType, initialize_agent\n", + "from langchain.agents.agent_toolkits.steam.toolkit import SteamToolkit\n", + "from langchain.llms import OpenAI\n", + "from langchain.utilities.steam import SteamWebAPIWrapper" + ] + }, { "cell_type": "code", "execution_count": 7, @@ -97,9 +132,9 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.10.1" + "version": "3.10.12" } }, "nbformat": 4, - "nbformat_minor": 2 + "nbformat_minor": 4 }