Agent virtuel Scripts d’action

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 11 minutes de lecture
  • Vous devez écrire un ensemble de scripts d’action et de flux secondaire obligatoires Concepteur de flux pour transmettre les données utilisateur à VACS, appliquer les transformations et renvoyer la réponse au point de terminaison de votre interface de messagerie instantanée.

    Script fournisseur et scripts entrants/sortants

    Un fournisseur, tel que Twilio, fournit la fonctionnalité de messagerie instantanée. Les scripts d’action utilisateur effectuent des actions de fournisseur, ainsi que la configuration de l’intégration conversationnelle de la messagerie instantanée personnalisée pour les actions de transformateur entrantes et sortantes pour votre chatbot ou vos conversations personnalisées. Des exemples de chaque script sont fournis. Ils comprennent une description de l’action de chaque script, ainsi que l’entrée et la sortie d’action. Vous voyez également des exemples du script JSON.

    Vous utilisez Concepteur de flux ces scripts pour transformer les messages serveur et client. Les scripts de fournisseur, d’expéditeur et de transformateur entrant/sortant sont requis. Vous pouvez utiliser les scripts supplémentaires pour ajouter plus de fonctionnalités à votre messagerie instantanée.

    Tableau 1. Scripts
    Nom de script Objectif Requis (O/N)
    Attribut de fournisseur Contient un jeton d’authentification de fournisseur, un identificateur d’utilisateur, une entrée utilisateur et des variables de contexte. Y
    Action de l'expéditeur

    Regroupe la demande et envoie une réponse de manière asynchrone via Concepteur de flux ou via le concentrateur d’intégration.

    Y
    Processeur de réponses Effectue des actions de plateforme, telles que la mise à jour de l’état d’un message, en fonction d’une réponse reçue pour un message sortant. N
    Action contextuelle Prend en charge les actions contextuelles. N
    Action du compte de lien Fournit un rappel indiquant si la liaison de compte a réussi ou non. N
    Transformateur sortant Transforme le contrôle pris en charge par un serveur de messagerie instantanée en un rendu spécifique à l’interface de messagerie instantanée. Y
    Transformateur entrant Facultatif. Vous pouvez utiliser les contrôles enrichis par défaut s’ils s’appliquent à votre fournisseur de messagerie instantanée. Vous n’avez pas besoin de fournir une transformation entrante distincte pour chaque contrôle d’entrée. Si un comportement par défaut ne fonctionne pas, vous pouvez remplacer le comportement par défaut par votre propre transformation entrante pour un contrôle de serveur d’Agent virtuel spécifique. Y

    Script d’action des attributs du fournisseur

    Le script d’action attributs de fournisseur extrait les données du message entrant. Le script connaît le protocole d’intégration conversationnelle de messagerie instantanée personnalisée et génère le contenu du message entrant, l’ID d’utilisateur de l’expéditeur et un jeton d’authentification facultatif.
    Remarque :
    Si votre script d’action attributs de fournisseur a une action contextuelle, votre script doit comporter à la fois request_context.contextual_action et request_context.typed_value afin que l’entrée de l’utilisateur (qui correspond à une action contextuelle) soit incluse dans la transcription. Si vous ne définissez pas l’attribut request_context.typed_value, le contenu de ce message n’apparaît pas dans la transcription.
    Tableau 2. Entrée/sortie du script d’action des attributs du fournisseur
    Entrée Sortie
    • En-têtes (JSON) : en-têtes de demande
    • Charge utile (JSON) : corps de la demande
    • Jeton (chaîne) : jeton d’authentification.
    • provider_user_id (chaîne) : nom de l’expéditeur, par exemple, un nom d’utilisateur dans un message Slack.
    • request_context (JSON) : contenu réel reçu.
      • typed_value contenu saisi, comme une réponse à une question.
      • attachment_value.url : URL de la pièce jointe.
      • attachment_value.content_type : type de contenu de la pièce jointe.
      • attachment_value.name : nom du fichier de la pièce jointe.
      • Action contextuelle : action à effectuer, telle que END_CONVERSATION, START_CONVERSATION, AGENT. Ce script examine le message entrant. S’il existe un mot clé reconnu, l’une des actions peut être définie, par exemple outputs.request_context.contextual_action = « END_CONVERSATION » ;. Le cadre de travail reconnaît ce mot clé et invoque le script d’action contextuelle.
      • context_vars variables contextuelles à transmettre à une conversation, telles que « outputs.request_context.context_vars = {language : « en"} ; ».
    Figure 1. Exemple : Concepteur de flux entrée de script d’action attributs du fournisseur, y compris les en-têtes et la charge utile
    Une entrée d’action dans Flow Designer avec les en-têtes et la charge utile définis pour utiliser JSON.
    Figure 2. Exemple : Concepteur de flux sortie du script d’action attributs du fournisseur, y compris jeton, request_context et provider_user_id
    Une sortie d’action dans Flow Designer spécifie les valeurs de jeton, de request_context et de provider_user_id.

    Exemple : script d’action Attributs du fournisseur.

    (function execute(inputs, outputs) {
        var headers = (inputs.headers);
        var payload = (inputs.payload);
    
        // check if an authentication token was included. this is optional.
        var smsUtil = new VASMSTwilioUtil();
        outputs.token = JSON.stringify(smsUtil.getToken(headers, payload));
    
        var data = payload.data;
        var request_context = {}; 
        // inspect the actual message. it could be an MMS (attachment) or raw text
        if (data['MediaUrl0']) {
            var attachment_value = {};
            attachment_value.url = data['MediaUrl0'];
            attachment_value.content_type = data['MediaContentType0'];
            attachment_value.name = smsUtil.getFileName(attachment_value.url , attachment_value.content_type);
            request_context.attachment_value = attachment_value;
        } else {
           request_context.typed_value = data['Body'];
        }
    
        // set the mandatory outputs
        outputs.request_context = request_context;
        outputs.provider_user_id = data.From;
    })(inputs, outputs);

    Script d’action de l’expéditeur (désactivé au Québec, voir flux secondaire de l’expéditeur)

    Le script d’action de l’expéditeur sait comment envoyer un message au fournisseur. Le script doit invoquer un flux secondaire ou Concepteur de fluxHub d'intégration de façon asynchrone. L’est libre de continuer à traiter les Agent virtuel messages plutôt que d’essayer d’envoyer des demandes externes.

    Tableau 3. Entrée du script d’action de l’expéditeur
    Entrée Sortie
    • Résultats (JSON) : tableau des messages à envoyer.
    • Charge utile (JSON) : dernière charge utile reçue d’un demandeur.
    • app_inbound_id (chaîne) : l’identificateur de l’expéditeur, tel que le numéro de téléphone « De » dans un ticket SMS.
    • channel_user_id (chaîne) : l’identificateur du destinataire, tel que le numéro de téléphone « À » dans un ticket SMS.
    Aucun

    Exemple : script d’action de l’expéditeur.

    (function execute(inputs, outputs) {
        var results = inputs.results;
        // transform the inputs to something this custom subflow knows about
        var sendInputs = {
            app_inbound_id : inputs["app_inbound_id"],
            channel_user_id: inputs["channel_user_id"],
            messages: JSON.stringify(results)
        };
    
        // invoke an asynchronous subflow which will send the external request. so this sender script will immediately return,
        // freeing up the chat server thread to do further message processing while putting the external request work on the
        // Flow Designer/Integration Hub
        sn_fd.FlowAPI.startSubflowQuick('sn_va_sms_twilio.va_sms_twilio_adapter_send_sms', sendInputs);
    })(inputs, outputs);

    Script de flux secondaire de l’expéditeur

    Le script de flux secondaire de l’expéditeur sait comment envoyer un message au fournisseur. Le script doit invoquer un flux secondaire ou Concepteur de fluxHub d'intégration de façon asynchrone. L’est libre de continuer à traiter les Agent virtuel messages plutôt que d’essayer d’envoyer des demandes externes. Lors de la création d’un flux secondaire, aucune action n’est requise pour appeler une action dans le flux secondaire.

    }else{
      outputs.sendmessage = true;
      messages = inputs.results.results;
      outputs.from = from;
      outputs.to = to;
      outputs.messages = getMessages(messages);
    }

    Script d’action contextuelle

    Le script d’action contextuelle effectue des actions de mots clés spéciales, telles que saisir l’agent dans une Agent virtuel rubrique pour être immédiatement transmis à un agent actif.

    Tableau 4. Entrée du script d’action contextuelle
    Entrée Sortie
    • conversation_id (chaîne) : ID de conversation.
    • request_context (JSON) : demande transmise à partir du script d’attribut de fournisseur qui contient l’action à effectuer, par exemple (END_CONVERSATION, START_CONVERSATION, AGENT).
    Aucun

    Exemple : script d’action contextuelle.

    (function execute(inputs, outputs) {
      var contextual_action = inputs.request_context.contextual_action;
      if (contextual_action === "END_CONVERSATION") {
        sn_cs.VASystemObject.endConversation(inputs.conversation_id);
      } else if (contextual_action === "AGENT") {
        sn_cs.VASystemObject.switchToLiveAgent(inputs.conversation_id);
      } else if (contextual_action === "START_CONVERSATION") {
        sn_cs.VASystemObject.startConversation(inputs.conversation_id);
      }
    })(inputs, outputs);

    Lier le script d’action du compte

    Le script d’action de compte de lien contient des identificateurs pour l’utilisateur qui établit la liaison. Le script contient également le compte auquel il est lié.

    Tableau 5. Entrée du script d’action de compte de lien
    Entrée Sortie
    • provider_user_id (chaîne) : l’identificateur de l’utilisateur qui établit le lien, tel qu’un numéro de téléphone dans un ticket SMS.
    • état (chaîne) : réussite/échec.
    • user_id (chaîne) : user_sys_id ServiceNow pour le compte auquel il était lié.
    Aucun

    Exemple : script d’action Lier le compte.

    (function execute(inputs, outputs) {
      
      var richControl = (inputs.rich_control);
      var value = richControl.value;
      outputs.result = richControl.header + ': ' + value.action;
      
    })(inputs, outputs);

    Script d’action du processeur de réponses

    Le script d’action du processeur de réponses effectue des actions spéciales en fonction de la réponse à une demande d’envoi de message. Le framework effectue déjà un suivi de l’état des messages de base.

    Tableau 6. Entrée du script d’action de compte de processeur de réponses
    Entrée Sortie
    • message_id (chaîne) : l’identificateur de sys_cs_message’enregistrement associé à cette réponse.
    • en-têtes (JSON) : en-têtes reçus.
    • corps (chaîne) : corps reçu.
    • code d’état (entier) : code d’état HTTP reçu.
    Aucun

    Exemple : script d’action du processeur de réponses.

    (function execute(inputs, outputs) {
        gs.debug("Response from provider: message_id = " + inputs.message_id + ", status_code = " +
          inputs.status_code + ", headers = " + JSON.stringify(inputs.headers) + ", body = " + inputs.body);
    })(inputs, outputs);

    Scripts de transformateur sortant

    Les scripts de transformateur sortant convertissent les messages sortants Agent virtuel en protocole lié à l’intégration conversationnelle de la messagerie instantanée personnalisée.

    Entrée.

    • rich_control (JSON) : Agent virtuel composant de contrôle riche en serveur qui doit être transformé.
    • charge utile (JSON) : dernière réponse reçue d’un demandeur.

    Sortie.

    résultat (chaîne) : message de composant approprié au fournisseur à envoyer.

    Tableau 7. Exemples : Scripts de transformateurs sortants
    Nom du transformateur sortant Exemple de script
    Agent virtuel : transformateur sortant du texte par défaut de l’adaptateur SMS Twilio
    (function execute(inputs, outputs) {
      var rich_control = inputs.rich_control;
      outputs.result = rich_control['label'];
    })(inputs, outputs);
    Agent virtuel : transformateur sortant de lien par défaut de l’adaptateur SMS Twilio
    (function execute(inputs, outputs) {
      var richControl = (inputs.rich_control);
      var value = richControl.value;
      outputs.result = richControl.header + ': ' + value.action;
    })(inputs, outputs);
    Agent virtuel : transformateur sortant du sélecteur par défaut de l’adaptateur SMS Twilio
    (function execute(inputs, outputs) {
      var rich_control = inputs.rich_control;
      var options = rich_control['options'];
      if (options && options.length > 0) {
          var optionsLength = options.length;
          var picker = rich_control['label'] || "";
          for (var x = 0; x < optionsLength; x++) {
              picker += "\n" + (x+1) +  ": " + options[x].label;
          }
      }
      outputs.text_message = picker;
    })(inputs, outputs);
    Agent virtuel : transformateur sortant multi-lien par défaut de l’adaptateur SMS Twilio
    (function execute(inputs, outputs) {
      var rich_control = inputs.rich_control;
      var linkResult = rich_control['header'];
      var totalValues = rich_control['values'].length;
      for (var i = 0; i < totalValues; i++) {
        linkResult = linkResult + '\n';
        var linkValue = rich_control['values'][i];
        linkResult = linkResult + '\n' + linkValue['description'] + ': ' + linkValue['action'];
      }
      outputs.result  = linkResult;
    })(inputs, outputs);
    Agent virtuel : transformateur sortant de la carte par défaut de l’adaptateur SMS Twilio
    (function execute(inputs, outputs) {
      var richControl = (inputs.rich_control);
      var data = JSON.parse(richControl.data);    
      var tableTitle = data.title;
      var fields = data.fields;
      var subtitle = data.subtitle;
      var url = data.url;    
      var message = subtitle ? getCardLine(tableTitle, subtitle) : tableTitle + "\n";
      for (var i= 0; i<fields.length; i++) {
         message += getCardLine(fields[i].fieldLabel, fields[i].fieldValue);
      }
      message += url;
      outputs.result = message;
    
      function getCardLine(key, value) {
          if (value == '' || value == null || key == '' || key == null)
              return;
          return key + ": " + value + "\n";
      }
    })(inputs, outputs);

    Scripts de transformateurs entrants

    Les scripts de transformateur entrants convertissent les messages entrants d’intégration de messagerie instantanée personnalisée conversationnelle en un protocole reconnu Agent virtuel . Il détermine la valeur requise à injecter dans le contrôle enrichi qui est présenté à l’utilisateur.

    Entrée.

    • request_context (JSON) : demande transmise à partir du script d’attribut de fournisseur.
    • rich_control (JSON) : dernier contrôle enrichi envoyé au demandeur qui contient la « question » d’origine.

    Sortie.

    résultat (JSON) : résultat attendu par le Agent virtuel serveur. Si le demandeur répond à un sélecteur de rubrique, il s’agit du sys_id de la rubrique. Si le demandeur répond à un texte d’entrée, il s’agit de la réponse texte.
    • valeur : sys_id ou valeur textuelle.
    • search_text : texte utilisé si le demandeur a sélectionné quelque chose d’inattendu. Par exemple, un utilisateur a tapé quelque chose pour lequel le NLU pourrait aider, par exemple « Aucune de ces options ne correspond à ce que je veux » en réponse à un composant de sélecteur de rubrique.
    Tableau 8. Exemples : Scripts de transformateurs entrants
    Nom du transformateur entrant Exemple de script
    Agent virtuel : transformateur entrant du texte par défaut de l’adaptateur SMS Twilio

    Objectif : trouver la réponse textuelle à la question InputText posée

    (function execute(inputs, outputs) {
      var requestContext = inputs.request_context;
      var richControl = inputs.rich_control;
      var typedValue = requestContext['typed_value'];
      var attachmentValue = requestContext['attachment_value'];
      var smsUtil = new VASMSTwilioUtil();
      var result = {};
      if(richControl['itemType'] == 'image' || richControl['itemType'] == 'file')	{
        if (attachmentValue && attachmentValue.content_type.includes('image')) {
          result.url = attachmentValue.url;
          result.content_type = attachmentValue.content_type;
          result.name = attachmentValue.name;
          result.headers = attachmentValue.headers;
        } else if (typedValue) {
          result.url = typedValue;
          var contentType = smsUtil.getContentType(typedValue);
          if (typeof contentType === 'undefined')
            gs.error('Please enter a valid image link. Inbound image link: {0}', typedValue);
          else
            result.content_type = contentType;
        } else {
          gs.error('Please upload an image or enter a valid image link.');
        }
      }
      result['value'] = typedValue;
      result['search_text'] = '';
      outputs.result = result;
    })(inputs, outputs);
    Agent virtuel : transformateur entrant du sélecteur par défaut de l’adaptateur SMS Twilio

    Objectif : recherchez le sys_id de l’option que l’utilisateur a sélectionnée pour cette question de sélecteur. Ce script utilise le même algorithme que le transformateur sortant. Si aucune option n’est sélectionnée et que l’utilisateur a tapé quelque chose à la place, le « search_text » est défini et introduit dans le NLU s’il est activé dans cette instance.

    (function execute(inputs, outputs) {
      var request_context = inputs.request_context;
      var rich_control = inputs.rich_control;
      var selectedValue = request_context["typed_value"];
      var result = {};
      result["value"] = "";
      result["search_text"] = "";
      if (rich_control['options']) {
        var options = rich_control['options'];
        var optionsLength = options.length;
        selectedValue === Number(selectedValue)
        if (selectedValue > 0 && selectedValue <= optionsLength) {
            var selectedOption = options[selectedValue - 1];
            result["value"] = selectedOption.value;
        } else {
            result["search_text"] = request_context["typed_value"];
        }
      }
      outputs.result = result;
    })(inputs, outputs);