Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .vale/styles/config/vocabularies/Mintlify/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,6 @@ transpilation
tsx
TTL
typeof
ui
uncached
undefined
uri
Expand Down
37 changes: 26 additions & 11 deletions ai/assistant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@

## About the assistant

The assistant answers questions about your documentation through natural language queries. It is embedded directly in your documentation site, so users can find answers quickly and succeed with your product.
The assistant answers questions about your documentation through natural language queries. Users access the assistant on your documentation site, so they can find answers quickly and succeed with your product even if they don't know where to look.

The assistant uses agentic RAG (retrieval-augmented generation) with tool calling powered by Claude Opus 4.5. When users ask questions, the assistant:

Check warning on line 15 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L15

Spell out 'RAG', if it's unfamiliar to the audience.

* **Searches and retrieves** relevant content from your documentation to provide accurate answers.
* **Cites sources** and provides navigable links to take users directly to referenced pages.
* **Generates copyable code examples** to help users implement solutions from your documentation.

Each message sent to the assistant counts toward your plan's message allowance. If you exceed your allowance, additional messages incur overage charges. You can set spending limits or disable the assistant if you reach your message allowance.

Check warning on line 21 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L21

Use 'turn off' or 'off' instead of 'disable'.

You can view assistant usage through your dashboard to understand user behavior and documentation effectiveness. Export and analyze query data to help identify:

Expand All @@ -40,18 +40,18 @@

## Configure the assistant

The assistant is enabled by default for Pro and Custom plans.
The assistant is active on Pro and Custom plans by default.

Manage the assistant from your [dashboard](https://dashboard.mintlify.com/products/assistant/settings). Click **Configuration** to enable or disable the assistant, configure response handling, add default questions, and set a spend limit.

Check warning on line 45 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L45

Use 'turn off' or 'off' instead of 'disable'.

<Frame>
<img src="/images/assistant/configuration-light.png" alt="The assistant toolbar in the dashboard. The Configuration button is emphasized with an orange rectangle." className="block dark:hidden" />
<img src="/images/assistant/configuration-dark.png" alt="The assistant toolbar in the dashboard. The Configuration button is emphasized with an orange rectangle." className="hidden dark:block" />
</Frame>

### Enable or disable the assistant

Check warning on line 52 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L52

Use 'turn off' or 'off' instead of 'disable'.

Toggle the assistant status to enable or disable the assistant for your documentation site.

Check warning on line 54 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L54

Use 'turn off' or 'off' instead of 'disable'.

<Frame>
<img src="/images/assistant/status-light.png" alt="The assistant status toggle in the dashboard." className="block dark:hidden" />
Expand Down Expand Up @@ -99,29 +99,44 @@
<img src="/images/assistant/search-suggestions-dark.png" alt="The search suggestions panel in the dashboard. What is an OpenAPI spec? is configured as a sample question." className="hidden dark:block" />
</Frame>

### Set a spend limit
### Change your assistant tier

Set a spend limit to control what happens if you reach your message allowance. By default, the assistant continues to answer user questions after you reach your message allowance, which incurs overages.
Assistant tiers determine your monthly message allowance and pricing.

When you reach your spend limit, the assistant is disabled until your message allowance resets.
View and change your current tier on the [Assistant Configurations](https://dashboard.mintlify.com/products/assistant/settings/billing) page of your dashboard.

1. Select the **Billing** tab.
<Frame>
<img src="/images/assistant/billing-light.png" alt="The billing tab on the Assistant Configurations page. The Billing tab is emphasized with an orange rectangle." className="block dark:hidden" style={{ width: '268px', height: 'auto' }} />
<img src="/images/assistant/billing-dark.png" alt="The billing tab on the Assistant Configurations page. The Billing tab is emphasized with an orange rectangle." className="hidden dark:block" style={{ width: '268px', height: 'auto' }} />
</Frame>
2. Set a spend limit for assistant messages beyond your allowance.
3. Set usage alerts to receive an email when you reach a certain percentage of your spend limit.
2. In the **Spending Controls** section, select your preferred tier from the dropdown menu.

**Upgrading your tier:**
- Your new message allowance is available immediately.
- You pay a prorated difference for the current billing cycle.

**Downgrading your tier:**
- Your new message allowance takes effect immediately.
- Unused messages from your current tier do not carry over.

### Allow overages

By default, the assistant does not allow overages. If you reach your message allowance, the assistant is unavailable until your message allowance resets.

If you want to allow overages, enable them in the **Billing Controls** section of the [Assistant Configurations](https://dashboard.mintlify.com/products/assistant/settings/billing) page of your dashboard.

You can also set usage alerts to receive an email when you reach a certain percentage of your message allowance.

## Use the assistant

Users have multiple ways to start a conversation with the assistant. Each method opens a chat panel on the right side of your docs. Users can ask any question and the assistant searches your documentation for an answer. If no relevant information is found, the assistant responds that it cannot answer the question.
Users have multiple ways to start a conversation with the assistant. Each method opens a chat panel on the right side of your docs. Users can ask any question and the assistant searches your documentation for an answer. If the assistant cannot retrieve relevant information, the assistant responds that it cannot answer the question.

Add the assistant as a bot to your [Slack workspace](/ai/slack-bot) or [Discord server](/ai/discord) so that your community can ask questions without leaving their preferred platform.

### UI placement

When the assistant is enabled, it appears in two locations: as a button next to the search bar and as a bar at the bottom of the page.
The assistant appears in two locations: as a button next to the search bar and as a bar at the bottom of the page.

<Columns cols={2}>
<Frame caption="Assistant button next to the search bar.">
Expand Down Expand Up @@ -244,7 +259,7 @@

### Categories

The categories tab uses LLMs to automatically categorize conversations. Categories show a summary of the topic or theme, when a question was last asked about the category, and how many questions have been asked about the category over time.
The categories tab uses LLMs to automatically categorize conversations. Categories show a summary of the topic or theme, when a question was last asked about the category, and the number of questions about the category over time.

Use categories to identify common topics, patterns in user needs and behavior, and areas where documentation might need expansion or clarification.

Expand All @@ -265,6 +280,6 @@
<Accordion title="Assistant chat bar not visible">
If the assistant UI is not visible in specific browsers, you may need to submit a false positive report to [EasyList](https://easylist.to). Browsers that use the EasyList Cookies List like Brave and Comet sometimes block the assistant or other UI elements. The EasyList Cookies List includes a domain-specific rule that hides fixed elements on certain domains to block cookie banners. This rule inadvertently affects legitimate UI components.

Submit a false positive report to [EasyList](https://github.com/easylist/easylist) to request removal of the rule. This resolves the issue for all users once the filter list is updated.
Submit a false positive report to [EasyList](https://github.com/easylist/easylist) to request removal of the rule. This resolves the issue for all users once the filter list updates.

</Accordion>