https://github.com/rocketchat/apps.chat.summarize
Summarize Rocket.Chat threads
https://github.com/rocketchat/apps.chat.summarize
Last synced: 3 months ago
JSON representation
Summarize Rocket.Chat threads
- Host: GitHub
- URL: https://github.com/rocketchat/apps.chat.summarize
- Owner: RocketChat
- Created: 2024-05-07T04:25:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-21T06:14:34.000Z (10 months ago)
- Last Synced: 2025-03-21T07:23:35.472Z (10 months ago)
- Language: TypeScript
- Size: 9.84 MB
- Stars: 6
- Watchers: 4
- Forks: 19
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Rocket.Chat AI Chat Summarizer App
We all get the annoying moments of scrolling through 80+ unread messages. With the
AI chat summarizer, these headaches become the past. This AI app
quickly turns messages in channels, DMs, or threads into a concise summary, boosting productivity for Rocket.Chat users.
Features 🚀
- Summarize messages from today with
/chat-summary today - Summarize messages from the current week with
/chat-summary week - Summarize all unread messages with
/chat-summary unread
/chat-summary @username
or multiple users like
/chat-summary @username1 @username2
-
/chat-summary help– Displays the welcome message and Frequently Asked Questions. -
/chat-summary help <question>– Provides an answer from the AI.
How to set up 💻
- Have a Rocket.Chat server ready. If you don't have a server, see this guide.
- Install the Rocket.Chat Apps Engline CLI.
```
npm install -g @rocket.chat/apps-cli
```
Verify if the CLI has been installed
```
rc-apps -v
# @rocket.chat/apps-cli/1.4.0 darwin-x64 node-v10.15.3
```
- Clone the GitHub Repository
- Navigate to the repository
- Install app dependencies
- To install private Rocket.Chat Apps on your server, it must be in development mode. Enable Apps development mode by navigating to Administration > General > Apps and turn on "Enable development mode".
- Deploy the app to the server
- Open the App, by navigating to Administration > Marketplace > Private Apps. You should see the app listed there. Click on the App name to open the app.
- Select the Settings tab and enter the LLM API Host URL. This is the URL of the LLM API you want to use. For example, if you are using OpenAI's GPT-3.5, the URL would be https://api.openai.com . If you are using a different LLM, enter the appropriate URL. Without any suffixes.
- If the LLM provider requires an API key, enter the API key in the API Key field. This is required for authentication with the LLM provider. Local deployments usually don't require an API key.
```
git clone https://github.com/RocketChat/Apps.Chat.Summarize.git
```
```
cd Apps.Chat.Summarize
```
```
cd app && npm install
```
```
rc-apps deploy --url --username --password
```
- If you are running server locally, `server_url` is http://localhost:3000. If you are running in another port, change the 3000 to the appropriate port.
- `username` is the username of your admin user.
- `password` is the password of your admin user.
How to use 💬
Once setup is completed, type /chat-summary in the chat box of any channel / DM / thread, and you will see a summary of the messages like the one below.
New Filtering Commands:
To summarize messages based on specific timeframes or unread messages, you can now use the following commands:
- /chat-summary today – Summarize messages from today.
- /chat-summary week – Summarize messages from the current week (past 7 days).
- /chat-summary unread – Summarize all unread messages for the user.
- /chat-summary @username – Summarize messages from a specific user.
- /chat-summary @username1 @username2 – Summarize messages from multiple users.
Help Command:
-
/chat-summary help – Displays the welcome message and Frequently Asked Questions.
-
/chat-summary help < question > – Provides an answer from the AI.
Support us ❤️
If you like this project, please leave a star ⭐️. This helps more people to know this project.