Connecteur d’entrée du lien de découverte XM

À propos du connecteur d’entrée XM Discover Link

Vous pouvez utiliser le connecteur d’entrée XM Discover Link pour pousser les données XM dans XM Discover via un point de terminaison d’API REST tout en exploitant toutes les fonctionnalités proposées par la structure des connecteurs, telles que le mappage de champs, les transformations, les filtres, le suivi des jobs, etc.

Formats de données pris en charge

Les types de données suivants sont pris en charge au format JSON uniquement :

• Feedback individuel
• Interactions numériques
• Transcriptions d’appel

Avant de configurer le connecteur, créez un exemple de fichier qui représente les champs que vous souhaitez importer dans XM Discover. Consultez les pages liées ci-dessus pour plus d’informations sur les champs requis et les formats de fichier.

Il existe également des fichiers modèles disponibles à télécharger dans le connecteur pour des formats de données spécifiques :

• Chat
  • Discussion en direct (par défaut) : utilisation pour les données d’interactions numériques standard.
  • Amazon Connect : utilisation pour les interactions numériques spécifiques à Amazon Connect Chat.
• Appel
  • Appel (par défaut) : utilisation pour les données de transcription d’appel standard.
  • Verint : Utilisation pour les transcriptions d’appel spécifiques à Verint.
• Commentaires
  • Dynamics 365 : Utilisation pour les données Microsoft Dynamics.

Création d’une tâche de connecteur d’entrée de lien de découverte XM

1. Dans l’onglet Tâches, cliquez sur Nouvelle tâche.
   
2. Cliquez sur la tâche XM Discover Link.
   
3. Donnez un nom à votre job pour pouvoir l’identifier.
   
4. Sélectionnez le projet dans lequel charger les données.
5. Donnez une description de votre travail pour connaître son objectif.
6. Cliquez sur Suivant.
7. Choisissez votre mode d’autorisation ou la manière dont vous vous connecterez à XM Discover :
   
   • Clé API : connectez-vous à l’aide d’un jeton API XM Discover.
   • OAuth 2.0 : connexion à l’aide d’un ID client et d’une clé secrète client fournis par le service d’authentification XM Discover. Contactez votre XM Success Manager pour demander cette méthode.
8. Cliquez sur Suivant.
9. Choisissez le format de vos données : discussion en direct (numérique), appel ou feedback.
   
10. Si vous le souhaitez, choisissez un modèle, puis cliquez sur le lien ici pour télécharger le fichier modèle.
11. Saisissez le chemin JSON d’un sous-ensemble de JSON contenant des nœuds de document. Ne renseignez pas cette zone si les documents se trouvent au niveau du nœud racine.
12. Cliquez sur le bouton Cliquer pour sélectionner le fichier à charger et sélectionnez l’exemple de fichier sur votre ordinateur.
13. Un aperçu du fichier s’affiche. Si vous voyez un message d’erreur ou des contenus bruts au lieu de l’aperçu, il peut y avoir un problème avec les options de format de données que vous avez sélectionnées. Consultez Exemple d’erreurs de fichier pour obtenir de l’aide pour résoudre le problème de votre fichier.
14. Cliquez sur Suivant.
15. Si nécessaire, ajustez vos mappages de données. Consultez la page d’assistance Mappage des données pour en savoir plus sur le mappage des champs dans XM Discover. La section Mappage de données par défaut contient des instructions spécifiques à ce connecteur.
    
16. Cliquez sur Suivant.
17. Si vous le souhaitez, vous pouvez ajouter des règles de substitution et de rédaction des données pour masquer les données sensibles ou remplacer automatiquement certains mots et expressions dans les commentaires et interactions des clients. Pour en savoir plus, consultez la page d’assistance sur la substitution et la rédaction des données.
    
18. Cliquez sur Suivant.
19. Si vous le souhaitez, vous pouvez ajouter un filtre de connecteur pour filtrer les données entrantes afin de limiter les données importées.
    
20. Cliquez sur Suivant.
21. Sélectionnez le mode de traitement des documents en double. Pour plus d’informations, voir Traitement des doublons.
    
22. Cliquez sur Suivant.
23. Vérifiez votre configuration. Si vous devez modifier un paramètre spécifique, cliquez sur le bouton Modifier pour accéder à cette étape dans la configuration du connecteur.
    
24. Le lien Documentation API contient votre point de terminaison d’API, qui sera utilisé pour envoyer des données à XM Discover. Pour en savoir plus, voir Accès au point de terminaison de l’API.
25. Cliquez sur Terminer pour sauvegarder votre configuration.

Mappage de données par défaut

Cette section contient des informations sur les champs par défaut pour les tâches XM Discover Inbound Link.

Lors du mappage de vos champs, les champs par défaut suivants sont disponibles :

• feedback_type : le type de feedback vous aide à identifier les données en fonction de leur type. Cela est utile pour le reporting lorsque votre projet contient différents types de données (par exemple, des enquêtes et des commentaires sur les médias sociaux). Cette zone est modifiable. Par défaut, la valeur de cet attribut est définie sur :
  • « appel » pour les transcriptions d’appel
  • « chat » pour les interactions digitales
  • « feedback » pour les avis individuels
  • Vous pouvez utiliser des transformations personnalisées pour définir une valeur personnalisée.
• source : la source vous aide à identifier les données obtenues à partir d’une source spécifique. Il peut s’agir de tout ce qui décrit l’origine des données, comme le nom d’une enquête ou d’une campagne marketing mobile. Cette zone est modifiable. Par défaut, la valeur de cet attribut est définie sur « Lien XM Discover ». Vous pouvez utiliser la transformation personnalisée pour définir une valeur personnalisée.
• richVerbatim : cette zone est utilisée pour les données conversationnelles (telles que les transcriptions d’appels et de discussions en direct) et n’est pas modifiable. XM Discover utilise un format verbatim conversationnel pour le champ richVerbatim. Ce format prend en charge l’ingestion des métadonnées spécifiques au dialogue requises pour débloquer la visualisation conversationnelle (tours de haut-parleur, silence, événements conversationnels, etc.) et les enrichissements (heure de début, durée, etc.). Ce champ verbatim comprend des champs « enfant » pour suivre le côté client et le côté représentant de la conversation :
  • clientVerbatim suit le côté client de la conversation.
  • agentVerbatim suit le côté (de l’agent) du représentant de la conversation.
  • inconnu suit le côté inconnu de la conversation.
• Astuce Qualtrics : les transformations ne sont pas prises en charge pour les champs verbatim conversationnels. Le même mot ne peut pas être utilisé pour différents types de données conversationnelles. Si vous souhaitez que votre projet héberge plusieurs types de conversation, utilisez des paires séparées de verbatims conversationnels par type de conversation.
• clientVerbatim : ce champ est utilisé pour les données conversationnelles et est modifiable. Cette zone permet de suivre le côté client de la conversation dans les interactions d’appel et de discussion en direct. Par défaut, ce champ est mappé sur :
  • clientVerbatimChat pour les interactions numériques.
  • clientVerbatimAppeler des interactions d’appel.
• agentVerbatim : cette zone est utilisée pour les données conversationnelles et est modifiable. Cette zone permet de suivre le côté représentant de la conversation dans les interactions d’appel et de discussion en direct. Par défaut, ce champ est mappé sur :
  • agentVerbatimChat pour les interactions numériques.
  • agentVerbatimAppeler pour les interactions d’appel.
• inconnu : cette zone est utilisée pour des données conversationnelles et est modifiable. Ce champ suit le côté inconnu de la conversation dans les interactions d’appel et de discussion en direct. Par défaut, ce champ est mappé sur :
  • unknownVerbatimChat pour les interactions numériques.
  • unknownVerbatimCall for call interactions.
• document_date : la date du document est le champ de date principal associé à un document. Cette date est utilisée dans les rapports XM Discover, les tendances, les alertes, etc. Pour la date du document, sélectionnez l’une des options suivantes :
  • conversationTimestamp (pour les données conversationnelles) : date et heure de toute la conversation.
  • Si les données source contiennent d’autres zones de date, vous pouvez définir l’une d’elles comme date du document en la sélectionnant dans le menu déroulant de la zone Nom de zone.
  • Vous pouvez également définir une date spécifique en ajoutant une zone personnalisée.
• natural_id : ID naturel sert d’identifiant unique d’un document et permet de traiter correctement les doublons. Pour l’ID naturel, sélectionnez l’une des options suivantes :
  • conversationId (pour les données conversationnelles) : ID unique pour l’ensemble de la conversation.
  • Sélectionnez un champ texte ou numérique parmi vos données dans Nom de champ.
  • Générez automatiquement des ID en ajoutant une zone personnalisée.
• feedback_provider : le fournisseur de feedback vous aide à identifier les données obtenues auprès d’un fournisseur spécifique. Pour les chargements XM Discover Link, la valeur de cet attribut est définie sur « Lien de découverte XM » et ne peut pas être modifiée.
• job_name : le nom du job vous aide à identifier les données en fonction du nom du job utilisé pour le chargement. Vous pouvez modifier la valeur de cet attribut dans la zone Nom de la tâche en haut de la page ou à l’aide du menu des options de tâche.
• loadDate : la date de chargement indique quand un document a été téléchargé dans XM Discover. Cette zone est définie automatiquement et ne peut pas être modifiée.

En plus des champs ci-dessus, vous pouvez également mapper les champs personnalisés que vous souhaitez importer. Consultez la page d’assistance Mappage des données pour plus d’informations sur les champs personnalisés.

Accès au point de terminaison de l’API

Le point de terminaison de l’API est utilisé pour charger des données dans XM Discover en envoyant les données via une demande d’API REST au format JSON.

Vous pouvez accéder au point de terminaison à partir de la page Tâches :

1. Sélectionnez Synthèse dans le menu des options du job pour votre job.
   
2. Cliquez sur le lien Documentation API.
   
3. Cliquez sur le bouton Imprimer pour télécharger toutes les informations de cette fenêtre au format PDF imprimable.
   
4. Vos informations de point de terminaison incluent :
   • URL de l’API : URL utilisée pour la demande d’API.
   • Méthode : utilisez la méthode POST pour charger les données dans XM Discover.
   • ID de la tâche : ID de la tâche actuellement sélectionnée.
5. Un exemple de données utiles JSON est inclus dans la section Corps de la demande. Une demande d’API doit contenir un seul document et inclure uniquement les champs dans les données utiles de l’exemple.
6. La section Réponses répertorie les réponses de réussite et d’erreur possibles de la demande d’API.
   
7. La section Schéma affiche le schéma de données. Les champs obligatoires se trouvent dans le tableau requis.

Suivi d’une tâche XM Discover Link via une API

Vous pouvez suivre le statut des tâches XM Discover Link sans vous connecter à XM Discover en appelant le point de terminaison de l’API de statut. Cela vous permet d’obtenir le statut d’exécution du job le plus récent, les métriques pour une exécution de job spécifique ou les métriques cumulées pour une période spécifique.

Informations sur le point d’extrémité du statut

Pour appeler le point de terminaison de statut, vous aurez besoin des éléments suivants :

• URL de l’API : https://na-data.clarabridge.net/v1/public/job/status/<jobID> ?apiKey=<apiKey>
  • <jobId> est l’ID de la tâche XM Discover Link que vous souhaitez surveiller.
  • <apiKey> est le jeton API.
• Type : utilisez REST HTTP
• Méthode HTTP : utilisez la méthode GET pour extraire les données.

Éléments d’entrée

Les éléments d’entrée facultatifs suivants peuvent être utilisés pour récupérer des métriques supplémentaires sur votre job :

• historicalRunId : ID de la session de chargement spécifique. Si cet élément est omis et qu’aucune plage de dates n’est fournie, l’appel d’API renvoie le dernier statut d’exécution de la tâche. Si cet élément est omis et qu’une plage de dates est fournie, l’appel d’API renvoie les métriques cumulées pour la période indiquée.
• startDate : définissez la date de début à partir de laquelle les données doivent être renvoyées.
• endDate : définissez la date de fin pour renvoyer les données en fonction du dernier chargement. Si cet élément est omis et que startDate est fourni, endDate est automatiquement défini sur la date actuelle.

Éléments de sortie

Les éléments de sortie suivants sont renvoyés, à condition que vous ayez saisi les éléments d’entrée requis :

• job_status : statut du job.
• job_failure_reason : si le job a échoué, la raison de l’échec.
• run_metric : informations sur les documents traités par le job. Les métriques suivantes sont incluses :
  • SUCCESSFULLY_CREATED : nombre de documents créés avec succès.
  • SUCCESSFULLY_UPDATED : Nombre de documents mis à jour avec succès.
  • SKIPPED_AS_DUPLICATES : nombre de documents ignorés en tant que doublons.
  • FILTERED_OUT : nombre de documents filtrés par filtre spécifique à la source ou filtre de connecteur.
  • BAD_RECORD : nombre d’interactions numériques soumises pour traitement qui ne correspondaient pas au format conversationnel Qualtrics.
  • SKIPPED_NO_ACTION : le nombre de documents ignorés en tant que documents non dupliqués.
  • FAILED_TO_LOAD : nombre de documents dont le chargement a échoué.
  • TOTAL : nombre total de documents traités lors de l’exécution de ce job.

Messages d’erreur

Le message d’erreur suivant est possible pour la demande de statut API :

• 401 Non autorisé : échec de l’authentification. Utilisez une autre clé API.
• 404 Introuvable : un job avec l’ID spécifié n’existe pas. Utilisez un autre ID de job.

Exemple de requête

Vous trouverez ci-dessous un exemple de demande pour obtenir le statut d’un job:

curl --location --request GET 'https://na-data.clarabridge.net/v1/public/job/status/62da736987c9788b830918e0?apiKey=02e7a0e26b592632dd50f623e974fff6'

Exemple de réponse

Vous trouverez ci-dessous un exemple de réponse d’un job ayant échoué :
{
"job_status": "fail",
"job_failure_reason": "{\"issue\":[{\"requestId":"RQ-MOB-f339aa58-71b6-4a1d-a67c-12b8d3439321","severity":"ERROR","description":"Length limit of 900 characters for Attribute supportenexpériesp has been"le}":"RO_length":"length":"Length limit of 900 characters for Attribute supportenexpériesp has been"le}":"RO_length":"Length limit of 900 characters for supportenexpériesp has been"le}":"RO_length":"
length":"Length limit of 900 characters for attribut supportenexpériesp has been"le}
","length": "RO_status":"Length limit of 900 characters for supportenceresp has been"le}","length": "RO_status":"Length of 900 characters for attribut supportenceresp has been"le}","length": "RO_status
":"Length of 900 characters\ attr

.

Exemples de données utiles

Cette section contient 1 exemple de données utiles JSON pour chaque type de données structurées pris en charge (feedback, discussion en direct, appel).

Cliquez ici pour afficher les données utiles de l’exemple de feedback.

curl --location --request POST 'https://na-data.clarabridge.net/v1/cb_link?apie_1
=

887fc11663c456f9f34844a8a8bdff64&jobId=5f4e583f9142ae48a1090a76 --
header 'Content-Type: application/json' \
--data-raw '{
"dataSource": "Standard JSON",
"Row_ID": "id43682",

"store_number": "226,1,0,0",

"address": "5916 W Loorep" "store_number" Continue up the good work.",
"LTR": 10,
"state": "TX",
"Rewards_Member": "MyBestBuy"
}'

Cliquez ici pour afficher les données utiles de l’exemple de discussion en direct.

curl --location --request POST 'https://na-data.clarabridge.net/v1/cb_link?apiKey,887fc11663c456f9f34844a8a8bdff64

&jobId=5f4d77656afa99b0396ef959 -
-header 'Content-Type: application

/json' \
--data-raw '{
"conversationId": "37854",
"conversationTimestamp": "2020-07-30T12:42:15.000Z",
"content": {
"contentENT Type": "CHAT",

" "content": "contentENT Type": "CHAT",
" "content
",
"timestamp": "2020-07-30T12:42:15.000Z",
"id": "3785201"
},
{
"participantId": "2",
"text": "Hi, are you open Today?",
"timestamp": "2020-07-30T12:42:15.000Z",
"id": "3785202"
},
"
participantId": "3720-07-30T12
:15.000Z",I

"

" "
antid":
"3720-07-30T12" Quel nom puis-je utiliser?",
"timestamp": "2020-07-30T12:42:15.000Z",
"id": "3785205"
}
] }
,
"city": "Boston",
"source": "Facebook"
}'

Cliquez ici pour afficher les données utiles de l’exemple d’appel.

curl --location --request POST 'https://na-data.clarabridge.net/v1/cb_link?apiKey,887fc11663c456f9f34844a8a8bdff64&jobId=5f4e564d9242ae6e6308ff04' \
--header 'Content-Type: application/json' \
--data-raw '{
"conversationId": "462896",
"conversationTimestamp": "2020-07-30T10:15:45.000Z",
"content": {
"participENT Type": "CALL"" "
" "content": {"contentENT Type": "CALL"" "
" "content": {"contentENT Type": "CALL"" "
" "content": {"participentType": "CALL"" "
" "content": {
"contentENT Type": "CALL"" "
" "content": {
"contentENT Type": "CALL"" "
" "content": {contentENT Type": "CALL"" "
" "content": {contentENT Type": "CALL"" "
" "content": "contentent Type": "CALL"
" "
" "type": "
" type: "contentent Type": "CALL"
" "
" "type": "
",
"start": 22000,
"end": 32000
},
{
"participant_id": "2",
"text": "Hi, I have a two of questions.",
"start": 32000,
"end": 42000
}
],
"contentSegmentType": "TURN"
},
"city"
: "Boston" "
Boston"

&nbsp ;