mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
51f9be82f8
* docs: document assistant link deflection and thread transcript endpoint * fix: correct link deflection anchor in assistant thread page --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
123 lines
7.0 KiB
Plaintext
123 lines
7.0 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 on the [Assistant](https://app.mintlify.com/products/assistant) page of your dashboard. Manage billing and usage on the [Usage](https://app.mintlify.com/settings/organization/usage) page.
|
|
|
|
## Enable or disable the assistant
|
|
|
|
Toggle the 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 emails
|
|
|
|
In the Response Handling section, enable the assistant to prompt users to contact your support and sales teams when it can't answer a question on its own.
|
|
|
|
Choose the **Email** deflection mode, then enter one or both of the following addresses:
|
|
|
|
- **Support**: For questions the assistant can't resolve from your documentation.
|
|
- **Sales**: For questions about pricing, plans, or purchasing.
|
|
|
|
When you enable deflection and the assistant detects a matching question, an in-chat contact form appears. The form asks for the user's first name, last name, company, company email, and a message. Mintlify emails the submission to the appropriate team, which can respond directly to the user's email.
|
|
|
|
The same contact form is available in the [assistant widget](/assistant/widget) embedded on other sites. No extra widget configuration is required.
|
|
|
|
<Tip>
|
|
If you prefer to route support questions to your existing support channels instead, disable the **Contact form** in the Response Handling section.
|
|
|
|
When you disable the contact form, the assistant directs users to your support email address in plain text instead of showing the in-chat form. Sales questions still use the in-chat form when a sales email is configured.
|
|
</Tip>
|
|
|
|
## Deflect to a support link
|
|
|
|
Switch the deflection mode to **Link** to send users to your existing support platform (for example, a help center, ticket portal, or community forum) instead of collecting email through an in-chat form.
|
|
|
|
Enter the full URL of your support destination. The URL must use `http` or `https` and cannot include credentials.
|
|
|
|
When the assistant detects a support question, it shows the user a card linking to your support URL. Mintlify appends the assistant thread ID as a `threadId` query parameter so your support tool can attach the conversation transcript to the resulting ticket. Fetch the transcript with the [Get assistant conversation thread](/api/analytics/assistant-thread) endpoint.
|
|
|
|
In link deflection mode, the assistant does not show the email contact form. Sales deflection is only available in email mode.
|
|
|
|
## 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`
|
|
{/* vale Vale.Terms = NO */}
|
|
- **Path-level filtering**
|
|
- `docs.example.com/api`: Search all pages under the `/api` subpath
|
|
{/* vale Vale.Terms = YES */}
|
|
- **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 Assistant** 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://app.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 runs on credits. Each assistant message consumes credits, where a message is any user interaction with the assistant that receives a response. See [Credit pricing](/credits) for more information.
|
|
|
|
### Change your credit tier
|
|
|
|
1. Go to the [Usage](https://app.mintlify.com/settings/organization/usage) page of your dashboard.
|
|
2. In the **Credit packages** section, select a tier from the dropdown menu.
|
|
3. Confirm the change to proceed to checkout.
|
|
|
|
### Allow overages
|
|
|
|
Your organization shares credits across deployments. By default, Mintlify disables overages. You can configure different overage limits for each deployment. If you disable overages for a deployment, the assistant becomes unavailable if you spend your organization's shared credit balance. The assistant remains unavailable until your credit balance resets.
|
|
|
|
To allow overages, enable them in the **Spending controls** section of the [Usage](https://app.mintlify.com/settings/organization/usage) page of your dashboard. If you enable overages, each credit spent beyond the shared balance incurs an overage charge.
|
|
|
|
### Set usage alerts
|
|
|
|
In the **Spending controls** section of your dashboard, set usage alerts to receive an email when your organization reaches a certain percentage of its shared credit balance.
|
|
|
|
### Higher credit volumes
|
|
|
|
For plans larger than 10,000 credits per month, [contact sales](mailto:sales@mintlify.com) to discuss custom credit packages.
|