In breve
- Lo stesso agente, su qualsiasi schermo.Le risposte vengono dalla stessa conoscenza, dalle stesse istruzioni e dalle stesse regole della chat sul suo sito.
- In streaming, parola per parola.Chieda uno stream e la risposta arriva mentre viene scritta, nel formato AI SDK UI Message Stream.
- Le fonti arrivano insieme.Ogni risposta include le fonti citate, con titoli e link per le pagine web.
- I nuovi tentativi non fatturano due volte.Riprovi con lo stesso Idempotency-Key e riceve la risposta salvata, non una seconda risposta.
Il suo sito non è l'unico posto in cui le persone hanno domande. Il personale di assistenza vuole risposte dentro il suo helpdesk, i clienti vogliono aiuto dentro la sua app mobile e il suo prodotto può aver bisogno di un agente nella propria interfaccia. La chat API le permette di usare il suo agente OneType ovunque possa fare una richiesta HTTPS, senza il widget del sito.
Due chiamate per una risposta con fonti
- Crei una chiave con il permesso conversations.write.
- Apra una conversazione per un agente con POST /v1/conversations.
- Invii il messaggio del visitatore con POST /v1/conversations/{id}/messages.
- Legga la risposta: parti di testo più una parte fonte per ogni fonte citata.
Ogni risposta viene scritta, salvata e contata esattamente come una risposta nella chat del suo sito. La conversazione compare nella sua inbox accanto alle chat del suo sito e aprendola si vede che è arrivata tramite l'API, così il suo team vede tutto in un unico posto.
Streaming
Invii stream: true e la risposta arriva come server-sent events mentre viene scritta, così la sua interfaccia può mostrare le parole man mano che appaiono. Il formato è l'AI SDK UI Message Stream, versione 1. Se usa il Vercel AI SDK sul suo server, può passare la risposta direttamente al suo hook di chat. Lo stream termina con un evento finish che dice come è finito il turno e con un marcatore done finale.
Nuovi tentativi sicuri
Le reti cadono. Invii un header Idempotency-Key con ogni messaggio. Se riprova con la stessa chiave, riceve la risposta salvata invece di una seconda risposta. Riprovare uno stream già concluso restituisce la risposta salvata come JSON. Disconnettersi non annulla una risposta: viene comunque scritta e salvata, quindi nulla va perso.
Limiti
Ogni chiave può inviare fino a 20 messaggi di chat ogni 10 secondi, entro il limite generale di 100 richieste ogni 10 secondi, lo stesso in ogni piano a pagamento. Le chiavi sono solo per i server, quindi la chat API va nel suo backend, non in una pagina web. Le chiavi API richiedono Premium o Enterprise. Free non ne ha.
Cosa ci costruiscono le persone
- Un pannello di aiuto dentro la sua app web o mobile, alimentato dal suo backend.
- Un agente dentro uno strumento interno, così il personale riceve risposte con fonti dalla sua documentazione.
- Un bot, in un altro strumento di messaggistica da lei gestito, che inoltra le domande al suo agente.
- Controlli automatici che pongono al suo agente un insieme fisso di domande e ne leggono l'esito.
In ogni caso le risposte seguono le stesse istruzioni, la stessa conoscenza e le stesse regole di sicurezza che ha impostato nella dashboard, e una risposta in streaming termina dicendo come è finito il turno.
Le risposte arrivano con le fonti come parti separate, ciascuna con un titolo e, per le pagine web, un link, così la sua interfaccia può mostrare le citazioni come preferisce. Ogni messaggio dice anche se è stato scritto da un'IA, il che aiuta a etichettarlo chiaramente per i suoi utenti.