-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
SumBot-AI-ProjectCompetition-2024.html
213 lines (152 loc) · 10.5 KB
/
SumBot-AI-ProjectCompetition-2024.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
<!-- Start Header -->
<!--
https://github.com/user-attachments/assets/5d926e06-3b75-4d9e-87a1-3830a490f5d4
-->
<!-- :bowtie: <img src="https://github.githubassets.com/images/icons/emoji/bowtie.png" width="48"> -->
<!-- End Header -->
<br><br>
<h2 align="center"> <img src="https://github.githubassets.com/images/icons/emoji/bowtie.png" width="40"> SumBot FreeCode </h2>
<h4 align="center"> 🤖🦾 <strong>AI-Powered ChatBot with GPT-3.5 Turbo integration.</strong></h4>
<br>
<!-- Gb Badges -->
<h4 align="center">
<a href="https://github.com/gayanvoice/top-github-users/blob/a21ad6fb4c8e302f4caebc5262554259e58aeceb/markdown/public_contributions/brazil.md">
<img src="https://github.com/gayanvoice/top-github-users/actions/workflows/action.yml/badge.svg" alt="Top GitHub Users">
</a>
</h4>
<h4 align="center">
<a href="https://github.com/sponsors/Mindful-AI-Assistants">
<img src="https://img.shields.io/badge/Sponsor-Mindful%20AI%20%20Assistants-brightgreen?logo=GitHub" alt="Sponsor Mindful AI Assistants">
</a>
</h4>
<h4 align="center">
<a href="https://github.com/AI-Powered-Bots/demo-repository/actions/workflows/proof-html.yml">
<img src="https://github.com/AI-Powered-Bots/demo-repository/actions/workflows/proof-html.yml/badge.svg" alt="Proof HTML">
</a>
<a href="https://github.com/AI-Powered-Bots/demo-repository/actions/workflows/auto-assign.yml">
<img src="https://github.com/AI-Powered-Bots/demo-repository/actions/workflows/auto-assign.yml/badge.svg" alt="Auto Assign">
</a>
</h4>
<br>
<p><strong>SumBot FreeCode</strong> leverages the power of <strong>GPT-3.5 Turbo</strong> to automatically summarize long messages, helping users to stay focused and manage information overload. Developed by <a href="https://github.com/FabianaCampanari">Fabiana Campanari</a> for the <strong>AI Project Showcase Hackaton 2024</strong>, in collaboration with <a href="https://app.readytensor.ai/">Ready Tensor AI</a> during the Hackathon, this chatbot is a prime example of AI applied to automated interactions, providing unique and efficient experiences.</p>
<p>For more information and access to the project, visit:</p>
<ul>
<li>The GitHub repository: <a href="https://github.com/Mindful-AI-Assistants/SumBot-FreeCode">SumBot FreeCode</a>.</li>
<li>Learn more about Ready Tensor's AI platform: <a href="https://app.readytensor.ai/">Ready Tensor AI</a>.</li>
</ul>
<br>
<h2>📑 Table of Contents</h2>
<ul>
<li><a href="#-introduction">Introduction</a></li>
<li><a href="#-features">Features</a></li>
<li><a href="#-purpose">Purpose</a></li>
<li><a href="#-vision">Vision</a></li>
<li><a href="#-why-sumbot">Why SumBot?</a></li>
<li><a href="#-how-it-works">How It Works</a></li>
<li><a href="#-who-is-it-for">Who Is It For?</a></li>
<li><a href="#-key-benefits">Key Benefits</a></li>
<li><a href="#-installation">Installation</a></li>
<li><a href="#-usage">Usage</a></li>
<li><a href="#-demo-videos">Demo Videos</a></li>
<li><a href="#-extra-ai-tools">Extra AI Tools</a></li>
<li><a href="#-contribute">Contribute</a></li>
<li><a href="#-code-of-conduct">Code of Conduct</a></li>
<li><a href="#-contact">Contact</a></li>
<li><a href="#license">License</a></li>
</ul>
<h2 id="introduction">📝 Introduction</h2>
<p>Welcome to <strong>SumBot FreeCode</strong>, an AI-powered chatbot that transforms long texts into concise summaries, making communication more efficient. Developed with <strong>GPT-3.5 Turbo</strong> and integrated with platforms like <strong>Slack</strong>, it’s the perfect tool for managing information overload, whether in business settings or academic environments.</p>
<h2 id="features">🌟 Features</h2>
<ul>
<li><strong>Automated Summarization</strong>: Summarizes long texts using GPT-3.5 Turbo.</li>
<li><strong>Slack Integration</strong>: Seamlessly automate tasks within Slack.</li>
<li><strong>Custom Triggers</strong>: Summarization triggered by bowtie :bowtie: emoji reactions.</li>
<li><strong>Zapier Workflow</strong>: Connect with various tools for smooth automation.</li>
<li><strong>No Programming Required</strong>: Easy to use for everyone, regardless of technical expertise.</li>
</ul>
<h2 id="purpose">🤔 Purpose</h2>
<p>The purpose of <strong>SumBot FreeCode</strong> is simple: <strong>manage information overload</strong>. By summarizing long texts automatically, it saves time and increases productivity across various platforms, from business reports to academic papers.</p>
<h2 id="vision">💭 Vision</h2>
<p>Imagine having a personal assistant that condenses overwhelming amounts of information into manageable summaries. That’s the vision behind <strong>SumBot</strong>—to simplify workflows by summarizing messages in Slack with a single emoji, such as the :bowtie: bowtie, making communication more streamlined.</p>
<h2 id="why-sumbot">:bulb: Why SumBot?</h2>
<p>In a world overflowing with information, <strong>SumBot</strong> helps you cut through the noise by efficiently summarizing lengthy texts. By leveraging <strong>OpenAI</strong>, <strong>Slack</strong>, and <strong>Zapier</strong>, it provides a simple yet powerful solution to improve productivity and communication without requiring any programming knowledge.</p>
<h2 id="how-it-works">✍️ How It Works</h2>
<ol>
<li><strong>OpenAI API</strong>: Powers the summarization using <strong>GPT-3.5 Turbo</strong>, an advanced natural language model.</li>
<li><strong>Slack</strong>: Provides the platform for user interaction, where <strong>SumBot</strong> summarizes messages when triggered.</li>
<li><strong>Zapier</strong>: Automates the workflow between Slack and OpenAI, enabling message summaries when specific emojis are used.</li>
</ol>
<h4 align="center"> <a href="#">Automation Workflow ☟</a> </h4>
<!--
<h4 align="center"> <img src="https://github.com/user-attachments/assets/fe005785-c760-4657-bd3e-086d8a73772a"> </h4>
-->
<h4 align="center"> <img width="525" alt="Automation Workflow" src="https://github.com/user-attachments/assets/fc12aef6-7198-4a3a-9515-296f122e2e3e"> </h4>
<h2 id="who-is-it-for">:dart: Who Is It For?</h2>
<h3><strong>SumBot FreeCode</strong> is ideal for a variety of users:</h3>
<ul>
<li><strong>Business Professionals</strong>: Summarizes reports and communications for quick comprehension.</li>
<li><strong>Students</strong>: Helps summarize academic articles and long study texts.</li>
<li><strong>Customer Support Teams</strong>: Provides concise summaries of customer conversations.</li>
<li><strong>Researchers</strong>: Extracts key insights from academic papers.</li>
<li><strong>Marketers</strong>: Summarizes social media interactions and discussions.</li>
<li><strong>Educators</strong>: Breaks down complex educational material into easier summaries.</li>
<li><strong>Writers</strong>: Extracts key points from research materials.</li>
</ul>
<h2 id="key-benefits">👌 Key Benefits</h2>
<ul>
<li><strong>Time-Saving</strong>: Quickly condenses long texts, so you can focus on what matters.</li>
<li><strong>Enhanced Productivity</strong>: Efficiently manage and process large amounts of information.</li>
<li><strong>Decision Support</strong>: Provides concise summaries to aid in quick decision-making.</li>
<li><strong>Customizable
</li>
<li><strong>Customizable Triggers</strong>: Set specific emojis or keywords to trigger summarizations automatically.</li>
<li><strong>Cross-Platform Integration</strong>: Integrate with Slack, Zapier, and more for seamless automation.</li>
</ul>
<h2 id="installation">💻 Installation</h2>
<p>To get started with <strong>SumBot FreeCode</strong>, follow these steps:</p>
<ol>
<li>Clone the repository: <code>git clone https://github.com/Mindful-AI-Assistants/SumBot-FreeCode.git</code></li>
<li>Install the required dependencies (Optional):
<ul>
<li>Create a <code>requirements.txt</code> file with necessary packages, or run <code>pip install openai slack-sdk</code> in your virtual environment.</li>
<li>Set up your environment variables to connect with OpenAI and Slack APIs.</li>
</ul>
</li>
<li>Run the application:
<ul>
<li>Use the provided <code>run.py</code> script to start the bot, or integrate it into your automation workflows via Zapier.</li>
</ul>
</li>
</ol>
<h2 id="usage">🔧 Usage</h2>
<p>Once installed, <strong>SumBot FreeCode</strong> can be easily used within your preferred platforms:</p>
<ul>
<li><strong>Slack:</strong> Trigger summarizations by using the <code>:bowtie:</code> emoji in any message or conversation.</li>
<li><strong>Zapier:</strong> Automate message summarizations across multiple tools using custom workflows.</li>
</ul>
<h2 id="demo-videos">🎥 Demo Videos</h2>
<p>Watch these demo videos to see <strong>SumBot FreeCode</strong> in action:</p>
<ul>
<li><a href="#">Slack Summarization Demo</a></li>
<li><a href="#">Workflow Automation Demo</a></li>
</ul>
<h2 id="extra-ai-tools">🤖 Extra AI Tools</h2>
<p><strong>SumBot FreeCode</strong> is just one example of how AI tools can enhance productivity. Check out more AI-powered tools on our <a href="https://github.com/Mindful-AI-Assistants">Mindful AI Assistants</a> GitHub page.</p>
<h2 id="contribute">🤝 Contribute</h2>
<p>We welcome contributions to improve <strong>SumBot FreeCode</strong>. Whether it's bug fixes, feature enhancements, or documentation improvements, your input is valuable.</p>
<ul>
<li>Fork the repository.</li>
<li>Create a feature branch (<code>git checkout -b feature/new-feature</code>).</li>
<li>Commit your changes (<code>git commit -m 'Add new feature'</code>).</li>
<li>Push to the branch (<code>git push origin feature/new-feature</code>).</li>
<li>Create a pull request.</li>
</ul>
<h2 id="code-of-conduct">📜 Code of Conduct</h2>
<p>Before contributing, please read our <a href="#">Code of Conduct</a> to ensure a respectful and welcoming environment for all participants.</p>
<h2 id="contact">📬 Contact</h2>
<p>If you have any questions, feel free to reach out to the project creator, <a href="https://github.com/FabianaCampanari">Fabiana Campanari</a>, via GitHub or the <a href="mailto:contact@example.com">email address</a> provided in the repository.</p>
<h2 id="license">📄 License</h2>
<p>This project is licensed under the <a href="#">MIT License</a>. Feel free to use, distribute, and contribute!</p>
<br><br>
<p align="center">💡 <strong>Thank you for checking out SumBot FreeCode!</strong> We hope it helps you streamline your workflows and stay on top of important information.</p>
<!-- End of README -->