Skip to content
23 changes: 22 additions & 1 deletion assistant/configure.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
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"]
keywords: ["assistant", "settings", "deflection", "bot protection", "billing", "BYOK", "bring your own model"]
---

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.
Expand All @@ -26,12 +26,12 @@

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.

Check warning on line 29 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L29

In general, use active voice instead of passive voice ('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.

Check warning on line 34 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L34

In general, use active voice instead of passive voice ('is configured').
</Tip>

## Deflect to a support link
Expand Down Expand Up @@ -97,6 +97,27 @@
If you use custom [Content Security Policy headers](/deploy/csp-configuration), you must include `hcaptcha.com` and `*.hcaptcha.com` in your allowlist.
</Note>

## Bring your own model

<Info>
Bringing your own model is an add-on for [Enterprise plans](https://mintlify.com/pricing?ref=byok). The **AI model** section appears in your dashboard only when the add-on is included in your contract. [Contact sales](mailto:sales@mintlify.com) to add it.

Check warning on line 103 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L103

In general, use active voice instead of passive voice ('is included').
</Info>

By default, Mintlify selects and manages the model that powers the assistant. Bring your own model to run Mintlify AI products on a model and API key that you control.

To configure your own model:

1. Go to the [API keys](https://app.mintlify.com/settings/organization/api-keys) page of your dashboard.
2. In the **AI model** section, toggle **Bring your own model** on.
3. Select a provider: **OpenRouter**, **Anthropic**, or **OpenAI-compatible**. OpenRouter is selected by default and works with all Mintlify AI products. Anthropic and OpenAI-compatible providers have limited compatibility: not all AI products work with them.

Check warning on line 112 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L112

In general, use active voice instead of passive voice ('is selected').
4. If you select **OpenAI-compatible**, enter a provider name and the provider's base URL. The base URL must use HTTPS and point to a publicly reachable hostname.
5. Select a model from the list for your provider.
6. Enter your provider API key and select **Save**.

Mintlify stores your API key securely and never displays it after saving. When you change models within the same provider, Mintlify reuses your saved key. When you change the provider or base URL, enter your key again. To rotate a key, enter a new key and save.

Toggle **Bring your own model** off to delete your configuration and return to Mintlify-managed models.

## 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.
Expand Down
25 changes: 24 additions & 1 deletion es/assistant/configure.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Configurar el assistant"
description: "Configura el assistant de IA en el dashboard de Mintlify: disponibilidad, respuestas personalizadas, preguntas iniciales, protección antibots y facturación."
keywords: ["assistant", "configuración", "derivación", "protección contra bots", "facturación"]
keywords: ["assistant", "configuración", "derivación", "protección contra bots", "facturación", "BYOK", "usa tu propio modelo"]
---

Configura el assistant en la página [Assistant](https://dashboard.mintlify.com/products/assistant) de tu dashboard. Administra la facturación y el uso en la página [Uso](https://dashboard.mintlify.com/settings/organization/usage).
Expand Down Expand Up @@ -108,6 +108,29 @@ Los cambios tardan hasta 10 minutos en propagarse.
Si usas [encabezados de Content Security Policy](/es/deploy/csp-configuration) personalizados, debes incluir `hcaptcha.com` y `*.hcaptcha.com` en tu lista de permitidos.
</Note>

<div id="bring-your-own-model">
## Usa tu propio modelo
</div>

<Info>
Usar tu propio modelo es un complemento para los [planes Enterprise](https://mintlify.com/pricing?ref=byok). La sección **AI model** aparece en tu dashboard solo cuando el complemento está incluido en tu contrato. [Contacta a ventas](mailto:sales@mintlify.com) para agregarlo.
</Info>

De forma predeterminada, Mintlify selecciona y administra el modelo que impulsa el assistant. Usa tu propio modelo para ejecutar los productos de IA de Mintlify con un modelo y una clave de API que tú controlas.

Para configurar tu propio modelo:

1. Ve a la página de [claves de API](https://app.mintlify.com/settings/organization/api-keys) de tu dashboard.
2. En la sección **AI model**, activa **Bring your own model**.
3. Selecciona un proveedor: **OpenRouter**, **Anthropic** u **OpenAI-compatible**. OpenRouter está seleccionado de forma predeterminada y funciona con todos los productos de IA de Mintlify. Los proveedores Anthropic y OpenAI-compatible tienen compatibilidad limitada: no todos los productos de IA funcionan con ellos.
4. Si seleccionas **OpenAI-compatible**, ingresa un nombre de proveedor y la URL base del proveedor. La URL base debe usar HTTPS y apuntar a un nombre de host accesible públicamente.
5. Selecciona un modelo de la lista de tu proveedor.
6. Ingresa la clave de API de tu proveedor y selecciona **Save**.

Mintlify almacena tu clave de API de forma segura y nunca la muestra después de guardarla. Cuando cambias de modelo dentro del mismo proveedor, Mintlify reutiliza tu clave guardada. Cuando cambias el proveedor o la URL base, ingresa tu clave de nuevo. Para rotar una clave, ingresa una clave nueva y guarda.

Desactiva **Bring your own model** para eliminar tu configuración y volver a los modelos administrados por Mintlify.

<div id="manage-billing">
## Administrar la facturación
</div>
Expand Down
25 changes: 24 additions & 1 deletion fr/assistant/configure.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Configurer l'assistant"
description: "Configurez l'assistant IA dans le tableau de bord Mintlify : disponibilité, réponses personnalisées, questions de démarrage, anti-bots et facturation."
keywords: ["assistant", "paramètres", "redirection", "protection contre les bots", "facturation"]
keywords: ["assistant", "paramètres", "redirection", "protection contre les bots", "facturation", "BYOK", "utiliser votre propre modèle"]
---

Configurez l'assistant sur la page [Assistant](https://dashboard.mintlify.com/products/assistant) de votre tableau de bord. Gérez la facturation et l'utilisation sur la page [Utilisation](https://dashboard.mintlify.com/settings/organization/usage).
Expand Down Expand Up @@ -108,6 +108,29 @@ Les modifications prennent jusqu'à 10 minutes pour se propager.
Si vous utilisez des [en-têtes Content Security Policy](/fr/deploy/csp-configuration) personnalisés, vous devez inclure `hcaptcha.com` et `*.hcaptcha.com` dans votre liste autorisée.
</Note>

<div id="bring-your-own-model">
## Utiliser votre propre modèle
</div>

<Info>
L'utilisation de votre propre modèle est une option complémentaire des [forfaits Enterprise](https://mintlify.com/pricing?ref=byok). La section **AI model** apparaît dans votre tableau de bord uniquement lorsque cette option est incluse dans votre contrat. [Contactez l'équipe commerciale](mailto:sales@mintlify.com) pour l'ajouter.
</Info>

Par défaut, Mintlify sélectionne et gère le modèle qui alimente l'assistant. Utilisez votre propre modèle pour exécuter les produits d'IA de Mintlify avec un modèle et une clé d'API que vous contrôlez.

Pour configurer votre propre modèle :

1. Rendez-vous sur la page [Clés d'API](https://app.mintlify.com/settings/organization/api-keys) de votre tableau de bord.
2. Dans la section **AI model**, activez **Bring your own model**.
3. Sélectionnez un fournisseur : **OpenRouter**, **Anthropic** ou **OpenAI-compatible**. OpenRouter est sélectionné par défaut et fonctionne avec tous les produits d'IA de Mintlify. Les fournisseurs Anthropic et OpenAI-compatible ont une compatibilité limitée : tous les produits d'IA ne fonctionnent pas avec eux.
4. Si vous sélectionnez **OpenAI-compatible**, saisissez un nom de fournisseur et l'URL de base du fournisseur. L'URL de base doit utiliser HTTPS et pointer vers un nom d'hôte accessible publiquement.
5. Sélectionnez un modèle dans la liste de votre fournisseur.
6. Saisissez la clé d'API de votre fournisseur et sélectionnez **Save**.

Mintlify stocke votre clé d'API de manière sécurisée et ne l'affiche jamais après l'enregistrement. Lorsque vous changez de modèle au sein du même fournisseur, Mintlify réutilise votre clé enregistrée. Lorsque vous changez de fournisseur ou d'URL de base, saisissez à nouveau votre clé. Pour effectuer la rotation d'une clé, saisissez une nouvelle clé et enregistrez.

Désactivez **Bring your own model** pour supprimer votre configuration et revenir aux modèles gérés par Mintlify.

<div id="manage-billing">
## Gérer la facturation
</div>
Expand Down
25 changes: 24 additions & 1 deletion zh/assistant/configure.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "配置 AI 助手"
description: "在 Mintlify 仪表盘中配置 AI 助手:启用或停用助手、自定义响应内容、添加起始问题、设置机器人防护、管理速率限制以及查看助手用量与计费。"
keywords: ["assistant", "设置", "转接", "机器人防护", "计费"]
keywords: ["assistant", "设置", "转接", "机器人防护", "计费", "BYOK", "使用自己的模型"]
---

在仪表盘的 [Assistant](https://dashboard.mintlify.com/products/assistant) 页面配置 AI 助手。在[用量](https://dashboard.mintlify.com/settings/organization/usage)页面管理计费和用量。
Expand Down Expand Up @@ -108,6 +108,29 @@ AI 助手可以根据用户正在查看的页面生成特定于页面的问题
如果你使用自定义的 [Content Security Policy 头](/zh/deploy/csp-configuration),你必须在允许列表中包含 `hcaptcha.com` 和 `*.hcaptcha.com`。
</Note>

<div id="bring-your-own-model">
## 使用自己的模型
</div>

<Info>
使用自己的模型是 [Enterprise 方案](https://mintlify.com/pricing?ref=byok)的附加功能。只有当你的合同包含该附加功能时,dashboard 中才会显示 **AI model** 部分。请[联系销售团队](mailto:sales@mintlify.com)添加该功能。
</Info>

默认情况下,Mintlify 会选择并管理为助手提供支持的模型。使用自己的模型,可以让 Mintlify 的 AI 产品运行在由你控制的模型和 API 密钥上。

配置自己的模型:

1. 前往 dashboard 的 [API 密钥](https://app.mintlify.com/settings/organization/api-keys)页面。
2. 在 **AI model** 部分,开启 **Bring your own model**。
3. 选择一个提供商:**OpenRouter**、**Anthropic** 或 **OpenAI-compatible**。默认选中 OpenRouter,它适用于所有 Mintlify AI 产品。Anthropic 和 OpenAI-compatible 提供商的兼容性有限:并非所有 AI 产品都能与它们配合使用。
4. 如果选择 **OpenAI-compatible**,请输入提供商名称和提供商的基础 URL。基础 URL 必须使用 HTTPS 并指向可公开访问的主机名。
5. 从提供商的列表中选择一个模型。
6. 输入提供商的 API 密钥,然后选择 **Save**。

Mintlify 会安全地存储你的 API 密钥,保存后不会再显示。在同一提供商内更换模型时,Mintlify 会复用已保存的密钥。更换提供商或基础 URL 时,需要重新输入密钥。要轮换密钥,请输入新密钥并保存。

关闭 **Bring your own model** 可删除你的配置,并恢复使用由 Mintlify 管理的模型。

<div id="manage-billing">
## 管理计费
</div>
Expand Down