diff --git a/docs/examples/discord_bot.mdx b/docs/examples/discord_bot.mdx index e23a672b..247f3c63 100644 --- a/docs/examples/discord_bot.mdx +++ b/docs/examples/discord_bot.mdx @@ -1,5 +1,5 @@ --- -title: '🤖 Discord Bot' +title: "🤖 Discord Bot" --- ### 🔑 Keys Setup @@ -12,9 +12,11 @@ title: '🤖 Discord Bot' - On the left sidebar, click on `OAuth2` and go to `General`. - Set `Authorization Method` to `In-app Authorization`. Under `Scopes` select `bot`. - Under `Bot Permissions` allow the following and then click on `Save Changes`. + ```text Send Messages (under Text Permissions) ``` + - Now under `OAuth2` and go to `URL Generator`. Under `Scopes` select `bot`. - Under `Bot Permissions` set the same permissions as above. - Now scroll down and copy the `Generated URL`. Paste it in a browser window and select the Server where you want to add the bot. @@ -23,40 +25,46 @@ Send Messages (under Text Permissions) ### Take the bot online -1. Install embedchain python package: + + + ```bash + docker run --name discord-bot -e OPENAI_API_KEY=sk-xxx -e DISCORD_BOT_TOKEN=xxx -p 8080:8080 embedchain/discord-bot:latest + ``` + + + ```bash + pip install --upgrade "embedchain[discord]" -```bash -pip install --upgrade "embedchain[discord]" -``` + python -m embedchain.bots.discord -2. Launch your Discord bot: - - -```bash -python -m embedchain.bots.discord -``` - -If you prefer to see the question and not only the answer, run it with - -```bash -python -m embedchain.bots.discord --include-question -``` + # or if you prefer to see the question and not only the answer, run it with + python -m embedchain.bots.discord --include-question + ``` + + ### 🚀 Usage Instructions - Go to the server where you have added your bot. + ![Slash commands interaction with bot](https://github.com/embedchain/embedchain/assets/73601258/bf1414e3-d408-4863-b0d2-ef382a76467e) - You can add data sources to the bot using the slash command: + ```text -/add +/ec add ``` + - You can ask your queries from the bot using the slash command: + ```text -/query +/ec query ``` + - You can chat with the bot using the slash command: + ```text -/chat +/ec chat ``` + 📝 Note: To use the bot privately, you can message the bot directly by right clicking the bot and selecting `Message`. 🎉 Happy Chatting! 🎉 diff --git a/examples/discord_bot/Dockerfile b/examples/discord_bot/Dockerfile index 2907c231..c4f45e58 100644 --- a/examples/discord_bot/Dockerfile +++ b/examples/discord_bot/Dockerfile @@ -1,4 +1,4 @@ -FROM python:3.11 AS backend +FROM python:3.11-slim WORKDIR /usr/src/discord_bot COPY requirements.txt . diff --git a/examples/discord_bot/README.md b/examples/discord_bot/README.md index 7e3f7e66..2d581871 100644 --- a/examples/discord_bot/README.md +++ b/examples/discord_bot/README.md @@ -1,3 +1,9 @@ # Discord Bot -This is a docker template to create your own Discord bot using the embedchain package. To know more about the bot and how to use it, go [here](https://docs.embedchain.ai/examples/discord_bot). \ No newline at end of file +This is a docker template to create your own Discord bot using the embedchain package. To know more about the bot and how to use it, go [here](https://docs.embedchain.ai/examples/discord_bot). + +To run this use the following command, + +```bash +docker run --name discord-bot -e OPENAI_API_KEY=sk-xxx -e DISCORD_BOT_TOKEN=xxx -p 8080:8080 embedchain/discord-bot:latest +```