Kurz gesagt
- Derselbe Agent, auf jedem Bildschirm.Die Antworten stammen aus demselben Wissen, denselben Anweisungen und denselben Regeln wie Ihr Website-Chat.
- Wort für Wort gestreamt.Fordern Sie einen Stream an, und die Antwort kommt an, während sie geschrieben wird, im Format AI SDK UI Message Stream.
- Quellen inklusive.Jede Antwort enthält die zitierten Quellen, bei Webseiten mit Titeln und Links.
- Wiederholungen werden nie doppelt berechnet.Wiederholen Sie die Anfrage mit demselben Idempotency-Key, und Sie erhalten die gespeicherte Antwort statt einer zweiten.
Ihre Website ist nicht der einzige Ort, an dem Menschen Fragen haben. Support-Mitarbeitende wollen Antworten direkt im Helpdesk, Kunden Hilfe in Ihrer mobilen App, und Ihr Produkt braucht vielleicht einen Agenten in der eigenen Oberfläche. Mit der Chat-API nutzen Sie Ihren OneType-Agenten überall dort, wo Sie eine HTTPS-Anfrage senden können, ganz ohne das Website-Widget.
Zwei Aufrufe bis zur Antwort mit Quellen
- Erstellen Sie einen Schlüssel mit der Berechtigung conversations.write.
- Eröffnen Sie mit POST /v1/conversations eine Unterhaltung für einen Agenten.
- Senden Sie die Nachricht des Besuchers mit POST /v1/conversations/{id}/messages.
- Lesen Sie die Antwort: Textteile plus ein Quellenteil für jede zitierte Quelle.
Jede Antwort wird genauso geschrieben, gespeichert und gezählt wie eine Antwort in Ihrem Website-Chat. Die Unterhaltung erscheint in Ihrem Posteingang neben Ihren Website-Chats, und beim Öffnen sehen Sie, dass sie über die API kam, sodass Ihr Team alles an einem Ort hat.
Streaming
Senden Sie stream: true, und die Antwort kommt als Server-Sent Events an, während sie geschrieben wird, sodass Ihre Oberfläche die Wörter beim Entstehen anzeigen kann. Das Format ist der AI SDK UI Message Stream, Version 1. Wenn Sie das Vercel AI SDK auf Ihrem Server nutzen, können Sie die Antwort direkt an dessen Chat-Hook weiterreichen. Der Stream endet mit einem Finish-Ereignis, das Ihnen mitteilt, wie der Durchgang endete, und einer abschließenden done-Markierung.
Sichere Wiederholungen
Netzwerke brechen ab. Senden Sie bei jeder Nachricht einen Idempotency-Key-Header. Wenn Sie mit demselben Schlüssel wiederholen, erhalten Sie die gespeicherte Antwort statt einer zweiten. Wiederholen Sie einen bereits beendeten Stream, wird die gespeicherte Antwort als JSON zurückgegeben. Ein Verbindungsabbruch bricht eine Antwort nicht ab: Sie wird trotzdem geschrieben und gespeichert, sodass nichts verloren geht.
Limits
Jeder Schlüssel kann bis zu 20 Chat-Nachrichten alle 10 Sekunden senden, innerhalb des allgemeinen Limits von 100 Anfragen alle 10 Sekunden, in jedem kostenpflichtigen Tarif gleich. Schlüssel sind nur für Server gedacht, die Chat-API gehört also in Ihr Backend, nicht in eine Webseite. API-Schlüssel setzen Premium oder Enterprise voraus. Free hat keine.
Was andere damit bauen
- Ein Hilfebereich in Ihrer Web- oder mobilen App, betrieben von Ihrem Backend.
- Ein Agent in einem internen Tool, damit Mitarbeitende Antworten mit Quellen aus Ihren Dokumenten erhalten.
- Ein Bot in einem anderen Messaging-Tool, das Sie betreiben und das Fragen an Ihren Agenten weiterleitet.
- Automatisierte Prüfungen, die Ihrem Agenten feste Fragen stellen und das Ergebnis auslesen.
In jedem Fall folgen die Antworten denselben Anweisungen, demselben Wissen und denselben Sicherheitsregeln, die Sie im Dashboard festgelegt haben, und eine gestreamte Antwort endet mit der Mitteilung, wie der Durchgang endete.
Antworten kommen mit ihren Quellen als eigene Teile, jeweils mit Titel und, bei Webseiten, einem Link, sodass Ihre Oberfläche Quellenangaben so darstellen kann, wie Sie es möchten. Jede Nachricht gibt außerdem an, ob sie von einer KI geschrieben wurde, was Ihnen hilft, sie gegenüber Ihren Nutzern klar zu kennzeichnen.