Référence d'événement de segment

Les tableaux suivants présentent les détails des événements que watsonx Assistant envoie à Segment à l'aide de l'extension de segment. Ces événements apparaissent sous la forme de tables dans votre entrepôt de segments et d'événements réguliers dans d'autres destinations.

Seuls les événements générés à l'aide de l'API watsonx Assistant v2 et associés à un ID utilisateur sont inclus.

Message traité

Envoyé lorsque l'assistant termine le traitement d'un message.

Propriété Type Description
accountId Chaîne ID du compte IBM.
assistantId Chaîne ID de l'assistant.
browser Chaîne Navigateur utilisé pour envoyer le message.
channel Chaîne Canal utilisé par le client pour envoyer le message (par exemple, phone ou chat).
device Chaîne Type d'unité utilisé pour envoyer le message.
environment Chaîne Environnement dans lequel le message a été traité (par exemple, draft ou live).
language Chaîne Langue de l'assistant.
pageUrl Chaîne URL de la page Web à partir de laquelle le message a été envoyé.
serviceInstance Chaîne L'instance de service IBM watsonx Assistant.
sessionId Chaîne ID de la session au cours de laquelle le message a été traité.
skillsInvoked Chaîne[] Tableau de chaînes répertoriant toutes les compétences appelées lors du traitement du message (par exemple, main skill ou actions skill).

Les propriétés suivantes sont incluses uniquement pour les messages qui ont été gérés par une compétence d'actions:

Propriété Type Description
action Chaîne Identificateur unique de l'action visitée lors du traitement du message (par exemple, action_202).
actionCompleted Booléen Indique si l'action s'est terminée lors du traitement du message.
actionCompletedReason Chaîne Raison pour laquelle l'action s'est terminée (par exemple, all_steps_done ou fallback).
actionStarted Booléen Indique si le traitement de l'action a démarré lors du traitement du message.
actionTitle Chaîne Titre de l'action visitée lors du traitement du message (par exemple, I want to pay my bill).
actionsVisited Chaîne[] Tableau de chaînes répertoriant les actions visitées lors du traitement du message.
fallbackReason Chaîne Raison pour laquelle l'action de rétromigration a été visitée (par exemple, escalade à l'agent humain ou aucune correspondance d'action).
handler Chaîne Nom de tout gestionnaire appelé.
stepsVisited Objet[] Un objet avec deux propriétés, stepId et stepTitle, qui répertorie les étapes que l'utilisateur a visitées lors du traitement du message.
subaction Chaîne Nom de toute autre action appelée par l'action qui a été déclenchée par le message.

Les propriétés suivantes sont incluses uniquement pour les messages qui ont été traités par une compétence de dialogue:

Propriété Type Description
branchExited Booléen Indique si la branche de dialogue a été fermée lors du traitement du message.
branchExitedReason Chaîne Raison pour laquelle la branche de dialogue a été fermée (par exemple, completed).
nodesVisited Chaîne[] Tableau de chaînes répertoriant les noeuds de dialogue visités lors de la gestion du message. Pour chaque noeud de dialogue, la chaîne spécifie le titre du noeud (le cas échéant) ou l'ID du noeud.

Action démarrée

Envoyé lorsque le traitement d'une action commence.

Propriété Type Description
accountId Chaîne ID du compte IBM.
action Chaîne Identificateur unique de l'action (par exemple, action_202).
actionTitle Chaîne Titre de l'action (par exemple, I want to pay my bill).
actionCompleted Booléen Indique si l'action s'est terminée lors du même échange de conversation.
actionCompletedReason Chaîne Raison pour laquelle l'action s'est terminée (par exemple, all_steps_done ou fallback).
assistantId Chaîne ID de l'assistant.
browser Chaîne Navigateur utilisé pour envoyer le message qui a déclenché l'action.
channel Chaîne Canal utilisé par le client pour envoyer le message qui a déclenché l'action (par exemple, phone ou chat).
device Chaîne Type de périphérique utilisé pour envoyer le message qui a déclenché l'action.
environment Chaîne Environnement dans lequel l'action a été démarrée (par exemple, draft ou live).
fallbackReason Chaîne Raison pour laquelle l'action de rétromigration a démarré (par exemple, escalade à l'agent humain ou aucune correspondance d'action).
handler Chaîne Nom de tout gestionnaire appelé.
language Chaîne Langue de l'assistant.
pageUrl Chaîne URL de la page Web à partir de laquelle le message qui a déclenché l'action a été envoyé.
serviceInstance Chaîne L'instance de service IBM watsonx Assistant.
sessionId Chaîne ID de la session au cours de laquelle le message qui a lancé l'action a été envoyé.
skillsInvoked Chaîne[] Tableau de chaînes répertoriant toutes les compétences qui ont été appelées lors du traitement du message qui a démarré l'action (par exemple, main skill ou actions skill).
stepsVisited Objet[] Un objet avec deux propriétés, stepId et stepTitle, qui répertorie les étapes que l'utilisateur a visitées lors du traitement du message.
subaction Chaîne Nom de toute autre action appelée par l'action lors du traitement.

Action terminée

Envoyé à la fin du traitement d'une action.

Propriété Type Description
accountId Chaîne ID du compte IBM.
action Chaîne Identificateur unique de l'action (par exemple, action_202).
actionCompletedReason Chaîne Raison pour laquelle l'action s'est terminée (par exemple, all_steps_done ou fallback).
actionStarted Booléen Indique si l'action a été démarrée lors du même échange de conversation.
actionTitle Chaîne Titre de l'action (par exemple, I want to pay my bill).
assistantId Chaîne ID de l'assistant.
browser Chaîne Navigateur utilisé pour envoyer le message qui a déclenché l'action.
channel Chaîne Canal utilisé par le client pour envoyer le message qui a lancé l'action (par exemple, phone ou chat).
device Chaîne Type de périphérique utilisé pour envoyer le message qui a déclenché l'action.
environment Chaîne Environnement dans lequel l'action s'est terminée (par exemple, draft ou live).
fallbackReason Chaîne Raison pour laquelle l'action de rétromigration a été appelée (par exemple, escalade à l'agent humain ou aucune correspondance d'action).
handler Chaîne Nom de tout gestionnaire appelé par l'action.
language Chaîne Langue de l'assistant.
pageUrl Chaîne URL de la page Web à partir de laquelle le message qui a déclenché l'action a été envoyé.
serviceInstance Chaîne L'instance de service IBM watsonx Assistant.
sessionId Chaîne ID de la session au cours de laquelle le message qui a lancé l'action a été envoyé.
skillsInvoked Chaîne[] Tableau de chaînes répertoriant toutes les compétences qui ont été appelées lors du traitement du message qui a démarré l'action (par exemple, main skill ou actions skill).
stepsVisited Objet[] Un objet avec deux propriétés, stepId et stepTitle, qui répertorie les étapes que l'utilisateur a visitées lors du traitement du message.
subaction Chaîne Nom de toute autre action appelée par l'action lors du traitement.

Session démarrée

Envoyé lorsqu'une nouvelle session est démarrée.

Remarque: l'API sans état v2 ne génère pas d'événements pour le démarrage de sessions.

Propriété Type Description
accountId Chaîne ID du compte IBM.
assistantId Chaîne ID de l'assistant.
browser Chaîne Navigateur utilisé pour envoyer le message qui a démarré la session.
channel Chaîne Canal qui a démarré la session (par exemple, phone ou chat).
device Chaîne Type d'unité utilisé pour envoyer le message qui a démarré la session.
environment Chaîne Environnement dans lequel la session a été démarrée (par exemple, draft ou live).
pageUrl Chaîne URL de la page Web à partir de laquelle le message qui a démarré la session a été envoyé.
serviceInstance Chaîne L'instance de service IBM watsonx Assistant.
sessionId Chaîne ID de la session.