Skip to content

Latest commit

 

History

History

slack_bot

README.md

Slack Bot

This package contains the infrastructure and the code to deploy and run a backend service that can respond to a Slack message with an answer from an LLM chain (chain.py). The package also contains a manifest file (slack-bot-app.yml) that can be imported directly to create a slack bot app. This app should be installed in your workspace for users to start using the application.

Design

Slack Bot Design

Code organization

app.py

Contains the infrastructure code written in CDK that will be deployed to AWS

config.py

Contains the configuration used by the infrastructure and the application code. The current setup expects the API keys and Slack bot token to be stored in Secrets Manager under the name api-keys. For example, the secrets in the AWS console will look like this:

{
    "openai-api-key": "<api-key-value>",
    "slack-bot-token": "<bot-token>"
}

message_reader.py

Lambda handler that processes the incoming messages and puts them in a queue to be processed by the LLM chain or saves them to the history database.

message_writer.py

Lambda handler that pulls messages from the SQS queue and call the LLM chain to process the user request. The handler writes the response from the chain to the slack message thread.

chain.py

The LLM chain code that calls the LLM with the input from the user.

Deploying to AWS

Clone the repository

git clone https://github.com/3coins/langchain-aws-template.git

Move to the package directory

cd slack_bot

Install the dependencies; this creates a Conda env named langchain-aws-slack-bot and activates it.

conda deactivate
conda env create -f environment.yml # only needed once
conda activate langchain-aws-slack-bot

Bundle the code for Lambda deployment.

./bundle.sh

Deploy to your AWS account. These steps require that you must have configured the AWS credentials on your machine using the AWS CLI and using an account that has permissions to deploy and create infrastructure. See the AWS CLI setup page and the CDK guide to learn more.

cdk bootstrap # Only needed once, if you have not used CDK before in your account
cdk deploy

After you run the above commands, you will see a list of assets that this code will generate and you will be asked whether you want to proceed. Enter y to go ahead with the deployment. Copy and save the API URL generated from the deployment; this will be used when you create the Slack app.

Creating Slack apps using manifests

Use the slack-bot-app.yml file to create the slack application. Update the <api-url> to the deployed API from the previous step. Follow the instructions here to create the app from the manifest file: https://api.slack.com/reference/manifests#creating_apps

After creating the app in Slack, navigate to the app's OAuth & Permissions tab and you should find a "Bot User OAuth Token". Copy this value and add it to your AWS Secrets Manager Secret under the key slack-bot-token so that it looks like this:

{
  "openai-api-key":"<YOUR OPENAPI KEY>",
  "slack-bot-token":"<SLACK BOT TOKEN>"
}