Aangepaste Payload-snippet

De informatie op deze helppagina is zowel van toepassing op Studio als op Desktop Studio.

Het fragmentAangepaste payload is vereist in uw script wanneer u acties gebruikt die de eigenschap customPayload hebben, zoals Voicebot Exchange of Textbot Conversation. Deze wordt gebruikt om data van CXone Mpower door te geven aan uw virtuele agentGesloten Een softwareapplicatie die klantinteracties afhandelt in plaats van een live (menselijke) agent.-provider. Wanneer u aangepaste data van uw virtuele agent wilt ontvangen, gebruikt u de customPayloadVarName (out)-variabele. Gebruik de informatie op deze pagina om het Custom Payload-fragment te maken dat voldoet aan de vereisten van de virtuele agentimplementatie van uw organisatie.

Deze snippet is vereist voor de volgende virtuele agents:

Bij alle andere virtuele agents hoeft u alleen de snippet op te nemen wanneer u aangepaste payloaddata heeft die aan de bot moeten worden doorgegeven. Wanneer u Dialogflow CX gebruikt, volgt u best practices voor het integreren van aangepaste payloads. Als u geen aangepast payload-fragment opneemt, zorg er dan voor dat u een tijdelijke aanduidingparameter doorgeeft.

Plaatshouder doorgeven

Als u een virtuele agent gebruikt waaraan geen informatie hoeft te worden doorgegeven, zoals Amazon Lex V2 of Amazon Lex V1, volgt u dit voorbeeld:

DYNAMIC customPayload 
 customPayload.placeholder=""

Data doorgeven

Volg dit voorbeeld voor alle virtuele-agentproviders die informatie aan de virtuele agent moeten doorgeven. Vervang de parameters in het voorbeeld door de informatie die u wilt doorgeven.

DYNAMIC customPayload
ASSIGN customPayload.context.id="information"
ASSIGN customPayload.context.lifespan=1
ASSIGN customPayload.context.parameters.name="Fenrir"
ASSIGN customPayload.context.parameters.age="19"
ASSIGN customPayload.context.parameters.date="20201020"			

Google Dialogflow CX Aangepaste payload

  • Dialogflow CX gebruikt geen contexten om gegevens door te geven aan Dialogflow-intentiesGesloten De betekenis of het doel achter hetgeen een contact zegt of typt; datgene wat de klant wil communiceren of bereiken.., in tegenstelling tot Dialogflow ES.
  • U kunt aangepaste gegevens aan Dialogflow CX doorgeven met behulp van JSON sleutel/waarde-paren. Maak een dynamisch customPayload-object in een Snippet-actionactie in uw script en voeg daar de sleutel/waardeparen aan toe. Bijvoorbeeld:

    DYNAMIC customPayload
    customPayload.ani = ani
    customPayload.contactID = contactId
    customPayload.masterContactId = masterId
    customPayloadJSON = "{customPayload.asJSON()}"	
  • Configureer in de actie Exchange in uw script de eigenschap customPayload met een variabele die de functie asJSON() in zijn waarde heeft. U vindt deze waarde in het customPayload-object.
  • Geef de customPayload-JSON door aan de virtuele agent via de Payload-eigenschap van QueryParameters. Zie de Google-documentatie over QueryParameters Een vierkant met een pijl die uit het midden naar de rechterbovenhoek wijst. voor Google Dialogflow CX.
  • Gegevens die via QueryParameters worden doorgegeven, worden ontvangen door een Webhook in Dialogflow CX. U kunt in de Dialogflow CX-console code schrijven om de doorgegeven gegevens te verwerken.
  • Nest geen objecten binnen het customPayload-object. Geneste objecten worden verzonden als letterlijke strings.
  • Om aangepaste gegevens van uw virtuele Dialogflow CX-agent te retourneren naar het script, gebruikt u het veld Aangepaste payload in de Dialogflow CX-console. Zorg dat u zich bevindt in de console voor de virtuele agent die u gebruikt met CXone Mpower. Koppel dit aan uw script met behulp van de variabele customPayloadVarName (out) in de actie VOICEBOT EXCHANGE  of TEXTBOT EXCHANGE Studio in uw script. U kunt dit bijvoorbeeld gebruiken om het gedrag van de volgende prompt in te stellen.
  • Als u aangepaste gegevens vanuit het script naar Dialogflow CX wilt doorgeven, gebruikt u session_params in het customPayload-object in een Snippet-actie. Bijvoorbeeld:

    DYNAMIC customPayload
    customPayload.session_params.name = "Winnie le Pooh" 
    customPayload.session_params.job = "Food critic" 
    customPayload.session_params.location = "Hundred Acre Wood"	

    U krijgt toegang tot de sessieparameters in de Dialogflow CX-agentintentie met behulp van de volgende syntax:

    $session.params.name = Winnie Le Pooh
    $session.params.job = Food critic
    $session.params.location = 100 Acre Wood
                    

    Sessieparameters worden alleen gebruikt met virtuele Dialogflow CX-agents. U gebruikt contexten om een vergelijkbaar resultaat te bereiken met Dialogflow ES.

  • Configureer hints voor spraakcontext en een aangepaste gespreks-IDom het gesprek over te dragen naar een andere Dialogflow virtuele CX-agent in het aangepaste payload-fragment.

  • Als u VOICEBOT EXCHANGE gebruikt: Voeg de parametermaxPostEnergySilenceMS toe aan de Next Prompt Behaviors-actie Default Next Prompt Behaviors of Snippet om te bepalen hoelang de virtuele agent moet wachten wanneer het contact stil is tijdens het gesprek.

Spraakcontexthints voorDialogflow CX

Spraakcontexthints kunnen worden doorgegeven in het fragment Custom Payload in de parameter speechContexts. De waarde van speechContexts.phrases moet een Google-klassetoken Een vierkant met een pijl die uit het midden naar de rechterbovenhoek wijst. zijn voor de hint die u wilt geven. Het token moet overeenkomen met de taal en de landinstellingen van uw contacten. Bijvoorbeeld:

DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10		

Configureer deze parameters als volgt:

  • speechContexts.phrases: De Google-klassetoken Een vierkant met een pijl die uit het midden naar de rechterbovenhoek wijst. voor de hint die u wilt geven. Het token moet overeenkomen met de taal en de landinstellingen van uw contacten. Als u meerdere tokens wilt toevoegen, voeg dan voor elk token een speechContexts.phrases-parameter toe.
  • speechContexts.boost: Een gewogen numerieke waarde tussen 1-20 voor de gespecificeerde phrase. De transcriptieservice gebruikt deze waarde bij het selecteren van een mogelijke transcriptie voor woorden in de audiogegevens. Hoe hoger de waarde, hoe hoger de waarschijnlijkheid dat de transcriptieservice dat woord of die woordgroep kiest uit de alternatieven.

U kunt de inhoud van deze parameter terugzien in Studio-traces en applicatielogs.

Contacten overdragen tussen Dialogflow CX virtuele agenten

Om het overdragen van een contactpersoon van de ene Dialogflow virtuele CX-agent naar de andere Dialogflow virtuele CX-agent in te stellen, neemt u de volgende regel op in het fragment Custom Payload. Vervang custom_value door de variabelenaam die de conversatie-ID bevat:

{
  “cxone_override_conversation“: {custom_value} 
}		

Zorg ervoor dat u uw script zo instelt dat de variabele die u gebruikt, wordt ingevuld met deze parameter.

Uw script moet zorgvuldig worden opgezet, zodat de

De parameter cxone_override_conversation is vergelijkbaar met de botsessiestatus-ID die is ingesteld in de Botsessiestatus snippet. Beide helpen de virtuele agent om de context van het gesprek tussen de beurten door te behouden. Uw script moet zorgvuldig worden ingesteld, zodat de sessiestatus-ID en conversatie-ID-waarden van de bot op de juiste locaties worden weergegeven. De sessiestatus van de bot heeft altijd voorrang op de parameter cxone_override_conversation. Stel uw script als volgt in:

Virtuele agent # Draai # Configuratie
1 1 De eigenschap botSessionState van de actie Voicebot EXCHANGEof Textbot EXCHANGE is leeg. De beurt retourneert een botsessiestatus-ID en vult botSessionStateVarName (out)in. Dit is botsessiestatus-ID #1.

1

2 en later beurten met deze virtuele agent Het script stuurt de botsessiestatus-ID #1 naar de Dialogflow CX virtuele agent #1. Dezelfde ID wordt naar het script geretourneerd.
2 3 (eerste met deze virtuele agent)

De eigenschap botSessionState van de actie Voicebot EXCHANGEof Textbot EXCHANGE is leeg.

Het aangepaste payload-fragment voor deze beurt bevat cxone_override_conversation = [variable].

De beurt retourneert een unieke botsessiestatus-ID en vult botSessionStateVarName (out)in, waardoor alle waarden die het al bevat, worden overschreven. Dit is botsessiestatus-ID #2.

2 4 (tweede beurt met deze virtuele agent) Het script stuurt de botsessiestatus-ID #2 naar de Dialogflow CX virtuele agent #2. Dezelfde ID wordt naar het script geretourneerd.

Als u meer dan twee exemplaren van Dialogflow CX gebruikt, blijft het patroon zoals in de voorgaande tabel is vastgelegd.

Deze methode voor overdracht tussen virtuele agenten is alleen vereist bij overdracht tussen twee of meer Dialogflow CX virtuele agenten. Als u overstapt tussen andere virtuele agentproviders, kunt u deBotsessiestatus-IDgebruiken.

Google Dialogflow ES Aangepaste payload

  • CustomPayload wordt gebruikt om context door te geven voor een intentieGesloten De betekenis of het doel achter hetgeen een contact zegt of typt; datgene wat de klant wil communiceren of bereiken... De context helpt de virtuele agent om de intentie van de gebruiker te begrijpen. Contextgegevens zijn niet vereist, maar ze helpen de virtuele agent om een uitingGesloten Iets wat een contact zegt of typt. te koppelen aan een intentie.
  • Maak in een Snippet -actie in uw script een customPayload-object volgens de indeling die is beschreven in de Google Dialogflow ES-documentatie Pictogram dat een link naar een externe website aanduidt voor REST Resource: projects.agent.sessions.context. De online help voor Studio biedt extra informatie over dynamische gegevensobjecten.
  • U kunt ook aangepaste gegevens zonder contextgegevens doorgeven met customPayload. Voeg hiervoor standaard JSON sleutel/waarde-paren toe aan een dynamisch gegevensobject.
  • Spraakcontexten worden als aangepaste payload doorgegeven in de parameter speech_contact. U kunt de inhoud van deze parameter terugzien in Studio-traces en applicatielogs.
  • Het dynamische customPayload-object wordt als virtual-agentparameter doorgegeven met JSON-indeling, zoals in het voorbeeldscript.
  • Configureer spraakcontexthints in het aangepaste payload-fragment.

Spraakcontexthints voor DialogflowES

Spraakcontexthints kunnen worden doorgegeven in het fragment Custom Payload in de parameter speechContexts. De waarde van speechContexts.phrases moet een Google-klassetoken Een vierkant met een pijl die uit het midden naar de rechterbovenhoek wijst. zijn voor de hint die u wilt geven. Het token moet overeenkomen met de taal en de landinstellingen van uw contacten. Bijvoorbeeld:

DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10		

Configureer deze parameters als volgt:

  • speechContexts.phrases: De Google-klassetoken Een vierkant met een pijl die uit het midden naar de rechterbovenhoek wijst. voor de hint die u wilt geven. Het token moet overeenkomen met de taal en de landinstellingen van uw contacten. Als u meerdere tokens wilt toevoegen, voeg dan voor elk token een speechContexts.phrases-parameter toe.
  • speechContexts.boost: Een gewogen numerieke waarde tussen 1-20 voor de gespecificeerde phrase. De transcriptieservice gebruikt deze waarde bij het selecteren van een mogelijke transcriptie voor woorden in de audiogegevens. Hoe hoger de waarde, hoe hoger de waarschijnlijkheid dat de transcriptieservice dat woord of die woordgroep kiest uit de alternatieven.

U kunt de inhoud van deze parameter terugzien in Studio-traces en applicatielogs.