Saltar al contenido principal
El assistant se habilita automáticamente en los planes Pro y Custom.

Acerca del assistant

El assistant responde preguntas sobre tu documentación mediante búsquedas en lenguaje natural. Está integrado directamente en tu sitio de documentación y ofrece a los usuarios acceso inmediato a ayuda contextual. El assistant utiliza RAG agentivo (generación aumentada por recuperación) con llamadas a herramientas, impulsado por Claude Sonnet 4. Cuando los usuarios hacen preguntas, el assistant:
  • Busca y recupera contenido relevante de tu documentación para ofrecer respuestas precisas.
  • Cita las fuentes y proporciona enlaces navegables que llevan a los usuarios directamente a las páginas de referencia.
  • Genera ejemplos de código copiables para ayudar a los usuarios a implementar soluciones a partir de tu documentación.
Cada mensaje enviado al assistant cuenta para la cuota de mensajes de tu plan. Si superas tu cuota, los mensajes adicionales generarán cargos por excedente. Puedes establecer límites de gasto o desactivar el assistant si alcanzas tu cuota de mensajes. Puedes ver el uso del assistant desde tu dashboard para comprender el comportamiento de los usuarios y la efectividad de la documentación. Exporta y analiza los datos de búsqueda para identificar:
  • Preguntas frecuentes que podrían necesitar mejor cobertura.
  • Brechas de contenido donde los usuarios tienen dificultades para encontrar respuestas.
  • Temas populares que podrían beneficiarse de contenido adicional.

Configuración del assistant

El assistant está habilitado de forma predeterminada para los planes Pro y Custom. Puedes gestionar el assistant desde tu dashboard, incluido activarlo o desactivarlo, configurar el manejo de respuestas y establecer un límite de gasto.

Estado del assistant

Activa o desactiva el assistant para habilitarlo o deshabilitarlo en tu sitio de documentación.

Desvío del assistant

Permite que el assistant redirija las preguntas sin respuesta a tu equipo de soporte. Proporciona una dirección de correo electrónico que el assistant facilitará a los usuarios que hagan preguntas que no pueda responder.

Buscar sitios

La búsqueda del sitio está en beta. Para habilitarla en tu sitio de documentación, contacta a nuestro equipo de ventas.
Configura los sitios que el assistant puede consultar para obtener contexto adicional al responder preguntas.
  • Los sitios deben ser públicamente accesibles.
  • No se admiten sitios que requieran JavaScript para cargarse.
Puedes usar la siguiente sintaxis de filtrado cuando configures sitios externos:
  • Filtrado a nivel de domain
    • example.com: Buscar solo el domain example.com
    • docs.example.com: Buscar solo el subdomain docs.example.com
    • *.example.com: Buscar todos los subdomains de example.com
  • Filtrado a nivel de ruta
    • docs.example.com/api: Buscar todas las páginas dentro de la subruta /api
  • Múltiples patrones
    • Agrega varias entradas para dirigirte a diferentes secciones de los sitios

Límite de gasto

Define un límite de gasto para controlar qué sucede si llegas a tu cupo de mensajes. De forma predeterminada, el assistant seguirá respondiendo preguntas de los usuarios después de alcanzar tu cupo de mensajes, lo que generará cargos por excedente. En la pestaña Billing de la página Assistant Configurations, puedes establecer un límite de gasto para los mensajes del assistant más allá de tu cupo. Cuando alcanzas tu límite de gasto, el assistant se desactiva hasta que se restablece tu cupo de mensajes. También puedes configurar alertas de uso para recibir un correo electrónico cuando alcances un porcentaje determinado de tu límite de gasto.

Uso del assistant

Los usuarios pueden acceder al assistant de tres maneras:
  • Atajo de teclado: Command + I (Ctrl + I en Windows)
  • Botón del assistant junto a la barra de búsqueda Barra de búsqueda y botón del assistant en modo claro.
  • URL con ?assistant=open añadida abrirá el assistant cuando cargue la página. Por ejemplo, https://mintlify.com/docs?assistant=open.
Estos métodos abren un panel de chat en el lado derecho de tu documentación. Los usuarios pueden hacer cualquier pregunta y el assistant buscará en tu documentación una respuesta. Si no se encuentra información relevante, el assistant indicará que no puede responder la pregunta.

Hacer que el contenido sea apto para la IA

Estructura tu documentación para ayudar al assistant a ofrecer 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.

Estructura y organización

  • Usa marcado semántico.
  • Escribe encabezados descriptivos para las secciones.
  • Crea una jerarquía lógica de la información.
  • Mantén un formato consistente en toda tu documentación.
  • Incluye metadata completa en el frontmatter de la página.
  • Divide los bloques largos de texto en párrafos más cortos.

Contexto

  • Define términos y siglas específicos la primera vez que se mencionen.
  • Proporciona suficiente contenido conceptual sobre funciones y procedimientos.
  • Incluye ejemplos y casos de uso.
  • Añade referencias cruzadas a temas relacionados.
  • Agrega páginas ocultas con contexto adicional que los usuarios no necesitan, pero que el assistant puede consultar.

Exportar y analizar consultas

Revisa y exporta consultas desde tu dashboard para entender cómo las personas interactúan con tu documentación e identificar oportunidades de mejora. Algunas maneras en que el análisis de consultas puede ayudarte a mejorar tu documentación:
  • Identifica brechas de contenido donde las consultas frecuentes reciben respuestas insuficientes.
  • Descubre patrones de comportamiento de los usuarios y necesidades de información comunes a partir de temas y patrones en las consultas.
  • Prioriza las páginas de alto tráfico para mejorar su precisión y calidad.
Puedes explorar las consultas desde tu dashboard, pero para obtener insights más potentes te recomendamos exportar un archivo CSV con tus consultas, respuestas y fuentes para analizarlas con tu herramienta de IA preferida.
  1. Ve a la página del assistant en tu dashboard.
  2. Selecciona Export to CSV.
  3. Analiza los datos exportados con tu herramienta preferida.

Ejemplos de prompts de análisis

  • Resume los temas más comunes de las consultas.
  • Enumera las consultas que no tengan fuentes citadas.
  • Encuentra patrones en las interacciones fallidas.
I