API
La documentation technique pour notre API sera bientôt disponible.
Mass-export
Pour effectuer un export de masse des données de conversations, vous pouvez consulter cette documentation technique :
https://api.satisfaction.ai/documentation/mass-export/.
- Fichier de sortie JSON
Le fichier de sortie et un fichier de format JSON comme par exemple celui-ci:
Si vous ne pouvez pas ouvrir facilement ce fichier JSON, vous pouvez trouver ci dessous le contenu de ce fichier ainsi que les définitions (dans le texte ci dessous, à droite des caractères “//” ) de toutes les données qui peuvent être exportées :
For one api query with theses parameters
timeZone=Europe/Paris
app_id=instance_app_id
start=Start date for the export
end=End date for the export
from=offset of export
all dates are UTC defined
{
"total": 11, // Total of sessions contained in the time range
"start": 1528149600000, // Start date for the export (Unix epoch millisecond format)
"end": 1528235999999, // End date for the export, Unix epoch millisecond format, The end date can't be today date
"sessions": [ // Transcripts belonging to the time range and the step defined
{
"Channel": "web", // The communication channel used by the client
"Duration": 17858, // Time of the discussion between client and agent. expressed in milliseconds
"End": "2018-06-05T21:23:20.725Z", // Last message received date
"Received": 1, // Number of client messages received on our platform
"Sent": 8, // Numer of agent messages sent
"Start": "2018-06-05T21:23:02.867Z", // First message sent or received date
"Step": 4.5, // the number of exchanges that have taken
"Total": 9, // Number of messages exchanged
"UniqueId": "bf1aad6c-338a-40c9-8385-e0d154622bee", // Unique identifier of this transcript
"ExternalUserId": "5c6e22db-0fc1-4a9f-9242-12beaf4eb852", // External Client Identifier, client dependant
"Atmosphere": "unknown", // Global atmosphere of the discussion. atmosphere can be one of: positive, neutral_positive, neutral_negative and negative
"Waiting": false, // true if the session was waiting at the end of the conversation, false otherwise
"Handled": false, // True if the session has been handled, false otherwise
"Messages": [ // List of all messages between client and agent
{
"Date": "2018-06-05T21:23:02.866Z", // Date of the message
"Type": "text", // Type of the message one of text, button
"From": "bot", // Who sent the message, one of user, bot
"Message": "Bonjour, je suis un assistant virtuel spécialiste des questions sur l'assurance.",
"Atmosphere": "unknown", // Atmosphere of the current message, one of : positive, neutral_positive, neutral_negative and negative
"AthenaElection": "", // DialogManager election based on user input, one of : "", default, intent_name, keyword matching, click_button, data extract or off topic, disambiguation
"AthenaExtraction":[]
},
{
"Date": "2018-06-05T21:23:04.882Z",
"Type": "text",
"From": "bot",
"Message": "Pour revenir au menu, veuillez écrire \"retour\" dans la zone de saisie \"Poser ma question\".",
"Atmosphere": "unknown",
"AthenaElection": "",
"AthenaExtraction":[]
},
{
"Date": "2018-06-05T21:23:07.899Z",
"Type": "text",
"From": "bot",
"Message": "En quoi puis-je vous aider ? :)",
"Atmosphere": "unknown",
"AthenaElection": "",
"AthenaExtraction":[]
},
{
"Date": "2018-06-05T21:23:08.914Z",
"Type": "text",
"From": "bot",
"Message": "[button title=\"M'informer sur l'assurance habitation\"]INFORMER[/button][button title=\"Faire un devis rapide\"]DEVIS[/button][button title=\"Déclarer un sinistre\"]CLA[/button][button title=\"Souscrire une assurance habitation\"]SOUSCRIRE[/button][button title=\"J'ai besoin d'une autre information\"]AUTRE[/button]",
"Atmosphere": "unknown",
"AthenaElection": "",
"AthenaExtraction":[]
},
{
"Date": "2018-06-05T21:23:14.672Z",
"Type": "button",
"From": "user",
"Message": "DEVIS",
"Atmosphere": "unknown",
"AthenaElection": "",
"AthenaExtraction":[]
},
{
"Date": "2018-06-05T21:23:14.688Z",
"Type": "text",
"From": "bot",
"Message": "Je suis heureux que vous pensiez à nous pour votre habitation !",
"Atmosphere": "unknown",
"AthenaElection": "",
"AthenaExtraction":[]
},
{
"Date": "2018-06-05T21:23:16.690Z",
"Type": "text",
"From": "bot",
"Message": "Obtenez un tarif habitation personnalisé à votre besoin [url=https://caassure.fr/tarif-express-habitation/#/]en cliquant ici[/url].",
"Atmosphere": "unknown",
"AthenaElection": "",
"AthenaExtraction":[]
},
{
"Date": "2018-06-05T21:23:18.708Z",
"Type": "text",
"From": "bot",
"Message": "Dîtes-nous si l'assistant virtuel a bien répondu à vos questions :",
"Atmosphere": "unknown",
"AthenaElection": "",
"AthenaExtraction":[]
},
{
"Date": "2018-06-05T21:23:20.724Z",
"Type": "text",
"From": "bot",
"Message": "[button type=\"url\" title=\"Donner mon avis\"]https://caassure.eu./jfe/form/9[/button]",
"Atmosphere": "unknown",
"AthenaElection": "",
"AthenaExtraction":[]
}
]
}
]
}
Pour plus d’informations sur ce qu’est un fichier JSON, veuillez consulter par exemple cette documentation externe: https://www.wikihow.com/Use-JSON
- Extraction des entités
Une fois l’export effectuée, l’entité (si détecté dans la phrase) est identifiable via la donnée suivante:
"AthenaExtraction":[]
NB:
Si vos utilisateurs fournissent des données personnelles dans les conversations avec votre xBot, ces données personnelles seront présentent dans les transcripts et les exports pendant seulement 28 jours, ceci afin d’être en accord avec le règlement général de l’UE sur la protection des données (RGPD).
Après 28 jours, l’export contiendra toujours la typologie de l’entité extraite (= par exemple Date, Time, Nom, Prenom) mais certaines données extraites seront anonymisées selon notre processus d’anonymsation des données.
- Export des métadonnées
Une métadonnée est une donnée qui sert à définir ou décrire une autre donnée.
Pour extraire la métadonnée de votre choix, il vous faut trouver l’Event / CustomMessage names correspondant dans la page de transcript après avoir cliqué sur “Show all events”. L’information à identifier est en rouge dans le détail du transcript et peut être introduit par exemple par ceci:
Ensuite une fois cette clef de message event exactement identifiée, il faut ajouter à la fin de l’url de la requête d’extraction le paramètre supplémentaire keys= pour obtenir la metadata voulue.
Exemple:
En prenant exactement le même exemple listé dans notre documentation technique , pour une métadonnée dont l’event est nommé par exemple eventmetadata dans le transcript, l’url d’extraction sera :
https://api.satisfaction.ai/reporting/transcripts/export?app_id=5463060b-3db7-4282-91cf-667491fec492&start=1528149600000&end=1528235999999&from=10&keys=eventmetadata
Documented/reviewed 01/04/2019 7:12:55 AM