SumBot

KO | EN

gitlite — search

#javascript #python #golang #android #linux #macos #nodejs #awesome #cli #awesome-list #openai #ios #mcp #open-source

(★ 19)

:bowtie: SumBot Free Code - AI-Powered Message Summarization ChatBot

SumBot Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

\[[🇧🇷 Português](README.pt_BR.md)\] \[**[🇺🇸 English](README.md)**\]

🏆 **I am thrilled to announce that this project [won the Best AI Tool Innovation Award at the Ready Tensor AI Project Showcase Competition 2024](https://github.com/Mindful-AI-Assistants/SumBot/blob/8783b148a8aa34a976dedfa61995449aead79a37/Ready%20Tensor%20AI%20Project%20Showcase%202024%20-%20Best%20AI%20Tool%20Innovation.pdf)!** 🪷

💡 **Best AI Tool Innovation:**

👉🏻 View the publication on the Ready Tensor [SumBot FreeCode](https://app.readytensor.ai/publications/uaWsno2Z7r2a).

👉🏻 SumBot FreeCode by [Fabiana Campanari](https://github.com/FabianaCampanari).

## <img src="https://github.githubassets.com/images/icons/emoji/bowtie.png" width="50"> SumBot FreeCode
#### 🤖🦾 **"SumBot FreeCode: [AI Chatbot]() Integrated with Slack using OpenAI GPT-3.5 Turbo API"**.

https://github.com/user-attachments/assets/12d1bdde-f3c9-4651-9060-091da3b3dd23

#### [![Top GitHub Users](https://github.com/gayanvoice/top-github-users/actions/workflows/action.yml/badge.svg)](https://github.com/gayanvoice/top-github-users/blob/a21ad6fb4c8e302f4caebc5262554259e58aeceb/markdown/public_contributions/brazil.md) [![Sponsor Mindful AI Assistants](https://img.shields.io/badge/Sponsor-Mindful%20AI%20%20Assistants-brightgreen?logo=GitHub)](https://github.com/sponsors/Mindful-AI-Assistants)

**SumBot FreeCode** is an AI-powered chatbot, integrated with GPT-3.5 Turbo**, designed to summarize long messages and deliver concise information. This project was developed by [Fabiana Campanari](https://github.com/FabianaCampanari) for the [AI Project Showcase Competition 2024 organized by Ready Tensor AI](https://app.readytensor.ai/competition).

For more information and access to the project, visit:

- GitHub: [SumBot FreeCode](https://github.com/Mindful-AI-Assistants/SumBot)

- Ready Tensor AI : [SumBot FreeCode](https://app.readytensor.ai/publications/uaWsno2Z7r2a).

## 🔭๋ Table of Contents

- [Introduction](#-introduction)
- [Features](#-features)
- [Purpose](#-purpose)
- [Vision](#-vision)
- [Why SumBot?](#-why-sumbot)
- [How It Works](#-how-it-works)
- [Who Is It For?](#-who-is-it-for)
- [Key Benefits](#-key-benefits)
- [For Developers](#-installation)
- [Usage](#-usage)
- [Demo Videos](#-demo-videos)
- [Watch on YouTube](#-watch-on-youtube)
- [Extra AI Tools](#-extra-ai-tools)
- [Contribute](#-contribute)
- [Code of Conduct](#-spread-the-world)
- [Spread the World](#license)
- [Contact](#-contact) 
- [Ready Tensor AI Project Showcase 2024 - Certificate for Best AI Tool Innovation Award](#-ready-tensor-ai-project-showcase-2024-certificate-best-ai-tool-innovation-award)
- [Main Theoretical Reference](#-main-theoretical-reference)
- [License](#-license)

## *ੈ✩ Introduction

Welcome to **SumBot FreeCode**, an AI-powered chatbot that transforms long texts into concise summaries, making communication more efficient. Developed with **GPT-3.5 Turbo** and integrated with platforms like **Slack**, it’s the perfect tool for managing information overload, whether in business settings or academic environments.

## *ੈ Features

- **Automated Summarization**: Summarizes long texts using GPT-3.5 Turbo.
- **Slack Integration**: Seamlessly automate tasks within Slack.
- **Custom Triggers**: Summarization triggered by bowtie :bowtie: emoji reactions.
- **Zapier Workflow**: Connect with various tools for smooth automation.
- **No Programming Required**: Easy to use for everyone, regardless of technical expertise.

## 𓋹 Purpose

The purpose of **SumBot FreeCode** is simple: **manage information overload**. By summarizing long texts automatically, it saves time and increases productivity across various platforms, from business reports to academic papers.

## 𓂀 Vision

Imagine having a personal assistant that condenses overwhelming amounts of information into manageable summaries. That’s the vision behind **SumBot**—to simplify workflows by summarizing messages in Slack with a single emoji, such as the :bowtie: bowtie, making communication more streamlined.

## 🕯 Why SumBot?

In a world overflowing with information, **SumBot** helps you cut through the noise by efficiently summarizing lengthy texts. By leveraging **OpenAI**, **Slack**, and **Zapier**, it provides a simple yet powerful solution to improve productivity and communication without requiring any programming knowledge.

## 🪬 How It Works

1. **OpenAI API**: Powers the summarization using **GPT-3.5 Turbo**, an advanced natural language model.
2. **Slack**: Provides the platform for user interaction, where **SumBot** summarizes messages when triggered.
3. **Zapier**: Automates the workflow between Slack and OpenAI, enabling message summaries when specific emojis are used.

### 🦾🤖 [Automation Workflow]() ☟

 
### <img width="425" alt="Automation Workflow" src="https://github.com/user-attachments/assets/900381fb-bc41-40e6-8ef1-51235bbf1a5a" />

## 🧘🏼‍♀️ Who Is It For?

### **SumBot FreeCode** is ideal for a variety of users:

- **Business Professionals**: Summarizes reports and communications for quick comprehension.
- **Students**: Helps summarize academic articles and long study texts.
- **Customer Support Teams**: Provides concise summaries of customer conversations.
- **Researchers**: Extracts key insights from academic papers.
- **Marketers**: Summarizes social media interactions and discussions.
- **Educators**: Breaks down complex educational material into easier summaries.
- **Writers**: Extracts key points from research materials.

## 🪷 Key Benefits

- **Time-Saving**: Quickly condenses long texts, so you can focus on what matters.
- **Enhanced Productivity**: Efficiently manage and process large amounts of information.
- **Decision Support**: Provides concise summaries to aid in quick decision-making.
- **Customizable Summaries**: Tailor the length and detail of summaries based on your needs.
- **AI-Powered Precision**: Utilizes **GPT-3.5 Turbo** for accurate and relevant summaries.

## ᯓ★ For Developers:

Although SumBot FreeCode is designed to be a real-use solution without the need for direct coding, you may include a `requirements.txt` file and a `python-run.py` script if you wish to use Python for managing integration or running automations in your project.

To set up **SumBot FreeCode**, follow these steps:

1. Clone the repository:
   ```bash
   git clone https://github.com/Mindful-AI-Assistants/SumBot.git
   ```

2. Navigate into the project directory:
   ```bash
   cd SumBot-ReadyTensorAI-Hackaton
   ```

3. Install the required dependencies:
   ```bash
   pip install -r requirements.txt
   ```

4. Set up environment variables for the OpenAI API and Slack integration.
   ```bash
   export OPENAI_API_KEY='your_openai_api_key_here'
   export SLACK_BOT_TOKEN='your_slack_bot_token_here'
   ```

5. Run the chatbot:
   ```bash
   python-run.py
   ```

##  🤺 Usage

To use **SumBot FreeCode**:

1. Connect the bot to your Slack workspace.
2. React to a message in Slack with the bowtie emoji :bowtie:.
3. **SumBot** will automatically summarize the message in the same thread.

Example:  
- Message: *"This is a very long message..."*  
- React with :bowtie:  
- Bot Response: *"Summary: The message talks about..."*

## 🎥 Demo Videos

1. :clapper: **Demo 1**: Building Slack Integration on Zapier

https://github.com/user-attachments/assets/971147f2-5de1-46f7-ba56-e4ef1bfae29b

2. :clapper: **Demo 2**: Integrating GPT-3.5 Turbo with Slack

https://github.com/user-attachments/assets/732e5bfe-fe61-4502-acd2-41e7bbaa4337

3. :clapper: **Demo 3**: Building the integration of Slack with ChatGpT-3.5 Turbo, Turbo, with the use of an API from OpenAI and return a summary response  in the Slack thread every time someone uses a reaction with the bowtie emoji, and utilizing the AI Monica virtual assistant to compose message

https://github.com/user-attachments/assets/9b407fcd-0835-492f-a6c6-c48e1f384586

4. :clapper: **Demo 4**: Testing the functionality of SumBot using the AI Monica virtual assistant to compose messages

https://github.com/user-attachments/assets/5fc934b1-200d-4f5b-a1f7-52f3e792d31b

## 🔭๋࣭  Extra Demo Videos:

5- :clapper: **Extra Demo 5:** Extra tools that can be integrated with OpenAI on Zapier

https://github.com/user-attachments/assets/c08948fb-4bbd-4d0c-a514-879a2274568f

6- :clapper: **Extra Demo 6:** Building the integration of Slack with ChatGpT and return a summary response in the Slack thread every time someone uses a reaction with the bowtie emoji

https://github.com/user-attachments/assets/d932be41-2ebb-4f21-8687-3ced710ee10b

## 📺 Watch on YouTube

- [Presentation Video](https://youtu.be/3XDdwhLv7xU)
- [Demo Video 1](https://youtu.be/spvV1CVlvH4)
- [Demo Video 2](https://youtu.be/bN-s3DJ1JPs)
- [Demo Video 3](https://youtu.be/9wjVa3Ka5X8)
- [Demo Video 4](https://youtu.be/xrOtjU2fZ1U)
- [Demo Video 5](https://youtu.be/G8sWtYGGwx0)
- [Demo Video 6](https://youtu.be/Sr0a5Q1-cs0)
- [5th Artificial Intelligence Congress of PUC-SP 2024 - The presentation starts at 3h:26min:20s of the video.](https://www.youtube.com/watch?v=d7WaC06C6m4)

## 📚 AI Tools Utilized

1. [OpenAI GPT-3.5 Turbo ](https://platform.openai.com/docs/models/gpt-3-5-turbo): Provides the AI engine API behind the chatbot using GPT-3.5 Turbo.
2. [Slack](https://slack.com): The messaging platform where **SumBot** is integrated.
3. [Zapier](https://zapier.com): Automates workflows between Slack and OpenAI.
4. [Monica AI](https://monica.im): Used for advanced testing and interaction scenarios.
5. [InVideo](https://studio.invideo.io/): A video creation and editing platform that allows users to create professional-quality videos with ease, offering a wide range of templates, editing tools, and customization options for various purposes.
6. [Canva Pro](https://www.canva.com/): Canva Pro is a graphic design platform that offers advanced features to create professional designs easily and intuitively.

## :octocat: Contribute

Contributions are welcome! Here's how to contribute:

1. Fork the repository.
   ```bash
    git clone https://github.com/Mindful-AI-Assistants/SumBot.git
   ```

2. Create a new branch:
   ```bash
   git checkout -b feature/YourFeature
   ```

3. Commit your changes:
   ```bash
   git commit -m 'Add new feature'
   ```

4. Push to the branch:
   ```bash
   git push origin feature/YourFeature
   ```

5. Open a Pull Request. After pushing, use the command below to open the Pull Request URL directly in the browser if you're using the GitHub CLI:
   ```bash
   gh pr create --fill
   ```

## ⭒✮⭒ Code of Conduct

We are committed to fostering an open and welcoming environment. Please take a moment to review our [Code of Conduct](./CODE_OF_CONDUCT.md) to ensure that we can maintain a healthy and inclusive community.

By participating in this project, you agree to adhere to the standards outlined in the Code of Conduct.

(🌸❛ ֊ ❛„)♡

## 💌 Contact

### <img src="https://github.com/user-attachments/assets/517fc573-7607-4c5d-82a7-38383cc0537d" />

## 👌 For any questions, suggestions, or collaborations, feel free to reach out:

[Fabiana 🚀 Campanari](https://github.com/FabianaCampanari)

For more information and access to the project, visit:

-The GitHub repository:[SumBot FreeCode](https://github.com/Mindful-AI-Assistants/SumBot)

- Explore Ready Tensor’s AI initiatives: [AI Project ShowCase Competition 2024](https://app.readytensor.ai/)

## 🏆 Ready Tensor AI Project Showcase 2024 - Certificate for Best AI Tool Innovation Award

### <img src="https://github.com/user-attachments/assets/27954751-6dde-4b21-929f-9dc111fbc3dc" />

## Main Theoretical Reference

✍️ * RAJ, S. Building Chatbots with Python. São Paulo: Novatec, 2020.
✍️ * NG, A. Machine Learning Yearning: Technical Strategy for AI Engineers, In the Era of Deep Learning. 2018. Available at: https://www.mlyearning.org.

###### [Copyright 2024 Mindful AI Assistants. Code released under the MIT license.](https://github.com/Mindful-AI-Assistants/SumBot-FreeCode/blob/ed50e73edbc89242bfb21dbf16aef236e1ec9d1f/LICENSE)

SumBot

SumBot Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

SumBot

SumBot Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README