セグメント・イベント参照
以下の表は、 watsonx Assistant が セグメント拡張子 を使用してセグメントに送信するイベントの詳細を示しています。 これらのイベントは、セグメント・ウェアハウスの表として、また他の宛先の通常のイベントとして表示されます。
watsonx Assistant v2 API を使用して生成され、ユーザー ID に関連付けられたイベントのみが含まれます。
処理されたメッセージ
アシスタントがメッセージの処理を完了したときに送信されます。
| プロパティー (Property) | タイプ | 説明 |
|---|---|---|
accountId |
ストリング | IBM アカウントの ID です。 |
assistantId |
ストリング | アシスタントの ID です。 |
browser |
ストリング | メッセージの送信に使用されたブラウザー。 |
channel |
ストリング | 顧客がメッセージの送信に使用したチャネル (例えば、 phone または chat)。 |
device |
ストリング | メッセージの送信に使用されたデバイスのタイプ。 |
environment |
ストリング | メッセージが処理された環境 (例えば、 draft または live)。 |
language |
ストリング | 支援機能の言語。 |
pageUrl |
ストリング | メッセージの送信元の Web ページの URL 。 |
serviceInstance |
ストリング | IBM watsonx Assistant サービス・インスタンス。 |
sessionId |
ストリング | メッセージが処理されたときのセッションの ID。 |
skillsInvoked |
ストリング[] | メッセージの処理中に呼び出されたすべてのスキルをリストしたストリングの配列 (例えば、 main skill または actions skill)。 |
以下のプロパティーは、アクション・スキルによって処理されたメッセージにのみ組み込まれます。
| プロパティー (Property) | タイプ | 説明 |
|---|---|---|
action |
ストリング | メッセージの処理中に訪問されたアクションの固有 ID (例えば、 action_202)。 |
actionCompleted |
ブール値 | メッセージの処理中にアクションが完了したかどうか。 |
actionCompletedReason |
ストリング | アクションが完了した理由 (例えば、 all_steps_done または fallback)。 |
actionStarted |
ブール値 | メッセージの処理中にアクションの処理が開始されたかどうか。 |
actionTitle |
ストリング | メッセージの処理中にアクセスされたアクションのタイトル (例: I want to pay my bill)。 |
actionsVisited |
ストリング[] | メッセージの処理中にアクセスされたアクションをリストするストリングの配列。 |
fallbackReason |
ストリング | フォールバック・アクションが訪問された理由 (例えば、人間のエージェントにエスカレートされたか、一致するアクションがない)。 |
handler |
ストリング | 呼び出されたすべてのハンドラーの名前。 |
stepsVisited |
オブジェクト[] | stepId と stepTitle の 2 つのプロパティーを持つオブジェクト。メッセージの処理中にユーザーがアクセスしたステップをリストします。 |
subaction |
ストリング | メッセージによってトリガーされたアクションによって呼び出されたその他のすべてのアクションの名前。 |
以下のプロパティーは、ダイアログ・スキルによって処理されたメッセージに対してのみ組み込まれます。
| プロパティー (Property) | タイプ | 説明 |
|---|---|---|
branchExited |
ブール値 | メッセージの処理中にダイアログ・ブランチが終了したかどうか。 |
branchExitedReason |
ストリング | ダイアログ・ブランチが終了した理由 (例: completed)。 |
nodesVisited |
ストリング[] | メッセージの処理中にアクセスされたダイアログ・ノードをリストするストリングの配列。 ダイアログ・ノードごとに、このストリングは、ノード・タイトル (ある場合) またはノード ID を指定します。 |
アクションは開始しました
アクションの処理が開始されたときに送信されます。
| プロパティー (Property) | タイプ | 説明 |
|---|---|---|
accountId |
ストリング | IBM アカウントの ID です。 |
action |
ストリング | アクションの一意の識別子 (例: action_202)。 |
actionTitle |
ストリング | アクションのタイトル (例えば、 I want to pay my bill など)。 |
actionCompleted |
ブール値 | 同じ会話のターン中にアクションが完了したかどうか。 |
actionCompletedReason |
ストリング | アクションが完了した理由 (例えば、 all_steps_done または fallback)。 |
assistantId |
ストリング | アシスタントの ID です。 |
browser |
ストリング | アクションをトリガーしたメッセージの送信に使用されたブラウザー。 |
channel |
ストリング | アクションをトリガーしたメッセージを送信するために顧客が使用したチャネル (例えば、 phone または chat)。 |
device |
ストリング | アクションをトリガーしたメッセージの送信に使用されたデバイスのタイプ。 |
environment |
ストリング | アクションが開始された環境 (例えば、 draft または live)。 |
fallbackReason |
ストリング | フォールバック・アクションが開始された理由 (例えば、人間のエージェントにエスカレートされた、または一致するアクションがないなど)。 |
handler |
ストリング | 呼び出されたすべてのハンドラーの名前。 |
language |
ストリング | 支援機能の言語。 |
pageUrl |
ストリング | アクションをトリガーしたメッセージの送信元の Web ページの URL 。 |
serviceInstance |
ストリング | IBM watsonx Assistant サービス・インスタンス。 |
sessionId |
ストリング | アクションを開始したメッセージが送信されたときのセッションの ID。 |
skillsInvoked |
ストリング[] | アクションを開始したメッセージの処理中に呼び出されたすべてのスキルをリストするストリングの配列 (例えば、 main skill または actions skill)。 |
stepsVisited |
オブジェクト[] | stepId と stepTitle の 2 つのプロパティーを持つオブジェクト。メッセージの処理中にユーザーがアクセスしたステップをリストします。 |
subaction |
ストリング | 処理中にアクションが呼び出したその他のアクションの名前。 |
アクションは完了しました
アクションの処理が終了したときに送信されます。
| プロパティー (Property) | タイプ | 説明 |
|---|---|---|
accountId |
ストリング | IBM アカウントの ID です。 |
action |
ストリング | アクションの一意の識別子 (例: action_202)。 |
actionCompletedReason |
ストリング | アクションが完了した理由 (例えば、 all_steps_done または fallback)。 |
actionStarted |
ブール値 | 同じ会話ターンの間にアクションが開始されたかどうか。 |
actionTitle |
ストリング | アクションのタイトル (例えば、 I want to pay my bill など)。 |
assistantId |
ストリング | アシスタントの ID です。 |
browser |
ストリング | アクションをトリガーしたメッセージの送信に使用されたブラウザー。 |
channel |
ストリング | アクションを開始したメッセージを送信するために顧客が使用したチャネル (例えば、 phone または chat)。 |
device |
ストリング | アクションをトリガーしたメッセージの送信に使用されたデバイスのタイプ。 |
environment |
ストリング | アクションが実行された環境 ( draft や live など)。 |
fallbackReason |
ストリング | フォールバック・アクションが呼び出された理由 (例えば、人間のエージェントにエスカレートされたか、一致するアクションがない)。 |
handler |
ストリング | アクションによって呼び出されたすべてのハンドラーの名前。 |
language |
ストリング | 支援機能の言語。 |
pageUrl |
ストリング | アクションをトリガーしたメッセージの送信元の Web ページの URL 。 |
serviceInstance |
ストリング | IBM watsonx Assistant サービス・インスタンス。 |
sessionId |
ストリング | アクションを開始したメッセージが送信されたときのセッションの ID。 |
skillsInvoked |
ストリング[] | アクションを開始したメッセージの処理中に呼び出されたすべてのスキルをリストするストリングの配列 (例えば、 main skill または actions skill)。 |
stepsVisited |
オブジェクト[] | stepId と stepTitle の 2 つのプロパティーを持つオブジェクト。メッセージの処理中にユーザーがアクセスしたステップをリストします。 |
subaction |
ストリング | 処理中にアクションが呼び出したその他のアクションの名前。 |
セッション開始
新規セッションの開始時に送信されます。
注: v2 ステートレス API は、セッションを開始するためのイベントを生成しません。
| プロパティー (Property) | タイプ | 説明 |
|---|---|---|
accountId |
ストリング | IBM アカウントの ID です。 |
assistantId |
ストリング | アシスタントの ID です。 |
browser |
ストリング | セッションを開始したメッセージの送信に使用されたブラウザー。 |
channel |
ストリング | セッションを開始したチャネル (例えば、 phone や chat)。 |
device |
ストリング | セッションを開始したメッセージの送信に使用された装置のタイプ。 |
environment |
ストリング | セッションが開始された環境 (例えば、 draft または live)。 |
pageUrl |
ストリング | セッションを開始したメッセージの送信元の Web ページの URL 。 |
serviceInstance |
ストリング | IBM watsonx Assistant サービス・インスタンス。 |
sessionId |
ストリング | セッションの ID です。 |