Riferimento evento segmento

Le seguenti tabelle mostrano i dettagli degli eventi che watsonx Assistant invia a Segment utilizzando l'estensione Segment. Questi eventi appaiono come tabelle nel tuo magazzino Segmento, e come eventi regolari in altre Destinazioni.

Sono inclusi solo gli eventi generati utilizzando l'API watsonx Assistant v2 e associati a un ID utente.

Messaggio Gestito

Inviato quando l'assistente completa la gestione di un messaggio.

Proprietà Immettere Descrizione
accountId Stringa L'ID dell'account IBM.
assistantId Stringa L'ID dell'assistente.
browser Stringa Il browser utilizzato per inviare il messaggio.
channel Stringa Il canale il cliente utilizzato per inviare il messaggio (ad esempio phone o chat).
device Stringa Il tipo di dispositivo utilizzato per inviare il messaggio.
environment Stringa L'ambiente in cui è stato gestito il messaggio (come draft o live.)
language Stringa La lingua dell'assistente.
pageUrl Stringa L' URL della pagina Web da cui è stato inviato il messaggio.
serviceInstance Stringa L'istanza del servizio IBM watsonx Assistant.
sessionId Stringa L'ID della sessione durante la quale è stato gestito il messaggio.
skillsInvoked Stringa[] Una schiera di stringhe che elencano tutte le competenze richiamate durante la gestione del messaggio (ad esempio main skill o actions skill).

Le seguenti proprietà sono incluse solo per i messaggi gestiti da un'abilità di azioni:

Proprietà Immettere Descrizione
action Stringa L'identificativo univoco dell'azione visitata durante la gestione del messaggio (ad esempio action_202).
actionCompleted Booleano Se l'azione completata durante la gestione del messaggio.
actionCompletedReason Stringa Il motivo per cui l'azione è stata completata (ad esempio all_steps_done o fallback.)
actionStarted Booleano Se l'elaborazione dell'azione è iniziata durante la gestione del messaggio.
actionTitle Stringa Il titolo dell'azione visitata durante la gestione del messaggio (ad esempio, I want to pay my bill).
actionsVisited Stringa[] Una schiera di stringhe che elencano le azioni visitate durante la gestione del messaggio.
fallbackReason Stringa Il motivo per cui è stata visitata l'azione di fallback (ad esempio, inoltrata all'agente umano o nessuna corrispondenza di azione).
handler Stringa Il nome di qualsiasi gestore chiamato.
stepsVisited Oggetto[] Un oggetto con due proprietà, stepId e stepTitle, che elenca i passi visitati dall'utente durante la gestione del messaggio.
subaction Stringa Il nome di ogni altra azione che è stata chiamata dall'azione innescata dal messaggio.

Le seguenti proprietà sono incluse solo per i messaggi gestiti da un'abilità di dialogo:

Proprietà Immettere Descrizione
branchExited Booleano Se il ramo di dialogo è stato esitato durante la gestione del messaggio.
branchExitedReason Stringa Il motivo per cui il ramo di dialogo è stato esitato (ad esempio, completed).
nodesVisited Stringa[] Una schiera di stringhe che elencano i nodi di dialogo visitati durante la gestione del messaggio. Per ogni nodo di dialogo, la stringa specifica il titolo del nodo (se presente) o il nodo ID.

Azione avviata

Inviato quando inizia l'elaborazione di un'azione.

Proprietà Immettere Descrizione
accountId Stringa L'ID dell'account IBM.
action Stringa L'identificativo univoco dell'azione (ad esempio, action_202).
actionTitle Stringa Il titolo dell'azione (ad esempio, I want to pay my bill).
actionCompleted Booleano Se l'azione completata durante lo stesso turno di conversazione.
actionCompletedReason Stringa Il motivo per cui l'azione è stata completata (ad esempio all_steps_done o fallback.)
assistantId Stringa L'ID dell'assistente.
browser Stringa Il browser utilizzato per inviare il messaggio che ha innescato l'azione.
channel Stringa Il canale il cliente utilizzato per inviare il messaggio che ha innescato l'azione (ad esempio phone o chat).
device Stringa Il tipo di dispositivo utilizzato per inviare il messaggio che ha innescato l'azione.
environment Stringa L'ambiente in cui è stata avviata l'azione (come draft o live.)
fallbackReason Stringa Il motivo per cui l'azione di fallback è iniziata (ad esempio, escalation all'agente umano o nessuna corrispondenza di azione).
handler Stringa Il nome di qualsiasi gestore chiamato.
language Stringa La lingua dell'assistente.
pageUrl Stringa L' URL della pagina Web da cui è stato inviato il messaggio che ha attivato l'azione.
serviceInstance Stringa L'istanza del servizio IBM watsonx Assistant.
sessionId Stringa L'ID della sessione durante la quale è stato inviato il messaggio che ha avviato l'azione.
skillsInvoked Stringa[] Una schiera di stringhe che elencano tutte le competenze richiamate durante la gestione del messaggio che ha avviato l'azione (ad esempio main skill o actions skill).
stepsVisited Oggetto[] Un oggetto con due proprietà, stepId e stepTitle, che elenca i passi visitati dall'utente durante la gestione del messaggio.
subaction Stringa Il nome di ogni altra azione che l'azione ha chiamato durante l'elaborazione.

Azione completata

Inviato quando termina l'elaborazione di un'azione.

Proprietà Immettere Descrizione
accountId Stringa L'ID dell'account IBM.
action Stringa L'identificativo univoco dell'azione (ad esempio, action_202).
actionCompletedReason Stringa Il motivo per cui l'azione è stata completata (ad esempio all_steps_done o fallback.)
actionStarted Booleano Se l'azione è stata avviata durante lo stesso turno di conversazione.
actionTitle Stringa Il titolo dell'azione (ad esempio, I want to pay my bill).
assistantId Stringa L'ID dell'assistente.
browser Stringa Il browser utilizzato per inviare il messaggio che ha innescato l'azione.
channel Stringa Il canale il cliente utilizzato per inviare il messaggio che ha avviato l'azione (ad esempio phone o chat).
device Stringa Il tipo di dispositivo utilizzato per inviare il messaggio che ha innescato l'azione.
environment Stringa L'ambiente in cui l'azione è stata completata (come draft o live.)
fallbackReason Stringa Il motivo per cui l'azione di fallback è stata chiamata (ad esempio, escalation all'agente umano o nessuna corrispondenza di azione).
handler Stringa Il nome di qualsiasi gestore chiamato dall'azione.
language Stringa La lingua dell'assistente.
pageUrl Stringa L' URL della pagina Web da cui è stato inviato il messaggio che ha attivato l'azione.
serviceInstance Stringa L'istanza del servizio IBM watsonx Assistant.
sessionId Stringa L'ID della sessione durante la quale è stato inviato il messaggio che ha avviato l'azione.
skillsInvoked Stringa[] Una schiera di stringhe che elencano tutte le competenze richiamate durante la gestione del messaggio che ha avviato l'azione (ad esempio main skill o actions skill).
stepsVisited Oggetto[] Un oggetto con due proprietà, stepId e stepTitle, che elenca i passi visitati dall'utente durante la gestione del messaggio.
subaction Stringa Il nome di ogni altra azione che l'azione ha chiamato durante l'elaborazione.

Sessione Avviata

Inviato quando viene avviata una nuova sessione.

Nota: L'API stateless v2 non genera eventi per le sessioni di avvio.

Proprietà Immettere Descrizione
accountId Stringa L'ID dell'account IBM.
assistantId Stringa L'ID dell'assistente.
browser Stringa Il browser utilizzato per inviare il messaggio che ha avviato la sessione.
channel Stringa Il canale che ha avviato la sessione (ad esempio phone o chat).
device Stringa Il tipo di dispositivo utilizzato per inviare il messaggio che ha avviato la sessione.
environment Stringa L'ambiente in cui è stata avviata la sessione (come draft o live.)
pageUrl Stringa L' URL della pagina Web da cui è stato inviato il messaggio che ha avviato la sessione.
serviceInstance Stringa L'istanza del servizio IBM watsonx Assistant.
sessionId Stringa L'ID della sessione.