Voorbeeld Aangepaste virtuele-agentintegratie

NICE CXone heeft een voorbeeld-proxytunnel ontwikkeld die u kunt gebruiken. U kunt deze voorbeeldintegratie instellen om beter te leren hoe aangepaste integraties werken. Dit voorbeeld simuleert een tekstgebaseerde aangepaste virtuele-agentintegratie die gebruikmaakt van CXone ACD-chat.

De voorbeeldcode wijkt af van de proxytunnel die in een werkelijke integratie wordt gebruikt. In een echte integratie wordt de proxytunnel geconfigureerd om te communiceren met de eindpunten van een virtuele agent. De voorbeeldcode communiceert niet met een werkelijke virtuele agent. In plaats daarvan wordt deze zodanig geconfigureerd dat de gebruikersinvoer wordt teruggezegd. Dus als u Hallo chatbot in het testvenster typt, antwoordt de bot met Hallo chatbot.

Om de voorbeeldintegratie te configureren, moet u de voorbeeldproxycode downloaden en installeren binnen uw omgeving. De voorbeeld-proxytunnel is beschikbaar in verschillende programmeertalen. Uw team kan de taal gebruiken waarmee zij het beste kunnen werken.

Het sjabloon voor het technische ontwerpdocument (TDD) voor de virtuele-agentintegratie bevat voorbeelden op basis van deze voorbeeldintegratie. De voorbeelden in de TDD-sjabloon kunnen u helpen de integratie van een aangepaste virtuele agent beter te begrijpen.

Sommige links op deze pagina openen externe sites die niet tot de online Help van CXone behoren.

Vereisten

Om de voorbeeldintegratie te testen, is het volgende vereist:

  • Studio moet zijn geïnstalleerd op uw computer.
  • Download het zipbestand met de voorbeeldcode. De voorbeeldcode is beschikbaar in de volgende talen:
    • C# .NET
    • Java
    • Node.js
    • PHP
    • Python
  • IDE- en compiler-afhankelijkheden voor de taal van de voorbeeldcode die u gebruikt:
    • C# .NET: VS Code of een andere code-editor.
    • Java: VS Code Community, Jet Brains, Net Beans, Intelli J, Eclipse of andere. Als u de Visual Studio code-editor gebruikt, moet u het Java-uitbreidingspakket downloaden van de Visual Studio Marketplace-website en dit vervolgens installeren.
    • Node.js: NPM.
    • PHP: VS Code of een andere code-editor.
    • Python: VSCode of een andere code-editor.
  • Ngrok moet zijn geïnstalleerd op uw computer. U vindt de installatie op deze site: https://ngrok.com/download.

Voer de onderstaande taken in de aangegeven volgorde uit.

Het proxytunnel-eindpunt configureren

Voer deze API-aanroep uit op een localhost-poort. Noteer het poortnummer waar de service op wordt uitgevoerd. U hebt dit nummer in een latere stap nodig. Klik op de vervolgkeuzelijst om instructies te zien voor het configureren van het eindpunt voor elke beschikbare taal.

  1. Pak het bestand ProxyTunnelExamples.zip uit.

  2. Navigeer in uw code-editor naar de map met de C#-proxytunnelcode in de uitgepakte bestanden.

    cd ProxyTunnel/examples/c#/ProxyTunnel

  3. Open het bestand Program.cs . Dit bestand bevat de code.

  4. Open Powershell en voer het volgende commando uit:

    dotnet run

  5. Onthoud het poortnummer waarop de service wordt uitgevoerd. In de volgende voorbeeldafbeelding wordt deze uitgevoerd op poort 8080.

U kunt het proxytunnel-eindpunt configureren met een code-editor. Als u geen Java-code-editor hebt, kunt u een hulpprogramma gebruiken zoals Apache Maven, waarmee u Java-bestanden kunt uitvoeren. Beide methoden worden hier beschreven.

Een code-editor gebruiken

Als u de Visual Studio code-editor gebruikt, moet u het Java-uitbreidingspakket downloaden van de Visual Studio Marketplace-website en dit vervolgens installeren. Dit uitbreidingspakket plaatst de optie Uitvoeren | Debuggen boven de hoofdfunctie.

  1. Pak het bestand ProxyTunnelExamples.zip uit.
  2. Open in uw code-editor de map met de Java-proxytunnelcode. Het pad naar de Java-proxytunnelcode is:

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

  3. Voer het eindpunt uit met de knop Uitvoeren die bovenaan de hoofdfunctie verschijnt. Het ziet er als volgt uit:

    De Java-proxytunnelcode in de Visual Studio code-editor die de optie Uitvoeren | Debuggen weergeeft boven de hoofdfunctie: public static voice main (String[] args).

  4. De toepassing wordt geïnitialiseerd. Noteer het poortnummer dat bovenaan de uitvoer in de terminal staat. In de volgende afbeelding is de poort 8080.

    De terminaluitvoer voor Java die de poort weergeeft waarop de proxytunnel wordt uitgevoerd, 8080 (http).

Java-hulpprogramma's gebruiken

  1. Installeer de volgende hulpprogramma's: 
  2. Configureer de omgevingsvariabelen die nodig zijn om het Java-programma lokaal uit te voeren:
    1. Zoek op uw computer naar Geavanceerde systeeminstellingen of Omgevingsvariabelen.
    2. Klik op Omgevingsvariabelen op het tabblad Geavanceerd in het venster Systeemeigenschappen.
    3. Selecteer in de sectie Systeemvariabelen Pad en klik op Bewerken.

    4. Maak twee nieuwe paden aan voor de bin-mappen van Maven en Java door te bladeren naar de locatie waar elk hulpprogramma is geïnstalleerd. De paden kunnen bijvoorbeeld zijn:

      C:\Program Files\apache-maven-3.8.6-bin

      C:\Program Files\Java-jdk-18.0.2

  3. Pak het bestand ProxyTunnelExamples.zip uit.

  4. De toepassing initialiseren: 

    1. Open Powershell of de opdrachtprompt en wijzig de map in de map met de toepassing. Voorbeeld:

      cd ProxyTunnel\examples\Java

    2. Voer de volgende commando's uit om de toepassing te compileren en om te zetten naar een Maven-pakket:

      mvn compile
      mvn package

      Dit genereert een JAR-bestand in een map met de naam \target.

    3. Voer het gegenereerde JAR-bestand uit.

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

    4. Noteer het poortnummer van de initialisatie-uitvoer in het opdrachtpromptvenster. In het volgende voorbeeld is de poort 8080.

      Een voorbeeld van de resultaten van het uitvoeren van het gegenereerde JAR-bestand. Het poortnummer dat moet worden gebruikt, wordt weergegeven.

Zorg dat het knooppunt en NPM op uw computer zijn geïnstalleerd voordat u deze taak uitvoert.

  1. Pak het bestand ProxyTunnelExamples.zip uit.

  2. Open PowerShell of de opdrachtprompt en ga naar de locatie van de Node.js-bestanden.

    cd ProxyTunnel/examples/Nodejs

  3. Voer deze opdracht uit vanuit de Nodejs-codemap:

    npm install

  4. Voer het eindpunt uit. Gebruik het commando voor het besturingssysteem dat u gebruikt.

    Linux:

    export DEBUG='javascriptechoproxy:server'
    npm run start

    Windows met Powershell: 

    npm run devstart

  5. Noteer het poortnummer van de initialisatie-uitvoer in het opdrachtpromptvenster. Het kan bijvoorbeeld 8080 zijn.

PHP moet op uw computer geïnstalleerd zijn om deze optie te kunnen gebruiken. Als PHP nog niet is geïnstalleerd, zijn er twee mogelijkheden om dit te installeren:

  • Gebruik Chocolatey, een hulpprogramma voor softwarebeheer. Dit is de voorkeursoptie.  Om PHP met Chocolatey te installeren, opent u Powershell als beheerder en voert u dit commando in:

    choco install php

  • Installeer PHP rechtstreeks vanaf de Windows PHP-website.

Nadat u PHP hebt geïnstalleerd, volgt u deze stappen om het proxytunnel-eindpunt in te stellen:

  1. Pak het bestand ProxyTunnel_PHP.zip uit.

  2. Gebruik PowerShell of de opdrachtprompt om naar de map \PHP te gaan.

    cd ProxyTunnel/examples/php

  3. Voer deze opdracht uit vanuit de PHP-map:

    php -S localhost:8000

    De toepassing wordt geïnitialiseerd en uitgevoerd op poort 8000. Onthoud dit poortnummer voor later gebruik in het installatieproces.

  1. Pak het bestand ProxyTunnelExamples.zip uit.

  2. Open in uw code-editor de map met de Python-proxytunnelcode.
  3. Gebruik de console van de code-editor om naar de map met het API-bestand te gaan.

  4. In het terminalvenster van uw code-editor of via de opdrachtprompt installeert u Flask op uw systeem met dit commando:

    pip install flask

  5. Gebruik dit commando om de proxytunnel uit te voeren:

    python echo-proxy-tunnel.py

    Noteer het poortnummer van de initialisatie-uitvoer in het terminalvenster. Onthoud dit poortnummer voor later gebruik in het installatieproces. In de volgende voorbeeldafbeelding is de poort 5000.

    Een voorbeeld van de uitvoer van de proxytunnel in Python. Het poortnummer in dit voorbeeld is 5000.

Het proxytunnel-eindpunt beschikbaar maken

Het proxytunnel-eindpunt moet beschikbaar worden gemaakt, zodat CXone globale toegang krijgt. Gebruik Ngrok om het eindpunt beschikbaar te maken.

  1. Installeer Ngrok, als u dat nog niet hebt gedaan.

  2. Start Ngrok met dit commando vanaf de opdrachtprompt:

    ngrok http [port number]

    waarbij [poortnummer] het poortnummer is dat u hebt genoteerd tijdens het configureren van het eindpunt.

  3. Kopieer de server-URL die door Ngrok beschikbaar wordt gemaakt en de vereiste API-eindpunten.

    Een voorbeeld van de resultaten van het uitvoeren van Ngrok op het proxytunnel-eindpunt, met de URL's die als gevolg hiervan beschikbaar worden gemaakt.

    In het voorbeeld is dit de beschikbaar gemaakte URL: https://4db3-5-46-62-207.nrgok.io. De is de basis-URL voor de webhook. Bepaal welk eindpunt u met uw URL wilt gebruiken. Sla de URL op om te gebruiken wanneer u de Studio-actie voor de tekstbot configureert in een latere taak.

    Taal Details eindpunt
    C#

    De server accepteert Virtuele Agent Hub-verzoeken via de POST proxy/performbotexchange-methode. Uw webhook-URL is:

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

    De server accepteert Virtuele Agent Hub-verzoeken via de POST api/proxy-methode. Uw webhook-URL is:

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

    De server accepteert Virtuele Agent Hub-verzoeken via de POST api/relay-methode. Uw webhook-URL is:

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

    De server accepteert Virtuele Agent Hub-verzoeken via de POST relayExchangeResponse-methode. Uw webhook-URL is:

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

    De server accepteert Virtuele Agent Hub-verzoeken via de POST proxy.php-methode. Uw webhook-URL is:

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

De stappen om het eindpunt te bepalen die in deze sectie worden beschreven, zijn alleen van toepassing op de voorbeeldintegratie. Wanneer u uw eigen eindpunt maakt, kan alles wat voldoet aan de behoeften van uw organisatie worden gebruikt.

Een eenvoudig chatscript configureren in Studio

  1. Download dit eenvoudige chatscript.
  2. Pak het bestand TextBotExchangeExample.xml uit op uw computer.
  3. Klik in Studio op Bestand > Importeren uit bestand, selecteer het uitgepakte bestand en klik op Openen.
  4. Sla het script op. Onthoud de naam die u aan het script geeft. Laat het script open. U hebt het in een latere taak weer nodig.

Een chatskill en een contactpunt maken in CXone

U moet een chatskillGesloten Skills worden gebruikt om de aanlevering van interacties te automatiseren op basis van de vaardigheden, capaciteiten en kennis van de agent en contactpuntGesloten Het toegangspunt dat een inbound contact gebruikt om een interactie te starten, zoals een telefoonnummer of e-mailadres. aanmaken. Het contactpunt roept het script aan dat u hebt geïmporteerd. Dit is de manier waarop CXone contacten naar uw virtuele agent routeert.

  1. Klik in CXone op de app-kiezer en selecteer ACD.
  2. Klik op Contactinstellingen > ACD-skills en maak een chatskill. U moet de skill een Naam geven en toewijzen aan een Campagne. Misschien moet u een campagne maken om te gebruiken voor de voorbeeldintegratie. U kunt de standaardinstellingen voor alle andere skill-opties accepteren.

  3. Ga naar Contactinstellingen > Contactpunten en maak een contactpunt met de volgende instellingen:

    • Mediatype: Selecteer Chat.
    • Script: Selecteer de naam van het script dat u hebt geïmporteerd om te gebruiken voor de voorbeeldintegratie.
    • Skill: Selecteer de naam van de skill die u in deze taak hebt gemaakt.

  4. Nadat u het contactpunt hebt gemaakt, kopieert u de Contactpunt-URL die wordt weergegeven op het tabblad Details. Plak deze URL in een tabblad in uw browser. U gebruikt deze URL in een latere taak om het script te testen.

    Het tabblad Details van het contactpunt dat is gemaakt om de voorbeeld-proxytunnel te testen. Het veld Contactpunt toont de URL die het script aanroept.

De TextBot Exchange-actie configureren

Deze stap configureert CXone om te communiceren met het proxytunnel-eindpunt.

  1. Open in Studio het voorbeeldscript dat u hebt geïmporteerd, als het niet al geopend is.

  2. Dubbelklik op een van de Textbot Exchange-acties om Virtuele Agent Hub te openen.

    Het pictogram voor de actie TextBot Exchange. Het is een chatbubbel met robotogen erin en een antenne bovenop met de tekens ABC eronder.
  3. Klik op Bot toevoegen.
  4. Voer een Naam voor virtuele agent (bot) in en selecteer Custom Exchange Endpoint als Bot provider.
  5. Klik op Volgende.
  6. Voer uw Webhook-URL in. Dit is de URL die u hebt opgeslagen nadat u het proxytunnel-eindpunt beschikbaar hebt gemaakt.
  7. Klik op Volgende.
  8. Selecteer op de pagina Spraak onder Opties voor spraakintegratie de optie Alleen tekst en klik op Volgende.
  9. Klik in de pagina Testen en toevoegen op Starten met welkomstintentie. Test eventueel ook andere opties, zoals het verzenden van aangepaste payloads. Als er geen fouten zijn, gaat u verder met de volgende taak. Als uw test fouten oplevert, controleert u de eerdere taken om de installatie en de beschikbaarstelling van het proxytunnel-eindpunt en de configuratie te verifiëren in Virtuele Agent Hub.

Het script testen vanuit een chatvenster

Wanneer u eventuele fouten hebt opgelost die zich voordeden tijdens het testen van de configuratie van de actie Textbot Exchange, kunt u het script testen met behulp van het contactpuntGesloten Het toegangspunt dat een inbound contact gebruikt om een interactie te starten, zoals een telefoonnummer of e-mailadres.-URL die u hebt gekopieerd in een vorige taak.

  1. Open in Studio het voorbeeldscript dat u hebt geïmporteerd.
  2. Klik op Debug > Script loggen > Alleen volgende instantie.
  3. Typ in het browsertabblad waarin u de contactpunt-URL hebt geplakt een bericht in het veld Voer de tekst in en klik op Verzenden.

  4. Het venster Trace-uitvoer wordt geopend in Studio. Het toont de voortgang van het script terwijl u berichten verzendt en het script reageert.

    Klik op een actie in het hoofdpaneel van het venster Trace Output .

    • Het tabblad Variabelen toont alle variabelen die in het script bestaan wanneer de geselecteerde actie is uitgevoerd. U ziet ook de waarde die elke variabele heeft op dat punt in het script.
    • Het tabblad Eigenschappen toont de eigenschappen van de geselecteerde actie. U kunt deze informatie gebruiken om de huidige configuratie van de actie te verifiëren.
    Het venster Trace-uitvoer in Studio met de trace-resultaten van het begin van het voorbeeldscript voor een virtuele agent-chatbot.
  5. Ga terug naar het script en breng eventueel wijzigingen aan.
  6. Als u de online Help voor een actie wilt openen, selecteert u deze op het canvas en drukt u op F1 op uw toetsenbord. De online Help-pagina's voor de acties beschrijven de eigenschappen en andere informatie over het gebruik van de acties in een script.
  7. Als u opnieuw wilt beginnen, klikt u op Chat beëindigen, vernieuwt u het browservenster en herhaalt u het proces vanaf stap 2.