diff --git a/guides/assistant.mdx b/guides/assistant.mdx index 9752b31be..8809b4930 100644 --- a/guides/assistant.mdx +++ b/guides/assistant.mdx @@ -30,19 +30,35 @@ You can view assistant usage through your dashboard to understand user behavior 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. - - Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:gtm@mintlify.com). - +### Search sites + + + Site search is in beta. To enable it for your documentation site, [contact our sales team](mailto:gtm@mintlify.com). + + +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 the following filtering syntax when you configure external sites: + +- **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 ### Spend limit