"Benutzerdefinierte Nutzlast"-Snippet

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

Verwenden Sie dieses Snippet mit Aktionen, die die Eigenschaft customPayload haben, wie Voicebot Exchange oder Textbot Conversation. Es wird verwendet, um Daten von CXone 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).

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.

Einen Platzhalter weitergeben

Wenn Sie Amazon Lex V1 oder Amazon Lex V2 verwenden und keine Informationen an den virtuellen Agenten übergeben müssen, folgen Sie diesem Beispiel:

DYNAMIC customPayload 
 customPayload.placeholder=""

Wenn Informationen an den virtuellen Agenten übergeben werden müssen, folgen Sie dem Beispiel im nächsten Abschnitt.

Daten weitergeben

Folgen Sie für alle Anbieter virtueller Agenten diesem Beispiel, um Informationen an den virtuellen Agenten zu übergeben. Ersetzen Sie die Parameter im Beispiel mit den Informationen, die Sie weitergeben müssen.


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

Beste Vorgehensweisen für 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- oder Conversation-Aktion in Ihrem Skript die customPayload-Eigenschaft mit einer Variablen, die die asJSON()-Funktion in ihrem Wert enthält. 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 verwenden. Ordnen Sie dies Ihrem Skript zu, indem Sie die Variable customPayloadVarName (out) in der voice- oder chat-Studio-Aktion in Ihrem Skript verwenden. Damit können Sie zum Beispiel das Verhalten der nächsten Eingabeaufforderung festlegen.
Parameter, die mithilfe von customPayload festgelegt werden, können nur im externen Webhook verwendet werden. Wenn Sie Parameter festlegen möchten, die außerhalb des externen Webhook verwendet werden sollen, legen Sie sie in einer Snippet-Aktion mit dem session_params-Feld fest. Beispiel:
```
{
	"session_params":
	{ 
		"name": "Winnie Le Pooh"
		"job": "Food critic"
		"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.
Hinweise zum Sprachkontext können mit der eigenen Payload im Parameter speechContexts weitergegeben werden. Der Wert von speechContexts.phrases muss ein Google Klassen-Token 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		
```
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 Next Prompt Behaviors- oder Default Next Prompt Behaviors Snippet-Aktion den maxPostEnergySilenceMS Parameter hinzu.

Beste Vorgehensweisen für 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.
Hinweise zum Sprachkontext können mit der eigenen Payload im Parameter speechContexts weitergegeben werden. Der Wert von speechContexts.phrases muss ein Google Klassen-Token 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		
```