Skip to content

RocketChat/Apps.Chat.Summarize

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 

Repository files navigation

chat-summarizer-illustration

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.

chat-summarizer-illustration

Features 🚀

  • Summarize messages in channel / DM / thread
  • Capture assigned tasks & participant summary in dialogue
  • Suggest follow-up questions for quick reply
  • Provide file summary of messages attachments
  • Support custom LLM selection
  • Detect and block malicious prompt injection

How to set up 💻

  1. Have a Rocket.Chat server ready. If you don't have a server, see this guide.
  2. 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
    
  3. Clone the GitHub Repository
  4.    git clone https://github.com/RocketChat/Apps.Chat.Summarize.git
    
  5. Install app dependencies
  6.   cd app && npm install
    
  7. 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".
  8. Deploy the app to the server
  9. rc-apps deploy --url <server_url> --username <username> --password <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.

Screenshot 2024-08-21 at 11 08 47 PM

Support us ❤️

If you like this project, please leave a star ⭐️. This helps more people to know this project.

About

Summarize Rocket.Chat threads

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published