セグメント・イベント参照

以下の表は、AIアシスタントがSegment拡張機能を使用してSegmentに送信するイベントの詳細を示しています。 これらのイベントは、Segment warehouseではテーブルとして表示され、他のDestinationでは通常のイベントとして表示されます。

AIアシスタントv2APIを使用して生成され、ユーザーIDに関連付けられたイベントのみが含まれます。

取扱メッセージ

AIアシスタントがメッセージの処理を完了したときに送信されます。

プロパティー タイプ 説明
accountId ストリング IBMアカウントのID。
assistantId ストリング AIアシスタントのID。
browser ストリング メッセージの送信に使われたブラウザ。
channel ストリング 顧客がメッセージの送信に使用したチャネル (例えば、'phoneまたは 'chat)。
device ストリング メッセージの送信に使用されたデバイスのタイプ。
environment ストリング メッセージが処理された環境（'draftや'liveなど）
language ストリング AIアシスタントの言語。
pageUrl ストリング メッセージ送信元のウェブページの URL。
serviceInstance ストリング IBMAIアシスタントのサービスインスタンス。
sessionId ストリング メッセージが処理されたセッションのID。
skillsInvoked String[] メッセージの処理中に呼び出されたすべてのスキル (たとえば 'main skillや 'actions skill など) を列挙した文字列の配列。

以下のプロパティは、アクションスキルによって処理されたメッセージにのみ含まれます：

プロパティー タイプ 説明
action ストリング メッセージの処理中に訪れたアクションの一意な識別子(例えば、'action_202)。
actionCompleted ブール値 メッセージの処理中にアクションが完了したかどうか。
actionCompletedReason ストリング アクションが完了した理由 (例えば、'all_steps_doneまたは 'fallback.)
actionStarted ブール値 メッセージの処理中にアクションの処理が始まったかどうか。
actionTitle ストリング メッセージの処理中に訪れたアクションのタイトル(例えば'I want to pay my bill)。
actionsVisited String[] メッセージの処理中に訪れたアクションを列挙した文字列の配列。
fallbackReason ストリング フォールバックアクションが訪問された理由（例えば、ヒューマンエージェントにエスカレーションされた、またはアクションがマッチしなかった）。
handler ストリング 呼び出されたハンドラの名前。
stepsVisited オブジェクト[] stepIdと 'stepTitle2つのプロパティを持つオブジェクトで、ユーザがメッセー ジの処理中に訪れたステップを列挙している。
subaction ストリング メッセージによってトリガーされたアクションによって呼び出された他のアクションの名前。

アクションは開始しました

アクションの処理が始まるときに送られる。

プロパティー タイプ 説明
accountId ストリング IBMアカウントのID。
action ストリング アクションの一意な識別子（例えば、'action_202）。
actionTitle ストリング アクションのタイトル（例えば「I want to pay my bill）。
actionCompleted ブール値 同じ会話ターン中にアクションが完了したかどうか。
actionCompletedReason ストリング アクションが完了した理由 (例えば、'all_steps_doneまたは 'fallback.)
assistantId ストリング AIアシスタントのID。
browser ストリング アクションのトリガーとなったメッセージの送信に使用されたブラウザ。
channel ストリング 顧客がアクションのトリガーとなるメッセージの送信に使用したチャネル (たとえば、'phoneや 'chat など)。
device ストリング アクションのトリガーとなったメッセージの送信に使用されたデバイスのタイプ。
environment ストリング アクションが開始された環境（'draftや'liveなど）
fallbackReason ストリング フォールバックアクションが開始された理由（例えば、人間のエージェントにエスカレーションされた、またはアクションが一致しない）。
handler ストリング 呼び出されたハンドラの名前。
language ストリング AIアシスタントの言語。
pageUrl ストリング アクションのトリガーとなったメッセージが送信されたウェブページの URL。
serviceInstance ストリング IBMAIアシスタントのサービスインスタンス。
sessionId ストリング アクションを開始したメッセージが送信されたセッションのID。
skillsInvoked String[] アクションを開始したメッセージの処理中に呼び出されたすべてのスキルの一覧を示す文字列の配列 (たとえば 'main skillや 'actions skill など)。
stepsVisited オブジェクト[] stepIdと 'stepTitle2つのプロパティを持つオブジェクトで、ユーザがメッセー ジの処理中に訪れたステップを列挙している。
subaction ストリング 処理中にアクションが呼び出した他のアクションの名前。

アクションは完了しました

アクションの処理が終了したときに送信される。

プロパティー タイプ 説明
accountId ストリング IBMアカウントのID。
action ストリング アクションの一意な識別子（例えば、'action_202）。
actionCompletedReason ストリング アクションが完了した理由 (例えば、'all_steps_doneまたは 'fallback.)
actionStarted ブール値 同じ会話ターン中にアクションが開始されたかどうか。
actionTitle ストリング アクションのタイトル（例えば「I want to pay my bill）。
assistantId ストリング AIアシスタントのID。
browser ストリング アクションのトリガーとなったメッセージの送信に使用されたブラウザ。
channel ストリング 顧客がアクションを開始するメッセージの送信に使用したチャネル (たとえば、'phoneや 'chat など)。
device ストリング アクションのトリガーとなったメッセージの送信に使用されたデバイスのタイプ。
environment ストリング アクションが完了した環境（'draftや'liveなど）
fallbackReason ストリング フォールバックアクションが呼び出された理由（例えば、ヒューマンエージェントにエスカレーションされた、またはアクションがマッチしなかった）。
handler ストリング アクションによって呼び出されたハンドラの名前。
language ストリング AIアシスタントの言語。
pageUrl ストリング アクションのトリガーとなったメッセージが送信されたウェブページの URL。
serviceInstance ストリング IBMAIアシスタントのサービスインスタンス。
sessionId ストリング アクションを開始したメッセージが送信されたセッションのID。
skillsInvoked String[] アクションを開始したメッセージの処理中に呼び出されたすべてのスキルの一覧を示す文字列の配列 (たとえば 'main skillや 'actions skill など)。
stepsVisited オブジェクト[] stepIdと 'stepTitle2つのプロパティを持つオブジェクトで、ユーザがメッセー ジの処理中に訪れたステップを列挙している。
subaction ストリング 処理中にアクションが呼び出した他のアクションの名前。

セッション開始

新しいセッションが開始されたときに送信される。

注： v2ステートレスAPIは、セッション開始のためのイベントを生成しない。

プロパティー タイプ 説明
accountId ストリング IBMアカウントのID。
assistantId ストリング AIアシスタントのID。
browser ストリング セッションを開始したメッセージの送信に使用されたブラウザ。
channel ストリング セッションを開始したチャンネル(例えば'phoneや'chat)。
device ストリング セッションを開始したメッセージの送信に使われたデバイスのタイプ。
environment ストリング セッションが開始された環境（'draftや'liveなど）
pageUrl ストリング セッションを開始したメッセージが送信されたウェブページの URL。
serviceInstance ストリング IBMAIアシスタントのサービスインスタンス。
sessionId ストリング セッション の ID