En bref
- Même agent, n'importe quel écran.Les réponses viennent des mêmes connaissances, instructions et règles que le chat de votre site web.
- En flux, mot à mot.Demandez un flux et la réponse arrive au fur et à mesure de son écriture, au format AI SDK UI Message Stream.
- Les sources viennent avec.Chaque réponse inclut les sources qu'elle a citées, avec titres et liens pour les pages web.
- Les nouvelles tentatives ne sont jamais facturées deux fois.Réessayez avec la même Idempotency-Key et vous obtenez la réponse enregistrée, pas une seconde réponse.
Votre site web n'est pas le seul endroit où les gens ont des questions. Le support veut des réponses dans votre helpdesk, les clients veulent de l'aide dans votre application mobile, et votre produit peut avoir besoin d'un agent dans sa propre interface. L'API de chat vous permet d'utiliser votre agent OneType partout où vous pouvez faire une requête HTTPS, sans le widget du site.
Deux appels pour une réponse avec sources
- Créez une clé avec la permission conversations.write.
- Ouvrez une conversation pour un agent avec POST /v1/conversations.
- Envoyez le message du visiteur avec POST /v1/conversations/{id}/messages.
- Lisez la réponse : des parties texte, plus une partie source pour chaque source citée.
Chaque réponse est écrite, enregistrée et comptée exactement comme une réponse de votre chat de site web. La conversation apparaît dans votre boîte de réception à côté des chats de votre site web, et l'ouvrir montre qu'elle est passée par l'API, afin que votre équipe voie tout au même endroit.
Streaming
Envoyez stream: true et la réponse arrive en server-sent events pendant son écriture, pour que votre interface affiche les mots au fur et à mesure. Le format est l'AI SDK UI Message Stream, version 1. Si vous utilisez le Vercel AI SDK sur votre serveur, vous pouvez transmettre la réponse telle quelle à son hook de chat. Le flux se termine par un événement finish qui indique comment le tour s'est terminé, puis un marqueur done final.
Nouvelles tentatives sûres
Les réseaux coupent. Envoyez un en-tête Idempotency-Key avec chaque message. Si vous réessayez avec la même clé, vous obtenez la réponse enregistrée au lieu d'une seconde réponse. Réessayer un flux déjà terminé renvoie la réponse enregistrée en JSON. Une déconnexion n'annule pas une réponse : elle est tout de même écrite et enregistrée, rien n'est donc perdu.
Limites
Chaque clé peut envoyer jusqu'à 20 messages de chat toutes les 10 secondes, dans la limite générale de 100 requêtes toutes les 10 secondes, identique avec toutes les offres payantes. Les clés sont réservées aux serveurs, donc l'API de chat a sa place dans votre backend, pas dans une page web. Les clés API exigent Premium ou Enterprise. Free n'en a aucune.
Ce que les gens en font
- Un panneau d'aide dans votre application web ou mobile, alimenté par votre backend.
- Un agent dans un outil interne, pour que le personnel obtienne des réponses avec sources issues de vos docs.
- Un bot dans un autre outil de messagerie que vous gérez, qui transmet les questions à votre agent.
- Des vérifications automatisées qui posent à votre agent un ensemble fixe de questions et lisent le résultat.
Dans tous les cas, les réponses suivent les mêmes instructions, connaissances et règles de sécurité que vous définissez dans le tableau de bord, et une réponse en flux se termine en indiquant comment le tour s'est terminé.
Les réponses arrivent avec leurs sources en parties séparées, chacune avec un titre et, pour les pages web, un lien, pour que votre interface affiche les citations comme elle le souhaite. Chaque message indique aussi s'il a été écrit par une IA, ce qui vous aide à l'étiqueter clairement pour vos utilisateurs.