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
Copy file name to clipboardExpand all lines: guides/assistant.mdx
+30-24Lines changed: 30 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,17 +14,17 @@ The assistant answers questions about your documentation through natural languag
14
14
15
15
The assistant uses agentic RAG (retrieval-augmented generation) with tool calling powered by Claude Sonnet 4. When users ask questions, the assistant:
16
16
17
-
***Searches and retrieves** relevant content from your documentation to provide accurate answers.
18
-
***Cites sources** and provides navigable links to take users directly to referenced pages.
19
-
***Generates copyable code examples** to help users implement solutions from your documentation.
17
+
-**Searches and retrieves** relevant content from your documentation to provide accurate answers.
18
+
-**Cites sources** and provides navigable links to take users directly to referenced pages.
19
+
-**Generates copyable code examples** to help users implement solutions from your documentation.
20
20
21
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
22
23
23
You can view assistant usage through your dashboard to understand user behavior and documentation effectiveness. Export and analyze query data to help identify:
24
24
25
-
* Frequently asked questions that might need better coverage.
26
-
* Content gaps where users struggle to find answers.
27
-
* Popular topics that could benefit from additional content.
25
+
- Frequently asked questions that might need better coverage.
26
+
- Content gaps where users struggle to find answers.
27
+
- Popular topics that could benefit from additional content.
28
28
29
29
## Configuring the assistant
30
30
@@ -34,15 +34,15 @@ The assistant is enabled by default for Pro and Custom plans. You can manage the
34
34
35
35
Toggle the assistant status to enable or disable the assistant for your documentation site.
36
36
37
-
### Response handling
37
+
### Response customization
38
38
39
-
Configure how the assistant responds when it cannot find answers in your documentation. You can redirect unanswered questions to your support team and enable the assistant to search external websites.
39
+
When the assistant cannot find answers in your documentation, you can surface your support team email to redirect users.
40
40
41
-
-**Assistant Deflection**: When enabled, the assistant directs users to your support team for questions that it cannot answer.
42
-
-**Search Sites**: The assistant can search specified external sites for additional context when answering questions.
43
-
<Note>
44
-
Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:[email protected]).
45
-
</Note>
41
+
To provide additional context when answering questions, you can enable the assistant to search external sites such as your blog, pricing page, or partner integration docs.
42
+
43
+
<Info>
44
+
Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:[email protected]).
45
+
</Info>
46
46
47
47
### Spend limit
48
48
@@ -56,27 +56,33 @@ You can also set usage alerts to receive an email when you reach a certain perce
56
56
57
57
Users can access the assistant in three ways:
58
58
59
-
-**Keyboard shortcuts**: <kbd>?</kbd> or <kbd>Command</kbd> + <kbd>I</kbd> (<kbd>Ctrl</kbd> + <kbd>I</kbd> on Windows)
alt="Search bar and assistant button in dark mode."
78
84
/>
79
-
-**URLs** with `?assistant=open` appended will open the assistant when the page loads. For example, [https://mintlify.com/docs?assistant=open](https://mintlify.com/docs?assistant=open).
85
+
-**URLs** with `?assistant=open` appended will open the assistant when the page loads. For example, https://mintlify.com/docs?assistant=open.
80
86
81
87
Both methods open a chat panel on the right side of your docs. Users can ask any question and the assistant will search your documentation for an answer. If no relevant information is found, the assistant will respond that it cannot answer the question.
82
88
@@ -119,4 +125,4 @@ You can explore queries from your [dashboard](https://dashboard.mintlify.com/pro
119
125
- Summarize the most common themes of the queries.
0 commit comments