---
sourceDocument: Interfaces conversationnelles Yokohama
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/yokohama/conversational-interfaces

 Release :

    - yokohama

ft:locale :

    - fr-FR

ft:publication_title :

    - Interfaces conversationnelles Yokohama

ft:clusterId :

    - convint

bundleId :

    - convint

workflow :

    - Platform


---

# Agent virtuel Scripts de

# Agent virtuel Scripts de {#ariaid-title1}

* Rversion finale: Yokohama
* 
* Mis à jour 29 janv. 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 10 minutes de lecture

Utilisez ServiceNow® Agent virtuel des méthodes et des variables de script pour écrire des scripts de messagerie instantanée, tels que des scripts de réponse, de déclencheur et de flux. Les variables peuvent également fournir un contexte pour vos sujets et conversations d'assistance en direct.

Agent virtuel Les scripts peuvent fournir un contexte pour des rubriques, telles que la conservation d'informations sur un utilisateur ou l'entrée d'un utilisateur. Vous pouvez utiliser ces informations pour personnaliser une conversation, par exemple pour présenter un message d'accueil ou de confirmation scripté. Les scripts peuvent également spécifier certaines actions à effectuer sur les informations obtenues au cours d'une conversation. Ces actions peuvent être utilisées pour créer ou mettre à jour ServiceNow des enregistrements.

Les scripts s'exécutent sur le serveur dans le périmètre dans lequel une rubrique est définie. Toutes les protections du champ d'application s'appliquent. Si vous développez une conversation pour une application incluse dans le périmètre, vous devez utiliser l'API incluse dans le périmètre. Vous pouvez utiliser la plupart des API qui s'exécutent dans des scripts serveurs.

## Variables d'entrée et ServiceNow d'enregistrement de l'utilisateur {#virtual-agent-scripts__section_ssh_pxw_sdb}

Dans Agent virtuel, les variables suivantes peuvent être utilisées dans les scripts que vous créez pour une rubrique.  

Variables d'entrée utilisateur

:   Lorsque vous ajoutez un contrôle d'entrée à une rubrique, le système crée automatiquement une variable pour stocker l'entrée utilisateur (chaîne, valeur booléenne, etc.). La syntaxe est `vaInputs.myvar` où `myvar` est le nom que vous avez affecté au nœud d'entrée.

    Par exemple, une invite d'entrée de texte portant le nom <kbd class="ph userinput">Première invite</kbd> comporte une variable définie par le système appelée `vaInputs.first_prompt`. Les espaces du nom sont remplacés par un trait de soulignement et les caractères majuscules sont remplacés par des minuscules.

ServiceNow Variables d'enregistrement

:   Si vous créez un script pour une rubrique qui interroge une ServiceNow table, l'objet d'enregistrement (GlideRecord) renvoyé est automatiquement disponible pour utilisation dans la rubrique. La syntaxe de la variable est `vaInputs.myvar` où `myvar` est l'objet d'enregistrement. Pour plus d'informations sur l'interrogation des ServiceNow tables pour renvoyer un objet d'enregistrement, consultez [Interrogation des tables dans un script](https://www.servicenow.com/docs/access?context=c_UsingGlideRecordToQueryTables&version=yokohama&pubname=yokohama-api-reference&ft:locale=en-US).

    Utilisez la remontée pas à pas dans les variables qui contiennent un ServiceNow enregistrement pour spécifier un champ particulier dans la table. La syntaxe est `vaInputs.myvar.field`. Pour plus d'informations sur la remontée pas à pas dans un script, consultez [Exemples de remontée pas à pas](https://www.servicenow.com/docs/access?context=dot-walking-examples&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US).

Accès aux variables d'entrée utilisateur et ServiceNow d'enregistrement

:   Utilisez les objets vaInputs pour accéder ServiceNow aux variables d'enregistrement dans les scripts. Par exemple, `vaInputs.myvar == << valeur attendue >>.` Pour accéder aux valeurs des entrées utilisateur qui ne sont pas des `enregistrements, utilisez vaInputs.myvar.getValue().`

    Les méthodes suivantes sont disponibles.  
    {#virtual-agent-scripts__table_uht_pzs_cpb__entry__2}

    | Méthode | Description |
    |-|-|
    | vaInputs.myvar == \<\< valeur attendue \>\> | Évalue si `myvar` correspond à une valeur attendue. Remarque : Les valeurs des variables d'entrée utilisateur sont affectées à l'aide des contrôles d'entrée utilisateur. Ces valeurs ne peuvent pas être modifiées dans vos scripts. * La Yokohama version prend en charge des types de données supplémentaires. Pour plus d'informations, consultez [Types de données d'entrée dans les Agent virtuel rubriques](https://servicenow-prod.fluidtopics.net/TrcsUibiKZe1dw_VBb5BXg "Vous pouvez définir des entrées des types de données Glide Agent virtuel (com.glide.cs.chatbot) couramment utilisés sans Concepteur d'agent virtuel écrire de script. Définissez le type de données d’entrée sur le nœud Démarrer d’un contrôle personnalisé ou d’un bloc de rubriques."). * Par défaut, la variable user (utilisateur) est disponible et constitue une référence à l'enregistrement sys_user pour l'utilisateur. {#virtual-agent-scripts__ul_dsz_rbt_cpb} |
    | vaInputs.myvar.getValue() ; | Renvoie la valeur. |
    | vaInputs.myvar.getDisplayValue() ; | Renvoie la valeur d'affichage si la valeur stockée n'est pas un ServiceNow enregistrement. Pour les variables qui contiennent ServiceNow des enregistrements, cette méthode renvoie la valeur d'affichage, telle que définie par le champ d'affichage de cette table. L'exemple suivant montre les valeurs d'étiquette et de choix pour une entrée utilisateur. Dans ce cas, `myVar.getValue()` renvoyait une valeur de 10, 20 ou 30, tandis que `myVar.getDisplayValue()` retournait Apple, Orange ou Pear. Figure 1. Exemple de liste de choix |
    | vaInputs.myvar.getDefaultValue() ; | Renvoie la valeur par défaut dans un message de confirmation. |
    | vaInputs.myvar.getDefaultDisplayValue() ; | Renvoie la valeur d'affichage de la valeur par défaut dans un message de confirmation. |
    | vaInputs.myvar.unbindEntity() ; | Supprime la valeur des variables d'entrée que le NLU service de prédiction a rempli avec les entités extraites (la dissocie de la valeur d'entrée initiale). Par exemple, si l'utilisateur décide de modifier son choix sur une invite de confirmation, vous pouvez dissocier la valeur de l'entité de la variable d'entrée. L'utilisateur sera ensuite invité à nouveau lorsqu'il reviendra au nœud d'entrée correspondant. Remarque : NLU doit être activé sur la rubrique. Dans le Concepteur d'agent virtuel, sélectionnez l'onglet Propriétés à configurer NLU. Pour plus d'informations sur la définition des NLU entités, voir [Entités](https://www.servicenow.com/docs/access?context=entities&version=yokohama&pubname=yokohama-intelligent-experiences&ft:locale=en-US). |
    [Tableau 1. Méthodes vaInputs]

    {#virtual-agent-scripts__table_uht_pzs_cpb}

## Variables de script {#virtual-agent-scripts__section_kpv_qxj_12b}

Vous pouvez définir des variables de script pour des informations qui ne sont pas stockées dans des ServiceNow tables, mais qui peuvent être utilisées pour partager ces informations ailleurs dans une rubrique. Les variables de script sont similaires aux variables de bloc-notes de workflow qui stockent des primitives telles que des entiers, des valeurs booléennes ou des chaînes. Une valeur de chaîne peut être une valeur de script statique ou dynamique. Utilisez la barre latérale Variables pour définir des variables de script pour une rubrique dans Concepteur d'agent virtuel.  
Figure 2. Barre latérale des variables  
Remarque :  
Les variables de script sont destinées à être utilisées par les auteurs de rubriques ayant des compétences avancées en matière de scripting.

La syntaxe de la variable est `vaVars.myvar`, où `myvar` est le nom que vous attribuez à la variable. Par exemple, vous pouvez affecter une valeur à la variable à l'aide `de vaVars.myvar = value ;`. Contrairement aux variables d'entrée utilisateur, les variables de script peuvent être affectées à des valeurs dans un script.

Pour plus d'informations sur la définition d'une variable de script dans une rubrique, reportez-vous à la section [Définir des variables de script pour une rubrique](https://servicenow-prod.fluidtopics.net/oKW4B~W~X8y_okUZMZ28nQ "Utilisez la barre latérale Variables pour définir des variables de script pour une rubrique. Les variables de script peuvent stocker des informations qui ne se trouvent pas dans les ServiceNow tables. Ces informations peuvent ensuite être partagées ailleurs dans une rubrique.").

## Variables de contexte {#virtual-agent-scripts__section_mc5_tvw_22b}

Les variables de contexte fonctionnent dans un champ d'application global, tandis que les variables système fonctionnent dans le cadre de la rubrique. Vous pouvez utiliser des variables de contexte dans les paramètres système de l'URL du client Web. Ces variables peuvent être utilisées n'importe où dans la conversation à l'aide de l'objet `vaContext` . Utilisez ces options pour créer des liens vers des Agent virtuel variables prédéfinies.

L'exemple de lien suivant contient un paramètre, `sysparm_city=milan`. En plus d'ouvrir une Agent virtuel conversation, l'utilisation de ce lien crée une variable appelée `city` avec une valeur de `milan`. Cette variable est accessible dans un script à l'aide `de vaContext.city`.

    https://<instance>.service-now.com/$sn-va-web-client-app.do?sysparm_city=milan

Un certain nombre de variables peuvent être utilisées dans les scripts de Agent actif rubriques. Ces variables sont notamment les suivantes :

* <var class="keyword varname">l'application</var>
* <var class="keyword varname">language</var>
* <var class="keyword varname">portail</var>
* <var class="keyword varname">search_text</var>
* <var class="keyword varname">short_description</var>
{#virtual-agent-scripts__ul_nvm_krg_rwb}

La syntaxe de la variable est `vaContext.LiveAgent_myvar`, où `myvar` est l'une des [variables de contexte d'agent actif](https://servicenow-prod.fluidtopics.net/UqnswTAdVTxPoiyCPhN6AA "Utilisez des variables de contexte de messagerie instantanée pour transmettre certaines informations de la rubrique à partager avec un agent actif ou pour contrôler la façon dont les conversations de bot sont acheminées vers des agents actifs. Agent virtuel inclut des variables par défaut et vous pouvez en définir de nouvelles.") disponibles. Accédez à la variable à l'aide de `vaContext.LiveAgent_myvar = valeur ;`.

Pour utiliser Agent actif des variables dans les scripts de rubrique, ouvrez la rubrique dans Concepteur d'agent virtuel. Dans l'onglet Propriétés , sélectionnez l'icône en forme de crayon en regard de Variables d'agent actif pour les ajouter à la rubrique.

Pour en savoir plus sur les variables contextuelles d'agent actif incluses dans Agent virtuel, reportez-vous à la section [Variables de contexte de chat d'agent actif](https://servicenow-prod.fluidtopics.net/UqnswTAdVTxPoiyCPhN6AA "Utilisez des variables de contexte de messagerie instantanée pour transmettre certaines informations de la rubrique à partager avec un agent actif ou pour contrôler la façon dont les conversations de bot sont acheminées vers des agents actifs. Agent virtuel inclut des variables par défaut et vous pouvez en définir de nouvelles.").  
{#virtual-agent-scripts__table_evl_vbd_cfc__entry__2}

| Méthode | Description |
|-|-|
| vaVars.global_utterance | Mises à jour lorsque le sélecteur de compétence s'affiche et qu'un énoncé est saisi. |
[Tableau 2. Méthodes vaVars]

{#virtual-agent-scripts__table_evl_vbd_cfc}

## Méthodes vaSystem {#virtual-agent-scripts__section_bdc_wtr_h2b}

Vous pouvez utiliser les méthodes de l'objet vaSystem pour effectuer diverses tâches. Certaines de ces tâches sont les suivantes :

* Joindre des images aux enregistrements.
* Accédez à la chaîne de recherche qui a été utilisée pour trouver la rubrique actuelle.
* Vérifiez qu'un agent actif est disponible pour recevoir une conversation.
* Connectez l'utilisateur à un agent opérationnel.
{#virtual-agent-scripts__ul_rgh_w31_fpb}  
Remarque :  
L'utilisation de méthodes système non documentées n'est pas recommandée, car elles ne sont pas prises en charge et peuvent être interrompues ou modifiées à tout moment sans préavis.
{#virtual-agent-scripts__table_xvn_c5r_h2b__entry__2}

| Méthode | Description |
|-|-|
| vaSystem.applyLinkTemplate(sysId de chaîne, nom de table de chaîne, actionName de chaîne) | Crée un lien externe spécifique à un portail. |
| vaSystem.attachRecordToConversation(String tableName, String sysId) | Joignez ServiceNow les enregistrements à la liste des tâches connexes dans un enregistrement d'interaction Agent virtuel . Ces enregistrements sont mis à jour ou créés au cours d'une Agent virtuel conversation. |
| vaSystem.attachToRecord(Chaîne mediaId, chaîne tableName, chaîne sysId) | Joindre une image chargée à un ServiceNow enregistrement. La méthode utilise les paramètres suivants : * `mediaId` : chemin d'accès de l'image à joindre. Pour utiliser une image saisie par le client, utilisez `getValue()` sur une variable d'entrée d'image. Par exemple, `vaInputs.image_input.getValue().` * `tableName` : chaîne qui contient le nom de la table. * `sysId` : sys_id de l'enregistrement. {#virtual-agent-scripts__ul_dlj_4yr_h2b} |
| vaSystem.connectToAgent() | Connecte le client à un agent actif. Pour plus d'informations sur cette méthode, reportez-vous à la section [Transfert de Agent virtuel conversations à un agent actif](https://servicenow-prod.fluidtopics.net/f2yqZ4oODKDFVSVKBKwp1g "Gérer l’assistance par messagerie instantanée en direct, y compris l’interface d’assistance par messagerie instantanée utilisée lorsqu’une Agent virtuel conversation est transférée à un agent actif."). |
| vaSystem.didConnectToLiveAgent() | Renvoie une valeur booléenne (vrai ou faux), si la conversation actuelle était connectée à un agent actif. |
| vaSystem.getClosingMessage() | Renvoie un message de clôture pour une conversation à partir de la propriété système : com.glide.cs.general.closing_message. (Le message est différent pour les applications de messagerie tierces telles que Microsoft Teams et Slack). |
| vaSystem.getConversationId() | Renvoie l'ID de la conversation actuelle. |
| vaSystem.getGreetingMessage() | Renvoie un message d'accueil à partir du message d'interface utilisateur avec la clé \<\< Bonjour, je suis votre agent virtuel. Dites-moi comment je peux vous aider aujourd'hui." |
| vaSystem.getInteractionSysId() | Renvoie l'ID d'interaction de la conversation actuelle. |
| vaSystem.getSearchText() | Renvoie le dernier énoncé tapé par l'utilisateur. |
| vaSystem.getTopicSelectionMessage() | Renvoie un message d'interface utilisateur avec la clé \<\< Quel est votre problème ou votre demande ? Ou jetez un coup d'œil à ce que je peux faire. (Le message est différent pour les applications de messagerie tierces telles que Microsoft Teams et Slack). Cette méthode est renvoyée à partir de la propriété com.glide.cs.topic_picker_msgsystème . |
| vaSystem.getTranscript() | Obtient la transcription de la conversation. |
| vaSystem.isLiveAgentAvailable() | Vérifie si un agent actif est disponible pour recevoir une conversation transférée à partir du bot. Pour transférer une conversation à un agent actif, appelez cette méthode avant d'utiliser `vaSystem.connectToAgent().` |
| vaSystem.isLiveAgentConfigured() | Indique si la messagerie instantanée en direct est activée. |
| vaSystem.resetAllEntities() | Réinitialise toutes les entités connectées dans la conversation. |
| vaSystem.sendBatchedMessages() | Envoie immédiatement des messages en file d'attente. |
| vaSystem.sendSeparatorMessage() | Envoie une ligne de message de séparateur et renvoie le message de fermeture à partir de `getClosingMessage().` |
| vaSystem.sendSystemMessage(Message de chaîne, booléen showAvatar) | Envoie un message système et renvoie le message de salutations à partir de `getGreetingMessage().` |
| vaSystem.sendTopicPickerControl(Chaîne topicSelectionMessage, Chaîne topicPickerButtonLabel) | Envoie un contrôle de sélecteur de rubrique avec des valeurs associées pour le message et l'étiquette du bouton \<\< Tout me montrer \>\>. |
| vaSystem.sendSkillPickerControl(skillSelectionMessage, args) | Envoie le contrôle du sélecteur de compétences à l'utilisateur. `skillSelectionMessage` est le message affiché avant d'afficher le sélecteur. Le paramètre `args permet des` options de configuration supplémentaires : * `hideSkillDetails` masque le message de sélection de compétences. La valeur par défaut est `false`. * `hidePromotedTopics` masque les rubriques mises en avant dans le sélecteur de compétences. La valeur par défaut est `false`. * `hideShowMeEverything` supprime le bouton \<\< Tout me montrer \>\> du sélecteur de compétences. La valeur par défaut est `false`. * `showNoSkillsConfigured` affiche un message \<\< Aucune compétence configurée \>\> s'il n'y a aucune compétence applicable. La valeur par défaut est `false`. * `appendPromotedSkillsToMsg` ajoute une liste à puces des compétences promues au message de sélection des compétences. La valeur par défaut est `true`. {#virtual-agent-scripts__ul_lwk_dgx_22c} |
| vaSystem.switchTopicByName() | Permet à l'utilisateur de passer de la rubrique de conversation actuelle au nom de la rubrique spécifiée. Le bouton X est disponible afin que l'utilisateur puisse terminer la conversation. Une fois la rubrique terminée, l'utilisateur reprend la rubrique globale. Lorsque la conversation est terminée, l'utilisateur peut sélectionner Cliquez ici pour démarrer une nouvelle conversation en bas de la fenêtre de messagerie instantanée pour redémarrer la rubrique. Le paramètre facultatif resumeBehavior spécifie comment le flux de conversation reprend, comme suit : * Si resumeBehavior=resume, Agent virtuel reprend la rubrique d'appel. * Si resumeBehavior=skip, Agent virtuel ignore la rubrique d'appel. {#virtual-agent-scripts__ul_x2k_rxk_gtb} Si resumeBehavior n'est pas spécifié, le comportement par défaut de l'instance est utilisé. |
| vaSystem.switchTopicById(sysid) | Cette méthode est le sysid de sys_cb_topicet permet à l'utilisateur de passer de la rubrique de conversation actuelle à l'ID de rubrique spécifié. Le bouton X est disponible afin que l'utilisateur puisse terminer la conversation. Une fois la rubrique terminée, l'utilisateur reprend la rubrique globale. Lorsque la conversation est terminée, l'utilisateur peut sélectionner Cliquez ici pour démarrer une nouvelle conversation en bas de la fenêtre de messagerie instantanée pour redémarrer la rubrique. Le paramètre facultatif resumeBehavior spécifie comment le flux de conversation reprend, comme suit : * Si resumeBehavior=resume, Agent virtuel reprend la rubrique d'appel. * Si resumeBehavior=skip, Agent virtuel ignore la rubrique d'appel. {#virtual-agent-scripts__ul_hwt_21l_gtb} Si resumeBehavior n'est pas spécifié, le comportement par défaut de l'instance est utilisé. |
| vaSystem.topicDiscovery(Chaîne searchTextOverride, booléen keywordImpl) | Effectue la searchTextOverride découverte de rubriques en fonction du terme du paramètre. La méthode utilise les paramètres suivants : * `searchTextOverride` : chaîne sur laquelle exécuter la découverte de rubriques. * `keywordImpl` : booléen qui détermine s'il faut utiliser des mots-clés. {#virtual-agent-scripts__ul_rq2_zst_ssb} |
[Tableau 3. Méthodes utilisées dans les Agent virtuel scripts de rubrique]

{#virtual-agent-scripts__table_xvn_c5r_h2b} {#virtual-agent-scripts__table_mqd_wqp_1jb__entry__2}

| Méthode | Description |
|-|-|
| sn_cs. VASystemObject.getTranscriptById(\<sysId de conversation\>) | Obtient la transcription de la conversation actuelle Agent virtuel . |
[Tableau 4. Méthode qui peut être utilisée en dehors des Agent virtuel rubriques]

{#virtual-agent-scripts__table_mqd_wqp_1jb}
**Concepts associés**   

* [Séparation de domaine et Agent virtuel](https://servicenow-prod.fluidtopics.net/x_vIjXxvFtoR7Lxq4Xb7Ew "L'application Agent virtuel prend en charge Séparation de domaine. Séparation de domaine vous permet de séparer les données, les processus et les tâches administratives en groupes logiques appelés domaines. Vous pouvez contrôler plusieurs aspects de cette séparation, notamment les utilisateurs qui peuvent voir les données et y accéder.")
* [Agent virtuel Enregistrements d'interaction](https://servicenow-prod.fluidtopics.net/egw9Vwp5yr5vf9fHq7wptg "Chaque fois qu’une conversation a lieu Agent virtuel , un enregistrement d’interaction capture l’intégralité de la conversation dans la table Interactions [interaction]. L’enregistrement inclut tous les éléments de rubrique utilisés dans la conversation, ainsi que les transferts d’agents actifs.")  
**Référence associée**   

* [Agent virtuel rôles](https://servicenow-prod.fluidtopics.net/VkRSa1lxfO7BrANIu90QRg#VA-roles "Agent virtuel ajoute plusieurs rôles pour les utilisateurs fonctionnant en tant qu’administrateurs Agent virtuel .")
* [Types de données d'entrée dans les Agent virtuel rubriques](https://servicenow-prod.fluidtopics.net/TrcsUibiKZe1dw_VBb5BXg "Vous pouvez définir des entrées des types de données Glide Agent virtuel (com.glide.cs.chatbot) couramment utilisés sans Concepteur d'agent virtuel écrire de script. Définissez le type de données d’entrée sur le nœud Démarrer d’un contrôle personnalisé ou d’un bloc de rubriques.")
* [NLU Entités système](https://servicenow-prod.fluidtopics.net/qIexnFQaXsav0PerEfcn2A "Utilisez des entités définies NLU globalement pour identifier les informations système qui Agent virtuel peuvent être extraites de la conversation. Vous pouvez définir des entités en tant que variables d’entrée « sans nœud » pour une rubrique. Ces variables peuvent être remplies à partir des prédictions du NLU fournisseur de service ou fournies en dehors du champ d’application de la rubrique.")
* [Agent virtuel Paramètres d'URL](https://servicenow-prod.fluidtopics.net/NUVlyoinvrBRWvlrbFKYjw "Agent virtuel fournit divers paramètres système que les administrateurs peuvent ajouter à une URL d’instance pour contrôler le rendu du contenu de la page.")
* [Commentaire sur la latence dans Agent virtuel](https://servicenow-prod.fluidtopics.net/YgoKYV6UQmZSDcFNXn9cAQ "La com.glide.cs.message.processing.enabled propriété système avertit les demandeurs chaque fois que le grand modèle de langage (LLM) de l’IA générative traite leur demande dans le widget et Now Assist le panneau de messagerie Agent virtuel instantanée.")