Usar el assistant

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.

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.

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.

Abre el panel de chat del assistant con el atajo de teclado Command + I en macOS y Ctrl + I en Windows.

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.

• ?assistant: Abre el panel de chat del assistant sin enviar ningún mensaje.
• ?assistant=<mensaje>: Abre el panel de chat del assistant y envía <mensaje> como el primer mensaje del usuario. Codifica el valor en URL para que los espacios y caracteres especiales se conserven en la solicitud.

https://yourdocs.mintlify.site/quickstart?assistant
https://yourdocs.mintlify.site/quickstart?assistant=How%20do%20I%20get%20started%3F

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.

Haz clic en el botón Preguntar al asistente 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.

Adjunta archivos a los mensajes del assistant para proporcionar contexto adicional.

Tipos de archivo compatibles:

• Imágenes: JPEG, PNG, GIF, WebP, SVG
• Documentos: PDF
• Archivos de código y texto: JavaScript (.js, .jsx, .mjs, .cjs), TypeScript (.ts, .tsx), Python, HTML, CSS, Markdown, MDX, JSON, YAML, XML, SQL, CSV, texto plano, scripts de shell (.sh, .bash, .env), GraphQL, TOML, Go, Rust, Ruby, Java, Kotlin, Swift, C (.c, .h), C++ (.cpp, .hpp), C#, PHP, Lua, R, Scala

Límites:

• Tamaño máximo de archivo: 5 MB por adjunto
• Máximo de adjuntos por mensaje: 10