๐Ÿ–ผ๏ธ Setup

  1. Create a workspace on Slack if you donโ€™t have one already by clicking here.
  2. Create a new App on your Slack account by going here.
  3. Select From Scratch, then enter the Bot Name and select your workspace.
  4. On the left Sidebar, go to OAuth and Permissions and add the following scopes under Bot Token Scopes:
app_mentions:read
channels:history
channels:read
chat:write
  1. Now select the option Install to Workspace and after itโ€™s done, copy the Bot User OAuth Token and set it in your secrets as SLACK_BOT_TOKEN.
  2. Run your bot now,
docker run --name slack-bot -e OPENAI_API_KEY=sk-xxx -e SLACK_BOT_TOKEN=xxx -p 8000:8000 embedchain/slack-bot
  1. Expose your bot to the internet. You can use your machineโ€™s public IP or DNS. Otherwise, employ a proxy server like ngrok to make your local bot accessible.
  2. On the Slack API website go to Event Subscriptions on the left Sidebar and turn on Enable Events.
  3. In Request URL, enter your server or ngrok address.
  4. After it gets verified, click on Subscribe to bot events, add message.channels Bot User Event and click on Save Changes.
  5. Now go to your workspace, right click on the bot name in the sidebar, click view app details, then add this app to a channel.

๐Ÿš€ Usage Instructions

  • Go to the channel where you have added your bot.
  • To add data sources to the bot, use the command:
add <data_type> <url_or_text>
  • To ask queries from the bot, use the command:
query <question>

๐ŸŽ‰ Happy Chatting! ๐ŸŽ‰