En resumen
- El mismo agente, en cualquier pantalla.Las respuestas salen del mismo conocimiento, las mismas instrucciones y las mismas reglas que el chat de su sitio web.
- En streaming, palabra a palabra.Pida un stream y la respuesta llega a medida que se escribe, en el formato AI SDK UI Message Stream.
- Las fuentes vienen incluidas.Cada respuesta incluye las fuentes que citó, con títulos y enlaces para las páginas web.
- Los reintentos nunca cobran doble.Reintente con la misma Idempotency-Key y recibirá la respuesta guardada, no una segunda respuesta.
Su sitio web no es el único lugar donde la gente tiene preguntas. El personal de soporte quiere respuestas dentro de su helpdesk, los clientes quieren ayuda dentro de su app móvil y su producto puede necesitar un agente en su propia interfaz. La API de chat le permite usar su agente de OneType en cualquier lugar desde el que pueda hacer una solicitud HTTPS, sin el widget del sitio web.
Dos llamadas hasta una respuesta con fuentes
- Cree una clave con el permiso conversations.write.
- Abra una conversación para un agente con POST /v1/conversations.
- Envíe el mensaje del visitante con POST /v1/conversations/{id}/messages.
- Lea la respuesta: partes de texto más una parte source por cada fuente citada.
Cada respuesta se escribe, se guarda y se cuenta exactamente igual que una respuesta en el chat de su sitio web. La conversación aparece en su bandeja de entrada junto a los chats de su sitio web, y al abrirla se ve que llegó por la API, así su equipo lo ve todo en un solo lugar.
Streaming
Envíe stream: true y la respuesta llega como server-sent events mientras se escribe, para que su interfaz pueda mostrar las palabras a medida que aparecen. El formato es AI SDK UI Message Stream, versión 1. Si usa el Vercel AI SDK en su servidor, puede pasar la respuesta directamente a su hook de chat. El stream termina con un evento finish que indica cómo terminó el turno, y una marca done final.
Reintentos seguros
Las redes fallan. Envíe una cabecera Idempotency-Key con cada mensaje. Si reintenta con la misma clave, recibe la respuesta guardada en lugar de una segunda respuesta. Reintentar un stream que ya terminó devuelve la respuesta guardada como JSON. Desconectarse no cancela una respuesta: se escribe y se guarda igualmente, así que no se pierde nada.
Límites
Cada clave puede enviar hasta 20 mensajes de chat cada 10 segundos, dentro del límite general de 100 solicitudes cada 10 segundos, igual en todos los planes de pago. Las claves son solo para servidores, así que la API de chat va en su backend, no en una página web. Las claves de API requieren Premium o Enterprise. Free no tiene.
Lo que la gente construye con ella
- Un panel de ayuda dentro de su app web o móvil, impulsado por su backend.
- Un agente dentro de una herramienta interna, para que el personal reciba respuestas con fuentes de su documentación.
- Un bot en otra herramienta de mensajería que usted gestiona y que reenvía preguntas a su agente.
- Comprobaciones automáticas que hacen a su agente un conjunto fijo de preguntas y leen el resultado.
En todos los casos las respuestas siguen las mismas instrucciones, el mismo conocimiento y las mismas reglas de seguridad que usted fijó en el panel, y una respuesta en streaming termina indicando cómo terminó el turno.
Las respuestas llegan con sus fuentes como partes separadas, cada una con un título y, para las páginas web, un enlace, de modo que su interfaz puede mostrar las citas como prefiera. Cada mensaje indica además si lo escribió una IA, lo que le ayuda a etiquetarlo claramente para sus usuarios.