Segmentereignisreferenz

Die folgenden Tabellen enthalten Details zu den Ereignissen, die watsonx Assistant mithilfe der Segmenterweiterung an das Segment sendet. Diese Ereignisse werden als Tabellen in Ihrem Segment-Warehouse und als reguläre Ereignisse in anderen Zielen angezeigt.

Es werden nur Ereignisse eingeschlossen, die mit der API watsonx Assistant v2 generiert und einer Benutzer-ID zugeordnet sind.

Nachricht bearbeitet

Wird gesendet, wenn der Assistent die Verarbeitung einer Nachricht beendet.

Eigenschaft Typ Beschreibung
accountId Zeichenfolge Die ID des IBM-Kontos.
assistantId Zeichenfolge Die ID des Assistenten.
browser Zeichenfolge Der Browser, der zum Senden der Nachricht verwendet wurde.
channel Zeichenfolge The channel the customer used to send the message (for example, phone or chat).
device Zeichenfolge Der Typ des Geräts, das zum Senden der Nachricht verwendet wurde
environment Zeichenfolge Die Umgebung, in der die Nachricht verarbeitet wurde (z. B. draft oder live)
language Zeichenfolge Die Sprache des Assistenten.
pageUrl Zeichenfolge Die URL der Webseite, von der die Nachricht gesendet wurde.
serviceInstance Zeichenfolge Die Serviceinstanz von IBM watsonx Assistant.
sessionId Zeichenfolge Die ID der Sitzung, in der die Nachricht verarbeitet wurde
skillsInvoked Zeichenfolge[] Ein Array von Zeichenfolgen, die alle Skills auflisten, die während der Verarbeitung der Nachricht aufgerufen wurden (z. B. main skill oder actions skill)

Die folgenden Eigenschaften sind nur für Nachrichten eingeschlossen, die von einem Aktionsskill verarbeitet wurden:

Eigenschaft Typ Beschreibung
action Zeichenfolge Die eindeutige Kennung der Aktion, die während der Verarbeitung der Nachricht aufgerufen wurde (z. B. action_202)
actionCompleted Boolesch Gibt an, ob die Aktion während der Verarbeitung der Nachricht abgeschlossen wurde
actionCompletedReason Zeichenfolge Der Grund für den Abschluss der Aktion (z. B. all_steps_done oder fallback).
actionStarted Boolesch Gibt an, ob die Verarbeitung der Aktion während der Verarbeitung der Nachricht gestartet wurde
actionTitle Zeichenfolge Der Titel der Aktion, die während der Verarbeitung der Nachricht aufgerufen wurde (z. B. I want to pay my bill)
actionsVisited Zeichenfolge[] Ein Array von Zeichenfolgen, die die Aktionen auflisten, die während der Verarbeitung der Nachricht aufgerufen wurden.
fallbackReason Zeichenfolge Der Grund für den Besuch der Ausweichaktion (z. B. Eskalation an einen Servicemitarbeiter oder keine übereinstimmende Aktion).
handler Zeichenfolge Der Name eines aufgerufenen Handlers.
stepsVisited Objekt[] Ein Objekt mit zwei Eigenschaften, stepId und stepTitle, das die Schritte auflistet, die der Benutzer während der Verarbeitung der Nachricht besucht hat.
subaction Zeichenfolge Der Name einer anderen Aktion, die von der durch die Nachricht ausgelösten Aktion aufgerufen wurde.

Die folgenden Eigenschaften sind nur für Nachrichten enthalten, die von einem Dialogskill verarbeitet wurden:

Eigenschaft Typ Beschreibung
branchExited Boolesch Gibt an, ob die Dialogverzweigung während der Verarbeitung der Nachricht beendet wurde
branchExitedReason Zeichenfolge Der Grund, warum die Dialogverzweigung beendet wurde (z. B. completed).
nodesVisited Zeichenfolge[] Ein Array von Zeichenfolgen, die die Dialogmodulknoten auflisten, die während der Verarbeitung der Nachricht besucht wurden. Für jeden Dialogmodulknoten gibt die Zeichenfolge den Knotentitel (falls vorhanden) oder die Knoten-ID an.

Aktion gestartet

Wird gesendet, wenn die Verarbeitung einer Aktion beginnt.

Eigenschaft Typ Beschreibung
accountId Zeichenfolge Die ID des IBM-Kontos.
action Zeichenfolge Die eindeutige Kennung der Aktion (z. B. action_202)
actionTitle Zeichenfolge Der Titel der Aktion (z. B. I want to pay my bill)
actionCompleted Boolesch Gibt an, ob die Aktion während desselben Dialogumlaufs abgeschlossen wurde.
actionCompletedReason Zeichenfolge Der Grund für den Abschluss der Aktion (z. B. all_steps_done oder fallback).
assistantId Zeichenfolge Die ID des Assistenten.
browser Zeichenfolge Der Browser, der zum Senden der Nachricht verwendet wurde, die die Aktion ausgelöst hat.
channel Zeichenfolge Der Kanal, über den der Kunde die Nachricht gesendet hat, die die Aktion ausgelöst hat (z. B. phone oder chat).
device Zeichenfolge Der Gerätetyp, der zum Senden der Nachricht verwendet wurde, die die Aktion ausgelöst hat.
environment Zeichenfolge Die Umgebung, in der die Aktion gestartet wurde (z. B. draft oder live)
fallbackReason Zeichenfolge Der Grund, warum die Fallback-Aktion gestartet wurde (z. B. an einen Servicemitarbeiter eskaliert oder keine Aktion übereinstimmt)
handler Zeichenfolge Der Name eines aufgerufenen Handlers.
language Zeichenfolge Die Sprache des Assistenten.
pageUrl Zeichenfolge Die URL der Webseite, von der aus die Nachricht gesendet wurde, die die Aktion ausgelöst hat
serviceInstance Zeichenfolge Die Serviceinstanz von IBM watsonx Assistant.
sessionId Zeichenfolge Die ID der Sitzung, in der die Nachricht gesendet wurde, die die Aktion gestartet hat.
skillsInvoked Zeichenfolge[] An array of strings listing all skills that were invoked during handling of the message that started the action (for example, main skill or actions skill).
stepsVisited Objekt[] Ein Objekt mit zwei Eigenschaften, stepId und stepTitle, das die Schritte auflistet, die der Benutzer während der Verarbeitung der Nachricht besucht hat.
subaction Zeichenfolge Der Name einer anderen Aktion, die die Aktion während der Verarbeitung aufgerufen hat.

Aktion abgeschlossen

Wird gesendet, wenn die Verarbeitung einer Aktion beendet wird.

Eigenschaft Typ Beschreibung
accountId Zeichenfolge Die ID des IBM-Kontos.
action Zeichenfolge Die eindeutige Kennung der Aktion (z. B. action_202)
actionCompletedReason Zeichenfolge Der Grund für den Abschluss der Aktion (z. B. all_steps_done oder fallback).
actionStarted Boolesch Gibt an, ob die Aktion während desselben Dialogumlaufs gestartet wurde.
actionTitle Zeichenfolge Der Titel der Aktion (z. B. I want to pay my bill)
assistantId Zeichenfolge Die ID des Assistenten.
browser Zeichenfolge Der Browser, der zum Senden der Nachricht verwendet wurde, die die Aktion ausgelöst hat.
channel Zeichenfolge Der Kanal, den der Kunde zum Senden der Nachricht verwendet hat, die die Aktion gestartet hat (z. B. phone oder chat)
device Zeichenfolge Der Gerätetyp, der zum Senden der Nachricht verwendet wurde, die die Aktion ausgelöst hat.
environment Zeichenfolge Die Umgebung, in der die Aktion ausgeführt wurde (beispielsweise draft oder live).
fallbackReason Zeichenfolge Der Grund, warum die Rückgriffaktion aufgerufen wurde (z. B. eskaliert an einen Servicemitarbeiter oder keine übereinstimmende Aktion).
handler Zeichenfolge Der Name eines beliebigen Handlers, der von der Aktion aufgerufen wurde
language Zeichenfolge Die Sprache des Assistenten.
pageUrl Zeichenfolge Die URL der Webseite, von der aus die Nachricht gesendet wurde, die die Aktion ausgelöst hat
serviceInstance Zeichenfolge Die Serviceinstanz von IBM watsonx Assistant.
sessionId Zeichenfolge Die ID der Sitzung, in der die Nachricht gesendet wurde, die die Aktion gestartet hat.
skillsInvoked Zeichenfolge[] An array of strings listing all skills that were invoked during handling of the message that started the action (for example, main skill or actions skill).
stepsVisited Objekt[] Ein Objekt mit zwei Eigenschaften, stepId und stepTitle, das die Schritte auflistet, die der Benutzer während der Verarbeitung der Nachricht besucht hat.
subaction Zeichenfolge Der Name einer anderen Aktion, die die Aktion während der Verarbeitung aufgerufen hat.

Sitzung gestartet

Gesendet, wenn eine neue Sitzung gestartet wird.

Hinweis: Die statusunabhängige API v2 generiert keine Ereignisse zum Starten von Sitzungen.

Eigenschaft Typ Beschreibung
accountId Zeichenfolge Die ID des IBM-Kontos.
assistantId Zeichenfolge Die ID des Assistenten.
browser Zeichenfolge Der Browser, der zum Senden der Nachricht verwendet wurde, mit der die Sitzung gestartet wurde.
channel Zeichenfolge Der Kanal, der die Sitzung gestartet hat (z. B. phone oder chat)
device Zeichenfolge Der Typ der Einheit, die zum Senden der Nachricht verwendet wurde, die die Sitzung gestartet hat.
environment Zeichenfolge The environment in which the session was started (such as draft or live.)
pageUrl Zeichenfolge Die URL der Webseite, von der aus die Nachricht gesendet wurde, die die Sitzung gestartet hat.
serviceInstance Zeichenfolge Die Serviceinstanz von IBM watsonx Assistant.
sessionId Zeichenfolge Die ID der Sitzung.