Der Integration Builder ist ein leistungsstarkes Tool ohne Code, mit dem Sie Ihren AI Agent ohne größere technische oder Programmierkenntnisse mit jeder beliebigen API oder Datenquelle verbinden können. In diesem Beitrag werden häufig gestellte Fragen (FAQ) zum Integration Builder behandelt.
In diesem Beitrag werden folgende Themen behandelt:
- Häufig gestellte Fragen zu Parametern und Daten
- Häufig gestellte Fragen zu Umgebungen
- Häufig gestellte Fragen zu Karten und Karussells
- Häufig gestellte Fragen zur Authentifizierung
Verwandte Beiträge:
Häufig gestellte Fragen zu Parametern und Daten
Wie werden Sitzungsdaten aus der Konversation erfasst?
Die Sitzungsdatenerfassung in AI Agent-Konversationen beginnt mit der automatischen Erfassung von Benutzer-Metadata zu Beginn der Sitzung und wird während der Interaktion mit dem AI Agent fortgesetzt, wobei Eingaben, Antworten und Inhaltseinheiten erfasst werden können.
Beim Starten einer Chat-Sitzung werden automatisch bestimmte Metadata erfasst, insbesondere wenn der Benutzer angemeldet ist. Diese Metadata umfassen typischerweise benutzerspezifische Details, zu denen die Benutzer-ID oder Kontoinformationen, Sitzungs-ID, Standort, Zeitstempel und weitere Angaben gehören können. Diese Daten können dann als Konversationsaktion gespeichert werden.
Während der Konversation können Sie bestimmte Antworten des Benutzers erfassen (entweder als Freitext verfasst oder über Schaltflächen eingereicht). Verwenden Sie dazu:
- Einen Parameter mit der Einstellung „Parameter erfassen“ in einem konditionalen Block
- Eine Inhaltseinheit
Diese Parameter können dann an die Integration übergeben und als Anfrageparameter im URL-Endpunkt oder im Text der Anforderung verwendet werden.
Was ist ein URL-Parameter und wie verwende ich ihn?
Ein URL-Parameter ist ein dynamischer Parameter in der URL, der sich je nach den Informationen ändert, die in den Anfrageparametern der Konversation an die Integration übermittelt werden.
Hier ist ein Beispiel für eine als Parameter verwendete Benutzer-ID:
https://{{zendesk_subdomain}}.zendesk.com/api/v2/users/{{user_id}}
In doppelten geschweiften Brackets wird der Parameter user_id zur URL hinzugefügt.
Wie greife ich auf Daten aus der Konversation zu, um sie in der API zu verwenden?
Um Daten aus der Konversation zu verwenden, müssen diese wie oben beschrieben als Parameter in der Sitzung gespeichert werden. Entweder wird der Parameter erfasst oder die Metadata werden in einem Parameter in den Sitzungsdaten gespeichert. Die Daten müssen als Anfrageparameter im Integration Builder gespeichert werden, wenn sie aus der Konversation stammen, oder als Sitzungsdaten/Metadata, um an die API gesendet zu werden. Sie können diesen Parameter dann auch dynamisch im Text der Anfrage senden.
Wie kann ich auf die Parameter oder Daten aus der API-Antwort zugreifen, um sie in der Konversation zu verwenden?
Damit Parameter oder Daten aus der API-Antwort verwendet werden können, müssen sie als Sitzungsparameter in der Umgebung (in den meisten Fällen im Erfolgsszenario) gespeichert werden. Nachdem die API gespeichert wurde und sich in einem bestimmten Szenario befindet, können Sie den Sitzungsparameter in einer AI-Agentennachricht oder als Parameter für einen konditionalen Block aufrufen und verwenden:
- In einer AI-Agentennachricht wird darauf zugegriffen als {{parameterName}}.
- In einem konditionalen Block erfolgt der Zugriff darauf mit dem Parameternamen.
Wie sende ich Anfrageparameter im Text?
Um einen Anfrageparameter im Text zu senden, müssen Sie ihn in doppelt geschweifte Brackets setzen, wie folgt:
{{exampleParameter}}
Kann ich ein Array im Anfragetext senden?
Ja, Sie können beim Definieren Ihrer Anfrageparameter den Datentyp als Array auswählen. Achten Sie beim Testen darauf, den Wert mit der JSONata-Funktion $eval($)neu zu formatieren. Die Eval-Funktion analysiert eine Zeichenfolge, die entweder einen JSON-Ausdruck oder einen JSONata-Ausdruck enthält, als handele es sich um einen JSON-Ausdruck.
In diesem Fall nehmen wir eine in einem Array enthaltene Zeichenfolge und verwenden $eval(), um sie als Array zu analysieren. Der häufigste Anwendungsfall ist das Senden einer Reihe von Bestellungen.
Warum erhalte ich beim Testen keine Anforderungsparameter oder falsche Parameter?
Zu Testzwecken müssen Sie als Anfrageparameter im Integration Builder einen Testwert verwenden, der den tatsächlichen Daten in Ihrem Endpunkt entspricht. In einer Live-Konversation stammt der Wert dieses Parameters jedoch aus der Konversation. Wenn Sie den Parameter und Wert in den Sitzungsdaten beim Testen nicht sehen können, sollten Sie sicherstellen, dass Sie ihn im Dialogfeld als richtigen Parameter erfassen und speichern.
Beachten Sie, dass bereinigte Sitzungsdaten nicht in den Konversationsprotokollen angezeigt werden. In diesem Fall müssen Sie diese möglicherweise vorübergehend in einer AI-Agentennachricht protokollieren, um stattdessen ein Debugging durchzuführen.
Warum sehe ich [Objekt, Objekt]?
Wenn [Objekt, Objekt] angezeigt wird, versuchen Sie, ein Objekt auszugeben, das System bietet jedoch keine strukturierte Möglichkeit, dies anzuzeigen. Um dieses Problem zu beheben, müssen Sie das Objekt in ein Zeichenfolgenformat umwandeln.
Protokollieren Sie erfolgreiche Anrufe?
Nein, aus Gründen der PII und der DSGVO protokollieren wir keine erfolgreichen Datenanrufe. Wir protokollieren erfolglose Anrufe, damit wir bei der Fehlerbehebung weitere Informationen darüber bereitstellen können, was schief gelaufen ist.
Häufig gestellte Fragen zu Umgebungen
Warum brauche ich andere Umgebungen?
Beim Testen Ihrer Integration möchten Sie möglicherweise keine echten oder Live-Daten verwenden. Wenn Sie Zugriff auf eine Sandbox-, Staging- oder Entwicklungsumgebung haben (wir empfehlen, sich bei Ihrem technischen Team oder in der API-Dokumentation zu informieren), können Sie diese im Integration Builder einrichten.
Umgebungen haben gemeinsame Anforderungsparameter und Ausgaben. Sie unterscheiden sich jedoch in Bezug auf Endpunkte und Authentifizierungsdetails. Im Dialoggenerator können Sie problemlos zwischen Umgebungen auf dem API-Knoten wechseln. Das bedeutet, dass Sie beim Testen nur ein Dialogfeld erstellen müssen und dann zu einer Produktionsumgebung wechseln können, wenn Sie bereit sind, die Integration live zu schalten.
Häufig gestellte Fragen zu Karten und Karussells
Muss ich eine maximale Anzahl von Karten festlegen?
Für die Sunshine Conversations-Integration sind maximal 10 Karten verfügbar.
Wir empfehlen, die Anzahl der Karten in einem Karussell auf 9 Karten oder 8 Karten mit einer Fallback-Karte zu begrenzen. Eine Fallback-Karte ermöglicht dem Benutzer, das Karussell zu verlassen (z. B. wenn er sein Element nicht sieht).
Muss ich Bilder auf Karten in einem Karussell anzeigen?
Ja, „Bild“ ist ein erforderliches Datenfeld. Wenn Sie keine dynamischen Bilder benötigen (z. B. ein Bild pro Produkt), können Sie das Feld „Bild“ mit einem generischen Bild-Link füllen.
Häufig gestellte Fragen zur Authentifizierung
Welche Authentifizierungsmethoden kann ich verwenden?
Sie können die folgenden Authentifizierungsmethoden verwenden:
- API-Schlüssel
- Inhaber-Token
- Ablauftoken
- Standardauthentifizierung
- OAuth 2.0
- Zulassungslisten für IP-Adressen
Weitere Informationen zur Authentifizierung für den Integration Builder finden Sie unter Technische Anforderungen für die Integration.
Kann ich eine Integration mit einem Endpunkt auf der Zulassungsliste erstellen?
Ja. Hierzu müssen Sie unsere IP-Adressen zur Zulassungsliste hinzufügen. Eine Liste der IP-Adressen finden Sie unter IP-Adressen für die Verbindung von fortschrittlichen AI Agents mit Ihrem CRM freigeben.
Was ist eine Nur-Authentifizierungs-Integration und wann benötige ich sie?
Weitere Informationen zu reinen Authentifizierungsintegrationen finden Sie unter Verwenden der angepassten Autorisierung mit dem Integration Builder.
Kann ich Ratenlimit und -drosselung implementieren?
Wir verhängen weder Ratenlimits noch Drosselungen direkt. Die Ratenlimitierung wird in der Regel durch die Systeme oder APIs erzwungen, mit denen wir integrieren, wie beispielsweise Ihr Backend-System. Diese Limits sind von der Konfiguration Ihres Backends abhängig.
Was passiert, wenn meine API länger als 9 Sekunden braucht, um zu antworten?
Das Add-on „AI Agents – Advanced“ erzwingt ein Timeout von 9 Sekunden für API-Antworten. Wenn Ihre API innerhalb dieser Zeit keine Antwort liefert, wird die Anforderung Timeout und der Fehler ECOSNABORTED wird zurückgegeben. Außerdem können längere Antwortzeiten das Benutzererlebnis negativ beeinflussen, da Benutzer es als frustrierend empfinden können, auf Informationen warten zu müssen.
Wenn Sie davon ausgehen, dass bestimmte API-Antworten länger als 9 Sekunden dauern, empfehlen wir, die erforderlichen API-Aufrufe möglichst zu Beginn der Konversation durchzuführen (z. B. beim Ereignis „Chat gestartet“) und die relevanten Informationen in der Sitzung zu speichern. Dadurch wird sichergestellt, dass die Daten zum gewünschten Zeitpunkt bereitgestellt werden, um Verzögerungen während des Konversationsflusses zu vermeiden.