diff --git a/ai/assistant.mdx b/ai/assistant.mdx index d85c10c95..be68df77e 100644 --- a/ai/assistant.mdx +++ b/ai/assistant.mdx @@ -12,7 +12,7 @@ keywords: ["chat", "RAG", "user support"] 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 uses agentic RAG (retrieval-augmented generation) with tool calling powered by Claude Sonnet 4.5. When users ask questions, the assistant: +The assistant uses agentic RAG (retrieval-augmented generation) with tool calling powered by Claude Opus 4.5. When users ask questions, the assistant: * **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. @@ -26,7 +26,7 @@ You can view assistant usage through your dashboard to understand user behavior * Content gaps where users struggle to find answers. * Popular topics that could benefit from additional content. -## Configuring the assistant +## Configure the assistant The assistant is enabled by default for Pro and Custom plans. @@ -67,7 +67,7 @@ In the response handling section, enable the assistant to redirect unanswered qu ### Search sites - Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:gtm@mintlify.com). + Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:gtm@mintlify.com). In the response handling section, configure sites that the assistant can search for additional context when answering questions. @@ -114,33 +114,82 @@ When you reach your spend limit, the assistant is disabled until your message al 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. -## Using the assistant - -Users can access the assistant in three ways: - -- **Keyboard shortcut**: Command + I (Ctrl + I on Windows) -- **Assistant button** next to the search bar - Search bar and assistant button in light mode. - Search bar and assistant button in dark mode. -- **URLs** with `?assistant=open` appended open the assistant when the page loads. For example, [https://mintlify.com/docs?assistant=open](https://mintlify.com/docs?assistant=open). - -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. +## 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. + +### UI placement + +Depending on how you configure your assistant placement, the assistant appears as either a button next to the search bar or a bar at the bottom of the page. + + + + Search bar and assistant button in light mode. +Search bar and assistant button in dark mode. + + +Assistant bar in light mode. +Assistant bar in dark mode. + + + +### Keyboard shortcut + +Open the assistant chat panel with the keyboard shortcut Command + I on macOS and Ctrl + I on Windows. + +### Highlight text + +Highlight text on a page and click the **Add to assistant** pop up button to open the assistant chat panel and add the highlighted text as context. You can add multiple text snippets or code blocks to the assistant's context. + + +The Add to assistant button above highlighted text in light mode. +The Add to assistant button above highlighted text in dark mode. + + +### Code blocks + +Click the **Ask AI** button in a code block to open the assistant chat panel and add the code block as context. You can add multiple code blocks or text snippets to the assistant's context. + + +The Ask AI button in a code block in light mode. +The Ask AI button in a code block in dark mode. + + +### URLs + +Append `?assistant=open` to a URL to open the assistant when the page loads. For example, [https://mintlify.com/docs?assistant=open](https://mintlify.com/docs?assistant=open). ## Making content AI ingestible diff --git a/images/assistant/assistant-bar-dark.png b/images/assistant/assistant-bar-dark.png new file mode 100644 index 000000000..b1f7c33c8 Binary files /dev/null and b/images/assistant/assistant-bar-dark.png differ diff --git a/images/assistant/assistant-bar-light.png b/images/assistant/assistant-bar-light.png new file mode 100644 index 000000000..e14de737b Binary files /dev/null and b/images/assistant/assistant-bar-light.png differ diff --git a/images/assistant/code-block-dark.png b/images/assistant/code-block-dark.png new file mode 100644 index 000000000..f699d0c3d Binary files /dev/null and b/images/assistant/code-block-dark.png differ diff --git a/images/assistant/code-block-light.png b/images/assistant/code-block-light.png new file mode 100644 index 000000000..0f10144a1 Binary files /dev/null and b/images/assistant/code-block-light.png differ diff --git a/images/assistant/highlight-dark.png b/images/assistant/highlight-dark.png new file mode 100644 index 000000000..37d61bd45 Binary files /dev/null and b/images/assistant/highlight-dark.png differ diff --git a/images/assistant/highlight-light.png b/images/assistant/highlight-light.png new file mode 100644 index 000000000..3ad65840a Binary files /dev/null and b/images/assistant/highlight-light.png differ