You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* update plan name
* add managing the assistant section
* add enable/disable info
* add info on message limits
* simplify managing the assistant section
* remove response handling
Copy file name to clipboardExpand all lines: guides/assistant.mdx
+19-1Lines changed: 19 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ icon: "bot"
5
5
---
6
6
7
7
<Info>
8
-
The assistant is automatically enabled on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=assistant).
8
+
The assistant is automatically enabled on [Pro and Custom plans](https://mintlify.com/pricing?ref=assistant).
9
9
</Info>
10
10
11
11
## About the assistant
@@ -18,12 +18,30 @@ The assistant uses agentic RAG (retrieval-augmented generation) with tool callin
18
18
***Cites sources** and provides navigable links to take users directly to referenced pages.
19
19
***Generates copyable code examples** to help users implement solutions from your documentation.
20
20
21
+
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.
22
+
21
23
You can view assistant usage through your dashboard to understand user behavior and documentation effectiveness. Export and analyze query data to help identify:
22
24
23
25
* Frequently asked questions that might need better coverage.
24
26
* Content gaps where users struggle to find answers.
25
27
* Popular topics that could benefit from additional content.
26
28
29
+
## Managing the assistant
30
+
31
+
The assistant is enabled by default for Pro and Custom plans. You can manage the assistant from your [dashboard](https://dashboard.mintlify.com/products/assistant/settings).
32
+
33
+
**Enable or disable the assistant**
34
+
35
+
Toggle the assistant status to enable or disable the assistant for your documentation site.
36
+
37
+
**Spend limit**
38
+
39
+
Set a spend limit to control what happens if you reach your message allowance. By default, the assistant will continue to answer user questions after you reach your message allowance, which incurs overages.
40
+
41
+
In the **Billing** tab of the [Assistant Configurations](https://dashboard.mintlify.com/products/assistant/settings) page, you can set a spend limit for assistant messages beyond your allowance. When you reach your spend limit, the assistant is disabled until your message allowance resets.
42
+
43
+
You can also set usage alerts to receive an email when you reach a certain percentage of your spend limit.
0 commit comments