Skip to content
Merged
Changes from 1 commit
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
31 changes: 23 additions & 8 deletions guides/assistant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

The assistant answers questions about your documentation through natural language queries. It is embedded directly in your documentation site, providing users with immediate access to contextual help.

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

Check warning on line 15 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L15

Did you really mean 'agentic'?

* **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.
Expand All @@ -30,19 +30,34 @@

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), including enabling or disabling it, configuring response handling, and setting a spend limit.

### Enable or disable the assistant
### Assistant status

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

### Response handling
### Assistant deflection

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.
Enable the assistant to redirect unanswered questions to your support team. Provide an email address that the assistant will provide to users who ask questions that it cannot answer.

- **Assistant Deflection**: When enabled, the assistant directs users to your support team for questions that it cannot answer.
- **Search Sites**: The assistant can search specified external sites for additional context when answering questions.
<Note>
Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:[email protected]).
</Note>
### Search sites

<Note>
Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:[email protected]).
</Note>

Configure sites that the assistant can search for additional context when answering questions.

- Sites must be publicly available.
- Sites that require JavaScript to load are not supported.

You can use Exa's [filtering syntax](https://docs.exa.ai/changelog/domain-path-filter) when you configure external sites.

Check warning on line 52 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L52

Did you really mean 'Exa's'?

- **Domain-level filtering**
- `example.com`: Search the entire domain
- `docs.example.com`: Search only the docs subdomain
- **Path-level filtering**
- `docs.example.com/api/*`: Only search API documentation sections
- **Multiple patterns**
- You can add multiple entries to target different sections across sites for more granular control over what external content the assistant can reference.

### Spend limit

Expand All @@ -56,7 +71,7 @@

Users can access the assistant in three ways:

- **Keyboard shortcuts**: <kbd>?</kbd> or <kbd>Command</kbd> + <kbd>I</kbd> (<kbd>Ctrl</kbd> + <kbd>I</kbd> on Windows)

Check warning on line 74 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L74

Did you really mean 'Ctrl'?
- **Assistant button** next to the search bar
<img
src="/images/assistant/assistant-button-light.png"
Expand All @@ -80,7 +95,7 @@

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.

## Making content AI ingestible

Check warning on line 98 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L98

Did you really mean 'ingestible'?

Structure your documentation to help the assistant provide accurate, relevant answers. Clear organization and comprehensive context benefit both human readers and AI understanding.

Expand All @@ -89,7 +104,7 @@
- Write descriptive headings for sections.
- Create a logical information hierarchy.
- Use consistent formatting across your docs.
- Include comprehensive metadata in page frontmatter.

Check warning on line 107 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L107

Did you really mean 'frontmatter'?
- Break up long blocks of text into shorter paragraphs.
</Card>

Expand Down