diff --git a/slack_support/README.md b/slack_support/README.md index 6bcd6eaf..2ec017d4 100644 --- a/slack_support/README.md +++ b/slack_support/README.md @@ -1,6 +1,6 @@ # AI Driven Slack Support -This automation uses a slack bot to receive requests for help as a bot mention. Once a request for help is received, the subject of the request is inferred using Google's Gemini AI. The appropiate person, per a predetemined table of expertize that reside in a Google Doc, is mention. The person can then `!take` the request, and later `!resolve` it. If no one picks up the request for a configurable duration, the automation will remind the person that a request is pending. +This automation implements a Slack bot to manage requests for help as a bot mentions using a durable workflow. Once a request for assistance is received, the subject of the request is inferred using Google's Gemini AI. The appropriate person is mentioned according to a predetermined table of expertise in a Google Doc. The person can then `!take` the request and later `!resolve` it. If no one picks up the request for a configurable duration, the automation will remind the person that a request is pending. For example, given this expertise table: @@ -28,21 +28,21 @@ First apply the manifest: $ ak manifest apply autokitteh.yaml ``` -Then initialize the google and slack connections. This will authenticate them to the desired Slack workspace and Google account. +Then, initialize the Google and Slack connections. This will authenticate them to the desired Slack workspace and Google account. ``` $ ak connection init slack_support/myslack $ ak connection init slack_support/mygsheets ``` -Now acquire a Gemini API key from google. Go to https://ai.google.dev/gemini-api/docs/api-key and follow the instructions. +Now acquire a Gemini API key from Google. Go to https://ai.google.dev/gemini-api/docs/api-key and follow the instructions. Set the variable in autokitteh: ``` $ ak env set --env slack_support/default --secret GEMINI_API_KEY ``` -Now create your Google Sheet containing the schedule, it shoud look like this: +Next, create your Google Sheet containing the schedule, it should look like this: ``` | A | B | C @@ -57,7 +57,7 @@ Set the sheet ID in the autokitteh environment: $ ak env set --env slack_support/default DIRECTORY_GOOGLE_SHEET_ID ``` -Now you are ready to roll. Deploy your project: +You are ready to roll. Deploy your project: ``` $ ak deploy --project slack_support --dir .