"Benutzerdefinierte Nutzlast"-Snippet

Die Informationen auf dieser Hilfeseite gelten für Studio und Desktop Studio.

Das SnippetBenutzerdefinierte Nutzlast ist in Ihrem Skript erforderlich, wenn Sie Aktionen verwenden, die über die Eigenschaft customPayload verfügen, wie beispielsweise Voicebot Exchange oder Textbot Conversation. Es wird verwendet, um Daten von CXone Mpower zu Ihremvirtuellen Agenten Eine Softwareanwendung, die Kundeninteraktionen anstelle eines Live-Mitarbeiters abwickelt.-Anbieter weiterzugeben. Wenn Sie benutzerdefinierte Daten von Ihrem virtuellen Agenten empfangen müssen, verwenden Sie die Variable customPayloadVarName (out). Verwenden Sie die Informationen auf dieser Seite, um das Snippet Benutzerdefinierte Payload zu erstellen, das die Anforderungen der virtuellen Agentenimplementierung Ihres Unternehmens erfüllt.

Dieses Snippet ist für die folgenden virtuellen Agenten erforderlich:

Amazon Lex V1 und Amazon Lex V2: Das Snippet Custom Payload ist für Lex V1 und Lex V2 erforderlich, auch wenn keine Daten an den virtuellen Agenten übergeben werden müssen. Der virtuelle Agent verwendet die Daten, die über die customPayload -Eigenschaft übergeben werden, um die SessionAttributes-Eigenschaft auf der Seite von Amazon auszufüllen.
Google Dialogflow ES: Die eigene Payload übergibt Kontextinformationen, die der Dialogflow virtuelle Agent von ES verwendet, um die Absicht Die Bedeutung oder der Zweck hinter dem, was ein Kontakt sagt/tippt; was der Kontakt mitteilen oder erreichen möchte. zu bestimmen. Befolgen Sie die empfohlenen Best Practices für die Integration von benutzerdefinierten Nutzdaten mit Google Dialogflow ES.

Für alle anderen virtuellen Agenten müssen Sie das Snippet nur einbeziehen, wenn benutzerdefinierte Nutzlastdaten zum Bot weitergegeben werden müssen. Wenn Sie Dialogflow CX verwenden, folgen Sie den empfohlenen Verfahren für das Einbeziehen der benutzerdefinierten Nutzlastdaten. Wenn Sie kein benutzerdefiniertes Payload-Snippet einschließen, müssen Sie unbedingt einen Platzhalterparameter übergeben.

Einen Platzhalter weitergeben

Wenn Sie einen virtuellen Agenten verwenden, an den keine Informationen übergeben werden müssen, wie z. B. Amazon Lex V2 oder Amazon Lex V1, folgen Sie diesem Beispiel:

DYNAMIC customPayload 
 customPayload.placeholder=""

Daten weitergeben

Befolgen Sie dieses Beispiel für alle Anbieter virtueller Agenten, die Informationen an den virtuellen Agenten weitergeben müssen. Ersetzen Sie die Parameter im Beispiel mit den Informationen, die Sie weitergeben müssen.

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 Benutzerdefinierte Nutzlast

Dialogflow CX verwendet keine Kontexte, um Daten an Dialogflow intents Die Bedeutung oder der Zweck hinter dem, was ein Kontakt sagt/tippt; was der Kontakt mitteilen oder erreichen möchte. zu übergeben, wie es DialogflowES tut.
Sie können benutzerdefinierte Daten unter Verwendung von JSON-Schlüssel-Wert-Paaren an Dialogflow CX übergeben. Erstellen Sie in einer Snippet action -Aktion in Ihrem Skript ein dynamisches customPayload-Objekt und fügen Sie ihm die Schlüssel-Wert-Paare hinzu. Beispiel:
```
DYNAMIC customPayload
customPayload.ani = ani
customPayload.contactID = contactId
customPayload.masterContactId = masterId
customPayloadJSON = "{customPayload.asJSON()}"	
```
Konfigurieren Sie in der Exchange Aktion in Ihrem Skript die customPayload-Eigenschaft mit einer Variable, die die asJSON()-Funktion in ihrem Wert hat. Sie finden diese Variable im customPayload-Objekt.
Übergeben Sie customPayload-JSON mit der Payload-Eigenschaft von QueryParameters an den virtuellen Agenten. Lesen Sie die Google-Dokumentation zu Abfrageparametern für Google Dialogflow CX.
Die über QueryParameters übergebenen Daten werden von einem Webhook in Dialogflow CX empfangen. Sie können Code in der Dialogflow CX-Konsole schreiben, um die übergebenen Daten zu verarbeiten.
Verschachteln Sie kein Objekt in dem customPayload-Objekt. Verschachtelte Objekte werden als buchstäbliche Zeichenfolgen gesendet.
Um eigene Daten von Ihrem virtuellen Dialogflow CX-Agenten an das Skript zurückzugeben, verwenden Sie das Feld Benutzerdefinierte Nutzdaten in der Dialogflow CX-Konsole. Stellen Sie sicher, dass Sie sich in der Konsole für den virtuellen Agenten befinden, den Sie mit CXone Mpower verwenden. Ordnen Sie dies Ihrem Skript zu, indem Sie die Variable customPayloadVarName (out) in der Aktion VOICEBOT EXCHANGE oder TEXTBOT EXCHANGE Studio in Ihrem Skript verwenden. Damit können Sie zum Beispiel das Verhalten der nächsten Eingabeaufforderung festlegen.
Um benutzerdefinierte Daten aus dem Skript an Dialogflow CX zu übergeben, verwenden Sie session_params im customPayload-Objekt in einer Snippet-Aktion. Beispiel:
```
DYNAMIC customPayload
customPayload.session_params.name = "Winnie le Pooh" 
customPayload.session_params.job = "Food critic" 
customPayload.session_params.location = "Hundred Acre Wood"	
```
Greifen Sie mit der folgenden Syntax auf die Sitzungsparameter in der Absicht des Dialogflow CX-Agenten zu:
```
$session.params.name = Winnie Le Pooh
$session.params.job = Food critic
$session.params.location = 100 Acre Wood
                
```
Sitzungsparameter werden nur mit virtuellen Dialogflow CX-Agenten verwendet. Verwenden Sie Kontexte, um ein ähnliches Ergebnis mit Dialogflow ES zu erzielen.
Konfigurieren Sie Sprachkontexthinweise und eine benutzerdefinierte Konversations-ID, um die Konversation an einen anderen Dialogflowvirtuellen CX-Agenten im Snippet Benutzerdefinierte Payloadzu übertragen.
Bei Verwendung von VOICEBOT EXCHANGE: Um festzulegen, wie lange der virtuelle Agent wartet, wenn der Kontakt beim Sprechen eine Pause macht, fügen Sie der - oder maxPostEnergySilenceMS-Aktion den Next Prompt Behaviors Default Next Prompt BehaviorsParameterSnippet hinzu.

Sprachkontexthinweise fürDialogflow CX

Hinweise zum Sprachkontext können im Snippet Benutzerdefinierte Nutzlast im Parameter speechContexts übergeben werden. Der Wert von speechContexts.phrases muss ein Google Klassen-Token Ein Kästchen mit einem Pfeil, der von der Mitte aus nach oben rechts weist. für den Hinweis sein, den Sie geben möchten. Das Token muss der Sprache und dem Gebietsschema Ihrer Kontakte entsprechen. Beispiel:

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

Konfigurieren Sie diese Parameter wie folgt:

speechContexts.phrases: Das Google Klassen-Token für den Hinweis, den Sie geben möchten. Das Token muss der Sprache und dem Gebietsschema Ihrer Kontakte entsprechen. Wenn Sie mehrere Tokens hinzufügen möchten, fügen Sie einen speechContexts.phrases-Parameter für jedes Token hinzu.
speechContexts.boost: Einen gewichteten nummerischen Wert zwischen 1-20 für die angegebene phrase. Der Transkriptionsdienst verwendet diesen Wert bei der Auswahl einer möglichen Transkription für Wörter in den Audiodaten. Je höher der Wert desto größer die Wahrscheinlichkeit, dass der Transkriptionsdienst dieses Wort oder diese Phrase aus den Alternativen auswählt.

Sie können die Inhalte dieses Parameters in Studio -Traces und Anwendungsprotokollen sehen.

Übertragen Sie Kontakte zwischen Dialogflow virtuellen CX-Agenten

Um die Übertragung eines Kontakts von einem Dialogflow virtuellen CX-Agenten zu einem anderen Dialogflow virtuellen CX-Agenten einzurichten, fügen Sie die folgende Zeile in das Snippet Benutzerdefinierte Nutzlast ein. Ersetzen Sie custom_value durch den Variablennamen, der die Konversations-ID enthält:

{
  “cxone_override_conversation“: {custom_value} 
}

Stellen Sie sicher, dass Ihr Skript so eingerichtet ist, dass die von Ihnen verwendete Variable mit diesem Parameter gefüllt wird.

Ihr Skript muss sorgfältig eingerichtet werden, damit die

Der Parameter cxone_override_conversation ähnelt der Bot-Sitzungsstatus-ID, die im Bot-Sitzungsstatus Snippetfestgelegt wurde. Beides hilft dem virtuellen Agenten, den Kontext des Gesprächs zwischen den Gesprächsrunden beizubehalten. Ihr Skript muss sorgfältig eingerichtet werden, damit die Werte für die Bot-Sitzungsstatus-ID und die Konversations-ID an den richtigen Stellen angezeigt werden. Der Bot-Sitzungsstatus hat immer Vorrang vor dem Parameter cxone_override_conversation. Richten Sie Ihr Skript wie folgt ein:

Virtueller Agent #	Drehen #	Konfiguration
1	1	Die Eigenschaft botSessionState der Aktion Voicebot EXCHANGEoder Textbot EXCHANGE ist leer. Der Turn gibt eine Bot-Sitzungsstatus-ID zurück und füllt botSessionStateVarName (out). Dies ist die Bot-Sitzungsstatus-ID Nr. 1.
1	2 und spätere Runden mit diesem virtuellen Agenten	Das Skript sendet die Bot-Sitzungsstatus-ID Nr. 1 an den Dialogflow virtuellen CX-Agenten Nr. 1. Dieselbe ID wird an das Skript zurückgegeben.
2	3 (erster mit diesem virtuellen Agenten)	Die Eigenschaft botSessionState der Aktion Voicebot EXCHANGEoder Textbot EXCHANGE ist leer. Der benutzerdefinierte Payload-Ausschnitt für diese Runde enthält cxone_override_conversation = [variable]. Der Turn gibt eine eindeutige Bot-Sitzungsstatus-ID zurück und füllt botSessionStateVarName (out)aus, wobei alle bereits enthaltenen Werte überschrieben werden. Dies ist die Bot-Sitzungsstatus-ID Nr. 2.
2	4 (zweiter Zug mit diesem virtuellen Agenten)	Das Skript sendet die Bot-Sitzungsstatus-ID Nr. 2 an den Dialogflow virtuellen CX-Agenten Nr. 2. Dieselbe ID wird an das Skript zurückgegeben.

Wenn Sie mehr als zwei Instanzen von Dialogflow CX verwenden, wird das Muster wie in der vorhergehenden Tabelle festgelegt fortgesetzt.

Diese Methode der Übertragung zwischen virtuellen Agenten ist nur bei der Übertragung zwischen zwei oder mehr Dialogflow virtuellen CX-Agenten erforderlich. Wenn Sie zwischen anderen Anbietern virtueller Agenten wechseln, können Sie dieBot-Sitzungsstatus-IDverwenden.

Google Dialogflow ES Benutzerdefinierte Nutzlast

CustomPayload wird verwendet, um den Kontext für eine Absicht Die Bedeutung oder der Zweck hinter dem, was ein Kontakt sagt/tippt; was der Kontakt mitteilen oder erreichen möchte. zu übergeben. Der Kontext hilft dem virtuellen Agenten, die Absicht des Benutzers zu verstehen. Kontexte sind nicht erforderlich, aber sie helfen dem virtuellen Agenten, eine Äußerung Was ein Kontakt sagt oder tippt. einer Absicht zuzuordnen.
Erstellen Sie in einer Snippet -Aktion in Ihrem Skript ein customPayload-Objekt mit dem Format gemäß Google Dialogflow ES-Dokumentation für die REST-Ressource: projects.agent.sessions.context. Die Onlinehilfe für Studio enthält weitere Informationen über dynamische Datenobjekte.
Sie können auch benutzerdefinierte Daten mit customPayload ohne Kontexte übergeben. Fügen Sie dazu standardmäßige JSON-Schlüssel-Wert-Paare in ein dynamisches Objekt ein.
Sprachkontexte werden in eigener Payload zum speech_contact-Parameter hinzugefügt. Sie können die Inhalte dieses Parameters in Studio-Traces und Anwendungsprotokollen sehen.
Das dynamische customPayload-Objekt wird als Parameter für den virtuellen Agenten in Form von JSON übergeben, wie im Beispielskript gezeigt.
Konfigurieren Sie Sprachkontexthinweise im Snippet Benutzerdefinierte Nutzlast .

Sprachkontexthinweise für DialogflowES

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

Konfigurieren Sie diese Parameter wie folgt:

speechContexts.phrases: Das Google Klassen-Token für den Hinweis, den Sie geben möchten. Das Token muss der Sprache und dem Gebietsschema Ihrer Kontakte entsprechen. Wenn Sie mehrere Tokens hinzufügen möchten, fügen Sie einen speechContexts.phrases-Parameter für jedes Token hinzu.
speechContexts.boost: Einen gewichteten nummerischen Wert zwischen 1-20 für die angegebene phrase. Der Transkriptionsdienst verwendet diesen Wert bei der Auswahl einer möglichen Transkription für Wörter in den Audiodaten. Je höher der Wert desto größer die Wahrscheinlichkeit, dass der Transkriptionsdienst dieses Wort oder diese Phrase aus den Alternativen auswählt.

Sie können die Inhalte dieses Parameters in Studio -Traces und Anwendungsprotokollen sehen.