Crear mensaje de assistant
Genera un mensaje de respuesta del assistant para el domain indicado. Compatible con el SDK de IA v5 o superior.
Autentícate con una clave de API del assistant.
Integración con useChat
useChat del AI SDK de Vercel es la forma recomendada de integrar la assistant API en tu aplicación.
Instalar AI SDK
Usar el hook
transport- UsaDefaultChatTransportpara configurar la conexión con la API.body.fp- Identificador de huella digital (usa'anonymous'o un identificador único de usuario).body.retrievalPageSize- Número de resultados de búsqueda que se usarán (recomendado: 5).
body.context- Array de información contextual que se le proporciona al assistant. Cada objeto de contexto contiene:type- Puede ser'code'o'textSelection'.value- El fragmento de código o el contenido de texto seleccionado.path(opcional) - Ruta al archivo o a la página de origen.elementId(opcional) - Identificador del elemento de la interfaz de usuario que contiene el contexto.
body.currentPath- La ruta de la página que el usuario está viendo en ese momento. Cuando se proporciona, el assistant utiliza este contexto para ofrecer respuestas más relevantes. Longitud máxima: 200 caracteres.
Límites de uso
- 10.000 solicitudes por organización de Mintlify por hora
- 10.000 solicitudes por IP por día
Autorizaciones
El encabezado Authorization requiere un token de tipo Bearer. Usa una clave de API del assistant. Genérala desde la página de claves de API de tu dashboard. En producción, envía las solicitudes a través de tu backend en lugar de incrustar la clave en el código del lado del cliente.
Parámetros de ruta
El identificador de domain de tu URL, por ejemplo domain.mintlify.site. Puedes encontrarlo al final de la URL de tu dashboard. Por ejemplo, en dashboard.mintlify.com/organization/domain, el identificador de domain es domain.
Cuerpo
Identificador de huella (fingerprint) para realizar el seguimiento de las sesiones de conversación. Usa anonymous para usuarios anónimos o proporciona un identificador de usuario único.
Array de mensajes de la conversación. Usa la función handleSubmit del hook useChat del paquete @ai-sdk/react para gestionar los mensajes y las respuestas en streaming.
Un identificador opcional que se utiliza para mantener la continuidad de la conversación a través de varios mensajes. Cuando se incluye, permite que el sistema asocie los mensajes posteriores con el mismo hilo de conversación. El threadId se devuelve en la respuesta como event.threadId cuando event.type === 'finish'.
Número de resultados de búsqueda en la documentación que se utilizarán para generar la respuesta. Valores más altos proporcionan más contexto, pero pueden aumentar el tiempo de respuesta. Recomendado: 5.
Criterios de filtrado opcionales para la búsqueda.
Array opcional de información contextual para proporcionar al assistant.
La ruta de la página que el usuario está viendo actualmente. Cuando se proporciona, el assistant usa este contexto para ofrecer respuestas más relevantes. Longitud máxima: 200 caracteres.
Respuesta
Mensaje generado con éxito
Streaming de respuestas compatible con AI SDK v5. Usa el hook useChat de @ai-sdk/react para gestionar el flujo de la respuesta.