chenilim / mattermost-plugin-ai

Mattermost AI Plugin

Table of Contents

• Mattermost AI Plugin
  • Table of Contents
  • Background
  • Install Mattermost + mattermost-plugin-ai
  • Usage
    • Conversation
    • Thread Summarization
    • Answer questions about Threads
    • Chat anywhere
    • React for me
    • RLHF Feedback Collection
  • Related Efforts
  • Contributing
  • License

Background

🚀 Check out our AI developer website, join the "AI Exchange" channel, and explore the peer-to-peer forums where Mattermost's open source community is sharing AI news and innovation in real time!

The LLM extensions plugin adds functionality to use and develop LLMs (like from OpenAI or Hugging Face) within Mattermost.

This plugin is currently experimental. More options and the ability to use local LLMs is on the roadmap. Contributions and suggestions are welcome, see below!

Install Mattermost + mattermost-plugin-ai

1. Clone and enter this repository:

• git clone https://github.com/mattermost/mattermost-plugin-ai && cd mattermost-plugin-ai

2. Start the services:

• docker compose up -d

3. Configure the Mattermost server from the init script:

• bash ./init.sh

4. Install mattermost-plugin-ai on Mattermost from the command line:

• MM_SERVICESETTINGS_SITEURL=http://localhost:8065 MM_ADMIN_USERNAME=root MM_ADMIN_PASSWORD=<YOUR_PASSWORD> make deploy

5. Access Mattermost and configure the plugin:

• Open Mattermost at http://localhost:8065
• Select View in Browser
• Log in with the generated root credentials
• In the top left Mattermost menu, click System Console ➡️ Mattermost AI Plugin
• Enable the plugin and configure plugin settings as desired.

For example, you can configure your OpenAI API key and allowed teams/users as desired.

Usage

Conversation

Chat with an LLM right inside the Mattermost interface. Answer are streamed so you don't have to wait:

conversation.mp4

Thread Summarization

Use the post menu or the /summarize command to get a summary of the thread in a DM:

Answer questions about Threads

Respond to the bot post to ask follow up questions:

thread_interrogation.mp4

Chat anywhere

Just mention @ai anywhere in Mattermost to ask it to respond. It will be given the context of the thread you are participating in:

React for me

Just for fun! Use the post menu to ask the bot to react to the post. It will try to pick an appropriate reaction.

reactforme.mp4

RLHF Feedback Collection

Bot posts will have 👍 👎 icons that will later be used to collect feedback for RLHF fine tuning. The idea would be to use this as input for RLHF fine tuning.

Related Efforts

Explore Mattermost's AI initiatives:

• https://ai.mattermost.com
• https://community.mattermost.com/core/channels/ai-exchange
• https://forum.mattermost.com/c/ai-frameworks/40
• https://docs.mattermost.com/about/mattermost-customizable-chatgpt-bot-framework.html
• https://mattermost.com/add-chatgpt-to-mattermost/
• https://github.com/Brightscout/mattermost-plugin-openai
• https://github.com/yGuy/chatgpt-mattermost-bot

Contributing

Visit our AI developer website and check out Mattermost's contributor guide to learn about contributing to our open source projects like this one.

License

This repository is licensed under Apache-2.