diff --git a/es.json b/es.json index dab38c850..ca2c0ee9f 100644 --- a/es.json +++ b/es.json @@ -147,6 +147,7 @@ }, "es/organize/navigation", "es/ai/contextual-menu", + "es/assistant/narration", "es/ai/bring-your-own-model", "es/create/redirects", "es/organize/mintignore", @@ -279,7 +280,17 @@ "pages": [ "es/assistant/index", "es/assistant/configure", - "es/assistant/customize", + "es/assistant/support-routing", + { + "group": "Mejorar las respuestas", + "pages": [ + "es/assistant/sources", + "es/assistant/customize", + "es/assistant/skills" + ] + }, + "es/assistant/use", + "es/assistant/embed", { "group": "Widget", "hidden": true, @@ -288,9 +299,7 @@ "es/assistant/widget" ] }, - "es/assistant/skills", - "es/assistant/narration", - "es/assistant/use" + "es/assistant/billing" ] }, { diff --git a/es/ai-native.mdx b/es/ai-native.mdx index 1a0d383ea..fda88512b 100644 --- a/es/ai-native.mdx +++ b/es/ai-native.mdx @@ -56,7 +56,7 @@ La búsqueda de texto completo y la comprensión semántica ayudan a los usuario Selecciona cualquiera de las siguientes tarjetas para obtener más información. - + Configura el assistant para buscar en sitios externos o derivar a las personas a tu equipo de soporte si no puede responder sus preguntas. diff --git a/es/api/analytics/assistant-thread.mdx b/es/api/analytics/assistant-thread.mdx index e080356be..ad11163ec 100644 --- a/es/api/analytics/assistant-thread.mdx +++ b/es/api/analytics/assistant-thread.mdx @@ -22,7 +22,7 @@ Usos comunes: Puedes obtener un `threadId` desde cualquiera de las siguientes fuentes: - El campo `conversationId` de cualquier fila devuelta por [Obtener conversaciones del assistant](/es/api/analytics/assistant-conversations). -- El parámetro de consulta `threadId` que Mintlify añade a la URL de soporte cuando el assistant deriva a tu plataforma de soporte usando la [derivación por enlace](/es/assistant/configure#deflect-to-a-support-link). +- El parámetro de consulta `threadId` que Mintlify añade a la URL de soporte cuando el assistant dirige a los usuarios a tu plataforma de soporte con la opción de soporte [Enlace](/es/assistant/support-routing#link-to-your-help-center). ## Límites de uso diff --git a/es/assistant/billing.mdx b/es/assistant/billing.mdx new file mode 100644 index 000000000..a5e66c05b --- /dev/null +++ b/es/assistant/billing.mdx @@ -0,0 +1,46 @@ +--- +title: "Gestionar la facturación del assistant" +sidebarTitle: "Facturación" +description: "Consulta cuántos créditos usa el assistant de IA, cambia tu nivel de créditos, permite excedentes, configura alertas de uso y usa tu propio modelo." +keywords: ["assistant", "facturación", "créditos", "excedentes", "alertas de uso", "nivel de créditos", "usar tu propio modelo"] +--- + + + El assistant requiere un [plan Pro o Enterprise](https://mintlify.com/pricing?ref=assistant). + + +El assistant funciona con créditos. Cada pregunta que el assistant responde cuesta 25 créditos. Si el assistant no encuentra una respuesta en tu documentación y así lo indica, el mensaje no cuesta nada. + +Cada plan Pro aporta 10,000 créditos al mes al saldo compartido de créditos de tu organización, que se usa para el assistant, Autopilot y otras funciones basadas en créditos en todos los proyectos. Consulta [Precios por créditos](/es/credits) para obtener más información. + +En los planes Enterprise, puedes [usar tu propio modelo](/es/ai/bring-your-own-model) para ejecutar el assistant con tu propio proveedor de LLM y clave de API. + +Administra la facturación y el uso en las páginas [Uso](https://app.mintlify.com/settings/organization/usage) y [Facturación](https://app.mintlify.com/settings/organization/billing) de tu dashboard. + +
+ ## Cambiar tu nivel de créditos +
+ +1. Ve a la página de [Uso](https://app.mintlify.com/settings/organization/usage) de tu dashboard. +2. En la sección **Credit packages**, selecciona un nivel del menú desplegable. +3. Confirma el cambio para continuar al checkout. + +
+ ## Permitir excedentes +
+ +Tu organización comparte los créditos entre proyectos. Por defecto, Mintlify deshabilita los excedentes. Puedes activar o desactivar los excedentes para cada proyecto. Si deshabilitas los excedentes en un proyecto, el assistant deja de estar disponible cuando se agota el saldo compartido de créditos de tu organización. El assistant permanece no disponible hasta que se renueva el saldo de créditos. + +Para permitir excedentes, activa el interruptor **Overage** en la tarjeta del proyecto, en la sección **Usage** de la página [Facturación](https://app.mintlify.com/settings/organization/billing) de tu dashboard. Si habilitas los excedentes, cada crédito gastado por encima del saldo compartido incurre en un cargo por excedente. Elige **Limit spend** para establecer un monto máximo de excedentes en dólares, o **No spend limit** para facturar los excedentes sin límite máximo. Cuando un proyecto alcanza su límite de gasto, sus funciones basadas en créditos se pausan hasta el siguiente ciclo de facturación. + +
+ ## Configurar alertas de uso +
+ +En la sección **Usage** de la página [Facturación](https://app.mintlify.com/settings/organization/billing), configura el umbral **Alert** para enviar un correo electrónico a los administradores de tu organización cuando el uso total alcance un cierto porcentaje de su saldo compartido de créditos. + +
+ ## Volúmenes de créditos más altos +
+ +Para añadir hasta 90,000 créditos al mes, compra un [complemento de créditos](/es/credits#credit-add-ons). Para añadir una cantidad mayor de créditos, [contacta con ventas](https://www.mintlify.com/contact/sales) para hablar de un paquete de créditos personalizado. diff --git a/es/assistant/configure.mdx b/es/assistant/configure.mdx index 2b86c5701..70e1298d6 100644 --- a/es/assistant/configure.mdx +++ b/es/assistant/configure.mdx @@ -1,14 +1,15 @@ --- title: "Configurar el assistant" -description: "Configura el assistant de IA: actívalo, dirige las preguntas de soporte a un correo, un enlace o tickets de Plain y Zendesk, añade preguntas iniciales y gestiona la facturación." -keywords: ["assistant", "configuración", "derivación", "tickets de soporte", "Plain", "Zendesk", "protección contra bots", "facturación"] +sidebarTitle: "Configuración" +description: "Activa el assistant de IA, añade preguntas iniciales, habilita la protección contra bots y prueba las respuestas en la vista previa local antes de que las vean los usuarios." +keywords: ["assistant", "configurar", "configuración", "habilitar", "preguntas iniciales", "protección contra bots", "previsualización local"] --- El assistant requiere un [plan Pro o Enterprise](https://mintlify.com/pricing?ref=assistant). -Configura el assistant en la página [Assistant](https://app.mintlify.com/products/assistant) de tu dashboard. Administra la facturación y el uso en la página [Uso](https://app.mintlify.com/settings/organization/usage). +Configura el assistant en la página [Assistant](https://app.mintlify.com/products/assistant) de tu dashboard. Después de activarlo y añadir preguntas iniciales, elige a dónde van las preguntas que el assistant no puede responder y, a continuación, pruébalo.
## Habilitar o deshabilitar el assistant @@ -16,91 +17,6 @@ Configura el assistant en la página [Assistant](https://app.mintlify.com/produc En la página [Assistant](https://app.mintlify.com/products/assistant) de tu dashboard, haz clic en el interruptor de estado para habilitar o deshabilitar el assistant en tu sitio. -
- ## Configurar correos de derivación -
- -En la sección Manejo de respuestas, habilita el assistant para invitar a los usuarios a contactar con tus equipos de soporte y ventas cuando no pueda responder por sí solo. - -El menú **Support** define a dónde van las preguntas de soporte. Tiene tres opciones: **Email**, **Link** y **Direct support ticketing**. Esta sección trata sobre **Email**. - -En el menú **Support**, selecciona **Email** y luego introduce una o ambas direcciones: - -- **Support email**: Para preguntas que el assistant no pueda resolver a partir de tu documentación. -- **Ventas**: Para preguntas sobre precios, planes o compras. - -Cuando habilitas la derivación y el assistant detecta una pregunta que coincide, aparece un formulario de contacto dentro del chat. El formulario solicita el nombre, los apellidos, la empresa, el correo corporativo y un mensaje del usuario. Mintlify envía la información por correo al equipo correspondiente, que puede responder directamente al correo del usuario. - -El mismo formulario de contacto está disponible en el [widget del assistant](/es/assistant/widget) integrado en otros sitios. - - -Si prefieres dirigir las preguntas de soporte a tus canales existentes, desactiva **Contact form** en la sección Manejo de respuestas. - -Cuando desactivas el formulario de contacto, el assistant dirige a los usuarios a tu dirección de correo de soporte como texto plano en lugar de mostrar el formulario dentro del chat. Las preguntas de ventas siguen usando el formulario dentro del chat cuando configuras un correo de ventas. - - - - -En el menú **Support**, selecciona **Link** para enviar a los usuarios a tu plataforma de soporte existente (por ejemplo, un centro de ayuda, un portal de tickets o un foro de la comunidad) en lugar de recopilar el correo mediante un formulario dentro del chat. - -Introduce la URL completa de tu destino de soporte. La URL debe usar `http` o `https` y no puede incluir credenciales. - -Cuando el assistant detecte una pregunta de soporte, mostrará al usuario una tarjeta con un enlace a tu URL de soporte. Mintlify añade el ID del hilo del assistant como parámetro de consulta `threadId` para que tu herramienta de soporte pueda adjuntar la transcripción de la conversación al ticket resultante. Recupera la transcripción con el endpoint [Obtener hilo de conversación del assistant](/es/api/analytics/assistant-thread). - -Con **Link** seleccionado, el assistant no muestra el formulario de contacto ni dirige las preguntas de ventas. - -
- ## Crear tickets en tu plataforma de soporte -
- -El assistant puede registrar las solicitudes de soporte como tickets en Plain o Zendesk en lugar de enviarlas por correo. - -Antes de conectar Plain, crea una clave de API de Plain con estos permisos: - -- `customer:create` -- `customer:edit` -- `customer:read` -- `thread:create` -- `thread:read` - -1. En la sección **Response handling** del menú **Support**, selecciona **Direct support ticketing**. -2. Selecciona una **Ticketing platform**: **Plain** o **Zendesk**. -3. En la tarjeta de la plataforma, haz clic en **Connect** y completa la conexión en la ventana que se abre. Para Plain, usa la clave de API que creaste. - -Mintlify guarda la creación directa de tickets de soporte solo después de que la plataforma se conecte. Hasta entonces, tu opción de soporte actual sigue activa. La conexión es una integración compartida para tu organización. - -Cuando el assistant detecta una pregunta de soporte, muestra el formulario de contacto dentro del chat. Mintlify crea un ticket en tu plataforma conectada a partir del envío. El ticket incluye los datos de contacto y el mensaje del usuario, además de hasta los tres primeros mensajes de la conversación con el assistant. Si la conversación es más larga, el ticket enlaza a la conversación completa en tu dashboard. - -Si guardaste una dirección de **Ventas** en **Email**, las preguntas de ventas siguen enviándose por correo a esa dirección. - -Si a la clave de API de Plain le falta alguno de los permisos requeridos, la tarjeta de la plataforma muestra **Scopes misconfigured**. Haz clic en **Configure** para ver qué permisos faltan y, a continuación, agrégalos a la clave de API en Plain. - -
- ## Dominios de búsqueda -
- - - Los dominios de búsqueda requieren un [plan Enterprise](https://mintlify.com/pricing?ref=assistant). - - -En la sección Manejo de respuestas, configura los dominios en los que el assistant puede buscar en la web para encontrar contexto adicional al responder preguntas. - -- Los dominios deben ser accesibles públicamente. -- El assistant no puede buscar en dominios que requieran JavaScript para cargar. - -Para un control más preciso sobre lo que el assistant puede buscar, usa la sintaxis de filtrado. - -- **Filtrado a nivel de dominio** - - `example.com`: Buscar solo en el dominio `example.com` - - `docs.example.com`: Buscar solo en el subdominio `docs.example.com` - - `*.example.com`: Buscar en todos los subdominios de `example.com` -- **Filtrado a nivel de ruta** - - `docs.example.com/api`: Buscar en todas las páginas bajo la subruta `/api` -- **Múltiples patrones** - - Agrega múltiples entradas para apuntar a diferentes secciones de sitios -
## Agregar preguntas de ejemplo
@@ -116,6 +32,12 @@ Puedes agregar hasta tres preguntas iniciales. Haz clic en **Ask Assistant** par El panel de sugerencias de búsqueda en el dashboard con preguntas iniciales contextuales habilitadas. +
+ ## Elegir a dónde van las preguntas sin respuesta +
+ +Cuando el assistant no puede responder una pregunta, puede enviar al usuario a tu equipo de soporte o ventas por correo, mediante un enlace a tu centro de ayuda o con un ticket en Plain o Zendesk. Consulta [Dirigir preguntas a tu equipo](/es/assistant/support-routing). +
## Protección contra bots
@@ -133,38 +55,14 @@ 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. -
- ## Administrar la facturación +
+ ## Probar el assistant
-El assistant funciona con créditos. Cada pregunta que el assistant responde cuesta 25 créditos. Si el assistant no encuentra una respuesta en tu documentación y así lo indica, el mensaje no cuesta nada. Consulta [Precios por créditos](/es/credits) para obtener más información. +El assistant está disponible en tu previsualización local cuando inicias sesión con la CLI. Usa la previsualización local para probar las respuestas y las instrucciones personalizadas en `Assistant.md` mientras escribes. -En los planes Enterprise, puedes [usar tu propio modelo](/es/ai/bring-your-own-model) para ejecutar el assistant con tu propio proveedor de LLM y clave de API. - -
- ### Cambiar tu nivel de créditos -
- -1. Ve a la página de [Uso](https://app.mintlify.com/settings/organization/usage) de tu dashboard. -2. En la sección **Credit packages**, selecciona un nivel del menú desplegable. -3. Confirma el cambio para continuar al checkout. - -
- ### Permitir excedentes -
- -Tu organización comparte los créditos entre proyectos. Por defecto, Mintlify deshabilita los excedentes. Puedes activar o desactivar los excedentes para cada proyecto. Si deshabilitas los excedentes en un proyecto, el assistant deja de estar disponible cuando se agota el saldo compartido de créditos de tu organización. El assistant permanece no disponible hasta que se renueva el saldo de créditos. - -Para permitir excedentes, activa el interruptor **Overage** en la tarjeta del proyecto, en la sección **Usage** de la página [Facturación](https://app.mintlify.com/settings/organization/billing) de tu dashboard. Si habilitas los excedentes, cada crédito gastado por encima del saldo compartido incurre en un cargo por excedente. Elige **Limit spend** para establecer un monto máximo de excedentes en dólares, o **No spend limit** para facturar los excedentes sin límite máximo. Cuando un proyecto alcanza su límite de gasto, sus funciones basadas en créditos se pausan hasta el siguiente ciclo de facturación. - -
- ### Configurar alertas de uso -
- -En la sección **Usage** de la página [Facturación](https://app.mintlify.com/settings/organization/billing), configura el umbral **Alert** para enviar un correo electrónico a los administradores de tu organización cuando el uso total alcance un cierto porcentaje de su saldo compartido de créditos. - -
- ### Volúmenes de créditos más altos -
+1. Si aún no lo has hecho, instala la CLI con `npm i -g mint`. +2. Ejecuta `mint login` para autenticarte. +3. Ejecuta `mint dev` para iniciar la previsualización local. -Para añadir hasta 90,000 créditos al mes, compra un [complemento de créditos](/es/credits#credit-add-ons). Para añadir una cantidad mayor de créditos, [contacta con ventas](https://www.mintlify.com/contact/sales) para hablar de un paquete de créditos personalizado. +El assistant en la previsualización local usa el mismo contenido indexado que tu sitio de documentación desplegado. diff --git a/es/assistant/embed.mdx b/es/assistant/embed.mdx new file mode 100644 index 000000000..7ffe645ae --- /dev/null +++ b/es/assistant/embed.mdx @@ -0,0 +1,17 @@ +--- +title: "Integrar el assistant en tu producto" +sidebarTitle: "Integrar en tu producto" +description: "Responde las preguntas de los usuarios dentro de tu aplicación, dashboard o portal de soporte creando tu propia interfaz sobre la API del assistant." +keywords: ["assistant", "integrar", "assistant en la aplicación", "API del assistant", "clave de API"] +--- + + + El assistant requiere un [plan Pro o Enterprise](https://mintlify.com/pricing?ref=assistant). + + +Lleva el assistant a los lugares donde tus usuarios ya trabajan, como tu aplicación, tu dashboard, tu sitio de marketing o tu portal de soporte. Responde a partir de la misma documentación que el assistant de tu sitio de documentación. + +Usa la API del assistant para crear tu propia interfaz con control total sobre su apariencia y comportamiento. Autentícate con una [clave de API del assistant](https://app.mintlify.com/settings/organization/api-keys). + +- Sigue [Crear un assistant en la aplicación](/es/guides/assistant-embed) para ver un ejemplo completo con Next.js. +- Consulta [Crear mensaje del assistant](/es/api/assistant/create-assistant-message-v2) y [Buscar en la documentación](/es/api/assistant/search) para ver los endpoints. diff --git a/es/assistant/index.mdx b/es/assistant/index.mdx index 4b947d997..4e4a56b8e 100644 --- a/es/assistant/index.mdx +++ b/es/assistant/index.mdx @@ -1,73 +1,54 @@ --- title: "Assistant" -description: "Agrega un asistente de chat con IA a tu documentación que responde preguntas, cita fuentes y genera ejemplos de código bajo demanda." +description: "Añade a tu sitio de documentación un assistant de IA que responde preguntas a partir de tu contenido, dirige a tu equipo lo que no puede responder y funciona dentro de tu producto." keywords: ["chat", "soporte al usuario", "multimodal"] boost: 3 --- - El assistant requiere un [plan Pro o Enterprise](https://mintlify.com/pricing?ref=assistant). Cada plan Pro aporta 10,000 créditos al mes al saldo compartido de créditos de tu organización, que se usa para el assistant, Autopilot y otras funciones basadas en créditos en todos los proyectos. Consulta [Gestionar la facturación](/es/assistant/configure#manage-billing) para obtener más información sobre los niveles y las opciones de créditos. + El assistant requiere un [plan Pro o Enterprise](https://mintlify.com/pricing?ref=assistant). -
- ## Acerca del assistant -
- -El assistant responde preguntas sobre tu documentación mediante consultas en lenguaje natural. Los usuarios acceden al assistant en tu sitio de documentación, para que puedan encontrar respuestas rápidamente y tener éxito con tu producto incluso si no saben dónde buscar. - -El assistant utiliza llamadas a herramientas para responder preguntas. Cuando los usuarios hacen preguntas, el assistant: - -* **Busca y recupera** contenido relevante de tu documentación en formato Markdown para proporcionar respuestas precisas. -* **Construye contexto** a partir de la página que el usuario está viendo cuando hace preguntas. -* **Lee imágenes** de tus páginas de documentación, como capturas de pantalla y diagramas, para responder preguntas sobre lo que muestran. El asistente solo ve imágenes que aparecen en páginas a las que puede acceder, por lo que no puede obtener URL de imágenes arbitrarias. -* **Cita fuentes** y proporciona enlaces navegables para llevar a los usuarios directamente a las páginas referenciadas. -* **Devuelve información detallada de la API** al responder preguntas sobre tu API, incluyendo métodos, parámetros, cuerpos de solicitud y esquemas de respuesta de tus especificaciones OpenAPI. -* **Genera ejemplos de código copiables** para ayudar a los usuarios a implementar soluciones desde tu documentación. -* **Soporta múltiples modalidades** permitiendo a los usuarios agregar texto, imágenes y otros archivos como contexto. +El assistant es un chat con IA en tu sitio de documentación. Los usuarios hacen preguntas en lenguaje natural y obtienen respuestas a partir de tu contenido, para que puedan tener éxito con tu producto incluso cuando no saben dónde buscar. -
- ### Cómo funciona la indexación +
+ ## Qué pueden hacer tus usuarios con el assistant
-El assistant indexa tu documentación publicada y especificaciones de API para responder preguntas con precisión. Cuando publicas cambios, el assistant indexa inmediatamente el contenido nuevo, actualizado o eliminado. El assistant no indexa ramas de borrador ni despliegues de vista previa. +- Obtener respuestas que citan las páginas de las que provienen, con enlaces a cada página. +- Preguntar sobre tu API y obtener métodos, parámetros, cuerpos de solicitud y esquemas de respuesta de tus especificaciones OpenAPI. +- Copiar ejemplos de código que el assistant escribe a partir de tu documentación. +- Preguntar sobre capturas de pantalla y diagramas de tus páginas. +- Añadir contexto resaltando texto, enviando un bloque de código o adjuntando archivos. El assistant también sabe en qué página está el usuario. Consulta [Añadir contexto a una pregunta](/es/assistant/use#add-context-to-a-question). +- Contactar con tu equipo por correo, tu centro de ayuda o un ticket de soporte cuando el assistant no puede responder. -Por defecto, el assistant no indexa páginas ocultas. Para incluir páginas ocultas en el índice del assistant, establece `seo.indexing: "all"` en tu `docs.json`. Consulta [Páginas ocultas](/es/organize/hidden-pages#search-seo-and-ai-indexing) para más información. - -
- ### Cómo el assistant maneja preguntas desconocidas +
+ ## Empezar con el assistant
-El assistant solo responde preguntas basándose en la información de tu documentación. Si no puede encontrar información relevante después de buscar, responde que no tiene suficiente información para contestar. - -Puedes [configurar un correo de derivación](/es/assistant/configure#set-deflection-emails) para que el assistant proporcione tu correo de soporte a los usuarios cuyas preguntas no puede responder. Esto da a los usuarios un camino a seguir, incluso si la documentación no aborda su pregunta específica. - -
- ## Información del assistant + + + Activa el assistant, añade preguntas iniciales y pruébalo antes de que lo vean los usuarios. + + + Envía las preguntas que el assistant no puede responder a un correo, tu centro de ayuda o tickets en Plain o Zendesk. + + + Encuentra las preguntas que el assistant no pudo responder, controla qué contenido usa y añade instrucciones y skills. + + + Abre el assistant desde tus propios enlaces, cambia el estilo de su botón u ocúltalo, o desactívalo. + + + Responde preguntas en tu aplicación, dashboard o portal de soporte con la API del assistant. + + + Consulta cuánto cuesta el assistant en créditos, permite excedentes y usa tu propio modelo. + + + +
+ ## Cómo responde el assistant
-Usa la información del assistant para entender cómo los usuarios interactúan con tu documentación e identificar oportunidades de mejora. - -La [página del assistant](https://dashboard.mintlify.com/products/assistant) muestra las tendencias de uso del mes actual. Consulta información más detallada en la página de [analíticas](/es/analytics/assistant). - -
- ## Haz que el contenido sea procesable por IA -
- -Estructura tu documentación para ayudar al assistant a proporcionar respuestas precisas y relevantes. Una organización clara y un contexto completo benefician tanto a los lectores humanos como a la comprensión de la IA. - - - - Usa marcado semántico. - - Escribe encabezados descriptivos para las secciones. - - Crea una jerarquía lógica de información. - - Usa un formato consistente en toda tu documentación. - - Incluye metadatos completos en el frontmatter de las páginas. - - Divide bloques largos de texto en párrafos más cortos. - - - - - Define términos específicos y acrónimos cuando se introducen por primera vez. - - Proporciona suficiente contenido conceptual sobre funcionalidades y procedimientos. - - Incluye ejemplos y casos de uso. - - Haz referencias cruzadas a temas relacionados. - - Agrega [páginas ocultas](/es/organize/hidden-pages) con contexto adicional que los usuarios no necesitan, pero que el assistant puede consultar. - +El assistant responde solo a partir de tu documentación publicada y tus especificaciones de API, además de los [dominios de búsqueda](/es/assistant/sources#search-domains) que añadas. Si no encuentra información relevante, lo indica en lugar de adivinar. Consulta [Gestionar lo que sabe el assistant](/es/assistant/sources) para controlar qué contenido usa. diff --git a/es/assistant/sources.mdx b/es/assistant/sources.mdx new file mode 100644 index 000000000..f6296bd56 --- /dev/null +++ b/es/assistant/sources.mdx @@ -0,0 +1,71 @@ +--- +title: "Gestionar lo que sabe el assistant" +sidebarTitle: "Fuentes e indexación" +description: "Controla de qué contenido responde el assistant de IA, añade contexto que los usuarios no ven, busca en otros sitios web y encuentra las preguntas que no pudo responder." +keywords: ["assistant", "indexación", "páginas ocultas", "dominios de búsqueda", "búsqueda web", "preguntas sin respuesta"] +--- + +El assistant responde solo a partir de tu documentación publicada y tus especificaciones de API, además de los dominios de búsqueda que añadas. Cuando publicas cambios, el assistant indexa de inmediato el contenido nuevo, actualizado o eliminado. No indexa ramas de borrador ni despliegues de vista previa. + +Para mejorar las respuestas, encuentra las preguntas que el assistant no pudo responder y corrige el contenido del que obtiene sus respuestas. Usa [instrucciones personalizadas](/es/assistant/customize) y [skills](/es/assistant/skills) para definir cómo responde. + +
+ ## Encontrar preguntas que el assistant no pudo responder +
+ +La lista **Unanswered conversations** en la [analítica del assistant](/es/analytics/assistant) muestra todas las conversaciones que el assistant no pudo responder a partir de tu documentación. Abre una transcripción para ver qué preguntó el usuario y, a continuación, añade o actualiza el contenido que lo responde. + +
+ ## Añadir contexto que los usuarios no ven +
+ +Por defecto, el assistant no indexa las páginas ocultas. Para incluir páginas ocultas en el índice del assistant, establece `seo.indexing: "all"` en tu `docs.json`. Usa páginas ocultas para el contexto que los usuarios no necesitan explorar, pero al que el assistant puede recurrir. Consulta [Páginas ocultas](/es/organize/hidden-pages#search-seo-and-ai-indexing) para ver cómo afecta cada configuración de página al assistant. + +Para mostrar contexto solo al assistant y a otras herramientas de IA en una página publicada, envuélvelo en el componente [`Visibility`](/es/components/visibility) con `for="agents"`. + +
+ ## Excluir contenido de las respuestas +
+ +Para mantener una página visible fuera de las respuestas del assistant, establece `searchable: false` en el frontmatter de la página. La página permanece en tu navegación, pero la búsqueda del sitio y el assistant la omiten. Consulta [Páginas ocultas](/es/organize/hidden-pages#search-seo-and-ai-indexing) para ver otras opciones. + +
+ ## Restringir respuestas por grupo de usuarios +
+ +Si tu sitio requiere [autenticación](/es/deploy/authentication-setup), el assistant respeta los grupos de usuarios. Responde a cada usuario que ha iniciado sesión solo a partir de las páginas a las que ese usuario puede acceder. + +
+ ## Dominios de búsqueda +
+ + + Los dominios de búsqueda requieren un [plan Enterprise](https://mintlify.com/pricing?ref=assistant). + + +En la sección Manejo de respuestas, configura los dominios en los que el assistant puede buscar en la web para encontrar contexto adicional al responder preguntas. + +- Los dominios deben ser accesibles públicamente. +- El assistant no puede buscar en dominios que requieran JavaScript para cargar. + +Para un control más preciso sobre lo que el assistant puede buscar, usa la sintaxis de filtrado. + +- **Filtrado a nivel de dominio** + - `example.com`: Buscar solo en el dominio `example.com` + - `docs.example.com`: Buscar solo en el subdominio `docs.example.com` + - `*.example.com`: Buscar en todos los subdominios de `example.com` +- **Filtrado a nivel de ruta** + - `docs.example.com/api`: Buscar en todas las páginas bajo la subruta `/api` +- **Múltiples patrones** + - Agrega múltiples entradas para apuntar a diferentes secciones de sitios + +
+ ## Escribir contenido que el assistant pueda usar +
+ +El assistant responde mejor cuando tu contenido es fácil de encontrar y entender. Una organización clara y un contexto completo ayudan tanto a las personas como a las herramientas de IA. + +- Escribe encabezados descriptivos y descripciones de frontmatter específicas para cada página. +- Define los términos y acrónimos la primera vez que los introduzcas. +- Incluye ejemplos y casos de uso, y enlaza temas relacionados. +- Divide los bloques de texto largos en párrafos más cortos. diff --git a/es/assistant/support-routing.mdx b/es/assistant/support-routing.mdx new file mode 100644 index 000000000..1ad96e173 --- /dev/null +++ b/es/assistant/support-routing.mdx @@ -0,0 +1,79 @@ +--- +title: "Dirigir preguntas a tu equipo" +sidebarTitle: "Dirigir a tu equipo" +description: "Envía las preguntas que el assistant no puede responder a tu equipo de soporte o ventas por correo, mediante un enlace a tu centro de ayuda o con tickets en Plain o Zendesk." +keywords: ["assistant", "enrutamiento de soporte", "derivación", "contactar con soporte", "formulario de contacto", "tickets de soporte", "help desk", "Zendesk", "Plain", "threadId"] +--- + + + El assistant requiere un [plan Pro o Enterprise](https://mintlify.com/pricing?ref=assistant). + + +Cuando el assistant no puede responder una pregunta a partir de tu documentación, puede derivar al usuario a tu equipo. Los usuarios obtienen una forma de contactar con una persona en lugar de llegar a un callejón sin salida. + +Elige a dónde van las preguntas de soporte en el menú **Support** de la sección Manejo de respuestas, en la página [Assistant](https://app.mintlify.com/products/assistant) de tu dashboard: + +| Opción | Lo que ven los usuarios | A dónde va la solicitud | +| :--- | :--- | :--- | +| [Email](#send-questions-by-email) | Un formulario de contacto dentro del chat | Tu dirección de correo de soporte o ventas | +| [Link](#link-to-your-help-center) | Una tarjeta con un enlace a tu URL de soporte | Tu centro de ayuda, portal de tickets o foro de la comunidad | +| [Direct support ticketing](#create-tickets-in-plain-or-zendesk) | Un formulario de contacto dentro del chat | Un nuevo ticket en Plain o Zendesk | + +Si usas un help desk distinto de Plain o Zendesk, usa **Link** para enviar a los usuarios a su página de contacto o a su centro de ayuda. + +
+ ## Enviar preguntas por correo +
+ +En el menú **Support**, selecciona **Email** y luego introduce una o ambas direcciones: + +- **Support email**: Para preguntas que el assistant no pueda resolver a partir de tu documentación. +- **Ventas**: Para preguntas sobre precios, planes o compras. + +Cuando el assistant detecta una pregunta que coincide, aparece un formulario de contacto dentro del chat. El formulario solicita el nombre, los apellidos, la empresa, el correo corporativo y un mensaje del usuario. Mintlify envía la información por correo al equipo correspondiente, que puede responder directamente al correo del usuario. + +El mismo formulario de contacto está disponible en el [widget del assistant](/es/assistant/widget) integrado en otros sitios. + + +Si prefieres dirigir las preguntas de soporte a tus canales existentes, desactiva **Contact form** en la sección Manejo de respuestas. + +Cuando desactivas el formulario de contacto, el assistant dirige a los usuarios a tu dirección de correo de soporte como texto plano en lugar de mostrar el formulario dentro del chat. Las preguntas de ventas siguen usando el formulario dentro del chat cuando configuras un correo de ventas. + + + + +En el menú **Support**, selecciona **Link** para enviar a los usuarios a tu plataforma de soporte existente, como un centro de ayuda, un portal de tickets o un foro de la comunidad, en lugar de recopilar el correo mediante un formulario dentro del chat. + +Introduce la URL completa de tu destino de soporte. La URL debe usar `http` o `https` y no puede incluir credenciales. + +Cuando el assistant detecte una pregunta de soporte, mostrará al usuario una tarjeta con un enlace a tu URL de soporte. Mintlify añade el ID del hilo del assistant como parámetro de consulta `threadId` para que tu herramienta de soporte pueda adjuntar la transcripción de la conversación al ticket resultante. Recupera la transcripción con el endpoint [Obtener hilo de conversación del assistant](/es/api/analytics/assistant-thread). + +Con **Link** seleccionado, el assistant no muestra el formulario de contacto ni dirige las preguntas de ventas. + +
+ ## Crear tickets en Plain o Zendesk +
+ +El assistant puede registrar las solicitudes de soporte como tickets en Plain o Zendesk en lugar de enviarlas por correo. + +Antes de conectar Plain, crea una clave de API de Plain con estos permisos: + +- `customer:create` +- `customer:edit` +- `customer:read` +- `thread:create` +- `thread:read` + +1. En la sección **Response handling** del menú **Support**, selecciona **Direct support ticketing**. +2. Selecciona una **Ticketing platform**: **Plain** o **Zendesk**. +3. En la tarjeta de la plataforma, haz clic en **Connect** y completa la conexión en la ventana que se abre. Para Plain, usa la clave de API que creaste. + +Mintlify guarda la creación directa de tickets de soporte solo después de que la plataforma se conecte. Hasta entonces, tu opción de soporte actual sigue activa. La conexión es una integración compartida para tu organización. + +Cuando el assistant detecta una pregunta de soporte, muestra el formulario de contacto dentro del chat. Mintlify crea un ticket en tu plataforma conectada a partir del envío. El ticket incluye los datos de contacto y el mensaje del usuario, además de hasta los tres primeros mensajes de la conversación con el assistant. Si la conversación es más larga, el ticket enlaza a la conversación completa en tu dashboard. + +Si guardaste una dirección de **Ventas** en **Email**, las preguntas de ventas siguen enviándose por correo a esa dirección. + +Si a la clave de API de Plain le falta alguno de los permisos requeridos, la tarjeta de la plataforma muestra **Scopes misconfigured**. Haz clic en **Configure** para ver qué permisos faltan y, a continuación, agrégalos a la clave de API en Plain. diff --git a/es/assistant/use.mdx b/es/assistant/use.mdx index e7f067dd4..69355df38 100644 --- a/es/assistant/use.mdx +++ b/es/assistant/use.mdx @@ -1,25 +1,14 @@ --- -title: "Usar el assistant" -description: "Abre el assistant con atajos de teclado, texto resaltado, bloques de código, archivos adjuntos o parámetros de URL, y pruébalo en local." -keywords: ["assistant", "atajo de teclado", "archivos adjuntos", "previsualización local", "parámetros de URL"] +title: "Controlar cómo aparece el assistant" +sidebarTitle: "Visualización" +description: "Controla dónde encuentran los usuarios el assistant de IA: ábrelo desde tus propios enlaces, oculta o cambia el estilo de su botón y consulta las formas en que los usuarios añaden contexto a una pregunta." +keywords: ["assistant", "atajo de teclado", "parámetros de URL", "enlace directo", "ocultar assistant", "CSS personalizado", "archivos adjuntos", "solución de problemas"] --- -Los usuarios tienen múltiples formas de iniciar una conversación con el assistant. Cada método abre un panel de chat en el lado derecho de tu documentación. Los usuarios pueden hacer cualquier pregunta y el assistant busca en tu documentación una respuesta. Si el assistant no puede recuperar información relevante, responde que no puede contestar la pregunta. +Los usuarios abren el assistant desde su botón, un atajo de teclado o un enlace que compartas. Puedes cambiar el aspecto del botón, ocultarlo o desactivar el assistant. -
- ## Usar el assistant en la previsualización local -
- -El assistant está disponible en tu previsualización local cuando inicias sesión con la CLI. Esto te permite probar el comportamiento del assistant, las instrucciones personalizadas en `Assistant.md` y las respuestas mientras desarrollas documentación localmente. - -1. Si aún no lo has hecho, instala la CLI con `npm i -g mint`. -2. Ejecuta `mint login` para autenticarte. -3. Ejecuta `mint dev` para iniciar la previsualización local. - -El assistant en la previsualización local usa el mismo contenido indexado que tu sitio de documentación desplegado. - -
- ## Ubicación en la interfaz +
+ ## Dónde aparece el assistant
El assistant aparece en dos ubicaciones: como un botón junto a la barra de búsqueda y como una barra en la parte inferior de la página. @@ -67,14 +56,10 @@ El assistant aparece en dos ubicaciones: como un botón junto a la barra de bús -
- ## Atajo de teclado -
- -Abre el panel de chat del assistant con el atajo de teclado Cmd + I en macOS y Ctrl + I en Windows. +Los usuarios también pueden abrir el panel de chat del assistant con el atajo de teclado Cmd + I en macOS y Ctrl + I en Windows. -
- ## Parámetros de URL + Abre el assistant desde cualquier página de tu sitio de documentación añadiendo el parámetro de consulta `?assistant` a la URL. Úsalo para crear enlaces directos al assistant desde contenido externo como correos, respuestas de soporte, banners en la aplicación o flujos de incorporación. @@ -87,14 +72,22 @@ https://yourdocs.mintlify.site/quickstart?assistant https://yourdocs.mintlify.site/quickstart?assistant=How%20do%20I%20get%20started%3F ``` +Para que los usuarios puedan abrir el assistant con la página actual como contexto desde el menú contextual de la página, añade la opción `"assistant"` a tu [menú contextual](/es/ai/contextual-menu). + +
+ ## Añadir contexto a una pregunta +
+ +Los usuarios pueden dar al assistant más contexto que su pregunta. El assistant también sabe en qué página está el usuario. +
- ## Resaltar texto + ### Resaltar texto
Resalta texto en una página y haz clic en el botón emergente **Add to assistant** para abrir el panel de chat del assistant y agregar el texto resaltado como contexto. Puedes agregar múltiples fragmentos de texto o bloques de código al contexto del assistant.
- ## Bloques de código + ### Bloques de código
Haz clic en el botón **Ask Assistant** en un bloque de código para abrir el panel de chat del assistant y agregar el bloque de código como contexto. Puedes agregar múltiples bloques de código o fragmentos de texto al contexto del assistant. @@ -105,7 +98,7 @@ Haz clic en el botón **Ask Assistant** en un bloque de código para abrir el pa
- ## Archivos adjuntos + ### Archivos adjuntos
Adjunta archivos a los mensajes del assistant para proporcionar contexto adicional. @@ -119,6 +112,18 @@ Límites: - Tamaño máximo de archivo: 5 MB por adjunto - Máximo de adjuntos por mensaje: 10 +
+ ## Ocultar o cambiar el estilo del assistant +
+ +Para cambiar el aspecto del botón del assistant, u ocultarlo en todo tu sitio, apunta al selector `[data-layout-item="assistant-entry"]` en un archivo de [CSS personalizado](/es/customize/custom-scripts#add-custom-css). Consulta [Scripts personalizados](/es/customize/custom-scripts#id-selectors) para ver los IDs del botón del assistant, el panel de chat y el campo de texto. + +
+ ## Desactivar el assistant +
+ +Para quitar el assistant de tu sitio, [deshabilita el assistant](/es/assistant/configure#enable-or-disable-the-assistant) en tu dashboard. +
## Solución de problemas
diff --git a/es/assistant/widget.mdx b/es/assistant/widget.mdx index 7ecff319b..75e023223 100644 --- a/es/assistant/widget.mdx +++ b/es/assistant/widget.mdx @@ -20,7 +20,7 @@ El [asistente](/es/assistant) responde preguntas en tu sitio de Mintlify. Para i Añade el widget a cualquier sitio web o aplicación web con un script alojado. El widget gestiona su propio activador y se renderiza dentro de un Shadow DOM cerrado, lo que evita que los estilos de tu aplicación afecten al widget. -La única opción de navegador obligatoria es tu ID público del widget. Configura las preguntas iniciales específicas del embed y un correo electrónico de soporte en la configuración del navegador. El widget usa el [formulario de contacto de deflection](/es/assistant/configure#set-deflection-emails) de la configuración de tu asistente. +La única opción de navegador obligatoria es tu ID público del widget. Configura las preguntas iniciales específicas del embed y un correo electrónico de soporte en la configuración del navegador. El widget usa el [formulario de contacto del enrutamiento de soporte](/es/assistant/support-routing#send-questions-by-email) de la configuración de tu asistente.
## Activar el widget diff --git a/es/migration-services/go-live-checklist.mdx b/es/migration-services/go-live-checklist.mdx index 5dc1985ac..dce6ff3f0 100644 --- a/es/migration-services/go-live-checklist.mdx +++ b/es/migration-services/go-live-checklist.mdx @@ -42,8 +42,8 @@ Esta es una lista completa de configuraciones que debes establecer y ajustes que
- **Activa y configura el asistente.** Consulta [Configurar el asistente](/es/assistant/configure). - - Configura tus [correos de desvío de soporte y ventas](/es/assistant/configure#set-deflection-emails). - - Configura tus [dominios de búsqueda](/es/assistant/configure#search-domains). + - Configura tus [correos de enrutamiento de soporte y ventas](/es/assistant/support-routing#send-questions-by-email). + - Configura tus [dominios de búsqueda](/es/assistant/sources#search-domains). - Personaliza los [patrones de respuesta del asistente](/es/assistant/customize) y [agrega habilidades del asistente](/es/assistant/skills). - **Inserta el widget del asistente.** Activa el [widget del asistente](/es/assistant/widget) para agregar el asistente al panel de tu producto, sitio de marketing o portal de soporte. - **Activa los complementos.** Ve a la página [Sitio](https://app.mintlify.com/settings/project/site) en tu panel. Activa complementos relevantes como los comentarios del agente, las [comprobaciones de CI](/es/deploy/ci), los temas relacionados y más. diff --git a/es/poc-onboarding.mdx b/es/poc-onboarding.mdx index d20ee8baf..1092c1674 100644 --- a/es/poc-onboarding.mdx +++ b/es/poc-onboarding.mdx @@ -275,9 +275,9 @@ Consulta [Ajustes de apariencia](/es/organize/settings-appearance), [Temas](/es/ Abre la página [Assistant](https://app.mintlify.com/products/assistant): 1. Activa el assistant. -2. Añade [correos electrónicos de desvío](/es/assistant/configure#set-deflection-emails) para preguntas que necesiten ayuda humana. +2. Añade [correos electrónicos de enrutamiento de soporte](/es/assistant/support-routing#send-questions-by-email) para preguntas que necesiten ayuda humana. 3. Añade hasta tres [preguntas iniciales](/es/assistant/configure#add-sample-questions). -4. Añade [dominios de búsqueda](/es/assistant/configure#search-domains) si hay contenido relevante repartido en varios sitios. +4. Añade [dominios de búsqueda](/es/assistant/sources#search-domains) si hay contenido relevante repartido en varios sitios. 5. Deja la [protección contra bots](/es/assistant/configure#bot-protection) activada. Consulta [Personalizar el assistant](/es/assistant/customize) y [Skills del assistant](/es/assistant/skills) para instrucciones y tono específicos del producto. diff --git a/fr.json b/fr.json index e7ddd5402..b3b2a2193 100644 --- a/fr.json +++ b/fr.json @@ -147,6 +147,7 @@ }, "fr/organize/navigation", "fr/ai/contextual-menu", + "fr/assistant/narration", "fr/ai/bring-your-own-model", "fr/create/redirects", "fr/organize/mintignore", @@ -279,7 +280,17 @@ "pages": [ "fr/assistant/index", "fr/assistant/configure", - "fr/assistant/customize", + "fr/assistant/support-routing", + { + "group": "Améliorer les réponses", + "pages": [ + "fr/assistant/sources", + "fr/assistant/customize", + "fr/assistant/skills" + ] + }, + "fr/assistant/use", + "fr/assistant/embed", { "group": "Widget", "hidden": true, @@ -288,9 +299,7 @@ "fr/assistant/widget" ] }, - "fr/assistant/skills", - "fr/assistant/narration", - "fr/assistant/use" + "fr/assistant/billing" ] }, { diff --git a/fr/ai-native.mdx b/fr/ai-native.mdx index 817f8a169..1dcf6413a 100644 --- a/fr/ai-native.mdx +++ b/fr/ai-native.mdx @@ -56,7 +56,7 @@ La recherche en texte intégral et la compréhension sémantique aident les util Sélectionnez l’une des cartes suivantes pour en savoir plus. - + Configurez l’Assistant pour rechercher sur des sites externes ou orienter les utilisateurs vers votre équipe d’assistance s’il ne peut pas répondre à leurs questions. diff --git a/fr/api/analytics/assistant-thread.mdx b/fr/api/analytics/assistant-thread.mdx index fe4708a55..de1f3ede5 100644 --- a/fr/api/analytics/assistant-thread.mdx +++ b/fr/api/analytics/assistant-thread.mdx @@ -22,7 +22,7 @@ Cas d'usage courants : Vous pouvez obtenir un `threadId` depuis l'une des sources suivantes : - Le champ `conversationId` de n'importe quelle ligne renvoyée par [Obtenir les conversations de l'assistant](/fr/api/analytics/assistant-conversations). -- Le paramètre de requête `threadId` que Mintlify ajoute à l'URL de support lorsque l'assistant redirige vers votre plateforme de support via la [redirection par lien](/fr/assistant/configure#deflect-to-a-support-link). +- Le paramètre de requête `threadId` que Mintlify ajoute à l'URL de support lorsque l'assistant oriente les utilisateurs vers votre plateforme de support avec l'option de support [Lien](/fr/assistant/support-routing#link-to-your-help-center). ## Limites d'utilisation diff --git a/fr/assistant/billing.mdx b/fr/assistant/billing.mdx new file mode 100644 index 000000000..32730c9a8 --- /dev/null +++ b/fr/assistant/billing.mdx @@ -0,0 +1,46 @@ +--- +title: "Gérer la facturation de l'assistant" +sidebarTitle: "Facturation" +description: "Consultez le nombre de crédits utilisés par l'assistant IA, changez de palier de crédits, autorisez les dépassements, définissez des alertes d'utilisation et utilisez votre propre modèle." +keywords: ["assistant", "facturation", "crédits", "dépassements", "alertes d'utilisation", "palier de crédits", "utiliser votre propre modèle"] +--- + + + L'assistant nécessite un [forfait Pro ou Enterprise](https://mintlify.com/pricing?ref=assistant). + + +L'assistant fonctionne avec des crédits. Chaque question à laquelle l'assistant répond coûte 25 crédits. Si l'assistant ne trouve pas de réponse dans votre documentation et le signale, le message ne coûte rien. + +Chaque forfait Pro contribue 10 000 crédits par mois au solde de crédits partagé de votre organisation, utilisé pour l'assistant, Autopilot et d'autres fonctionnalités basées sur les crédits sur tous les projets. Pour en savoir plus, consultez [Tarification par crédits](/fr/credits). + +Sur les forfaits Enterprise, vous pouvez [utiliser votre propre modèle](/fr/ai/bring-your-own-model) pour exécuter l'assistant avec votre propre fournisseur LLM et votre propre clé d'API. + +Gérez la facturation et l'utilisation sur les pages [Utilisation](https://app.mintlify.com/settings/organization/usage) et [Facturation](https://app.mintlify.com/settings/organization/billing) de votre tableau de bord. + +
+ ## Changer de palier de crédits +
+ +1. Rendez-vous sur la page [Utilisation](https://app.mintlify.com/settings/organization/usage) de votre tableau de bord. +2. Dans la section **Credit packages**, sélectionnez un palier dans le menu déroulant. +3. Confirmez le changement pour passer au checkout. + +
+ ## Autoriser les dépassements +
+ +Votre organisation partage les crédits entre les projets. Par défaut, Mintlify désactive les dépassements. Vous pouvez activer ou désactiver les dépassements pour chaque projet. Si vous désactivez les dépassements pour un projet, l'assistant devient indisponible dès que vous épuisez le solde de crédits partagé de votre organisation. L'assistant reste indisponible jusqu'au renouvellement du solde de crédits. + +Pour autoriser les dépassements, activez l'interrupteur **Overage** sur la carte du projet, dans la section **Usage** de la page [Facturation](https://app.mintlify.com/settings/organization/billing) de votre tableau de bord. Si vous activez les dépassements, chaque crédit dépensé au-delà du solde partagé entraîne des frais de dépassement. Choisissez **Limit spend** pour définir un montant maximal de dépassement en dollars, ou **No spend limit** pour facturer les dépassements sans plafond. Lorsqu'un projet atteint sa limite de dépenses, ses fonctionnalités alimentées par les crédits sont suspendues jusqu'au prochain cycle de facturation. + +
+ ## Configurer les alertes d'utilisation +
+ +Dans la section **Usage** de la page [Facturation](https://app.mintlify.com/settings/organization/billing), définissez le seuil **Alert** pour envoyer un e-mail aux administrateurs de votre organisation lorsque l'utilisation totale atteint un certain pourcentage de son solde de crédits partagé. + +
+ ## Volumes de crédits plus élevés +
+ +Pour ajouter jusqu'à 90 000 crédits par mois, achetez un [module complémentaire de crédits](/fr/credits#credit-add-ons). Pour ajouter un volume de crédits plus important, [contactez l'équipe commerciale](https://www.mintlify.com/contact/sales) pour discuter d'un forfait de crédits personnalisé. diff --git a/fr/assistant/configure.mdx b/fr/assistant/configure.mdx index fdc598040..6e42ad9b4 100644 --- a/fr/assistant/configure.mdx +++ b/fr/assistant/configure.mdx @@ -1,14 +1,15 @@ --- title: "Configurer l'assistant" -description: "Configurez l'assistant IA : activez-le, envoyez les questions de support vers un e-mail, un lien ou des tickets Plain et Zendesk, ajoutez des questions de démarrage et gérez la facturation." -keywords: ["assistant", "paramètres", "redirection", "tickets de support", "Plain", "Zendesk", "protection contre les bots", "facturation"] +sidebarTitle: "Configuration" +description: "Activez l'assistant IA, ajoutez des questions de démarrage, activez la protection contre les bots et testez les réponses en prévisualisation locale avant que les utilisateurs ne les voient." +keywords: ["assistant", "configurer", "paramètres", "activer", "questions de démarrage", "protection contre les bots", "prévisualisation locale"] --- L'assistant nécessite un [forfait Pro ou Enterprise](https://mintlify.com/pricing?ref=assistant). -Configurez l'assistant sur la page [Assistant](https://app.mintlify.com/products/assistant) de votre tableau de bord. Gérez la facturation et l'utilisation sur la page [Utilisation](https://app.mintlify.com/settings/organization/usage). +Configurez l'assistant sur la page [Assistant](https://app.mintlify.com/products/assistant) de votre tableau de bord. Après l'avoir activé et avoir ajouté des questions de démarrage, choisissez où vont les questions auxquelles l'assistant ne peut pas répondre, puis testez-le.
## Activer ou désactiver l'assistant @@ -16,91 +17,6 @@ Configurez l'assistant sur la page [Assistant](https://app.mintlify.com/products Sur la page [Assistant](https://app.mintlify.com/products/assistant) de votre tableau de bord, cliquez sur le bouton de statut pour activer ou désactiver l'assistant sur votre site. -
- ## Définir les e-mails de redirection -
- -Dans la section Gestion des réponses, activez l'assistant pour inviter les utilisateurs à contacter vos équipes de support et de ventes lorsqu'il ne peut pas répondre à une question par lui-même. - -Le menu **Support** définit où vont les questions de support. Il propose trois options : **Email**, **Link** et **Direct support ticketing**. Cette section traite de **Email**. - -Dans le menu **Support**, sélectionnez **Email**, puis renseignez l'une ou les deux adresses suivantes : - -- **Support email** : Pour les questions que l'assistant ne peut pas résoudre à partir de votre documentation. -- **Ventes** : Pour les questions sur les tarifs, les offres ou les achats. - -Lorsque vous activez la redirection et que l'assistant détecte une question correspondante, un formulaire de contact s'affiche dans le chat. Le formulaire demande le prénom, le nom, l'entreprise, l'e-mail professionnel et un message de l'utilisateur. Mintlify envoie la soumission par e-mail à l'équipe appropriée, qui peut répondre directement à l'e-mail de l'utilisateur. - -Le même formulaire de contact est disponible dans le [widget de l'assistant](/fr/assistant/widget) intégré sur d'autres sites. - - -Si vous préférez rediriger les questions de support vers vos canaux existants, désactivez **Contact form** dans la section Gestion des réponses. - -Lorsque vous désactivez le formulaire de contact, l'assistant redirige les utilisateurs vers votre adresse e-mail de support en texte brut au lieu d'afficher le formulaire dans le chat. Les questions commerciales continuent d'utiliser le formulaire dans le chat lorsque vous configurez un e-mail commercial. - - - - -Dans le menu **Support**, sélectionnez **Link** pour envoyer les utilisateurs vers votre plateforme de support existante (par exemple, un centre d'aide, un portail de tickets ou un forum communautaire) au lieu de collecter leur e-mail via un formulaire dans le chat. - -Saisissez l'URL complète de votre destination de support. L'URL doit utiliser `http` ou `https` et ne peut pas contenir d'identifiants. - -Lorsque l'assistant détecte une question de support, il affiche à l'utilisateur une carte contenant un lien vers votre URL de support. Mintlify ajoute l'identifiant du fil de conversation de l'assistant en tant que paramètre de requête `threadId`, afin que votre outil de support puisse joindre la transcription de la conversation au ticket créé. Récupérez la transcription avec l'endpoint [Obtenir un fil de conversation de l'assistant](/fr/api/analytics/assistant-thread). - -Lorsque **Link** est sélectionné, l'assistant n'affiche pas le formulaire de contact et ne redirige pas les questions commerciales. - -
- ## Créer des tickets dans votre plateforme de support -
- -L'assistant peut enregistrer les demandes de support sous forme de tickets dans Plain ou Zendesk au lieu de les envoyer par e-mail. - -Avant de connecter Plain, créez une clé d'API Plain avec ces autorisations : - -- `customer:create` -- `customer:edit` -- `customer:read` -- `thread:create` -- `thread:read` - -1. Dans la section **Response handling** du menu **Support**, sélectionnez **Direct support ticketing**. -2. Sélectionnez une **Ticketing platform** : **Plain** ou **Zendesk**. -3. Sur la carte de la plateforme, cliquez sur **Connect** et terminez la connexion dans la fenêtre qui s'ouvre. Pour Plain, utilisez la clé d'API que vous avez créée. - -Mintlify n'enregistre la création directe de tickets de support qu'une fois la plateforme connectée. D'ici là, votre option de support actuelle reste active. La connexion est une intégration partagée pour votre organisation. - -Lorsque l'assistant détecte une question de support, il affiche le formulaire de contact dans le chat. Mintlify crée un ticket dans votre plateforme connectée à partir de la soumission. Le ticket inclut les coordonnées et le message de l'utilisateur, ainsi que jusqu'aux trois premiers messages de la conversation avec l'assistant. Si la conversation est plus longue, le ticket renvoie vers la conversation complète dans votre dashboard. - -Si vous avez enregistré une adresse **Ventes** sous **Email**, les questions commerciales sont toujours envoyées par e-mail à cette adresse. - -S'il manque à la clé d'API Plain l'une des autorisations requises, la carte de la plateforme affiche **Scopes misconfigured**. Cliquez sur **Configure** pour voir les autorisations manquantes, puis ajoutez-les à la clé d'API dans Plain. - -
- ## Domaines de recherche -
- - - Les domaines de recherche nécessitent une [offre Enterprise](https://mintlify.com/pricing?ref=assistant). - - -Dans la section Gestion des réponses, configurez les domaines que l'assistant peut utiliser pour effectuer des recherches web afin de trouver un contexte supplémentaire lorsqu'il répond aux questions. - -- Les domaines doivent être accessibles publiquement. -- L'assistant ne peut pas effectuer de recherches sur les domaines nécessitant JavaScript pour se charger. - -Pour un contrôle plus précis sur ce que l'assistant peut rechercher, utilisez la syntaxe de filtrage. - -- **Filtrage au niveau du domaine** - - `example.com` : Rechercher uniquement sur le domaine `example.com` - - `docs.example.com` : Rechercher uniquement sur le sous-domaine `docs.example.com` - - `*.example.com` : Rechercher sur tous les sous-domaines de `example.com` -- **Filtrage au niveau du chemin** - - `docs.example.com/api` : Rechercher toutes les pages sous le sous-chemin `/api` -- **Plusieurs motifs** - - Ajoutez plusieurs entrées pour cibler différentes sections de sites -
## Ajouter des questions de démarrage
@@ -116,6 +32,12 @@ Vous pouvez ajouter jusqu'à trois questions de démarrage. Cliquez sur **Demand Le panneau de suggestions de recherche dans le tableau de bord avec les questions de démarrage contextuelles activées. +
+ ## Choisir où vont les questions sans réponse +
+ +Lorsque l'assistant ne peut pas répondre à une question, il peut orienter l'utilisateur vers votre équipe de support ou commerciale par e-mail, via un lien vers votre centre d'aide ou avec un ticket dans Plain ou Zendesk. Consultez [Orienter les questions vers votre équipe](/fr/assistant/support-routing). +
## Protection contre les bots
@@ -133,38 +55,14 @@ 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. -
- ## Gérer la facturation +
+ ## Tester l'assistant
-L'assistant fonctionne avec des crédits. Chaque question à laquelle l'assistant répond coûte 25 crédits. Si l'assistant ne trouve pas de réponse dans votre documentation et le signale, le message ne coûte rien. Pour en savoir plus, consultez [Tarification par crédits](/fr/credits). +L'assistant est disponible dans votre prévisualisation locale lorsque vous vous connectez avec la CLI. Utilisez la prévisualisation locale pour tester les réponses et les instructions personnalisées dans `Assistant.md` pendant que vous rédigez. -Sur les forfaits Enterprise, vous pouvez [utiliser votre propre modèle](/fr/ai/bring-your-own-model) pour exécuter l'assistant avec votre propre fournisseur LLM et votre propre clé d'API. - -
- ### Changer de palier de crédits -
- -1. Rendez-vous sur la page [Utilisation](https://app.mintlify.com/settings/organization/usage) de votre tableau de bord. -2. Dans la section **Credit packages**, sélectionnez un palier dans le menu déroulant. -3. Confirmez le changement pour passer au checkout. - -
- ### Autoriser les dépassements -
- -Votre organisation partage les crédits entre les projets. Par défaut, Mintlify désactive les dépassements. Vous pouvez activer ou désactiver les dépassements pour chaque projet. Si vous désactivez les dépassements pour un projet, l'assistant devient indisponible dès que vous épuisez le solde de crédits partagé de votre organisation. L'assistant reste indisponible jusqu'au renouvellement du solde de crédits. - -Pour autoriser les dépassements, activez l'interrupteur **Overage** sur la carte du projet, dans la section **Usage** de la page [Facturation](https://app.mintlify.com/settings/organization/billing) de votre tableau de bord. Si vous activez les dépassements, chaque crédit dépensé au-delà du solde partagé entraîne des frais de dépassement. Choisissez **Limit spend** pour définir un montant maximal de dépassement en dollars, ou **No spend limit** pour facturer les dépassements sans plafond. Lorsqu'un projet atteint sa limite de dépenses, ses fonctionnalités alimentées par les crédits sont suspendues jusqu'au prochain cycle de facturation. - -
- ### Configurer les alertes d'utilisation -
- -Dans la section **Usage** de la page [Facturation](https://app.mintlify.com/settings/organization/billing), définissez le seuil **Alert** pour envoyer un e-mail aux administrateurs de votre organisation lorsque l'utilisation totale atteint un certain pourcentage de son solde de crédits partagé. - -
- ### Volumes de crédits plus élevés -
+1. Si ce n'est pas déjà fait, installez la CLI avec `npm i -g mint`. +2. Exécutez `mint login` pour vous authentifier. +3. Exécutez `mint dev` pour démarrer la prévisualisation locale. -Pour ajouter jusqu'à 90 000 crédits par mois, achetez un [module complémentaire de crédits](/fr/credits#credit-add-ons). Pour ajouter un volume de crédits plus important, [contactez l'équipe commerciale](https://www.mintlify.com/contact/sales) pour discuter d'un forfait de crédits personnalisé. +L'assistant en prévisualisation locale utilise le même contenu indexé que votre site de documentation déployé. diff --git a/fr/assistant/embed.mdx b/fr/assistant/embed.mdx new file mode 100644 index 000000000..39e4a88a9 --- /dev/null +++ b/fr/assistant/embed.mdx @@ -0,0 +1,17 @@ +--- +title: "Intégrer l'assistant dans votre produit" +sidebarTitle: "Intégrer dans votre produit" +description: "Répondez aux questions des utilisateurs dans votre application, votre tableau de bord ou votre portail de support en créant votre propre interface avec l'API de l'assistant." +keywords: ["assistant", "intégrer", "assistant intégré à l'application", "API de l'assistant", "clé d'API"] +--- + + + L'assistant nécessite un [forfait Pro ou Enterprise](https://mintlify.com/pricing?ref=assistant). + + +Proposez l'assistant là où vos utilisateurs travaillent déjà, comme votre application, votre tableau de bord, votre site marketing ou votre portail de support. Il répond à partir de la même documentation que l'assistant de votre site de documentation. + +Utilisez l'API de l'assistant pour créer votre propre interface en contrôlant entièrement son apparence et son comportement. Authentifiez-vous avec une [clé d'API de l'assistant](https://app.mintlify.com/settings/organization/api-keys). + +- Suivez [Créer un assistant intégré à l'application](/fr/guides/assistant-embed) pour un exemple complet avec Next.js. +- Consultez [Créer un message de l'assistant](/fr/api/assistant/create-assistant-message-v2) et [Rechercher dans la documentation](/fr/api/assistant/search) pour les endpoints. diff --git a/fr/assistant/index.mdx b/fr/assistant/index.mdx index 1a9a2b421..e2dda32b5 100644 --- a/fr/assistant/index.mdx +++ b/fr/assistant/index.mdx @@ -1,73 +1,54 @@ --- title: "Assistant" -description: "Ajoutez un assistant de chat IA à votre site de documentation : il répond aux questions, cite les sources et génère des exemples de code à la demande." +description: "Ajoutez à votre site de documentation un assistant IA qui répond aux questions à partir de votre contenu, oriente vers votre équipe ce à quoi il ne peut pas répondre et fonctionne dans votre produit." keywords: ["chat", "support utilisateur", "multimodal"] boost: 3 --- - L'assistant nécessite un [forfait Pro ou Enterprise](https://mintlify.com/pricing?ref=assistant). Chaque forfait Pro contribue 10 000 crédits par mois au solde de crédits partagé de votre organisation, utilisé pour l'assistant, Autopilot et d'autres fonctionnalités basées sur les crédits sur tous les projets. Consultez [Gérer la facturation](/fr/assistant/configure#manage-billing) pour en savoir plus sur les paliers et les options de crédits. + L'assistant nécessite un [forfait Pro ou Enterprise](https://mintlify.com/pricing?ref=assistant). -
- ## À propos de l'assistant -
- -L'assistant répond aux questions sur votre documentation par des requêtes en langage naturel. Les utilisateurs accèdent à l'assistant sur votre site de documentation, afin de trouver des réponses rapidement et d'utiliser votre produit avec succès même s'ils ne savent pas où chercher. - -L'assistant utilise l'appel d'outils pour répondre aux questions. Lorsque les utilisateurs posent des questions, l'assistant : - -* **Recherche et récupère** le contenu pertinent de votre documentation au format Markdown pour fournir des réponses précises. -* **Construit le contexte** à partir de la page que l'utilisateur consulte lorsqu'il pose des questions. -* **Lit les images** de vos pages de documentation, comme les captures d'écran et les diagrammes, pour répondre aux questions sur ce qu'elles montrent. L'assistant ne consulte que les images qui figurent sur des pages auxquelles il a accès, il ne peut donc pas récupérer des URL d'images arbitraires. -* **Cite les sources** et fournit des liens navigables pour amener les utilisateurs directement aux pages référencées. -* **Renvoie des informations détaillées sur l'API** lorsqu'il répond à des questions sur votre API, y compris les méthodes, paramètres, corps de requête et schémas de réponse de vos spécifications OpenAPI. -* **Génère des exemples de code copiables** pour aider les utilisateurs à implémenter des solutions à partir de votre documentation. -* **Prend en charge plusieurs modalités** en permettant aux utilisateurs d'ajouter du texte, des images et d'autres fichiers comme contexte. +L'assistant est un chat IA sur votre site de documentation. Les utilisateurs posent des questions en langage naturel et obtiennent des réponses à partir de votre contenu, afin de réussir avec votre produit même lorsqu'ils ne savent pas où chercher. -
- ### Fonctionnement de l'indexation +
+ ## Ce que vos utilisateurs peuvent faire avec l'assistant
-L'assistant indexe votre documentation publiée et vos spécifications d'API pour répondre aux questions avec précision. Lorsque vous publiez des modifications, l'assistant indexe immédiatement le contenu nouveau, mis à jour ou supprimé. L'assistant n'indexe pas les branches de brouillon ni les déploiements de prévisualisation. +- Obtenir des réponses qui citent les pages dont elles proviennent, avec des liens vers chaque page. +- Poser des questions sur votre API et obtenir les méthodes, paramètres, corps de requête et schémas de réponse de vos spécifications OpenAPI. +- Copier des exemples de code que l'assistant rédige à partir de votre documentation. +- Poser des questions sur les captures d'écran et les diagrammes de vos pages. +- Ajouter du contexte en surlignant du texte, en envoyant un bloc de code ou en joignant des fichiers. L'assistant sait aussi sur quelle page se trouve l'utilisateur. Consultez [Ajouter du contexte à une question](/fr/assistant/use#add-context-to-a-question). +- Joindre votre équipe par e-mail, via votre centre d'aide ou par un ticket de support lorsque l'assistant ne peut pas répondre. -Par défaut, l'assistant n'indexe pas les pages masquées. Pour inclure les pages masquées dans l'index de l'assistant, définissez `seo.indexing: "all"` dans votre `docs.json`. Consultez [Pages masquées](/fr/organize/hidden-pages#search-seo-and-ai-indexing) pour plus d'informations. - -
- ### Comment l'assistant gère les questions inconnues +
+ ## Démarrer avec l'assistant
-L'assistant répond uniquement aux questions en se basant sur les informations de votre documentation. S'il ne trouve pas d'informations pertinentes après avoir effectué une recherche, il répond qu'il ne dispose pas de suffisamment d'informations pour répondre. - -Vous pouvez [définir un e-mail de redirection](/fr/assistant/configure#set-deflection-emails) pour que l'assistant fournisse votre e-mail de support aux utilisateurs dont il ne peut pas répondre aux questions. Cela offre aux utilisateurs une solution de recours, même si la documentation ne traite pas leur question spécifique. - -
- ## Statistiques de l'assistant + + + Activez l'assistant, ajoutez des questions de démarrage et testez-le avant que les utilisateurs ne le voient. + + + Envoyez les questions auxquelles l'assistant ne peut pas répondre vers un e-mail, votre centre d'aide ou des tickets dans Plain ou Zendesk. + + + Trouvez les questions auxquelles l'assistant n'a pas pu répondre, contrôlez le contenu qu'il utilise et ajoutez des instructions et des skills. + + + Ouvrez l'assistant depuis vos propres liens, modifiez le style de son bouton ou masquez-le, ou désactivez-le. + + + Répondez aux questions dans votre application, votre tableau de bord ou votre portail de support avec l'API de l'assistant. + + + Consultez le coût de l'assistant en crédits, autorisez les dépassements et utilisez votre propre modèle. + + + +
+ ## Comment l'assistant répond
-Utilisez les statistiques de l'assistant pour comprendre comment les utilisateurs interagissent avec votre documentation et identifier des opportunités d'amélioration. - -La [page de l'assistant](https://dashboard.mintlify.com/products/assistant) affiche les tendances d'utilisation du mois en cours. Consultez des statistiques plus détaillées sur la page [analytiques](/fr/analytics/assistant). - -
- ## Rendre le contenu exploitable par l'IA -
- -Structurez votre documentation pour aider l'assistant à fournir des réponses précises et pertinentes. Une organisation claire et un contexte complet profitent aussi bien aux lecteurs humains qu'à la compréhension par l'IA. - - - - Utilisez un balisage sémantique. - - Rédigez des titres descriptifs pour les sections. - - Créez une hiérarchie logique de l'information. - - Utilisez un formatage cohérent dans toute votre documentation. - - Incluez des métadonnées complètes dans le frontmatter des pages. - - Découpez les longs blocs de texte en paragraphes plus courts. - - - - - Définissez les termes spécifiques et les acronymes lors de leur première apparition. - - Fournissez suffisamment de contenu conceptuel sur les fonctionnalités et les procédures. - - Incluez des exemples et des cas d'utilisation. - - Faites des références croisées vers les sujets connexes. - - Ajoutez des [pages masquées](/fr/organize/hidden-pages) avec du contexte supplémentaire dont les utilisateurs n'ont pas besoin, mais que l'assistant peut consulter. - +L'assistant répond uniquement à partir de votre documentation publiée et de vos spécifications d'API, ainsi que des [domaines de recherche](/fr/assistant/sources#search-domains) que vous ajoutez. S'il ne trouve pas d'informations pertinentes, il le dit au lieu de deviner. Consultez [Gérer ce que sait l'assistant](/fr/assistant/sources) pour contrôler le contenu qu'il utilise. diff --git a/fr/assistant/sources.mdx b/fr/assistant/sources.mdx new file mode 100644 index 000000000..40621644e --- /dev/null +++ b/fr/assistant/sources.mdx @@ -0,0 +1,71 @@ +--- +title: "Gérer ce que sait l'assistant" +sidebarTitle: "Sources et indexation" +description: "Contrôlez le contenu à partir duquel l'assistant IA répond, ajoutez du contexte que les utilisateurs ne voient pas, recherchez sur d'autres sites web et trouvez les questions auxquelles il n'a pas pu répondre." +keywords: ["assistant", "indexation", "pages masquées", "domaines de recherche", "recherche web", "questions sans réponse"] +--- + +L'assistant répond uniquement à partir de votre documentation publiée et de vos spécifications d'API, ainsi que des domaines de recherche que vous ajoutez. Lorsque vous publiez des modifications, l'assistant indexe immédiatement le contenu nouveau, mis à jour ou supprimé. Il n'indexe pas les branches de brouillon ni les déploiements de prévisualisation. + +Pour améliorer les réponses, trouvez les questions auxquelles l'assistant n'a pas pu répondre, puis corrigez le contenu à partir duquel il répond. Utilisez des [instructions personnalisées](/fr/assistant/customize) et des [skills](/fr/assistant/skills) pour définir sa façon de répondre. + +
+ ## Trouver les questions auxquelles l'assistant n'a pas pu répondre +
+ +La liste **Unanswered conversations** des [analyses de l'assistant](/fr/analytics/assistant) affiche toutes les conversations auxquelles l'assistant n'a pas pu répondre à partir de votre documentation. Ouvrez une transcription pour voir ce que l'utilisateur a demandé, puis ajoutez ou mettez à jour le contenu qui y répond. + +
+ ## Ajouter du contexte que les utilisateurs ne voient pas +
+ +Par défaut, l'assistant n'indexe pas les pages masquées. Pour inclure les pages masquées dans l'index de l'assistant, définissez `seo.indexing: "all"` dans votre `docs.json`. Utilisez des pages masquées pour le contexte que les utilisateurs n'ont pas besoin de parcourir, mais que l'assistant peut consulter. Consultez [Pages masquées](/fr/organize/hidden-pages#search-seo-and-ai-indexing) pour savoir comment chaque paramètre de page affecte l'assistant. + +Pour présenter du contexte uniquement à l'assistant et aux autres outils d'IA sur une page publiée, encadrez-le avec le composant [`Visibility`](/fr/components/visibility) et `for="agents"`. + +
+ ## Exclure du contenu des réponses +
+ +Pour exclure une page visible des réponses de l'assistant, définissez `searchable: false` dans le frontmatter de la page. La page reste dans votre navigation, mais la recherche du site et l'assistant l'ignorent. Consultez [Pages masquées](/fr/organize/hidden-pages#search-seo-and-ai-indexing) pour d'autres options. + +
+ ## Restreindre les réponses par groupe d'utilisateurs +
+ +Si votre site nécessite une [authentification](/fr/deploy/authentication-setup), l'assistant respecte les groupes d'utilisateurs. Il répond à chaque utilisateur connecté uniquement à partir des pages auxquelles cet utilisateur a accès. + +
+ ## Domaines de recherche +
+ + + Les domaines de recherche nécessitent une [offre Enterprise](https://mintlify.com/pricing?ref=assistant). + + +Dans la section Gestion des réponses, configurez les domaines que l'assistant peut utiliser pour effectuer des recherches web afin de trouver un contexte supplémentaire lorsqu'il répond aux questions. + +- Les domaines doivent être accessibles publiquement. +- L'assistant ne peut pas effectuer de recherches sur les domaines nécessitant JavaScript pour se charger. + +Pour un contrôle plus précis sur ce que l'assistant peut rechercher, utilisez la syntaxe de filtrage. + +- **Filtrage au niveau du domaine** + - `example.com` : Rechercher uniquement sur le domaine `example.com` + - `docs.example.com` : Rechercher uniquement sur le sous-domaine `docs.example.com` + - `*.example.com` : Rechercher sur tous les sous-domaines de `example.com` +- **Filtrage au niveau du chemin** + - `docs.example.com/api` : Rechercher toutes les pages sous le sous-chemin `/api` +- **Plusieurs motifs** + - Ajoutez plusieurs entrées pour cibler différentes sections de sites + +
+ ## Rédiger du contenu exploitable par l'assistant +
+ +L'assistant répond mieux lorsque votre contenu est facile à trouver et à comprendre. Une organisation claire et un contexte complet aident à la fois les personnes et les outils d'IA. + +- Rédigez des titres descriptifs et des descriptions de frontmatter précises pour chaque page. +- Définissez les termes et acronymes lors de leur première utilisation. +- Incluez des exemples et des cas d'usage, et liez les sujets connexes. +- Découpez les longs blocs de texte en paragraphes plus courts. diff --git a/fr/assistant/support-routing.mdx b/fr/assistant/support-routing.mdx new file mode 100644 index 000000000..51526ecfa --- /dev/null +++ b/fr/assistant/support-routing.mdx @@ -0,0 +1,79 @@ +--- +title: "Orienter les questions vers votre équipe" +sidebarTitle: "Orienter vers votre équipe" +description: "Envoyez les questions auxquelles l'assistant ne peut pas répondre à votre équipe de support ou commerciale par e-mail, via un lien vers votre centre d'aide ou sous forme de tickets dans Plain ou Zendesk." +keywords: ["assistant", "orientation vers le support", "redirection", "contacter le support", "formulaire de contact", "tickets de support", "help desk", "Zendesk", "Plain", "threadId"] +--- + + + L'assistant nécessite un [forfait Pro ou Enterprise](https://mintlify.com/pricing?ref=assistant). + + +Lorsque l'assistant ne peut pas répondre à une question à partir de votre documentation, il peut transmettre l'utilisateur à votre équipe. Les utilisateurs disposent ainsi d'un moyen de joindre une personne au lieu de se retrouver dans une impasse. + +Choisissez où vont les questions de support dans le menu **Support** de la section Gestion des réponses, sur la page [Assistant](https://app.mintlify.com/products/assistant) de votre tableau de bord : + +| Option | Ce que voient les utilisateurs | Où va la demande | +| :--- | :--- | :--- | +| [Email](#send-questions-by-email) | Un formulaire de contact dans le chat | Votre adresse e-mail de support ou commerciale | +| [Link](#link-to-your-help-center) | Une carte contenant un lien vers votre URL de support | Votre centre d'aide, portail de tickets ou forum communautaire | +| [Direct support ticketing](#create-tickets-in-plain-or-zendesk) | Un formulaire de contact dans le chat | Un nouveau ticket dans Plain ou Zendesk | + +Si vous utilisez un help desk autre que Plain ou Zendesk, utilisez **Link** pour envoyer les utilisateurs vers sa page de contact ou son centre d'aide. + +
+ ## Envoyer les questions par e-mail +
+ +Dans le menu **Support**, sélectionnez **Email**, puis renseignez l'une ou les deux adresses suivantes : + +- **Support email** : Pour les questions que l'assistant ne peut pas résoudre à partir de votre documentation. +- **Ventes** : Pour les questions sur les tarifs, les offres ou les achats. + +Lorsque l'assistant détecte une question correspondante, un formulaire de contact s'affiche dans le chat. Le formulaire demande le prénom, le nom, l'entreprise, l'e-mail professionnel et un message de l'utilisateur. Mintlify envoie la soumission par e-mail à l'équipe appropriée, qui peut répondre directement à l'e-mail de l'utilisateur. + +Le même formulaire de contact est disponible dans le [widget de l'assistant](/fr/assistant/widget) intégré sur d'autres sites. + + +Si vous préférez rediriger les questions de support vers vos canaux existants, désactivez **Contact form** dans la section Gestion des réponses. + +Lorsque vous désactivez le formulaire de contact, l'assistant redirige les utilisateurs vers votre adresse e-mail de support en texte brut au lieu d'afficher le formulaire dans le chat. Les questions commerciales continuent d'utiliser le formulaire dans le chat lorsque vous configurez un e-mail commercial. + + + + +Dans le menu **Support**, sélectionnez **Link** pour envoyer les utilisateurs vers votre plateforme de support existante, comme un centre d'aide, un portail de tickets ou un forum communautaire, au lieu de collecter leur e-mail via un formulaire dans le chat. + +Saisissez l'URL complète de votre destination de support. L'URL doit utiliser `http` ou `https` et ne peut pas contenir d'identifiants. + +Lorsque l'assistant détecte une question de support, il affiche à l'utilisateur une carte contenant un lien vers votre URL de support. Mintlify ajoute l'identifiant du fil de conversation de l'assistant en tant que paramètre de requête `threadId`, afin que votre outil de support puisse joindre la transcription de la conversation au ticket créé. Récupérez la transcription avec l'endpoint [Obtenir un fil de conversation de l'assistant](/fr/api/analytics/assistant-thread). + +Lorsque **Link** est sélectionné, l'assistant n'affiche pas le formulaire de contact et ne redirige pas les questions commerciales. + +
+ ## Créer des tickets dans Plain ou Zendesk +
+ +L'assistant peut enregistrer les demandes de support sous forme de tickets dans Plain ou Zendesk au lieu de les envoyer par e-mail. + +Avant de connecter Plain, créez une clé d'API Plain avec ces autorisations : + +- `customer:create` +- `customer:edit` +- `customer:read` +- `thread:create` +- `thread:read` + +1. Dans la section **Response handling** du menu **Support**, sélectionnez **Direct support ticketing**. +2. Sélectionnez une **Ticketing platform** : **Plain** ou **Zendesk**. +3. Sur la carte de la plateforme, cliquez sur **Connect** et terminez la connexion dans la fenêtre qui s'ouvre. Pour Plain, utilisez la clé d'API que vous avez créée. + +Mintlify n'enregistre la création directe de tickets de support qu'une fois la plateforme connectée. D'ici là, votre option de support actuelle reste active. La connexion est une intégration partagée pour votre organisation. + +Lorsque l'assistant détecte une question de support, il affiche le formulaire de contact dans le chat. Mintlify crée un ticket dans votre plateforme connectée à partir de la soumission. Le ticket inclut les coordonnées et le message de l'utilisateur, ainsi que jusqu'aux trois premiers messages de la conversation avec l'assistant. Si la conversation est plus longue, le ticket renvoie vers la conversation complète dans votre dashboard. + +Si vous avez enregistré une adresse **Ventes** sous **Email**, les questions commerciales sont toujours envoyées par e-mail à cette adresse. + +S'il manque à la clé d'API Plain l'une des autorisations requises, la carte de la plateforme affiche **Scopes misconfigured**. Cliquez sur **Configure** pour voir les autorisations manquantes, puis ajoutez-les à la clé d'API dans Plain. diff --git a/fr/assistant/use.mdx b/fr/assistant/use.mdx index 07e15a092..85fd0ce2b 100644 --- a/fr/assistant/use.mdx +++ b/fr/assistant/use.mdx @@ -1,25 +1,14 @@ --- -title: "Utiliser l'assistant" -description: "Ouvrez l'assistant via raccourcis clavier, texte surligné, blocs de code, pièces jointes ou paramètres d'URL, et testez-le en prévisualisation locale." -keywords: ["assistant", "raccourci clavier", "pièces jointes", "prévisualisation locale", "paramètres d'URL"] +title: "Contrôler l'affichage de l'assistant" +sidebarTitle: "Affichage" +description: "Contrôlez où les utilisateurs trouvent l'assistant IA : ouvrez-le depuis vos propres liens, masquez ou modifiez le style de son bouton et découvrez comment les utilisateurs ajoutent du contexte à une question." +keywords: ["assistant", "raccourci clavier", "paramètres d'URL", "lien direct", "masquer l'assistant", "CSS personnalisé", "pièces jointes", "dépannage"] --- -Les utilisateurs disposent de plusieurs moyens pour démarrer une conversation avec l'assistant. Chaque méthode ouvre un panneau de chat sur le côté droit de votre documentation. Les utilisateurs peuvent poser n'importe quelle question et l'assistant recherche une réponse dans votre documentation. Si l'assistant ne parvient pas à récupérer des informations pertinentes, il répond qu'il ne peut pas répondre à la question. +Les utilisateurs ouvrent l'assistant depuis son bouton, un raccourci clavier ou un lien que vous partagez. Vous pouvez modifier l'apparence du bouton, le masquer ou désactiver l'assistant. -
- ## Utiliser l'assistant en prévisualisation locale -
- -L'assistant est disponible dans votre prévisualisation locale lorsque vous vous connectez avec la CLI. Cela vous permet de tester le comportement de l'assistant, les instructions personnalisées dans `Assistant.md` et les réponses pendant que vous développez votre documentation localement. - -1. Si ce n'est pas déjà fait, installez la CLI avec `npm i -g mint`. -2. Exécutez `mint login` pour vous authentifier. -3. Exécutez `mint dev` pour démarrer la prévisualisation locale. - -L'assistant en prévisualisation locale utilise le même contenu indexé que votre site de documentation déployé. - -
- ## Emplacement dans l'interface +
+ ## Où apparaît l'assistant
L'assistant apparaît à deux endroits : sous forme de bouton à côté de la barre de recherche et sous forme de barre en bas de la page. @@ -67,14 +56,10 @@ L'assistant apparaît à deux endroits : sous forme de bouton à côté de la ba -
- ## Raccourci clavier -
- -Ouvrez le panneau de chat de l'assistant avec le raccourci clavier Cmd + I sur macOS et Ctrl + I sur Windows. +Les utilisateurs peuvent aussi ouvrir le panneau de chat de l'assistant avec le raccourci clavier Cmd + I sur macOS et Ctrl + I sur Windows. -
- ## Paramètres d'URL + Ouvrez l'assistant depuis n'importe quelle page de votre site de documentation en ajoutant le paramètre de requête `?assistant` à l'URL. Utilisez-le pour créer un lien direct vers l'assistant depuis du contenu externe comme des e-mails, des réponses de support, des bannières in-app ou des parcours d'intégration. @@ -87,14 +72,22 @@ https://yourdocs.mintlify.site/quickstart?assistant https://yourdocs.mintlify.site/quickstart?assistant=How%20do%20I%20get%20started%3F ``` +Pour permettre aux utilisateurs d'ouvrir l'assistant avec la page actuelle comme contexte depuis le menu contextuel de la page, ajoutez l'option `"assistant"` à votre [menu contextuel](/fr/ai/contextual-menu). + +
+ ## Ajouter du contexte à une question +
+ +Les utilisateurs peuvent donner à l'assistant plus de contexte que leur seule question. L'assistant sait aussi sur quelle page se trouve l'utilisateur. +
- ## Surligner du texte + ### Surligner du texte
Surlignez du texte sur une page et cliquez sur le bouton contextuel **Add to assistant** pour ouvrir le panneau de chat de l'assistant et ajouter le texte surligné comme contexte. Vous pouvez ajouter plusieurs extraits de texte ou blocs de code au contexte de l'assistant.
- ## Blocs de code + ### Blocs de code
Cliquez sur le bouton **Demander à l'assistant** dans un bloc de code pour ouvrir le panneau de chat de l'assistant et ajouter le bloc de code comme contexte. Vous pouvez ajouter plusieurs blocs de code ou extraits de texte au contexte de l'assistant. @@ -105,7 +98,7 @@ Cliquez sur le bouton **Demander à l'assistant** dans un bloc de code pour ouvr
- ## Pièces jointes + ### Pièces jointes
Joignez des fichiers aux messages de l'assistant pour fournir un contexte supplémentaire. @@ -119,6 +112,18 @@ Limites : - Taille maximale du fichier : 5 Mo par pièce jointe - Nombre maximal de pièces jointes par message : 10 +
+ ## Masquer ou modifier le style de l'assistant +
+ +Pour modifier l'apparence du bouton de l'assistant, ou le masquer sur l'ensemble de votre site, ciblez le sélecteur `[data-layout-item="assistant-entry"]` dans un fichier [CSS personnalisé](/fr/customize/custom-scripts#add-custom-css). Consultez [Scripts personnalisés](/fr/customize/custom-scripts#id-selectors) pour connaître les ID du bouton de l'assistant, du panneau de chat et du champ de saisie. + +
+ ## Désactiver l'assistant +
+ +Pour retirer l'assistant de votre site, [désactivez l'assistant](/fr/assistant/configure#enable-or-disable-the-assistant) dans votre tableau de bord. +
## Dépannage
diff --git a/fr/assistant/widget.mdx b/fr/assistant/widget.mdx index 23f359f38..8b0c214c3 100644 --- a/fr/assistant/widget.mdx +++ b/fr/assistant/widget.mdx @@ -20,7 +20,7 @@ L'[assistant](/fr/assistant) répond aux questions sur votre site Mintlify. Pour Ajoutez le widget à n'importe quel site web ou application web à l'aide d'un script hébergé. Le widget possède son propre déclencheur et s'affiche dans un Shadow DOM fermé, ce qui empêche les styles de votre application d'affecter le widget. -La seule option de navigateur requise est votre ID public du widget. Définissez les questions d'introduction spécifiques à l'intégration et une adresse e-mail d'assistance dans la configuration du navigateur. Le widget utilise le [formulaire de contact de déflexion](/fr/assistant/configure#set-deflection-emails) défini dans les paramètres de votre assistant. +La seule option de navigateur requise est votre ID public du widget. Définissez les questions d'introduction spécifiques à l'intégration et une adresse e-mail d'assistance dans la configuration du navigateur. Le widget utilise le [formulaire de contact de l'orientation vers le support](/fr/assistant/support-routing#send-questions-by-email) défini dans les paramètres de votre assistant.
## Activer le widget diff --git a/fr/migration-services/go-live-checklist.mdx b/fr/migration-services/go-live-checklist.mdx index 5c39dd9eb..51bc125c5 100644 --- a/fr/migration-services/go-live-checklist.mdx +++ b/fr/migration-services/go-live-checklist.mdx @@ -42,8 +42,8 @@ Cette liste récapitule les configurations à mettre en place et les paramètres
- **Activez et configurez l'assistant.** Consultez la page [Configurer l'assistant](/fr/assistant/configure). - - Configurez vos [e-mails de redirection du support et des ventes](/fr/assistant/configure#set-deflection-emails). - - Configurez vos [domaines de recherche](/fr/assistant/configure#search-domains). + - Configurez vos [e-mails d'orientation vers le support et les ventes](/fr/assistant/support-routing#send-questions-by-email). + - Configurez vos [domaines de recherche](/fr/assistant/sources#search-domains). - Personnalisez les [modèles de réponse de l'assistant](/fr/assistant/customize) et [ajoutez des compétences à l'assistant](/fr/assistant/skills). - **Intégrez le widget de l'assistant.** Activez le [widget de l'assistant](/fr/assistant/widget) pour ajouter l'assistant au tableau de bord de votre produit, à votre site marketing ou à votre portail d'assistance. - **Activez les modules complémentaires.** Accédez à la page [Site](https://app.mintlify.com/settings/project/site) de votre tableau de bord. Activez les modules pertinents, comme les commentaires de l'agent, les [vérifications CI](/fr/deploy/ci), les sujets associés, etc. diff --git a/fr/poc-onboarding.mdx b/fr/poc-onboarding.mdx index 3cb8fc23d..ce801be19 100644 --- a/fr/poc-onboarding.mdx +++ b/fr/poc-onboarding.mdx @@ -305,9 +305,9 @@ Consultez les [paramètres d'apparence](/fr/organize/settings-appearance), les [ Ouvrez la page [Assistant](https://app.mintlify.com/products/assistant) : 1. Activez l'assistant. -2. Ajoutez des [e-mails de redirection](/fr/assistant/configure#set-deflection-emails) pour les questions nécessitant une aide humaine. +2. Ajoutez des [adresses e-mail d'orientation vers le support](/fr/assistant/support-routing#send-questions-by-email) pour les questions nécessitant une aide humaine. 3. Ajoutez jusqu'à trois [questions de démarrage](/fr/assistant/configure#add-sample-questions). -4. Ajoutez des [domaines de recherche](/fr/assistant/configure#search-domains) si du contenu pertinent est réparti sur plusieurs sites. +4. Ajoutez des [domaines de recherche](/fr/assistant/sources#search-domains) si du contenu pertinent est réparti sur plusieurs sites. 5. Laissez la [protection contre les bots](/fr/assistant/configure#bot-protection) activée. Consultez [Personnaliser l'assistant](/fr/assistant/customize) et [Compétences de l'assistant](/fr/assistant/skills) pour des instructions spécifiques au produit et le ton des réponses. diff --git a/zh.json b/zh.json index 781f70e48..96924a441 100644 --- a/zh.json +++ b/zh.json @@ -147,6 +147,7 @@ }, "zh/organize/navigation", "zh/ai/contextual-menu", + "zh/assistant/narration", "zh/ai/bring-your-own-model", "zh/create/redirects", "zh/organize/mintignore", @@ -279,7 +280,17 @@ "pages": [ "zh/assistant/index", "zh/assistant/configure", - "zh/assistant/customize", + "zh/assistant/support-routing", + { + "group": "改进回答", + "pages": [ + "zh/assistant/sources", + "zh/assistant/customize", + "zh/assistant/skills" + ] + }, + "zh/assistant/use", + "zh/assistant/embed", { "group": "小组件", "hidden": true, @@ -288,9 +299,7 @@ "zh/assistant/widget" ] }, - "zh/assistant/skills", - "zh/assistant/narration", - "zh/assistant/use" + "zh/assistant/billing" ] }, { diff --git a/zh/ai-native.mdx b/zh/ai-native.mdx index 5558368b9..1ea7293a3 100644 --- a/zh/ai-native.mdx +++ b/zh/ai-native.mdx @@ -56,7 +56,7 @@ Mintlify 会为你的文档托管 `llms.txt` 和 `skill.md` 文件。这些行 选择以下任意卡片以了解更多信息。 - + 配置 AI 助手以搜索外部网站，或在其无法回答问题时将用户引导至你的支持团队。 diff --git a/zh/api/analytics/assistant-thread.mdx b/zh/api/analytics/assistant-thread.mdx index abd7a3482..a8ebe7e12 100644 --- a/zh/api/analytics/assistant-thread.mdx +++ b/zh/api/analytics/assistant-thread.mdx @@ -22,7 +22,7 @@ keywords: ["analytics", "assistant", "thread", "transcript", "export", "AI"] 你可以通过以下任一来源获取 `threadId`： - [获取 AI 助手会话](/zh/api/analytics/assistant-conversations) 返回的任一行的 `conversationId` 字段。 -- 当 AI 助手通过[链接转接](/zh/assistant/configure#deflect-to-a-support-link)将用户引导到你的支持平台时，Mintlify 追加到支持 URL 上的 `threadId` 查询参数。 +- 当 AI 助手通过[链接](/zh/assistant/support-routing#link-to-your-help-center)支持选项将用户引导到你的支持平台时，Mintlify 追加到支持 URL 上的 `threadId` 查询参数。 ## 速率限制 diff --git a/zh/assistant/billing.mdx b/zh/assistant/billing.mdx new file mode 100644 index 000000000..599722d2c --- /dev/null +++ b/zh/assistant/billing.mdx @@ -0,0 +1,46 @@ +--- +title: "管理 AI 助手计费" +sidebarTitle: "计费" +description: "查看 AI 助手使用的积分数量，更改积分等级，允许超额使用，设置用量提醒，并使用你自己的模型。" +keywords: ["assistant", "计费", "积分", "超额", "用量提醒", "积分等级", "使用自己的模型"] +--- + + + AI 助手需要 [Pro 或 Enterprise 套餐](https://mintlify.com/pricing?ref=assistant)。 + + +AI 助手使用积分。AI 助手每回答一个问题消耗 25 个积分。如果 AI 助手在你的文档中找不到答案并如实说明，该条消息不消耗积分。 + +每个 Pro 套餐每月为你组织的共享积分余额贡献 10,000 个积分，可在所有项目上用于 AI 助手、Autopilot 以及其他基于积分的功能。更多信息请参阅[积分定价](/zh/credits)。 + +在 Enterprise 方案中，你可以[使用自己的模型](/zh/ai/bring-your-own-model)，通过你自己的 LLM 提供商和 API 密钥运行 assistant。 + +在仪表盘的[用量](https://app.mintlify.com/settings/organization/usage)和[计费](https://app.mintlify.com/settings/organization/billing)页面管理计费和用量。 + +
+ ## 更改你的积分等级 +
+ +1. 前往仪表盘的[用量](https://app.mintlify.com/settings/organization/usage)页面。 +2. 在 **Credit packages** 部分，从下拉菜单中选择一个等级。 +3. 确认更改以继续结账。 + +
+ ## 允许超额 +
+ +你的组织在各项目间共享积分。默认情况下，Mintlify 禁用超额。你可以为每个项目开启或关闭超额。如果某个项目禁用了超额，当你用尽组织的共享积分余额后，该项目上的 AI 助手将不可用。AI 助手会一直不可用，直到积分余额重置。 + +如需允许超额，请在仪表盘[账单](https://app.mintlify.com/settings/organization/billing)页面的 **Usage** 部分，打开项目卡片上的 **Overage** 开关。如果启用超额，超出共享余额的每个积分都会产生超额费用。选择 **Limit spend** 可设置以美元计的最高超额金额，选择 **No spend limit** 则对超额不设上限计费。项目达到其支出上限后，其积分驱动的功能将暂停，直到下一个计费周期。 + +
+ ## 设置用量提醒 +
+ +在[账单](https://app.mintlify.com/settings/organization/billing)页面的 **Usage** 部分，设置 **Alert** 阈值，当总用量达到共享积分余额的一定百分比时，系统会向组织管理员发送电子邮件通知。 + +
+ ## 更高的积分用量 +
+ +如需每月增加最多 90,000 个积分，请购买[积分附加包](/zh/credits#credit-add-ons)。如需增加更多积分，请[联系销售](https://www.mintlify.com/contact/sales)以讨论定制积分套餐。 diff --git a/zh/assistant/configure.mdx b/zh/assistant/configure.mdx index 33c316006..137ad01b5 100644 --- a/zh/assistant/configure.mdx +++ b/zh/assistant/configure.mdx @@ -1,14 +1,15 @@ --- -title: "配置 AI 助手" -description: "配置 AI 助手：启用助手，将支持类问题转到邮箱、链接或 Plain 和 Zendesk 工单，添加起始问题，并管理计费。" -keywords: ["assistant", "设置", "转接", "支持工单", "Plain", "Zendesk", "机器人防护", "计费"] +title: "设置 AI 助手" +sidebarTitle: "设置" +description: "启用 AI 助手，添加起始问题，开启机器人防护，并在用户看到之前于本地预览中测试回答。" +keywords: ["assistant", "配置", "设置", "启用", "起始问题", "机器人防护", "本地预览"] --- AI 助手需要 [Pro 或 Enterprise 套餐](https://mintlify.com/pricing?ref=assistant)。 -在仪表盘的 [Assistant](https://app.mintlify.com/products/assistant) 页面配置 AI 助手。在[用量](https://app.mintlify.com/settings/organization/usage)页面管理计费和用量。 +在仪表盘的 [Assistant](https://app.mintlify.com/products/assistant) 页面设置 AI 助手。启用它并添加起始问题后，选择 AI 助手无法回答的问题的去向，然后进行测试。
## 启用或禁用 AI 助手 @@ -16,91 +17,6 @@ keywords: ["assistant", "设置", "转接", "支持工单", "Plain", "Zendesk", 在仪表盘的 [Assistant](https://app.mintlify.com/products/assistant) 页面，点击状态开关，即可为你的站点启用或禁用 AI 助手。 -
- ## 设置转接邮箱 -
- -在"响应处理"部分，启用 AI 助手，让它在无法自行回答问题时引导用户联系你的支持团队和销售团队。 - -**Support** 菜单用于设置支持类问题的去向。它有三个选项：**Email**、**Link** 和 **Direct support ticketing**。本节介绍 **Email**。 - -在 **Support** 菜单中选择 **Email**，然后填写以下任一或两个地址： - -- **Support email**：AI 助手无法根据文档解答的问题。 -- **销售**：与定价、套餐或购买相关的问题。 - -当你启用转接且 AI 助手检测到匹配的问题时，聊天面板中会出现一个联系表单。该表单会向用户询问名字、姓氏、公司、公司邮箱和一条消息。Mintlify 会通过电子邮件将提交内容发送给对应的团队，该团队可以直接回复用户的邮箱。 - -嵌入到其他站点的 [assistant widget](/zh/assistant/widget) 中也提供同一联系表单。 - - -如果你希望将支持类问题引导至现有的支持渠道，请在“响应处理”部分关闭 **Contact form**。 - -当联系表单关闭时，AI 助手会以纯文本形式将用户引导至你的支持邮箱地址，而不再显示聊天面板中的表单。当已配置销售邮箱时，销售类问题仍会使用聊天面板中的表单。 - - - - -在 **Support** 菜单中选择 **Link**，将用户引导到你现有的支持平台（例如帮助中心、工单门户或社区论坛），而不是通过聊天面板中的表单收集邮箱。 - -输入你的支持目标的完整 URL。URL 必须使用 `http` 或 `https`，且不能包含凭据。 - -当 AI 助手检测到支持类问题时，会向用户显示一张带有你支持 URL 链接的卡片。Mintlify 会将 AI 助手会话线程 ID 作为 `threadId` 查询参数追加到该 URL，方便你的支持工具将会话转录附加到生成的工单。使用 [获取 AI 助手会话线程](/zh/api/analytics/assistant-thread) 端点获取转录。 - -选择 **Link** 后，AI 助手不会显示联系表单，也不会转接销售类问题。 - -
- ## 在你的支持平台中创建工单 -
- -AI 助手可以将支持请求作为工单提交到 Plain 或 Zendesk，而不是通过邮件发送。 - -在连接 Plain 之前，请创建一个具有以下权限的 Plain API 密钥： - -- `customer:create` -- `customer:edit` -- `customer:read` -- `thread:create` -- `thread:read` - -1. 在 **Support** 菜单的 **Response handling** 部分，选择 **Direct support ticketing**。 -2. 选择一个 **Ticketing platform**：**Plain** 或 **Zendesk**。 -3. 在平台卡片上，点击 **Connect**，并在打开的窗口中完成连接。对于 Plain，请使用你创建的 API 密钥。 - -只有在平台连接成功后，Mintlify 才会保存直接支持工单设置。在此之前，你当前的支持选项仍保持生效。该连接是你组织共享的集成。 - -当 AI 助手检测到支持类问题时，会显示聊天内联系表单。Mintlify 会根据提交内容在你已连接的平台中创建工单。工单包含用户的联系方式和消息，以及 AI 助手对话中最多前三条消息。如果对话更长，工单会链接到你 dashboard 中的完整对话。 - -如果你已在 **Email** 下保存了 **销售** 地址，销售类问题仍会通过邮件发送到该地址。 - -如果 Plain API 密钥缺少任一所需权限，平台卡片会显示 **Scopes misconfigured**。点击 **Configure** 查看缺少哪些权限，然后在 Plain 中将其添加到该 API 密钥。 - -
- ## 搜索域名 -
- - - 搜索域名需要 [Enterprise 套餐](https://mintlify.com/pricing?ref=assistant)。 - - -在"响应处理"部分，配置 AI 助手可以用于网络搜索的域名，以在回答问题时查找额外的上下文。 - -- 域名必须是公开可访问的。 -- AI 助手无法搜索需要 JavaScript 加载的域名。 - -要更精确地控制 AI 助手的搜索范围，请使用过滤语法。 - -- **域名级别过滤** - - `example.com`：仅在 `example.com` 域名搜索 - - `docs.example.com`：仅在 `docs.example.com` 子域名搜索 - - `*.example.com`：在 `example.com` 的所有子域名搜索 -- **路径级别过滤** - - `docs.example.com/api`：搜索 `/api` 子路径下的所有页面 -- **多种模式** - - 添加多个条目以定位不同站点的不同部分 -
## 添加示例问题
@@ -116,6 +32,12 @@ AI 助手可以根据用户正在查看的页面生成特定于页面的问题 仪表盘中的搜索建议面板，已启用上下文相关的示例问题。 +
+ ## 选择未回答问题的去向 +
+ +当 AI 助手无法回答某个问题时，它可以通过邮件、帮助中心链接或 Plain、Zendesk 工单，将用户转给你的支持或销售团队。请参阅[将问题转给你的团队](/zh/assistant/support-routing)。 +
## 机器人防护
@@ -133,38 +55,14 @@ AI 助手可以根据用户正在查看的页面生成特定于页面的问题 如果你使用自定义的 [Content Security Policy 头](/zh/deploy/csp-configuration)，你必须在允许列表中包含 `hcaptcha.com` 和 `*.hcaptcha.com`。 -
- ## 管理计费 +
+ ## 测试 AI 助手
-AI 助手使用积分。AI 助手每回答一个问题消耗 25 个积分。如果 AI 助手在你的文档中找不到答案并如实说明，该条消息不消耗积分。更多信息请参阅[积分定价](/zh/credits)。 +当你使用 CLI 登录后，AI 助手会在本地预览中可用。在编写文档时，使用本地预览测试回答以及 `Assistant.md` 中的自定义指令。 -在 Enterprise 方案中，你可以[使用自己的模型](/zh/ai/bring-your-own-model)，通过你自己的 LLM 提供商和 API 密钥运行 assistant。 - -
- ### 更改你的积分等级 -
- -1. 前往仪表盘的[用量](https://app.mintlify.com/settings/organization/usage)页面。 -2. 在 **Credit packages** 部分，从下拉菜单中选择一个等级。 -3. 确认更改以继续结账。 - -
- ### 允许超额 -
- -你的组织在各项目间共享积分。默认情况下，Mintlify 禁用超额。你可以为每个项目开启或关闭超额。如果某个项目禁用了超额，当你用尽组织的共享积分余额后，该项目上的 AI 助手将不可用。AI 助手会一直不可用，直到积分余额重置。 - -如需允许超额，请在仪表盘[账单](https://app.mintlify.com/settings/organization/billing)页面的 **Usage** 部分，打开项目卡片上的 **Overage** 开关。如果启用超额，超出共享余额的每个积分都会产生超额费用。选择 **Limit spend** 可设置以美元计的最高超额金额，选择 **No spend limit** 则对超额不设上限计费。项目达到其支出上限后，其积分驱动的功能将暂停，直到下一个计费周期。 - -
- ### 设置用量提醒 -
- -在[账单](https://app.mintlify.com/settings/organization/billing)页面的 **Usage** 部分，设置 **Alert** 阈值，当总用量达到共享积分余额的一定百分比时，系统会向组织管理员发送电子邮件通知。 - -
- ### 更高的积分用量 -
+1. 如果还没有安装，请使用 `npm i -g mint` 安装 CLI。 +2. 运行 `mint login` 进行身份验证。 +3. 运行 `mint dev` 启动本地预览。 -如需每月增加最多 90,000 个积分，请购买[积分附加包](/zh/credits#credit-add-ons)。如需增加更多积分，请[联系销售](https://www.mintlify.com/contact/sales)以讨论定制积分套餐。 +本地预览中的 AI 助手使用与你部署的文档站点相同的索引内容。 diff --git a/zh/assistant/embed.mdx b/zh/assistant/embed.mdx new file mode 100644 index 000000000..d6030762c --- /dev/null +++ b/zh/assistant/embed.mdx @@ -0,0 +1,17 @@ +--- +title: "在你的产品中嵌入 AI 助手" +sidebarTitle: "嵌入你的产品" +description: "基于 AI 助手 API 构建你自己的界面，在你的应用、仪表盘或支持门户中回答用户问题。" +keywords: ["assistant", "嵌入", "应用内助手", "AI 助手 API", "API 密钥"] +--- + + + AI 助手需要 [Pro 或 Enterprise 套餐](https://mintlify.com/pricing?ref=assistant)。 + + +把 AI 助手带到用户已经在使用的地方，例如你的应用、仪表盘、营销网站或支持门户。它与你文档站点上的 AI 助手基于同一份文档作答。 + +使用 AI 助手 API 构建你自己的界面，完全掌控它的外观和行为。使用 [AI 助手 API 密钥](https://app.mintlify.com/settings/organization/api-keys)进行身份验证。 + +- 按照[构建应用内 AI 助手](/zh/guides/assistant-embed)查看完整的 Next.js 示例。 +- 有关端点，请参阅[创建 AI 助手消息](/zh/api/assistant/create-assistant-message-v2)和[搜索文档](/zh/api/assistant/search)。 diff --git a/zh/assistant/index.mdx b/zh/assistant/index.mdx index 63f334ddb..d0e7bb916 100644 --- a/zh/assistant/index.mdx +++ b/zh/assistant/index.mdx @@ -1,73 +1,54 @@ --- title: "AI 助手" -description: "为你的文档站点添加由 AI 驱动的聊天助手，实时回答用户问题、引用文档来源、按需生成代码示例，并支持自定义指令与多模态输入。" +description: "为你的文档站点添加 AI 助手：它根据你的内容回答问题，将无法回答的问题转给你的团队，并可在你的产品中运行。" keywords: ["聊天", "用户支持", "多模态"] boost: 3 --- - AI 助手需要 [Pro 或 Enterprise 方案](https://mintlify.com/pricing?ref=assistant)。每个 Pro 方案每月为你的组织的共享积分余额贡献 10,000 个积分，可在所有项目上用于助手、Autopilot 以及其他基于积分的功能。有关积分等级和选项的更多信息，请参阅[管理计费](/zh/assistant/configure#manage-billing)。 + AI 助手需要 [Pro 或 Enterprise 套餐](https://mintlify.com/pricing?ref=assistant)。 -
- ## 关于 AI 助手 -
- -AI 助手通过自然语言查询回答有关你文档的问题。用户可以在你的文档站点上使用 AI 助手，快速找到答案，即使不知道在哪里查找也能成功使用你的产品。 - -AI 助手使用工具调用来回答问题。当用户提问时，AI 助手会： - -* **搜索并检索**文档中的相关内容，以 Markdown 形式提供准确的答案。 -* **构建上下文**，基于用户提问时正在查看的页面。 -* **读取图片**：读取你文档页面中的图片（如截图和图表），回答有关图片内容的问题。助手只会查看其可访问页面中出现的图片，因此无法获取任意图片 URL。 -* **引用来源**并提供可导航的链接，将用户直接带到引用的页面。 -* **返回详细的 API 信息**，在回答有关 API 的问题时提供方法、参数、请求体和来自 OpenAPI 规范的响应 schema。 -* **生成可复制的代码示例**，帮助用户根据文档实现解决方案。 -* **支持多种模态**，允许用户添加文本、图片和其他文件作为上下文。 +AI 助手是你文档站点上的 AI 聊天功能。用户用自然语言提问，并从你的内容中获得答案，即使不知道该去哪里查找，也能顺利使用你的产品。 -
- ### 索引工作原理 +
+ ## 用户可以用 AI 助手做什么
-AI 助手索引你发布的文档和 API 规范，以准确回答问题。当你发布更改时，AI 助手会立即索引新增、更新或删除的内容。AI 助手不会索引草稿分支或预览部署。 +- 获得引用来源页面的答案，并附有每个页面的链接。 +- 询问有关你的 API 的问题，并获得来自 OpenAPI 规范的方法、参数、请求体和响应 schema。 +- 复制 AI 助手根据你的文档编写的代码示例。 +- 询问你页面上的截图和图表。 +- 通过选中文本、发送代码块或附加文件来添加上下文。AI 助手也知道用户当前所在的页面。请参阅[为问题添加上下文](/zh/assistant/use#add-context-to-a-question)。 +- 当 AI 助手无法回答时，通过邮件、你的帮助中心或支持工单联系你的团队。 -默认情况下，AI 助手不会索引隐藏页面。要在 AI 助手的索引中包含隐藏页面，请在 `docs.json` 中设置 `seo.indexing: "all"`。更多信息请参见[隐藏页面](/zh/organize/hidden-pages#search-seo-and-ai-indexing)。 - -
- ### AI 助手如何处理未知问题 +
+ ## 开始使用 AI 助手
-AI 助手仅基于你文档中的信息回答问题。如果搜索后找不到相关信息，它会回复没有足够的信息来回答。 - -你可以[设置转接邮箱](/zh/assistant/configure#set-deflection-emails)，让 AI 助手在无法回答用户问题时提供你的支持邮箱。即使文档没有涵盖用户的特定问题，这也能为用户提供一条出路。 - -
- ## AI 助手数据洞察 + + + 启用 AI 助手，添加起始问题，并在用户看到之前进行测试。 + + + 将 AI 助手无法回答的问题发送到邮箱、你的帮助中心，或 Plain、Zendesk 中的工单。 + + + 找出 AI 助手无法回答的问题，控制它使用的内容，并添加指令和 skills。 + + + 通过你自己的链接打开 AI 助手，调整或隐藏它的按钮样式，或将其关闭。 + + + 使用 AI 助手 API，在你的应用、仪表盘或支持门户中回答问题。 + + + 了解 AI 助手消耗的积分，允许超额使用，并使用你自己的模型。 + + + +
+ ## AI 助手如何作答
-使用 AI 助手数据洞察来了解用户如何与你的文档交互，并发现改进机会。 - -[AI 助手页面](https://dashboard.mintlify.com/products/assistant)显示本月至今的使用趋势。在[分析](/zh/analytics/assistant)页面查看更详细的洞察。 - -
- ## 使内容适合 AI 处理 -
- -合理组织你的文档结构，帮助 AI 助手提供准确、相关的答案。清晰的组织和全面的上下文既有利于人类读者，也有利于 AI 理解。 - - - - 使用语义化标记。 - - 为章节编写描述性标题。 - - 创建合理的信息层级。 - - 在文档中使用一致的格式。 - - 在页面 frontmatter 中包含完整的元数据。 - - 将长段落拆分为较短的段落。 - - - - - 在首次出现时定义专业术语和缩写。 - - 提供关于功能和流程的充分概念性内容。 - - 包含示例和使用场景。 - - 交叉引用相关主题。 - - 添加[隐藏页面](/zh/organize/hidden-pages)，提供用户不需要但 AI 助手可以参考的额外上下文。 - +AI 助手只根据你已发布的文档和 API 规范以及你添加的[搜索域名](/zh/assistant/sources#search-domains)作答。如果找不到相关信息，它会如实说明，而不是猜测。请参阅[管理 AI 助手掌握的内容](/zh/assistant/sources)，控制它使用的内容。 diff --git a/zh/assistant/sources.mdx b/zh/assistant/sources.mdx new file mode 100644 index 000000000..b6040ec4d --- /dev/null +++ b/zh/assistant/sources.mdx @@ -0,0 +1,71 @@ +--- +title: "管理 AI 助手掌握的内容" +sidebarTitle: "来源和索引" +description: "控制 AI 助手基于哪些内容作答，添加用户看不到的上下文，搜索其他网站，并找出它无法回答的问题。" +keywords: ["assistant", "索引", "隐藏页面", "搜索域名", "网页搜索", "未回答的问题"] +--- + +AI 助手只根据你已发布的文档和 API 规范以及你添加的搜索域名作答。当你发布更改时，AI 助手会立即索引新增、更新或删除的内容。它不会索引草稿分支或预览部署。 + +要改进回答，请找出 AI 助手无法回答的问题，然后修正它作答所依据的内容。使用[自定义指令](/zh/assistant/customize)和 [skills](/zh/assistant/skills) 来调整它的回答方式。 + +
+ ## 找出 AI 助手无法回答的问题 +
+ +[AI 助手分析](/zh/analytics/assistant)中的 **Unanswered conversations** 列表会显示 AI 助手无法根据你的文档回答的所有对话。打开一份对话记录，查看用户问了什么，然后添加或更新能回答该问题的内容。 + +
+ ## 添加用户看不到的上下文 +
+ +默认情况下，AI 助手不会索引隐藏页面。要在 AI 助手的索引中包含隐藏页面，请在 `docs.json` 中设置 `seo.indexing: "all"`。将隐藏页面用于用户无需浏览、但 AI 助手可以参考的上下文。请参阅[隐藏页面](/zh/organize/hidden-pages#search-seo-and-ai-indexing)，了解每种页面设置如何影响 AI 助手。 + +要在已发布的页面上只向 AI 助手和其他 AI 工具展示上下文，请用 [`Visibility`](/zh/components/visibility) 组件并设置 `for="agents"` 将其包裹。 + +
+ ## 从回答中排除内容 +
+ +要让某个可见页面不出现在 AI 助手的回答中，请在该页面的 frontmatter 中设置 `searchable: false`。该页面仍保留在导航中，但站点搜索和 AI 助手会跳过它。其他选项请参阅[隐藏页面](/zh/organize/hidden-pages#search-seo-and-ai-indexing)。 + +
+ ## 按用户组限制回答 +
+ +如果你的站点需要[身份验证](/zh/deploy/authentication-setup)，AI 助手会遵循用户组设置。它只根据每位已登录用户可以访问的页面为其作答。 + +
+ ## 搜索域名 +
+ + + 搜索域名需要 [Enterprise 套餐](https://mintlify.com/pricing?ref=assistant)。 + + +在"响应处理"部分，配置 AI 助手可以用于网络搜索的域名，以在回答问题时查找额外的上下文。 + +- 域名必须是公开可访问的。 +- AI 助手无法搜索需要 JavaScript 加载的域名。 + +要更精确地控制 AI 助手的搜索范围，请使用过滤语法。 + +- **域名级别过滤** + - `example.com`：仅在 `example.com` 域名搜索 + - `docs.example.com`：仅在 `docs.example.com` 子域名搜索 + - `*.example.com`：在 `example.com` 的所有子域名搜索 +- **路径级别过滤** + - `docs.example.com/api`：搜索 `/api` 子路径下的所有页面 +- **多种模式** + - 添加多个条目以定位不同站点的不同部分 + +
+ ## 编写 AI 助手可用的内容 +
+ +当你的内容易于查找和理解时，AI 助手的回答效果最好。清晰的组织结构和完整的上下文对人和 AI 工具都有帮助。 + +- 为每个页面编写描述性的标题和具体的 frontmatter 描述。 +- 在首次引入术语和缩写时给出定义。 +- 提供示例和使用场景，并链接相关主题。 +- 将较长的文本块拆分为较短的段落。 diff --git a/zh/assistant/support-routing.mdx b/zh/assistant/support-routing.mdx new file mode 100644 index 000000000..80a70f931 --- /dev/null +++ b/zh/assistant/support-routing.mdx @@ -0,0 +1,79 @@ +--- +title: "将问题转给你的团队" +sidebarTitle: "转给你的团队" +description: "通过邮件、帮助中心链接或 Plain、Zendesk 工单，将 AI 助手无法回答的问题转给你的支持或销售团队。" +keywords: ["assistant", "支持路由", "转接", "联系支持", "联系表单", "支持工单", "help desk", "Zendesk", "Plain", "threadId"] +--- + + + AI 助手需要 [Pro 或 Enterprise 套餐](https://mintlify.com/pricing?ref=assistant)。 + + +当 AI 助手无法根据你的文档回答问题时，它可以把用户转给你的团队。用户因此有办法联系到真人，而不会走进死胡同。 + +在仪表盘 [Assistant](https://app.mintlify.com/products/assistant) 页面“响应处理”部分的 **Support** 菜单中，选择支持类问题的去向： + +| 选项 | 用户看到的内容 | 请求的去向 | +| :--- | :--- | :--- | +| [Email](#send-questions-by-email) | 聊天中的联系表单 | 你的支持或销售邮箱地址 | +| [Link](#link-to-your-help-center) | 一张链接到你支持 URL 的卡片 | 你的帮助中心、工单门户或社区论坛 | +| [Direct support ticketing](#create-tickets-in-plain-or-zendesk) | 聊天中的联系表单 | Plain 或 Zendesk 中的新工单 | + +如果你使用 Plain 或 Zendesk 以外的 help desk，请使用 **Link** 将用户引导到其联系页面或帮助中心。 + +
+ ## 通过邮件发送问题 +
+ +在 **Support** 菜单中选择 **Email**，然后填写以下任一或两个地址： + +- **Support email**：AI 助手无法根据文档解答的问题。 +- **销售**：与定价、套餐或购买相关的问题。 + +当 AI 助手检测到匹配的问题时，聊天面板中会出现一个联系表单。该表单会向用户询问名字、姓氏、公司、公司邮箱和一条消息。Mintlify 会通过电子邮件将提交内容发送给对应的团队，该团队可以直接回复用户的邮箱。 + +嵌入到其他站点的 [assistant widget](/zh/assistant/widget) 中也提供同一联系表单。 + + +如果你希望将支持类问题引导至现有的支持渠道，请在“响应处理”部分关闭 **Contact form**。 + +当联系表单关闭时，AI 助手会以纯文本形式将用户引导至你的支持邮箱地址，而不再显示聊天面板中的表单。当已配置销售邮箱时，销售类问题仍会使用聊天面板中的表单。 + + + + +在 **Support** 菜单中选择 **Link**，将用户引导到你现有的支持平台，例如帮助中心、工单门户或社区论坛，而不是通过聊天面板中的表单收集邮箱。 + +输入你的支持目标的完整 URL。URL 必须使用 `http` 或 `https`，且不能包含凭据。 + +当 AI 助手检测到支持类问题时，会向用户显示一张带有你支持 URL 链接的卡片。Mintlify 会将 AI 助手会话线程 ID 作为 `threadId` 查询参数追加到该 URL，方便你的支持工具将会话转录附加到生成的工单。使用 [获取 AI 助手会话线程](/zh/api/analytics/assistant-thread) 端点获取转录。 + +选择 **Link** 后，AI 助手不会显示联系表单，也不会转接销售类问题。 + +
+ ## 在 Plain 或 Zendesk 中创建工单 +
+ +AI 助手可以将支持请求作为工单提交到 Plain 或 Zendesk，而不是通过邮件发送。 + +在连接 Plain 之前，请创建一个具有以下权限的 Plain API 密钥： + +- `customer:create` +- `customer:edit` +- `customer:read` +- `thread:create` +- `thread:read` + +1. 在 **Support** 菜单的 **Response handling** 部分，选择 **Direct support ticketing**。 +2. 选择一个 **Ticketing platform**：**Plain** 或 **Zendesk**。 +3. 在平台卡片上，点击 **Connect**，并在打开的窗口中完成连接。对于 Plain，请使用你创建的 API 密钥。 + +只有在平台连接成功后，Mintlify 才会保存直接支持工单设置。在此之前，你当前的支持选项仍保持生效。该连接是你组织共享的集成。 + +当 AI 助手检测到支持类问题时，会显示聊天内联系表单。Mintlify 会根据提交内容在你已连接的平台中创建工单。工单包含用户的联系方式和消息，以及 AI 助手对话中最多前三条消息。如果对话更长，工单会链接到你 dashboard 中的完整对话。 + +如果你已在 **Email** 下保存了 **销售** 地址，销售类问题仍会通过邮件发送到该地址。 + +如果 Plain API 密钥缺少任一所需权限，平台卡片会显示 **Scopes misconfigured**。点击 **Configure** 查看缺少哪些权限，然后在 Plain 中将其添加到该 API 密钥。 diff --git a/zh/assistant/use.mdx b/zh/assistant/use.mdx index e7f6fda68..c9647a0c5 100644 --- a/zh/assistant/use.mdx +++ b/zh/assistant/use.mdx @@ -1,25 +1,14 @@ --- -title: "使用 AI 助手" -description: "通过键盘快捷键、选中文本、代码块、文件附件或 URL 参数打开并调用 AI 助手，在本地预览环境中测试助手响应、指令与自定义配置的行为。" -keywords: ["assistant", "键盘快捷键", "文件附件", "本地预览", "URL 参数"] +title: "控制 AI 助手的显示方式" +sidebarTitle: "显示" +description: "控制用户在哪里找到 AI 助手：通过你自己的链接打开它，隐藏或调整其按钮样式，并了解用户为问题添加上下文的方式。" +keywords: ["assistant", "键盘快捷键", "URL 参数", "深度链接", "隐藏助手", "自定义 CSS", "文件附件", "故障排除"] --- -用户有多种方式与 AI 助手开始对话。每种方式都会在文档右侧打开一个聊天面板。用户可以提出任何问题，AI 助手会在你的文档中搜索答案。如果 AI 助手无法检索到相关信息，它会回复无法回答该问题。 +用户可以通过 AI 助手的按钮、键盘快捷键或你分享的链接打开它。你可以更改按钮的外观、隐藏按钮或关闭 AI 助手。 -
- ## 在本地预览中使用 AI 助手 -
- -当你使用 CLI 登录后，AI 助手会在本地预览中可用。这让你可以在本地开发文档时测试 AI 助手的行为、`Assistant.md` 中的自定义指令和响应。 - -1. 如果还没有安装，请使用 `npm i -g mint` 安装 CLI。 -2. 运行 `mint login` 进行身份验证。 -3. 运行 `mint dev` 启动本地预览。 - -本地预览中的 AI 助手使用与你部署的文档站点相同的索引内容。 - -
- ## 界面位置 +
+ ## AI 助手出现的位置
AI 助手出现在两个位置：搜索栏旁边的按钮和页面底部的横栏。 @@ -67,14 +56,10 @@ AI 助手出现在两个位置：搜索栏旁边的按钮和页面底部的横 -
- ## 键盘快捷键 -
- -使用键盘快捷键打开 AI 助手聊天面板：macOS 上使用 Cmd + I，Windows 上使用 Ctrl + I。 +用户还可以使用键盘快捷键打开 AI 助手聊天面板：macOS 上使用 Cmd + I，Windows 上使用 Ctrl + I。 -
- ## URL 参数 + 通过在 URL 上添加 `?assistant` 查询参数，从文档站点的任意页面打开 AI 助手。可用于从外部内容（如邮件、支持回复、应用内横幅或新手引导流程）深度链接到 AI 助手。 @@ -87,14 +72,22 @@ https://yourdocs.mintlify.site/quickstart?assistant https://yourdocs.mintlify.site/quickstart?assistant=How%20do%20I%20get%20started%3F ``` +要让用户从页面的上下文菜单中以当前页面为上下文打开 AI 助手，请在你的[上下文菜单](/zh/ai/contextual-menu)中添加 `"assistant"` 选项。 + +
+ ## 为问题添加上下文 +
+ +除了问题本身，用户还可以为 AI 助手提供更多上下文。AI 助手也知道用户当前所在的页面。 +
- ## 选中文本 + ### 选中文本
在页面上选中文本，然后点击弹出的 **Add to assistant** 按钮，即可打开 AI 助手聊天面板并将选中的文本添加为上下文。你可以向 AI 助手的上下文中添加多个文本片段或代码块。
- ## 代码块 + ### 代码块
点击代码块中的 **询问助手** 按钮，打开 AI 助手聊天面板并将代码块添加为上下文。你可以向 AI 助手的上下文中添加多个代码块或文本片段。 @@ -105,7 +98,7 @@ https://yourdocs.mintlify.site/quickstart?assistant=How%20do%20I%20get%20started
- ## 文件附件 + ### 文件附件
向 AI 助手消息附加文件以提供额外的上下文。 @@ -119,6 +112,18 @@ https://yourdocs.mintlify.site/quickstart?assistant=How%20do%20I%20get%20started - 最大文件大小：每个附件 5 MB - 每条消息最大附件数：10 +
+ ## 隐藏或调整 AI 助手样式 +
+ +要更改 AI 助手按钮的外观，或在整个站点上隐藏它，请在[自定义 CSS](/zh/customize/custom-scripts#add-custom-css) 文件中定位 `[data-layout-item="assistant-entry"]` 选择器。有关 AI 助手按钮、聊天面板和文本输入框的 ID，请参阅[自定义脚本](/zh/customize/custom-scripts#id-selectors)。 + +
+ ## 关闭 AI 助手 +
+ +要从你的站点移除 AI 助手，请在仪表盘中[禁用 AI 助手](/zh/assistant/configure#enable-or-disable-the-assistant)。 +
## 故障排除
diff --git a/zh/assistant/widget.mdx b/zh/assistant/widget.mdx index 9b96332cc..bfa5891c8 100644 --- a/zh/assistant/widget.mdx +++ b/zh/assistant/widget.mdx @@ -20,7 +20,7 @@ export const WidgetCodeBlock = ({ children, ...props }) => ( 通过一段托管脚本,即可将小组件添加到任何网站或 Web 应用。小组件自带触发器,并在封闭的 Shadow DOM 内渲染,可防止你的应用样式影响小组件。 -浏览器端唯一必需的选项是你的公共小组件 ID。可在浏览器配置中设置针对该嵌入的起始问题和支持邮箱。小组件会使用你助手设置中的[分流联系表单](/zh/assistant/configure#set-deflection-emails)。 +浏览器端唯一必需的选项是你的公共小组件 ID。可在浏览器配置中设置针对该嵌入的起始问题和支持邮箱。小组件会使用你助手设置中的[支持路由联系表单](/zh/assistant/support-routing#send-questions-by-email)。
## 启用小组件 diff --git a/zh/migration-services/go-live-checklist.mdx b/zh/migration-services/go-live-checklist.mdx index 3ced46ebe..73bcd44af 100644 --- a/zh/migration-services/go-live-checklist.mdx +++ b/zh/migration-services/go-live-checklist.mdx @@ -42,8 +42,8 @@ noindex: true
- **启用并配置助手。** 请参阅[配置助手](/zh/assistant/configure)。 - - 配置[支持和销售转接电子邮件](/zh/assistant/configure#set-deflection-emails)。 - - 配置[搜索域名](/zh/assistant/configure#search-domains)。 + - 配置[支持和销售路由电子邮件](/zh/assistant/support-routing#send-questions-by-email)。 + - 配置[搜索域名](/zh/assistant/sources#search-domains)。 - 自定义[助手的响应模式](/zh/assistant/customize)，并[添加助手技能](/zh/assistant/skills)。 - **嵌入助手组件。** 启用[助手组件](/zh/assistant/widget)，将助手添加到产品控制面板、营销网站或支持门户。 - **启用附加功能。** 前往控制面板中的[站点](https://app.mintlify.com/settings/project/site)页面。启用相关附加功能，例如代理反馈、[CI 检查](/zh/deploy/ci)、相关主题等。 diff --git a/zh/poc-onboarding.mdx b/zh/poc-onboarding.mdx index ecd10966a..ea395a606 100644 --- a/zh/poc-onboarding.mdx +++ b/zh/poc-onboarding.mdx @@ -305,9 +305,9 @@ noindex: true 打开 [Assistant](https://app.mintlify.com/products/assistant) 页面： 1. 启用 assistant。 -2. 为需要人工协助的问题添加[转接电子邮件地址](/zh/assistant/configure#set-deflection-emails)。 +2. 为需要人工协助的问题添加[支持路由电子邮件地址](/zh/assistant/support-routing#send-questions-by-email)。 3. 添加最多三个[起始问题](/zh/assistant/configure#add-sample-questions)。 -4. 如果相关内容分布在多个站点上，请添加[搜索域名](/zh/assistant/configure#search-domains)。 +4. 如果相关内容分布在多个站点上，请添加[搜索域名](/zh/assistant/sources#search-domains)。 5. 保持[机器人防护](/zh/assistant/configure#bot-protection)处于启用状态。 有关产品专属说明和语气，请参阅[自定义 assistant](/zh/assistant/customize) 和 [Assistant skills](/zh/assistant/skills)。