Configurer l’action TextBotExchange

L’action TextBotExchange envoie les messages du contact à AI Agents (Cognigy) et reçoit les réponses du bot. Elle fournit également des variables de sortie et des conditions de branchement que votre script utilise pour déterminer la suite. Configurez les propriétés de l’action comme décrit dans cette tâche.

autorisations requises : Studio Script View, Create/Edit

Dans le script Studio, cliquez sur Actions dans le panneau de droite.
Agrandissez la catégorie URL de l’Éditeur Web.
Faites glisser l’action TextBotExchange sur la zone de script. Placez-la après l’action qui recueille la saisie du contact.
Si votre script nécessite plus qu’un tour, ajoutez une deuxième TextBotExchange action et connectez-la à la boucle de conversation. Un minimum de deux TextBotExchange action est requis pour la plupart des mises en œuvre.
Avant la première action TextBotExchange, ajoutez une action Extrait et configurez-la avec le code d’Extrait Bot Session State. Cet Extrait initialise la variable botSessionState qui maintient le contexte de la conversation entre les tours.

Propriétés d’entrée

Sélectionnez l’action TextBotExchange et configurez les propriétés d’entrée suivantes dans le panneau propriétés. Utilisez le tableau ci-dessous pour comprendre chaque propriété :

Propriété	Valeur acceptable ou FORMAT	Description
Légende	Étiquette courte et descriptive. Exemple : TextBotExchange_CognigyStart	Identifie cette action spécifique sur la zone Studio. La valeur par défaut est « TEXTBOT EXCHANGE ». Entrez une légende unique lorsque votre script contient plus qu’une TextBotExchange action.
ID de l’agent virtuel	Rempli automatiquement après avoir assigné le bot dans le Virtual Agent Hub. La valeur est égale au Nom de l’Agent virtuel (bot) de Virtual Agent Hub.	Identifie la configuration Virtual Agent Hub à utiliser. Ce champ est rempli automatiquement lorsque vous assignez le bot à l’action dans Virtual Agent Hub. Vous pouvez remplacer cette valeur en utilisant une variable Studio, par exemple {virtualAgentId}, si vous devez sélectionner dynamiquement la configuration du bot au moment de l’exécution. Cette approche est couramment utilisée lors du changement entre plusieurs configurations de bot.
Intention automatisée	Chaîne Standard : Bienvenue. Utilisé uniquement lors du premier tour.	Déclenche une intention spécifique dans AI Agents (Cognigy) au lieu d’envoyer la saisie textuelle du contact. Ce champ peut être utilisé pour appeler des intentions prédéfinies telles que Bienvenue ou toute autre intention prise en charge par le bot. Bien qu’il soit couramment utilisé lors du premier tour pour déclencher un message de bienvenue, il peut également être utilisé lors des tours suivants pour appeler d’autres intentions de façon dynamique. Laissez ce champ vide lorsque vous souhaitez transmettre le message réel du contact à la place.
Saisie de l'utilisateur	Variable Studio qui contient le message saisi par le contact. Exemple : {customerMessage}	Le message texte saisi par le contact, transmis à AI Agents (Cognigy) pour la reconnaissance d'intention et la génération de réponse. Au premier tour, ce champ peut être vide si automatedIntent est défini sur Welcome. À chaque tour subséquent, ce champ doit contenir le dernier énoncé du contact.
Charge utile personnalisée	Objet JSON converti en chaîne. Exemple : {customPayload.asJSON()}. Facultatif.	Transmet des données contextuelles personnalisées du script Studio à AI Agents (Cognigy). Voici des exemples : le nom du contact, l'ID de compte ou des données CRM. Vous devez définir l'objet de charge utile personnalisée dans une action Snippet. N'utilisez pas cette propriété si vous devez traiter des données que l'agent virtuel retourne au script. Utilisez plutôt la variable customPayloadVarName (out).
État de la session du robot	Variable remplie par botSessionStateVarName (out) lors du tour précédent. Exemple : {botState}	Maintient le contexte de la conversation d'un tour à l'autre en retransmettant un identifiant de session à AI Agents (Cognigy) à chaque demande. AI Agents (Cognigy) crée cet identifiant au premier tour. À tous les tours subséquents, le script doit transmettre la valeur stockée dans N'utilisez pas cette propriété si vous devez traiter des données que l'agent virtuel retourne au script. Utilisez plutôt la variable customPayloadVarName (sortant) de nouveau dans ce champ. Si cela n'est pas configuré correctement, AI Agents (Cognigy) crée une nouvelle session à chaque tour et perd le contexte.

Propriétés de sortie

Les propriétés de sortie suivantes sont disponibles après l'exécution de l'action TextBotExchange. Référencez ces variables dans les actions subséquentes de votre script.

Propriété	Valeur acceptable ou FORMAT
nextPromptVarName (sortie)	Contient les paramètres de comportement qui déterminent la façon dont NiCE CXone sollicite le contact au tour de conversation suivant. Cette variable peut être modifiée dans une action Snippet avant le prochain appel TextBotExchange afin de personnaliser le comportement pour chaque tour.
Nom de la variable de charge utile personnalisée (sortant)	Retourne des données JSON personnalisées de AI Agents (Cognigy) vers le script Studio. Utilisez cette propriété pour traiter les données d'exécution ou les instructions de routage envoyées par AI Agents (Cognigy). Voici des valeurs courantes : escalat ou toute intention commençant par escalat, comme « escalate » ou « escalation » — achemine le contact vers un agent en direct. Le script Studio détecte ce préfixe afin de gérer l'escalade de manière fiable pour différents noms d'intention de bot. end — met fin à l'interaction. Le script Studio utilise cette valeur pour terminer proprement la session du contact. Ne confondez pas ceci avec la propriété de saisie customPayload.
errorDetailsVarName (sortie)	Contient des informations sur l'erreur lorsque la branche OnError est empruntée. Vérifiez cette variable dans la branche OnError pour consigner ou traiter l'erreur. La variable système _ERR contient également une description condensée de l'erreur.
intentInfoVarName (sortie)	Contient des détails sur l'intention identifiée par AI Agents (Cognigy) pour le tour actuel. Utilisez cette variable dans votre script pour consigner les données d'intention ou prendre des décisions d'acheminement en fonction de l'intention identifiée.
Nom de variable de l'état de la session du robot (sortie)	Contient l'identifiant de l'état de la session renvoyé par AI Agents (Cognigy) après chaque tour. Vous devez transmettre la valeur de cette variable à la propriété de saisie botSessionState lors du tour suivant afin de maintenir le contexte de la conversation. Cette propriété est requise pour un fonctionnement correct.