Referência de evento de segmento

As tabelas a seguir mostram detalhes dos eventos que o watsonx Assistant envia para o Segmento usando a extensão do Segmento. Esses eventos aparecem como tabelas em seu warehouse de Segmento e como eventos regulares em outros Destinos

Somente eventos gerados usando a API watsonx Assistant v2 e associados a um ID do usuário são incluídos.

Mensagem manipulada

Enviado quando o assistente conclui a manipulação de uma mensagem

Propriedade Tipo Descrição
accountId Sequência O ID da conta IBM.
assistantId Sequência O ID do assistente..
browser Sequência O navegador que foi usado para enviar a mensagem
channel Sequência O canal usado pelo cliente para enviar a mensagem (por exemplo, phone ou chat).
device Sequência O tipo de dispositivo utilizado para enviar a mensagem.
environment Sequência O ambiente no qual a mensagem foi manipulada (como draft ou live.)
language Sequência O idioma do assistente.
pageUrl Sequência A URL da página da web da qual a mensagem foi enviada.
serviceInstance Sequência A instância de serviço IBM watsonx Assistant.
sessionId Sequência O ID da sessão durante a qual a mensagem foi manipulada.
skillsInvoked Sequência[] Uma matriz de sequências listando todas as qualificações que foram chamadas durante a manipulação da mensagem (por exemplo, main skill ou actions skill).

As propriedades a seguir são incluídas apenas para mensagens que foram manipuladas por uma qualificação de ações:

Propriedade Tipo Descrição
action Sequência O identificador exclusivo da ação visitada durante a manipulação da mensagem (por exemplo, action_202).
actionCompleted booleano Se a ação foi concluída durante a manipulação da mensagem.
actionCompletedReason Sequência O motivo pelo qual a ação foi concluída (por exemplo, all_steps_done ou fallback)
actionStarted booleano Se o processamento da ação foi iniciado durante a manipulação da mensagem
actionTitle Sequência O título da ação visitada durante a manipulação da mensagem (por exemplo, I want to pay my bill).
actionsVisited Sequência[] Uma matriz de sequências que listam as ações visitadas durante a manipulação da mensagem
fallbackReason Sequência O motivo pelo qual a ação de fallback foi visitada (por exemplo, escalada para agente humano ou nenhuma ação correspondente).
handler Sequência O nome de qualquer manipulador que foi chamado.
stepsVisited Objeto[] Um objeto com duas propriedades, stepId e stepTitle, que lista as etapas que o usuário visitou durante a manipulação da mensagem..
subaction Sequência O nome de qualquer outra ação que foi chamada pela ação acionada pela mensagem.

As seguintes propriedades são incluídas apenas para mensagens que foram manipuladas por uma qualificação de diálogo:

Propriedade Tipo Descrição
branchExited booleano Se a ramificação do diálogo foi encerrada durante a manipulação da mensagem..
branchExitedReason Sequência O motivo pelo qual a ramificação do diálogo foi encerrada (por exemplo, completed)
nodesVisited Sequência[] Uma matriz de sequências que listam os nós de diálogo visitados durante a manipulação da mensagem Para cada nó de diálogo, a sequência especifica o título do nó (se houver) ou o ID do nó.

Ação iniciada

Enviado quando o processamento de uma ação é iniciado

Propriedade Tipo Descrição
accountId Sequência O ID da conta IBM.
action Sequência O identificador exclusivo da ação (por exemplo, action_202)
actionTitle Sequência O título da ação (por exemplo, I want to pay my bill).
actionCompleted booleano Se a ação foi concluída durante a mesma conversa.
actionCompletedReason Sequência O motivo pelo qual a ação foi concluída (por exemplo, all_steps_done ou fallback)
assistantId Sequência O ID do assistente..
browser Sequência O navegador usado para enviar a mensagem que acionou a ação.
channel Sequência O canal usado pelo cliente para enviar a mensagem que acionou a ação (por exemplo, phone ou chat).
device Sequência O tipo de dispositivo usado para enviar a mensagem que acionou a ação.
environment Sequência O ambiente no qual a ação foi iniciada (como draft ou live.)
fallbackReason Sequência O motivo pelo qual a ação de fallback foi iniciada (por exemplo, escalada para agente humano ou nenhuma ação correspondente).
handler Sequência O nome de qualquer manipulador que foi chamado.
language Sequência O idioma do assistente.
pageUrl Sequência A URL da página da web da qual a mensagem que acionou a ação foi enviada.
serviceInstance Sequência A instância de serviço IBM watsonx Assistant.
sessionId Sequência O ID da sessão durante a qual a mensagem que iniciou a ação foi enviada.
skillsInvoked Sequência[] Uma matriz de sequências listando todas as qualificações que foram chamadas durante a manipulação da mensagem que iniciou a ação (por exemplo, main skill ou actions skill).
stepsVisited Objeto[] Um objeto com duas propriedades, stepId e stepTitle, que lista as etapas que o usuário visitou durante a manipulação da mensagem..
subaction Sequência O nome de qualquer outra ação chamada pela ação durante o processamento.

Ação Concluída

Enviado quando o processamento de uma ação termina.

Propriedade Tipo Descrição
accountId Sequência O ID da conta IBM.
action Sequência O identificador exclusivo da ação (por exemplo, action_202)
actionCompletedReason Sequência O motivo pelo qual a ação foi concluída (por exemplo, all_steps_done ou fallback)
actionStarted booleano Se a ação foi iniciada durante a mesma conversa.
actionTitle Sequência O título da ação (por exemplo, I want to pay my bill).
assistantId Sequência O ID do assistente..
browser Sequência O navegador usado para enviar a mensagem que acionou a ação.
channel Sequência O canal usado pelo cliente para enviar a mensagem que iniciou a ação (por exemplo, phone ou chat).
device Sequência O tipo de dispositivo usado para enviar a mensagem que acionou a ação.
environment Sequência O ambiente no qual a ação foi concluída (como draft ou live.)
fallbackReason Sequência O motivo pelo qual a ação de fallback foi chamada (por exemplo, escalada para agente humano ou nenhuma ação correspondente).
handler Sequência O nome de qualquer manipulador que foi chamado pela ação.
language Sequência O idioma do assistente.
pageUrl Sequência A URL da página da web da qual a mensagem que acionou a ação foi enviada.
serviceInstance Sequência A instância de serviço IBM watsonx Assistant.
sessionId Sequência O ID da sessão durante a qual a mensagem que iniciou a ação foi enviada.
skillsInvoked Sequência[] Uma matriz de sequências listando todas as qualificações que foram chamadas durante a manipulação da mensagem que iniciou a ação (por exemplo, main skill ou actions skill).
stepsVisited Objeto[] Um objeto com duas propriedades, stepId e stepTitle, que lista as etapas que o usuário visitou durante a manipulação da mensagem..
subaction Sequência O nome de qualquer outra ação chamada pela ação durante o processamento.

Sessão iniciada

Enviado quando uma nova sessão é iniciada

Nota: a API sem estado v2 não gera eventos para iniciar sessões.

Propriedade Tipo Descrição
accountId Sequência O ID da conta IBM.
assistantId Sequência O ID do assistente..
browser Sequência O navegador que foi usado para enviar a mensagem que iniciou a sessão
channel Sequência O canal que iniciou a sessão (por exemplo, phone ou chat).
device Sequência O tipo de dispositivo utilizado para enviar a mensagem que iniciou a sessão.
environment Sequência O ambiente no qual a sessão foi iniciada (como draft ou live.)
pageUrl Sequência A URL da página da web da qual a mensagem que iniciou a sessão foi enviada.
serviceInstance Sequência A instância de serviço IBM watsonx Assistant.
sessionId Sequência O ID da sessão.