Skip to content

Latest commit

 

History

History
351 lines (206 loc) · 13.4 KB

README.md

File metadata and controls

351 lines (206 loc) · 13.4 KB
Raw

[🇧🇷 Português] [🇺🇸 English]


🏆 I am thrilled to announce that this project won the Best AI Tool Innovation Award at the Ready Tensor AI Project Showcase Competition 2024! 🪷

💡 Best AI Tool Innovation:

👉🏻 View the publication on the Ready Tensor SumBot FreeCode. 👉🏻 SumBot FreeCode by Fabiana Campanari.


SumBot FreeCode

🤖🦾 "SumBot FreeCode: AI Chatbot Integrated with Slack using OpenAI GPT-3.5 Turbo API".**



SumBot-Presentation.mp4



Top GitHub Users Sponsor 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 for the AI Project Showcase Competition 2024 organized by Ready Tensor AI.


For more information and access to the project, visit:

🔭๋࣭ Table of Contents

*ੈ✩ 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 ☟☟

Automation Workflow

🧘🏼‍♀️ 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:

    git clone https://github.com/Mindful-AI-Assistants/SumBot.git

  2. Navigate into the project directory:

    cd SumBot-ReadyTensorAI-Hackaton

  3. Install the required dependencies:

    pip install -r requirements.txt

  4. Set up environment variables for the OpenAI API and Slack integration.

    export OPENAI_API_KEY='your_openai_api_key_here'
export SLACK_BOT_TOKEN='your_slack_bot_token_here'

  5. Run the chatbot:

    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. 🎬 Demo 1: Building Slack Integration on Zapier
1_Building.Slack.Integration.on.Zappier.mov

  1. 🎬 Demo 2: Integrating GPT-3.5 Turbo with Slack
2_Building.the.ChatGpT.3.5.Turbo.Integration.with.Slack.on.Zapier.mov

  1. 🎬 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
3_Building.SumBot_Testing_using.AI.Monica.to.compose.the.messages.mov

  1. 🎬 Demo 4: Testing the functionality of SumBot using the AI Monica virtual assistant to compose messages
4_Testing.the.functionality.of.SumBot.using.the.AI.Monica.virtual.assistant.to.compose.message.mov

🔭๋࣭ Extra Demo Videos:


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

5-Other.tools.that.can.be.integrated.with.OpenAI.on.Zapier.mov

6- 🎬 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

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.mov

📺 Watch on YouTube

📚 AI Tools Utilized

  1. OpenAI GPT-3.5 Turbo : Provides the AI engine API behind the chatbot using GPT-3.5 Turbo.
  2. Slack: The messaging platform where SumBot is integrated.
  3. Zapier: Automates workflows between Slack and OpenAI.
  4. Monica AI: Used for advanced testing and interaction scenarios.
  5. InVideo: 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: 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.

     git clone https://github.com/Mindful-AI-Assistants/SumBot.git

  2. Create a new branch:

    git checkout -b feature/YourFeature

  3. Commit your changes:

    git commit -m 'Add new feature'

  4. Push to the branch:

    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:

    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 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.

(🌸❛ ֊ ❛„)♡

Spread the word!

I encourage everyone to participate in the project and contribute to its success!


˗ˏˋॐˎˊ˗


TOGETHER WE ARE STRONGER, TOGETHER WE CAN CHANGE THE WORLD! 🌎🤍

💌 Contact



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

Fabiana 🚀 Campanari

For more information and access to the project, visit:

-The GitHub repository:SumBot FreeCode


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




Back to top



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.