diff --git a/.vale/styles/config/vocabularies/Mintlify/accept.txt b/.vale/styles/config/vocabularies/Mintlify/accept.txt index 7465c6910..752ebd501 100644 --- a/.vale/styles/config/vocabularies/Mintlify/accept.txt +++ b/.vale/styles/config/vocabularies/Mintlify/accept.txt @@ -234,7 +234,6 @@ transpilation tsx TTL typeof -ui uncached undefined uri diff --git a/ai/assistant.mdx b/ai/assistant.mdx index df7161e48..47d0894fd 100644 --- a/ai/assistant.mdx +++ b/ai/assistant.mdx @@ -10,7 +10,7 @@ keywords: ["chat", "RAG", "user support"] ## 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: @@ -40,7 +40,7 @@ You can [set a deflection email](/ai/assistant#set-deflection-email) so that the ## 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. @@ -99,29 +99,44 @@ Help your users start questions with the assistant by adding sample questions. I The search suggestions panel in the dashboard. What is an OpenAPI spec? is configured as a sample question. -### 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. The billing tab on the Assistant Configurations page. The Billing tab is emphasized with an orange rectangle. The billing tab on the Assistant Configurations page. The Billing tab is emphasized with an orange rectangle. -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. @@ -244,7 +259,7 @@ Use assistant insights to understand how users interact with your documentation ### 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. @@ -265,6 +280,6 @@ The chat history tab displays chronological records of all assistant conversatio 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.