Extrait de code de charge utile personnalisée

Les informations contenues dans cette page d’aide s’appliquent à la fois à CXone Studio et à Desktop Studio.

Utilisez cet extrait de code avec les actions qui ont la propriété customPayload, telles que Voicebot Exchange ou Textbot Conversation. Il est utilisé pour transmettre des données de CXone à votre fournisseur d’agent virtuel Une application logicielle qui traite les interactions avec les clients à la place d’un agent en chair et en os.. Si vous devez recevoir des données personnalisées de votre agent virtuel, utilisez la variable customPayloadVarName (out).

Cet extrait de code est nécessaire pour les agents virtuels suivants :

Amazon Lex V1 et Amazon Lex V2 : L’extrait de code Charge utile personnalisée est requis pour Lex V1 et Lex V2, même si vous n’avez pas besoin de transmettre des données à l’agent virtuel. L’agent virtuel utilise les données transmises par la propriété customPayload pour remplir la propriété SessionAttributes du côté Amazon.
Google Dialogflow ES : La charge utile personnalisée transmet des informations contextuelles que l’agent virtuel Dialogflow ES utilise pour déterminer l’intention La signification ou le but derrière ce qu’un contact dit/tape ; ce que le contact veut communiquer ou accomplir. Suivre les bonnes pratiques recommandées pour intégrer des données de charge utile personnalisées avec Google Dialogflow ES.

Pour tous les autres agents virtuels, vous ne devez inclure l’extrait que si vous avez des données personnalisées à transmettre au bot. Si vous utilisez Dialogflow CX, suivez les meilleures pratiques pour inclure une charge utile personnalisée.

Transmettre un espace réservé

Si vous utilisez Amazon Lex V1 ou Amazon Lex V2 et que vous n’avez pas besoin de transmettre des informations à l’agent virtuel, suivez cet exemple :

DYNAMIC customPayload 
 customPayload.placeholder=""

Si vous devez transmettre des informations à l’agent virtuel, suivez l’exemple de la section suivante.

Transmettre des données

Pour tous les fournisseurs d’agents virtuels, suivez cet exemple pour transmettre des informations à l’agent virtuel. Remplacez les paramètres de l’exemple par les informations que vous devez transmettre.


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

Meilleures pratiques pour la charge utile personnalisée Google Dialogflow CX

Dialogflow CX n’utilise pas de contextes pour transmettre des données aux Dialogflowintentions La signification ou le but derrière ce qu’un contact dit/tape ; ce que le contact veut communiquer ou accomplir commeDialogflowES.
Vous pouvez transmettre des données personnalisées à Dialogflow CX utilisant des paires clé-valeur JSON. Dans une action Snippet action de votre script, créez un objet customPayload dynamique et ajoutez-y les paires clé-valeur. Par exemple :
```
DYNAMIC customPayload
customPayload.ani = ani
customPayload.contactID = contactId
customPayload.masterContactId = masterId
customPayloadJSON = "{customPayload.asJSON()}"	
```
Dans l’action Exchange ou Conversation de votre script, configurez la propriété customPayload avec une variable qui a la fonction asJSON() dans sa valeur. Vous trouverez cette variable dans l’objet customPayload.
Transmettez JSON customPayload à l’agent virtuel en utilisant la propriété Payload de QueryParameters. Consultez la documentation SECRET concernant les paramètres QueryParameters pour Google Dialogflow CX.
Les données transmises via QueryParameters sont reçues par un webhook dans Dialogflow CX. Vous pouvez écrire du code dans le Dialogflow Console CX pour gérer les données transmises.
N’imbriquez pas d’objet dans l’objet customPayload. Les objets imbriqués sont envoyés sous forme de chaînes littérales.
Pour transmettre des données personnalisées de votre agent virtuel Dialogflow CX au script, utilisez le champ Charge utile personnalisée dans la console Dialogflow CX. Assurez-vous que vous êtes dans la console de l’agent virtuel que vous utilisez avec CXone. Mappez cela dans votre script en utilisant la variable customPayloadVarName (out) dans l’action voix ou clavardage Studio de votre script. Par exemple, vous pouvez l’utiliser pour définir les comportements de l’invite suivante.
Les paramètres définis en utilisant customPayload ne peuvent être utilisés que dans le webhook externe. Si vous souhaitez définir des paramètres à utiliser en dehors du webhook externe, définissez-les dans une action Snippet avec le champ session_params. Par exemple :
```
{
	"session_params":
	{ 
		"name": "Winnie Le Pooh"
		"job": "Food critic"
		"location": "Hundred Acre Wood"
	}
}
```
Accédez aux paramètres de session dans l’intention de l’agent CX Dialogflow à l’aide de la syntaxe suivante :

$session.params.name = Winnie Le Pooh

$session.params.job = Food critic

$session.params.location = 100 Acre Wood

Les paramètres de session ne sont utilisés qu’avec les agents virtuels Dialogflow CX. Pour obtenir un résultat similaire avec Dialogflow ES, utilisez des contextes.
Les indices de contexte vocal peuvent être transmis avec une charge utile personnalisée dans le paramètre speechContexts. La valeur de speechContexts.phrases doit être un jeton de classe SECRET pour l’indice que vous voulez donner. Le jeton doit correspondre à la langue et aux paramètres régionaux de vos contacts. Par exemple :
```
DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10		
```
Lorsque vous utilisez VOICEBOT EXCHANGE : Pour configurer la durée d’attente de l’agent virtuel lorsque le contact fait une pause endant qu’il parle, ajoutez le paramètre maxPostEnergySilenceMS à l’action Next Prompt Behaviors ou Default Next Prompt Behaviors Snippet.

Meilleures pratiques pour la charge utile personnalisée Google Dialogflow ES

CustomPayload est utilisé pour transmettre le contexte d’une intention La signification ou le but derrière ce qu’un contact dit/tape ; ce que le contact veut communiquer ou accomplir. Le contexte aide l’agent virtuel à comprendre l’intention de l’utilisateur. Les contextes ne sont pas nécessaires, mais ils aident l’agent virtuel à faire correspondre un énoncé Ce qu’un contact dit ou tape. à une intention.
Dans une action Snippet de votre script, créez un objet customPayload qui suit le format décrit dans la documentation Google Dialogflow ES pour REST Resource : projects.agent.sessions.context. L’aide en ligne Studio fournit des informations supplémentaires sur les objets de données dynamiques.
Vous pouvez également transmettre des données personnalisées à customPayload sans contexte. Pour ce faire, incluez des paires clé-valeur JSON standards dans un objet de données dynamiques.
Les contextes vocaux sont transmis dans la charge utile personnalisée dans le paramètre speech_contact. Le contenu de ce paramètre est visible dans les traces Studio et les journaux de l’application.
L’objet dynamique customPayload est transmis en tant que paramètre d’agent virtuel au format JSON, comme le montre l’exemple de script.
Les indices de contexte vocal peuvent être transmis avec une charge utile personnalisée dans le paramètre speechContexts. La valeur de speechContexts.phrases doit être un jeton de classe SECRET pour l’indice que vous voulez donner. Le jeton doit correspondre à la langue et aux paramètres régionaux de vos contacts. Par exemple :
```
DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10		
```