mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
d45477d10f
* Improve SEO metadata across docs Generated-By: mintlify-agent * revert api/* changes * Update components/cards.mdx * Update components/visibility.mdx --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
110 lines
6.1 KiB
Plaintext
110 lines
6.1 KiB
Plaintext
---
|
|
title: "Configure the assistant"
|
|
description: "Configure the AI assistant in your Mintlify dashboard: toggle availability, customize responses, add starter questions, set bot protection, and manage billing."
|
|
keywords: ["assistant", "settings", "deflection", "bot protection", "billing"]
|
|
---
|
|
|
|
Configure the assistant and manage billing on the [Assistant](https://dashboard.mintlify.com/products/assistant) page of your dashboard.
|
|
|
|
## Enable or disable the assistant
|
|
|
|
Toggle the assistant status to enable or disable the assistant for your documentation site.
|
|
|
|
<Frame>
|
|
<img src="/images/assistant/status-light.png" alt="The assistant status toggle in the dashboard." className="block dark:hidden" />
|
|
<img src="/images/assistant/status-dark.png" alt="The assistant status toggle in the dashboard." className="hidden dark:block" />
|
|
</Frame>
|
|
|
|
## Set deflection email
|
|
|
|
In the Response Handling section, enable the assistant to redirect unanswered questions to your support team.
|
|
|
|
Specify an email address for the assistant to give to users if it cannot answer their question. You can also enable a "Contact support" button to appear in the assistant chat panel.
|
|
|
|
<Frame>
|
|
<img src="/images/assistant/deflection-light.png" alt="The assistant deflection panel in the dashboard. Assistant deflection is toggled on and support@mintlify.com is set as the deflection email." className="block dark:hidden" />
|
|
<img src="/images/assistant/deflection-dark.png" alt="The assistant deflection panel in the dashboard. Assistant deflection is toggled on and support@mintlify.com is set as the deflection email." className="hidden dark:block" />
|
|
</Frame>
|
|
|
|
## Search domains
|
|
|
|
In the Response Handling section, configure domains that the assistant can use for web search to find additional context when answering questions.
|
|
|
|
- Domains must be publicly available.
|
|
- Domains that require JavaScript to load are not supported.
|
|
|
|
<Frame>
|
|
<img src="/images/assistant/search-domains-light.png" alt="The assistant search domains panel enabled in the dashboard. The assistant is configured to search the mintlify.com/pricing domain." className="block dark:hidden" />
|
|
<img src="/images/assistant/search-domains-dark.png" alt="The assistant search domains panel enabled in the dashboard. The assistant is configured to search the mintlify.com/pricing domain." className="hidden dark:block" />
|
|
</Frame>
|
|
|
|
For more precise control over what the assistant can search, use filtering syntax.
|
|
|
|
- **Domain-level filtering**
|
|
- `example.com`: Search only the `example.com` domain
|
|
- `docs.example.com`: Search only the `docs.example.com` subdomain
|
|
- `*.example.com`: Search all subdomains of `example.com`
|
|
- **Path-level filtering**
|
|
- `docs.example.com/api`: Search all pages under the `/api` subpath
|
|
- **Multiple patterns**
|
|
- Add multiple entries to target different sections of sites
|
|
|
|
## Add sample questions
|
|
|
|
Help your users begin conversations with the assistant by adding starter questions.
|
|
|
|
The assistant can generate page-specific questions based on the page a user is viewing or you can add persistent questions that are available across pages.
|
|
|
|
You can add up to three starter questions. Click **Ask AI** for recommended questions based on your documentation.
|
|
|
|
<Frame>
|
|
<img src="/images/assistant/search-suggestions-light.png" alt="The search suggestions panel in the dashboard with contextual starter questions enabled." className="block dark:hidden" />
|
|
<img src="/images/assistant/search-suggestions-dark.png" alt="The search suggestions panel in the dashboard with contextual starter questions enabled." className="hidden dark:block" />
|
|
</Frame>
|
|
|
|
## Bot protection
|
|
|
|
In the Bot Protection section, enable invisible captcha to protect your assistant from automated abuse. The bot protection is privacy-friendly and invisible to nearly all visitors.
|
|
|
|
To enable bot protection:
|
|
|
|
1. Go to the [Assistant settings](https://dashboard.mintlify.com/products/assistant/settings) page in your dashboard.
|
|
2. In the **Bot Protection** section, toggle **Invisible Captcha** on.
|
|
|
|
Changes take up to 10 minutes to propagate.
|
|
|
|
<Note>
|
|
If you use custom [Content Security Policy headers](/deploy/csp-configuration), you must include `hcaptcha.com` and `*.hcaptcha.com` in your allowlist.
|
|
</Note>
|
|
|
|
## Manage billing
|
|
|
|
The assistant uses tiered message allowances. A message is any user interaction with the assistant that receives a correct response. If you have unused messages, up to half of your message allowance can carry over to the next billing cycle. For example, if you have a 1,000 message allowance and you use 300 messages, 500 messages carry over to the next billing cycle giving you a total of 1,500 messages for the next billing cycle.
|
|
|
|
By default, the assistant allows overages. You can disable overages to avoid incurring additional costs for usage beyond your tier. If you reach your message allowance with overages disabled, the assistant is unavailable until your message allowance resets. If you allow overages, each message beyond your allowance incurs an overage charge, but occasional overages may be cheaper than upgrading to a higher tier depending on your usage.
|
|
|
|
### Change your assistant tier
|
|
|
|
Assistant tiers determine your monthly message allowance and pricing.
|
|
|
|
View and change your current tier on the [Billing tab](https://dashboard.mintlify.com/products/assistant?tab=billing) of the assistant page in your dashboard.
|
|
|
|
In the **Spending Controls** section, select your preferred tier from the dropdown menu.
|
|
|
|
**Upgrade your tier:**
|
|
- Your new message allowance is available immediately.
|
|
- You pay a prorated difference for the current billing cycle.
|
|
|
|
**Downgrade your tier:**
|
|
- Your message allowance updates immediately.
|
|
- Pricing changes take effect at the start of your next billing cycle.
|
|
- Unused messages from your current tier **do not** carry over.
|
|
|
|
### Allow overages
|
|
|
|
If you want to disallow overages, disable them in the **Billing Controls** section of the [Billing tab](https://dashboard.mintlify.com/products/assistant?tab=billing) of the assistant page in your dashboard.
|
|
|
|
### Set usage alerts
|
|
|
|
In the Billing Controls section, set usage alerts to receive an email when you reach a certain percentage of your message allowance.
|