Beispiel für die benutzerdefinierte Integration eines virtuellen Agenten

NICE CXone hat einen Beispiel-Proxytunnel entwickelt, den Sie verwenden können. Sie können dieses Beispiel für eine benutzerdefinierte Integration einrichten, um zu erfahren, wie benutzerdefinierte Integrationen funktionieren. Bei diesem Beispiel wird die benutzerdefinierte Integration eines textbasierten virtuellen Agenten mit CXone ACD-Chat simuliert.

Der Beispielcode unterscheidet sich von dem Proxytunnel-Code, der in einer echten Integration verwendet würde. In einer echten Integration kommuniziert der Proxytunnel mit den Endpunkten eines virtuellen Agenten. Im Beispielcode erfolgt keine Kommunikation mit einem echten virtuellen Agenten. Stattdessen wird die Eingabe des Benutzers, der den Code testet, per Echo zurückgegeben. Wenn Sie also Hallo Chatbot in das Testfenster eingeben, wird mit Hallo Chatbot geantwortet.

Zum Einrichten der Beispielintegration müssen Sie den Proxy-Beispielcode herunterladen und in Ihrer Umgebung installieren. Der Beispiel-Proxytunnel ist in mehreren Programmiersprachen verfügbar. Ihr Team kann seine bevorzugte Sprache verwenden.

Die Vorlage für das technische Designdokument (TDD) der benutzerdefinierten Integration virtueller Agenten enthält Beispiele, die auf dieser Beispielintegration basieren. Die Beispiele in der TDD-Vorlage veranschaulichen die benutzerdefinierte Integration eines virtuellen Agenten.

Mit einigen Links auf dieser Seite werden Websites geöffnet, die nicht zur CXone-Onlinehilfe gehören.

Anforderungen

Im Folgenden werden die Voraussetzungen zum Testen der Beispielintegration aufgelistet:

  • Studio muss auf Ihrem Computer installiert sein.
  • Die ZIP-Datei mit dem Beispielcode wurde heruntergeladen. Der Beispielcode ist in den folgenden Sprachen verfügbar:
    • C# .NET
    • Java
    • Node.js
    • PHP
    • Python
  • IDE- und Compiler-Abhängigkeiten für die verwendete Sprache des Beispielcodes:
    • C# .NET: VS Code-Editor oder anderer Code-Editor.
    • Java: VS Code Community, Jet Brains, Net Beans, Intelli J, Eclipse oder andere. Wenn Sie den VS Code-Editor verwenden, müssen Sie das Java-Erweiterungspaket von der Website Visual Studio Marketplace herunterladen und installieren.
    • Node.js: NPM.
    • PHP: VS Code-Editor oder anderer Code-Editor.
    • Python: VS Code-Editor oder anderer Code-Editor.
  • Ngrok muss auf Ihrem Computer installiert sein. Sie finden das Installationspaket auf dieser Website: https://ngrok.com/download.

Führen Sie jede dieser Aufgaben in der angegebenen Reihenfolge aus.

Einrichten des Proxytunnel-Endpunkts

Führen Sie diesen API-Aufruf auf einem localhost-Port aus. Notieren Sie sich die Nummer des Ports, auf dem der Dienst ausgeführt wird. Sie benötigen diese Nummer später. Klicken Sie auf das Dropdownmenü, um Anleitungen zum Einrichten des Endpunkts für jede verfügbare Sprache anzuzeigen.

  1. Extrahieren Sie die Datei ProxyTunnelExamples.zip.

  2. Navigieren Sie im Code-Editor zu dem Ordner, der den Proxytunnel-Code in C# in den extrahierten Dateien enthält.

    cd ProxyTunnel/examples/c#/ProxyTunnel

  3. Öffnen Sie die Datei Program.cs. Diese Datei enthält den Code.

  4. Öffnen Sie PowerShell und führen Sie den folgenden Befehl aus:

    dotnet run

  5. Merken Sie sich die Nummer des Ports, auf dem der Dienst ausgeführt wird. Im folgenden Beispiel wird er auf Port 8080 ausgeführt.

Sie können den Proxytunnel-Endpunkt mit einem Code-Editor einrichten. Wenn Sie keinen Java-Code-Editor haben, können Sie ein Dienstprogramm wie Apache Maven verwenden, in dem Java-Dateien ausgeführt werden können. Beide Methoden werden hier beschrieben.

Verwenden eines Code-Editors

Wenn Sie den VS Code-Editor verwenden, müssen Sie das Java-Erweiterungspaket von der Website Visual Studio Marketplace herunterladen und installieren. Durch dieses Erweiterungspaket werden die Optionen Ausführen | Debuggen oberhalb der Hauptfunktion eingefügt.

  1. Extrahieren Sie die Datei ProxyTunnelExamples.zip.
  2. Öffnen Sie im Code-Editor den Ordner, der den Java-Code für den Proxytunnel enthält. Der Pfad zum Java-Code für den Proxytunnel lautet:

    ProxyTunnel\examples\java\src\main\java\com\icx\javaproxytunnel

  3. Führen Sie den Endpunkt aus, indem Sie auf die Schaltfläche Ausführen klicken, die sich oberhalb der Hauptfunktion befindet. Sie sieht folgendermaßen aus:

    Der Java-Code für den Proxytunnel im VS Code-Editor mit den Optionen "Ausführen" | "Debuggen" oberhalb der Hauptfunktion: public static voice main (String[] args).

  4. Die Anwendung wird initialisiert. Notieren Sie sich den Port, der oben in der Terminal-Ausgabe angezeigt wird. Im folgenden Bild lautet der Port 8080.

    Die Terminal-Ausgabe für Java zeigt den Port, auf dem der Proxytunnel ausgeführt wird: 8080 (http).

Verwenden von Java-Dienstprogrammen

  1. Installieren Sie die folgenden Dienstprogramme: 
  2. Richten Sie die Umgebungsvariablen ein, die erforderlich sind, um das Java-Programm lokal auszuführen:
    1. Suchen Sie auf Ihrem Computer nach Erweiterte Systemeinstellungen oder Umgebungsvariablen.
    2. Klicken Sie im Fenster "Systemeigenschaften" auf der Registerkarte "Erweitert" auf Umgebungsvariablen.
    3. Wählen Sie im Abschnitt "Systemvariablen" die Option Pfad aus und klicken Sie auf Bearbeiten.

    4. Erstellen Sie zwei neue Pfade für die Bin-Ordner von Maven und Java, indem Sie zu dem Speicherort navigieren, an dem die Dienstprogramme installiert sind. Die Pfade können beispielsweise folgendermaßen lauten:

      C:\Programme\apache-maven-3,8,6-bin\apache-maven-3.8.6\bin

      C:\Programme\Java\jdk-18.0.2\bin

  3. Extrahieren Sie die Datei ProxyTunnelExamples.zip.

  4. Initialisieren Sie die Anwendung: 

    1. Öffnen Sie PowerShell oder eine Eingabeaufforderung und ändern Sie das Verzeichnis in den Ordner, der die Anwendung enthält. Zum Beispiel:

      cd ProxyTunnel\examples\Java

    2. Führen Sie die folgenden Befehle aus, um die Anwendung zu kompilieren und in ein Maven-Paket zu konvertieren:

      mvn compile
      mvn package

      Dadurch wird eine JAR-Datei in einem Verzeichnis namens "\target" erstellt.

    3. Führen Sie die erstellte JAR-Datei aus.

      java -jar target/javaproxytunnel-0.0.1-SNAPSHOT.jar

    4. Notieren Sie sich die Portnummer in der Initialisierungsausgabe im Fenster der Eingabeaufforderung. Im folgenden Beispiel lautet der Port 8080.

      Und Beispiel der Ergebnisse beim Ausführen der generierten JAR-Datei. Zeigt die zu verwendende Portnummer.

Bevor Sie diese Aufgabe ausführen, stellen Sie sicher, dass der Knoten und NPM auf Ihrem Computer installiert sind.

  1. Extrahieren Sie die Datei ProxyTunnelExamples.zip.

  2. Öffnen Sie PowerShell oder eine Eingabeaufforderung und wechseln Sie zum Speicherort der Node.js-Dateien.

    cd ProxyTunnel/examples/Nodejs

  3. Führen Sie im Ordner mit dem Node.js-Code den folgenden Befehl aus:

    npm install

  4. Führen Sie den Endpunkt aus. Verwenden Sie den Befehl für Ihr Betriebssystem.

    Linux:

    export DEBUG='javascriptechoproxy:server'
    npm run start

    Windows mit PowerShell: 

    npm run devstart

  5. Notieren Sie sich die Portnummer in der Initialisierungsausgabe im Fenster der Eingabeaufforderung. Sie könnte z. B. 8080 lauten.

PHP muss auf Ihrem Computer installiert sein, damit Sie diese Option verwenden können. Wenn PHP noch nicht installiert ist, können Sie es mit zwei Methoden installieren:

  • Verwenden Sie das Softwareverwaltungstool Chocolatey. Dies ist die bevorzugte Option.  Zum Installieren von PHP mit Chocolatey öffnen Sie PowerShell als Administrator und geben Sie diesen Befehl ein:

    choco install php

  • Installieren Sie PHP direkt von der Windows PHP-Website.

Nachdem Sie PHP installiert haben, führen Sie diese Schritte aus, um den Proxytunnel-Endpunkt einzurichten:

  1. Extrahieren Sie die Datei ProxyTunnel_PHP.zip.

  2. Verwenden Sie eine Eingabeaufforderung oder PowerShell, um zum Ordner "\PHP" zu wechseln.

    cd ProxyTunnel/examples/php

  3. Führen Sie im PHP-Ordner diesen Befehl aus:

    php -S localhost:8000

    Die Anwendung wird initialisiert und auf Port 8000 ausgeführt. Merken Sie sich diese Portnummer. Sie benötigen sie später beim Einrichtungsvorgang.

  1. Extrahieren Sie die Datei ProxyTunnelExamples.zip.

  2. Öffnen Sie im Code-Editor den Python-Ordner für den Proxytunnel.
  3. Wechseln Sie in der Code-Editor-Konsole zu dem Ordner, der die API-Datei enthält.

  4. Führen Sie im Terminal-Bereich des Code-Editors oder an der Eingabeaufforderung den folgenden Befehl aus, um Flask auf Ihrem System zu installieren:

    pip install flask

  5. Verwenden Sie diesen Befehl, um den Proxytunnel auszuführen:

    python echo-proxy-tunnel.py

    Notieren Sie sich die Portnummer in der Initialisierungsausgabe im Terminal-Fenster. Merken Sie sich diese Portnummer. Sie benötigen sie später beim Einrichtungsvorgang. Im folgenden Beispielbild lautet der Port 5000.

    Ein Beispiel der Ausgabe für die Ausführung des Proxytunnels in Python. Die Portnummer in diesem Beispiel ist 5000.

Proxytunnel-Endpunkt verfügbar machen

Der Proxytunnel-Endpunkt muss verfügbar gemacht werden, damit CXone global darauf zugreifen kann. Verwenden Sie Ngrok, um den Endpunkt verfügbar zu machen.

  1. Installieren Sie Ngrok, falls noch nicht geschehen.

  2. Starten Sie Ngrok, indem Sie an der Eingabeaufforderung diesen Befehl ausführen:

    ngrok http [port number]

    Dabei ist [Portnummer] die Portnummer, die Sie sich beim Einrichten des Endpunkts notiert haben.

  3. Kopieren Sie die von Ngrok angezeigte Server-URL und die erforderlichen API-Endpunkte.

    Ein Beispiel der Ergebnisse beim Ausführen von Ngrok auf dem Proxytunnel-Endpunkt. Es zeigt die URLs, die als Resultat sichtbar sind.

    Im Beispielbild wird die folgende URL angezeigt: https://4db3-5-46-62-207.nrgok.io. Dies ist die Basis-URL für den Webhook. Bestimmen Sie, welcher Endpunkt mit der URL verwendet werden soll. Speichern Sie die URL, die verwendet werden soll, wenn die Studio-Aktion für den Textbot später konfiguriert wird.

    Sprache Details des Endpunkts
    C#

    Der Server akzeptiert Virtueller Agenten-Hub-Anfragen in der POST proxy/performbotexchange-Methode. Die Webhook-URL lautet:

    https://[Basis-URL]/proxy/performbotexchange
    Java

    Der Server akzeptiert Virtueller Agenten-Hub-Anfragen in der POST api/proxy-Methode. Die Webhook-URL lautet:

    https://[Basis-URL]/api/proxy
    Node.js

    Der Server akzeptiert Virtueller Agenten-Hub-Anfragen in der POST api/relay-Methode. Die Webhook-URL lautet:

    https://[Basis-URL]/api/relay
    Python

    Der Server akzeptiert Virtueller Agenten-Hub-Anfragen in der POST relayExchangeResponse-Methode. Die Webhook-URL lautet:

    https://[Basis-URL]/relayExchangeResponse
    PHP

    Der Server akzeptiert Virtueller Agenten-Hub-Anfragen in der POST proxy.php-Methode. Die Webhook-URL lautet:

    https://[Basis-URL]/proxy.php

Die in diesem Abschnitt beschriebenen Schritte zum Bestimmen des Endpunkts gelten nur für die Beispielintegration. Wenn Sie Ihren eigenen Endpunkt erstellen, müssen die Schritte an die Anforderungen Ihrer Organisation angepasst werden.

Einrichten eines einfachen Chatskripts in Studio

  1. Laden Sie dieses einfache Chatskript herunter.
  2. Extrahieren Sie die Datei TextBotExchangeExample.xml auf Ihren Computer.
  3. Klicken Sie in Studio auf Datei > Aus Datei importieren, wählen Sie die extrahierte Datei aus und klicken Sie auf Öffnen.
  4. Speichern Sie das Skript. Merken Sie sich den Namen, den Sie dem Skript geben. Lassen Sie das Skript geöffnet. Sie kehren später wieder zu ihm zurück.

Erstellen einer Chatkompetenz und einer Kontaktstelle in CXone

Sie müssen eine Chat-KompetenzGeschlossen Wird verwendet, um die Bereitstellung von Interaktionen basierend auf den Kompetenzen, Fertigkeiten und Kenntnissen der Agenten zu automatisieren und eine KontaktstelleGeschlossen Der Eintrittspunkt, den ein eingehender Kontakt verwendet, um eine Interaktion zu initiieren, wie z. B. Telefonnummer oder E-Mail-Adresse. erstellen. Die Kontaktstelle ruft das Skript auf, das Sie importiert haben. Auf diese Weise leitet CXone Kontakte an Ihren virtuellen Agenten weiter.

  1. Klicken Sie unter CXone auf die App-Auswahl und wählen SieACD.
  2. Klicken Sie auf Kontakteinstellungen > ACD-Skills und erstellen Sie eine Chatkompetenz. Sie müssen der Kompetenz einen Namen geben und sie einer Kampagne zuweisen. Sie können eine Kampagne erstellen, die für die Beispielintegration verwendet werden soll. Für alle anderen Optionen für die Kompetenz können Sie die Standardeinstellungen übernehmen.

  3. Wählen Sie Kontakteinstellungen > Kontaktstellen aus und erstellen Sie eine Kontaktstelle mit den folgenden Einstellungen:

    • Medienart: Wählen Sie Chat aus.
    • Skript: Wählen Sie den Namen des Skripts aus, das Sie zur Verwendung mit der Beispielintegration importiert haben.
    • Skill: Wählen Sie den Namen des Skills aus, den Sie in dieser Aufgabe erstellt haben.

  4. Nachdem Sie die Kontaktstelle erstellt haben, kopieren Sie die URL der Kontaktstelle, die auf der Registerkarte "Details" angezeigt wird. Fügen Sie sie auf einer Registerkarte in Ihrem Browser ein. Sie verwenden diese URL später beim Testen des Skripts.

    Die Registerkarte "Details" der Kontaktstelle, die zum Testen des Beispiel-Proxytunnels erstellt wurde. Im Feld "Kontaktstelle" wird die URL angezeigt, die das Skript aufruft.

Konfigurieren der Textbot-Exchange-Aktion

In diesem Schritt wird CXone für die Kommunikation mit dem Endpunkt des Beispiel-Proxytunnels konfiguriert.

  1. Öffnen Sie in Studio das importierte Beispielskript, wenn es nicht bereits geöffnet ist.

  2. Doppelklicken Sie auf eine der Textbot Exchange-Aktionen, um Virtueller Agenten-Hub zu öffnen.

    Das Symbol für die Aktion Textbot Exchange. Es ist eine Chatblase, die Roboteraugen enthält. Oben befindet sich eine Antenne, unter der die Buchstaben ABC angezeigt werden.
  3. Klicken Sie auf Bot hinzufügen.
  4. Geben Sie einen Namen für den virtuellen Agenten (Bot) ein und wählen Sie dann Custom Exchange Endpoint als Bot-Anbieter aus.
  5. Klicken Sie auf Next (Weiter).
  6. Geben Sie die Webhook-URL ein. Dies ist die URL, die Sie gespeichert haben, nachdem der Proxytunnel-Endpunkt verfügbar gemacht wurde.
  7. Klicken Sie auf Next (Weiter).
  8. Wählen Sie auf der Seite "Sprache" unter Optionen für die Sprachintegration die Option Nur Text aus und klicken Sie dann auf Weiter.
  9. Klicken Sie auf der Seite "Testen und Hinzufügen" auf Start mit Begrüßungsabsicht. Testen Sie weitere Optionen, wie beispielsweise das Senden von benutzerdefinierten Nutzdaten. Wenn keine Fehler auftreten, fahren Sie mit der nächsten Aufgabe fort. Wenn beim Test Fehler auftreten, überprüfen Sie die vorherigen Aufgaben. Stellen Sie sicher, dass der Proxytunnel-Endpunkt korrekt eingerichtet ist und verfügbar gemacht wurde, und überprüfen Sie die Konfiguration in Virtueller Agenten-Hub.

Testen des Skripts in einem Chatfenster

Nachdem Sie die Konfiguration der Textbot Exchange-Aktion getestet und eventuelle Fehler behoben haben, können Sie das Skript mit der KontaktstellenGeschlossen Der Eintrittspunkt, den ein eingehender Kontakt verwendet, um eine Interaktion zu initiieren, wie z. B. Telefonnummer oder E-Mail-Adresse.-URL testen, die Sie in einem vorherigen Schritt kopiert haben.

  1. Öffnen Sie in Studio das importierte Beispielskript.
  2. Klicken Sie auf Debug > Capture Script > Next Instance Only.
  3. Wechseln Sie zu der Browser-Registerkarte, in die Sie die Kontaktstellen-URL eingefügt haben, geben Sie eine Nachricht in das Feld Ihren Text eingeben ein und klicken Sie auf Senden.

  4. In Studio wird das Fenster "Trace Output" geöffnet. Im Fenster wird der Ablauf des Skripts angezeigt, während Sie Nachrichten senden und das Skript darauf antwortet.

    Klicken Sie im Hauptbereich des Fensters für die Trace Output auf eine Aktion.

    • Auf der Registerkarte "Variables" sind alle Variablen aufgeführt, die im Skript enthalten sind, wenn die ausgewählte Aktion abgeschlossen wurde. Hier sehen Sie auch den Wert, den die einzelnen Variablen an dieser Stelle des Skripts haben.
    • Auf der Registerkarte "Properties" sind die Eigenschaften der ausgewählten Aktion aufgeführt. Damit können Sie die aktuelle Konfiguration der Aktion überprüfen.
    Das Fenster für die Überwachungsausgabe in Studio, das die Überwachungsergebnisse ab dem Anfang des Beispielskripts für den Chat mit einem virtuellen Agenten zeigt.
  5. Kehren Sie zu Ihrem Skript zurück und nehmen Sie ggf. Änderungen vor.
  6. Sie können die Onlinehilfe für eine Aktion öffnen, indem Sie sie im Arbeitsbereich auswählen und dann auf der Tastatur F1 drücken. Auf der Online-Hilfeseite einer Aktion finden Sie die Eigenschaften und weitere Informationen zur Verwendung dieser Aktion in einem Skript.
  7. Wenn Sie von vorn anfangen möchten, klicken Sie auf Chat beenden, aktualisieren Sie das Browserfenster und wiederholen Sie den Prozess ab Schritt 2.