Skip to content

Commit

Permalink
Improve Copilot + local AI setup instructions (#7413)
Browse files Browse the repository at this point in the history
* Improve Copilot + local AI setup instructions

* Update source/configure/enable-copilot.rst

* πŸ“ (academy-copilot-setup.rst): Add new file to include Mattermost Academy badge
πŸ“ (enable-copilot.rst): Include Mattermost Academy badge and update API URL instructions
The new file academy-copilot-setup.rst was added to include a Mattermost Academy badge that links to a tutorial on setting up and configuring Mattermost Copilot with multiple LLMs. This badge was then included in enable-copilot.rst to provide users with a direct link to the tutorial. The instructions for entering the API URL were also updated to clarify the URL format for services other than Ollama.

---------

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>
  • Loading branch information
azigler and cwarnermm authored Oct 10, 2024
1 parent d551492 commit 13a58a4
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
12 changes: 12 additions & 0 deletions source/_static/badges/academy-copilot-setup.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
:orphan:
:nosearch:

.. raw:: html

<a href="https://academy.mattermost.com/p/new-mattermost-copilot-multi-llm-setup-usage" class="mm-badge mm-badge--academy" target="_blank">
<img src="../_static/images/badges/academy-callout-image.jpg" alt="" />
<div class="mm-badge__copy">
<span class="mm-badge__accent-text">Mattermost Academy</span>
<span class="mm-badge__title">Learn about setting up and configuring Mattermost Copilot with multiple LLMs</span>
</div>
</a>
5 changes: 4 additions & 1 deletion source/configure/enable-copilot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ Enable Copilot

Signficantly increase team productivity and decision-making speed by enhancing your real-time collaboration capabilities with instant access to AI-generated information, discussion summaries, and contextually-aware action recommendations with Mattermost's Copilot. Your users can interact with AI capabilities directly within their daily communication channels without needing to switch between multiple tools or platforms

.. include:: ../_static/badges/academy-copilot-setup.rst
:start-after: :nosearch:

Setup
------

Expand Down Expand Up @@ -82,7 +85,7 @@ Configure a large language model (LLM) for your Copilot integration by going to

1. Deploy your model, for example, on `Ollama <https://ollama.com/>`_.
2. Select **OpenAI Compatible** in the **AI Service** dropdown.
3. Enter the URL to your AI service from your Mattermost deployment in the **API URL** field.
3. Enter the URL to your AI service from your Mattermost deployment in the **API URL** field. Be sure to include the port, and append ``/v1`` to the end of the URL if using Ollama. (e.g., ``http://localhost:11434/v1`` for Ollama, otherwise ``http://localhost:11434/``)
4. If using Ollama, leave the **API Key** field blank.
5. Specify your model name in the **Default Model** field.

Expand Down

0 comments on commit 13a58a4

Please sign in to comment.