it33 / mattermost-plugin-ai

Mattermost plugin for LLMs

Mattermost AI Plugin

Table of Contents

• Background
• Install Mattermost + mattermost-plugin-ai
  • On my existing MM server
  • Local Development
  • Gitpod Demo
• Usage
  • Streaming Conversation
  • Thread Summarization
  • Answer questions about Threads
  • Chat anywhere
  • React for me
  • RLHF Feedback Collection
• Related Efforts
• Contributing
• License

Background

🚀 Join the "AI Exchange" community server channel where Mattermost's open source community is sharing the latest AI resources and innovations!

The Mattermost AI plugin adds functionality to use LLMs (like from OpenAI or Hugging Face) within Mattermost.

This plugin is currently experimental. Contributions and suggestions are welcome, see below!

Install Mattermost + mattermost-plugin-ai

On existing Mattermost server

1. Download the latest release from https://github.com/mattermost/mattermost-plugin-ai/releases
2. Upload it to your server via System Console > Plugin Management.
3. Enable the plugin and configure the settings as desired.

Local Development

1. Clone and enter this repository:

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

2. Install mattermost-plugin-ai on Mattermost:

   `MM_SERVICESETTINGS_SITEURL=http://localhost:8065 MM_ADMIN_USERNAME=<YOUR_USERNAME> MM_ADMIN_PASSWORD=<YOUR_PASSWORD> make deploy`

3. Access Mattermost and configure the plugin:

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

Gitpod Demo

See our demo setup OpenOps for an easy to start demo.

Usage

Streaming Conversation

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

Thread Summarization

Use the post menu or the /summarize command to get a summary of the thread in a Direct Message from the AI Bot:

Answer questions about Threads

Respond to the bot post to ask follow up questions:

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:

Create meeting summary

Create meeting summaries! Designed to work with the calls plugin's recording feature.

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 have 👍 👎 icons that collect user feedback. The idea would be to use this as input for RLHF fine tuning or prompt development.

Related Efforts

Explore Mattermost's AI initiatives via the "Welcome to Mattermost’s AI Community" thread in the AI forums.

Contributing

To contribute to the project see contributor guide

Join the AI Exchange channel on our community server to discuss any questions.

Read our documentation about the Developer Workflow and Developer Setup for more information about developing and extending plugins.

See the issues for what you can do to help.

License

This repository is licensed under Apache-2.