El assistant está disponible en los planes Pro y Enterprise y está habilitado por defecto en esos planes.
Acerca del assistant
- Busca y recupera contenido relevante de tu documentación para proporcionar respuestas precisas.
- Construye contexto a partir de la página que el usuario está viendo cuando hace preguntas.
- 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.
Cómo funciona la indexación
seo.indexing: "all" en tu docs.json. Consulta Páginas ocultas para más información.
Cómo el assistant maneja preguntas desconocidas
Información del assistant
Haz que el contenido sea procesable por IA
Estructura y organización
- 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.
Contexto
- 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 con contexto adicional que los usuarios no necesitan, pero que el assistant puede consultar.