Skip to content

Latest commit

 

History

History
26 lines (15 loc) · 2.03 KB

README.md

File metadata and controls

26 lines (15 loc) · 2.03 KB

toneIn

This app was created in 24 hours at the Revolution UC Hackathon sponsored by Major League Hacking where it won first place. Learn more about our submission and view a demo of our application here https://devpost.com/software/tone-in.

What It Is Used For

toneIn is a Slack application that uses machine learning and data collection to educate users on the tone of their work and personal environments. By analyzing the tone of each message in a channel using OpenAI's "davinci" model, toneIn provides users with real-time feedback on their message's formality and professionalism. It also measures each message against an overall channel tone or a tone value assigned by an administrator to ensure consistency and alert you when a message you sent may not meet the level of formality in the channel.

Using it

If you would like to use this project yourself the first step is to make a Slack Application which can be outlined here https://api.slack.com/start/building/bolt-python.

In order to use the application you will need to create an account with OpenAI's API and Slack's API to generate API keys to allow for usage. These will be added into a .env file with the names you can find in our code.

Once an app has been made, with all the necessary keys and tokens pasted into the .env file the next thing to do is to set your applications permissions to allow it to access the proper events and have the proper scopes. The needed event handlers, slash commands and scopes will be included below:

Slash Commands

Screenshot_20230228_144608

Event Handlers

Screenshot_20230228_144803

Scopes

Screenshot_20230228_145115

That should be all you need to know, if you have any questions feel free to reach me at [email protected]!