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 consultas en lenguaje natural. Está integrado directamente en tu sitio de documentación, ofreciendo a los usuarios acceso inmediato a ayuda contextual. El assistant utiliza RAG agente (generación aumentada por recuperación) con llamadas a herramientas impulsadas 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 referenciadas.
  • Genera ejemplos de código que se pueden copiar para ayudar a los usuarios a implementar soluciones a partir de tu documentación.
Cada mensaje enviado al assistant cuenta para el límite de mensajes de tu plan. Si superas ese límite, los mensajes adicionales generarán cargos por excedente. Puedes establecer límites de gasto o desactivar el assistant cuando alcances tu límite 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 ayudar a 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 administrar el assistant desde tu dashboard, incluyendo habilitarlo o deshabilitarlo, configurar el manejo de respuestas y establecer un límite de gasto.

Estado del assistant

Alterna el estado del 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 dará a los usuarios que hagan preguntas que no pueda responder.

Buscar sitios

La búsqueda de sitios 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 de acceso público.
  • No se admiten sitios que requieran JavaScript para cargarse.
Puedes usar la siguiente sintaxis de filtrado al configurar sitios externos:
  • Filtrado a nivel de domain
    • example.com: Buscar solo en el domain example.com
    • docs.example.com: Buscar solo en 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 bajo la subruta /api
  • Múltiples patrones
    • Agrega varias entradas para abarcar diferentes secciones de los sitios

Límite de gasto

Establece un límite de gasto para controlar qué sucede si alcanzas tu cupo de mensajes. De forma predeterminada, el assistant seguirá respondiendo las preguntas de los usuarios después de que alcances tu cupo de mensajes, lo que genera 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 cierto porcentaje 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.
  • URLs con ?assistant=open al final abrirán 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á una respuesta en tu documentación. 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 proporcionar respuestas precisas y relevantes. Una organización clara y un contexto completo benefician tanto a las personas lectoras 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 de información lógica.
  • Usa un formato coherente 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íficas cuando se introduzcan 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 con contexto adicional que las personas usuarias no necesitan, pero a las que el assistant puede hacer referencia.

Exportar y analizar consultas

Revisa y exporta consultas desde tu dashboard para comprender cómo las personas interactúan con tu documentación e identificar oportunidades de mejora. Algunas formas en que el análisis de consultas puede ayudarte a mejorar tu documentación:
  • Identificar brechas de contenido donde las consultas frecuentes reciben respuestas insuficientes.
  • Descubrir patrones de comportamiento de los usuarios y necesidades de información comunes a partir de los temas y patrones en las consultas.
  • Priorizar las páginas con mayor tráfico para mejorar su precisión y calidad.
Puedes explorar las consultas desde tu dashboard, pero para obtener insights más potentes recomendamos exportar un archivo CSV con tus consultas, respuestas y fuentes para analizarlo 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.

Prompts de análisis de ejemplo

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