Endpunkttransformatoren ermöglichen die Änderung des Endpunktverhaltens.
Sie können sie für Folgendes verwenden:
Ändern Sie die Anforderungsnutzlast von einem Endpunkt, bevor sie an den Flow gesendet wird.
Ändern Sie die Ausgaben eines Flows, bevor sie an den Benutzer gesendet werden
Erstellen Sie zusätzliche Integrationen mit einem benutzerdefinierten Endpunkt
Transformieren Sie die Ausgabe eines Kanals, um auf einem anderen Kanal zu funktionieren, z. B. konvertieren Sie die Webchat-Ausgabe in eine WhatsApp-kompatible Ausgabe
Behandeln von Webhook-Ereignissen aus benutzerdefinierten Diensten
Übersetzen Sie die Nachrichten eines Benutzers in die Sprache des Flows
Die Transformer haben volle TypeScript-Unterstützung, was bedeutet, dass die Variablen und NPM-Module typisiert sind und es möglich ist, benutzerdefinierte Schnittstellen in den Transformer zu schreiben. TypeScript-Kenntnisse sind jedoch nicht erforderlich und es kann auch einfaches JavaScript verwendet werden.
Sehen Sie sich diese Folge von Cognigy Sessions an, um einen technischen Einblick zu erhalten
## Transformator-FunktionenDie folgende Liste gibt einen Überblick über alle verfügbaren Transformer-Funktionen. Jede Transformer-Funktion hat ein eigenes Kapitel, das viel mehr ins Detail geht.
Diese Transformer-Funktion wird ausgeführt, wenn ein Benutzer eine Nachricht an einen Endpunkt sendet, bevor der Flow ausgeführt wird. Der Rückgabewert der Funktion wird an den Flow gesendet.
Diese Transformer-Funktion wird für jeden Ausgang des Flows ausgeführt. Bei Webhook- und Socket-basierten Endpunkten wird der Rückgabewert an den Benutzer gesendet. Lesen Sie mehr hier.
Diese Transformer-Funktion wird ausgeführt, wenn die Flow-Ausführung abgeschlossen ist. Bei REST-basierten Endpunkten wird der Rückgabewert an den Benutzer gesendet. Lesen Sie mehr hier.
Diese Transformer-Funktion wird ausgeführt, wenn die Endpoint Notify-API verwendet wird. Der Rückgabewert der Funktion wird als Benachrichtigung direkt an den Benutzer gesendet.
Um einen Transformer für einen Endpunkt zu erstellen, öffnen Sie die Registerkarte ''Transformer-Funktionen'' im Endpunkt. Hier sind die verschiedenen Transformer-Einstellungen, die konfiguriert werden können, sowie der Transformer-Code-Editor.
Transformatorfunktionen aktivieren
Jede Transformer-Funktion ist standardmäßig deaktiviert und muss separat im Abschnitt Transformer-Einstellungen aktiviert werden.
Der Transformer-Code-Editor verfügt über einen Standardwert für neue Endpunkte, in dem kurz erläutert wird, wie die einzelnen Transformer-Funktionen verwendet werden sollten. Sobald ein bestimmter Transformer aktiviert wurde, wird der Code in der entsprechenden Transformer-Funktion ausgeführt.
Um eine bestimmte Transformer-Funktion verwenden zu können, muss sie im Abschnitt Transformer-Einstellungen aktiviert werden. Es gibt einen Schalter, um jede einzelne Transformer-Funktion zu aktivieren. Transformer-Funktionen können dabei auch temporär deaktiviert werden, ohne den Code löschen zu müssen.
Die Standardfehlerbehandlung für Transformers besteht darin, den Fehler auf der Protokollseite zu protokollieren und dann mit der normalen Ausführung fortzufahren. Das heißt, wenn in der Transformer-Funktion ein Fehler auftritt, wird die Nachricht trotzdem so verarbeitet, als ob die Transformer-Funktion nicht vorhanden wäre.
Wenn der Transformer ein wichtiger Bestandteil der Pipeline ist, z. B. beim Erstellen einer benutzerdefinierten Endpunktintegration, ist es möglicherweise nicht sinnvoll, den zugrunde liegenden Endpunkt im Fehlerfall auszuführen. Es gibt eine Einstellung namens 'Abort On Error', die eingeschaltet werden kann, um die Ausführung vollständig zu stoppen, nachdem der Transformer einen Fehler ausgelöst hat.
Zeilennummer in Fehlerprotokollen
Wenn während der Ausführung ein Fehler in einem Transformer ausgelöst wird, wird die Zeilennummer, in der der Fehler aufgetreten ist, im Protokoll aufgeführt. Die Zeilennummer kann etwas falsch sein, da sie Zeilen, die von Schnittstellen und Kommentaren belegt sind, nicht berücksichtigt.
Beachten Sie auch, dass keine Zeilennummer angezeigt wird, wenn der Fehler durch einen Fehler bei der Überprüfung des Rückgabewerts verursacht wird.
Transformer-Ausführung stoppenJede Transformer-Funktion erwartet einen bestimmten Rückgabewert, den sie dann je nach spezifischer Transformer-Funktion auf unterschiedliche Weise verwendet. In einigen Fällen kann es wünschenswert sein, die Ausführung vollständig zu stoppen, z. B. wenn die Ausgabe des Flows bereits an eine andere Plattform weitergeleitet wurde. Um dies zu erreichen, kann die Transformer-Funktion einen falschen Wert zurückgeben, z.B. null oder void.¶
Transformatoren, wie z. B. Codeknoten, können die Funktion 'getTextCleaner' verwenden, um eine Instanz von Text Cleaner, die Funktionen zum Bereinigen von Text verfügbar macht.
Es ist möglich, die exponierten Module 'console.log', 'console.info' und 'console.error' in den Transformern zu verwenden. Dadurch wird das Protokoll auf der Seite Projektprotokolle als Debug-Protokoll, Info-Protokoll bzw. Fehlerprotokoll angezeigt.
Es ist möglich, HTTP-Anfragen aus einem Transformer heraus an externe Dienste zu senden. Zu diesem Zweck können alle Transformer-Funktionen auf das Modul 'httpRequest' zugreifen. Das Modul wird als Funktion aufgerufen, die ein einzelnes Konfigurationsobjekt als Argumente verwendet. Dieses Objekt hat das gleiche Format wie das options-Objekt für das NPM-Modul Request. Beispiel:
Standardmäßig ist es nur möglich, eine HTTP-Anfrage pro Transformer-Ausführung zu senden, und es ist standardmäßig nicht möglich, HTTP-Anfragen an andere Endpunkte zu senden.
Der Sitzungsspeicher ist ein Speicherobjekt, das für alle Transformer-Funktionen verfügbar ist und während der gesamten Sitzung verfügbar ist. Dies kann verwendet werden, um Variablen zu speichern, die später verwendet werden müssen, in anderen Transformer-Funktionen oder um den Konversationsstatus zu speichern. Es gibt eine Funktion namens "getSessionStorage", die für die Transformer-Funktionen verfügbar gemacht wird und die "userId" und "sessionId" als Argumente verwendet. Es wird ein Promise zurückgegeben, das mit dem 'sessionStorage'-Objekt aufgelöst wird, das wie ein normales Objekt manipuliert werden kann. Beispiel:
Mutation von Objekten innerhalb von SessionStorage
Komplexe Objekte (z.B. Arrays) sollen nicht direkt, sondern lokal mutiert (z.B. gepusht) und dem sessionStorage neu zugewiesen werden. Siehe unten.
Stummschalten komplexer Objekte
Anstatt die Objekte direkt in sessionStorage zu ändern
Ändern Sie sie lokal und weisen Sie sie dann dem sessionStorage zu
let tempArr = sessionStorage.arr || [];
tempArr.push(1);
tempArr.push(2);
sessionStorage.arr = tempArr;
}
'''
Verschiedene Sockel-Transformator-TypenEs gibt drei verschiedene Arten von Transformern, und jeder Endpunkt implementiert einen von ihnen. Jeder Transformer-Typ hat eine etwas andere Art und Weise, die spezifischen Transformatorfunktionen zu handhaben.¶
Die folgenden Abschnitte geben einen kurzen Überblick über die verschiedenen Transformer-Typen. Wie jede Transformer-Funktion für jeden Transformer-Typ unterschiedlich funktioniert, wird in den Unterkapiteln zu den einzelnen Transformer-Funktionen erklärt.
Der REST-Transformator wird für alle Endpunkte implementiert, die REST-basiert sind, was bedeutet, dass sie eine Nachricht vom Benutzer empfangen und eine Antwort zurücksenden. Für diese Endpunkte ist es möglich, mehr Say-Knoten im Flow zu haben, aber alle Ausgaben werden zu einer Ausgabe verkettet, die dann an den Benutzer gesendet wird.
Der Webhook-Transformer ist für alle Endpunkte implementiert, die Webhook-basiert sind, was bedeutet, dass sie eine Nachricht vom Benutzer erhalten, dem Benutzer aber mehrmals über eine Webhook-URL antworten können.
Um eine Integration mit einem benutzerdefinierten Kanal zu erstellen, müssen Sie zunächst herausfinden, um welche Art von Endpunkt es sich bei diesem benutzerdefinierten Kanal handelt. Wenn bekannt ist, ob die benutzerdefinierte Integration eine REST-basierte API, eine Webhook-API oder Socket-basiert ist, kann der entsprechende Endpunkt in Cognigy.AI erstellt werden.
Ein Beispiel für eine benutzerdefinierte Integration finden Sie im Beispiel-Repository (siehe unten).
Beispiel-RepositoryBeispielimplementierungen für verschiedene Transformer finden Sie in unserem neuen GitHub-Repository:¶
