Extrait de code de charge utile personnalisée

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

L'extrait de codeCustom Payload est requis dans votre script lorsque vous utilisez des actions qui ont la propriété customPayload, comme Voicebot Exchange ou Textbot Conversation. Il est utilisé pour transmettre des données de CXone Mpower à votre fournisseur d’agent virtuelFermé 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). Utilisez les informations de cette page pour créer l'extrait de code Charge utile personnalisée qui répond aux exigences de l'implémentation de l'agent virtuel de votre organisation.

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

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. Si vous n'incluez pas d'extrait de charge utile personnalisé, assurez-vous de transmettre un paramètre d'espace réservé.

Transmettre un espace réservé

Si vous utilisez un agent virtuel qui n'a pas besoin de recevoir d'informations, comme Amazon Lex V2 ou Amazon Lex V1, suivez cet exemple :

DYNAMIC customPayload 
 customPayload.placeholder=""

Transmettre des données

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

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 Charge utile personnalisée

  • Dialogflow CX n’utilise pas de contextes pour transmettre des données aux DialogflowintentionsFermé 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 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 Google concernant les paramètres QueryParameters Un carré avec une flèche pointant du centre vers le coin supérieur droit. 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 Mpower. Associez ceci à votre script en utilisant la variable customPayloadVarName (out) dans l'action VOICEBOT EXCHANGE  ou TEXTBOT EXCHANGE Studio dans votre script. Par exemple, vous pouvez l’utiliser pour définir les comportements de l’invite suivante.
  • Pour passer des données personnalisées à Dialogflow CX à partir du script, utilisez session_params dans l'objet customPayload dans une action Snippet. Par exemple :

    DYNAMIC customPayload
    customPayload.session_params.name = "Winnie le Pooh" 
    customPayload.session_params.job = "Food critic" 
    customPayload.session_params.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.

  • Configurez les conseils de contexte vocal et un ID de conversation personnalisépour transférer la conversation vers un autre Dialogflowagent virtuel CX dans l'extrait de code Charge utile personnalisée.

  • 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ètremaxPostEnergySilenceMS à l’action Next Prompt Behaviors ou Default Next Prompt Behaviors Snippet.

Conseils contextuels pourDialogflow CX

Les conseils de contexte de parole peuvent être transmis dans l'extrait de code Charge utile personnalisée dans le paramètre speechContexts. La valeur de speechContexts.phrases doit être un jeton de classe Google Un carré avec une flèche pointant du centre vers le coin supérieur droit. 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		

Configurez ces paramètres comme suit :

  • speechContexts.phrases : Le jeton de classe Google Un carré avec une flèche pointant du centre vers le coin supérieur droit. pour l’indice que vous voulez donner. Le jeton doit correspondre à la langue et aux paramètres régionaux de vos contacts. Si vous souhaitez ajouter plusieurs jetons, ajoutez un paramètre speechContexts.phrases pour chaque jeton.
  • speechContexts.boost : Une valeur numérique pondérée entre 1-20 et la valeur phrase spécifiée. Le service de transcription utilise cette valeur lorsqu’il sélectionne une transcription possible pour les mots dans les données audio. Plus la valeur est élevée, plus la probabilité que le service de transcription choisisse ce mot ou cette phrase parmi les alternatives est grande.

Vous pouvez voir le contenu de ce paramètre dans les traces Studio et dans les journaux de l’application.

Transférer des contacts entre Dialogflow agents virtuels CX

Pour configurer le transfert d'un contact d'un Dialogflow agent virtuel CX vers un autre Dialogflow agent virtuel CX, incluez la ligne suivante dans l'extrait de code Charge utile personnalisée. Remplacez custom_value par le nom de la variable qui contient l'ID de conversation :

{
  “cxone_override_conversation“: {custom_value} 
}		

Assurez-vous de configurer votre script pour remplir la variable que vous utilisez avec ce paramètre.

Votre script doit être configuré avec soin afin que

Le paramètre cxone_override_conversation est semblable à l'ID d'état de session du bot défini dans l'extrait État de session du bot snippet. Les deux aident l'agent virtuel à maintenir le contexte de la conversation entre les tours. Votre script doit être configuré avec soin afin que les valeurs d'ID d'état de session du bot et d'ID de conversation apparaissent aux emplacements corrects. L'état de la session du bot a toujours priorité sur le paramètre cxone_override_conversation. Configurez votre script comme suit :

Agent virtuel Tourner # Configuration
1. 1. La propriété botSessionState de l'action Voicebot EXCHANGEou Textbot EXCHANGE est vide. Le tour retourne un ID d'état de session de bot et remplit botSessionStateVarName (out). Il s'agit de l'ID d'état de session du bot n°1.

1.

2 tours ou plus avec cet agent virtuel Le script envoie l'ID d'état de session du bot n° 1 à l'agent virtuel CX n° 1 Dialogflow. Le même ID est retourné au script.
2. 3 (premier avec cet agent virtuel)

La propriété botSessionState de l'action Voicebot EXCHANGEou Textbot EXCHANGE est vide.

L'extrait de charge utile personnalisé pour ce tour contient cxone_override_conversation = [variable].

Le tour retourne un ID d'état de session de bot unique et remplit botSessionStateVarName (out), remplaçant toute valeur qu'il contient déjà. Il s'agit de l'ID d'état de session du bot n°2.

2. 4 (deuxième tour avec cet agent virtuel) Le script envoie l'ID d'état de session du bot n° 2 à l'agent virtuel CX n° 2 Dialogflow. Le même ID est retourné au script.

Si vous utilisez plus de deux instances de Dialogflow CX, le modèle continue comme établi dans le tableau précédent.

Cette méthode de transfert entre agents virtuels n'est requise que lors du transfert entre deux ou plusieurs agents virtuels Dialogflow CX. Si vous transférez entre d'autres fournisseurs d'agents virtuels, vous pouvez utiliser l'ID d'état de session du bot.

Google Dialogflow ES Charge utile personnalisée

  • CustomPayload est utilisé pour transmettre le contexte d’une intentionFermé 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éFermé 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 Icône indiquant que le lien renvoie à un site Web externe 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.
  • Configurez les conseils de contexte vocal dans l'extrait de code Charge utile personnalisée.

Conseils contextuels pour le discours DialogflowES

Conseils de contexte de parole peuvent être transmis dans l'extrait de code Charge utile personnalisée dans le paramètre speechContexts. La valeur de speechContexts.phrases doit être un jeton de classe Google Un carré avec une flèche pointant du centre vers le coin supérieur droit. 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		

Configurez ces paramètres comme suit :

  • speechContexts.phrases : Le jeton de classe Google Un carré avec une flèche pointant du centre vers le coin supérieur droit. pour l’indice que vous voulez donner. Le jeton doit correspondre à la langue et aux paramètres régionaux de vos contacts. Si vous souhaitez ajouter plusieurs jetons, ajoutez un paramètre speechContexts.phrases pour chaque jeton.
  • speechContexts.boost : Une valeur numérique pondérée entre 1-20 et la valeur phrase spécifiée. Le service de transcription utilise cette valeur lorsqu’il sélectionne une transcription possible pour les mots dans les données audio. Plus la valeur est élevée, plus la probabilité que le service de transcription choisisse ce mot ou cette phrase parmi les alternatives est grande.

Vous pouvez voir le contenu de ce paramètre dans les traces Studio et dans les journaux de l’application.