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

オンラインで編集する

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

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

取扱メッセージ

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


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

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


プロパティー	タイプ	説明
`action`	ストリング	メッセージの処理中に訪れたアクションの一意な識別子(例えば、'`action_202`)。
`actionCompleted`	ブール値	メッセージの処理中にアクションが完了したかどうか。
`actionCompletedReason`	ストリング	アクションが完了した理由 (例えば、'`all_steps_done`または '`fallback`.)
`actionStarted`	ブール値	メッセージの処理中にアクションの処理が始まったかどうか。
`actionTitle`	ストリング	メッセージの処理中に訪れたアクションのタイトル(例えば'`I want to pay my bill`)。
`actionsVisited`	文字列の配列	メッセージの処理中に訪れたアクションを列挙した文字列の配列。
`fallbackReason`	ストリング	フォールバックアクションが訪問された理由（例えば、ヒューマンエージェントにエスカレーションされた、またはアクションがマッチしなかった）。
`handler`	ストリング	呼び出されたハンドラの名前。
`stepsVisited`	オブジェクト[]	`stepId`と '`stepTitle`2つのプロパティを持つオブジェクトで、ユーザがメッセージの処理中に訪れたステップを列挙している。
`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`	ストリング	IBM の AIアシスタントサービスのインスタンス。
`sessionId`	ストリング	アクションを開始したメッセージが送信されたセッションのID。
`skillsInvoked`	文字列の配列	アクションを開始したメッセージの処理中に呼び出されたすべてのスキルの一覧を示す文字列の配列 (たとえば '`main skill`や '`actions skill` など)。
`stepsVisited`	オブジェクト[]	`stepId`と '`stepTitle`2つのプロパティを持つオブジェクトで、ユーザがメッセージの処理中に訪れたステップを列挙している。
`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`	ストリング	IBM の AIアシスタントサービスのインスタンス。
`sessionId`	ストリング	アクションを開始したメッセージが送信されたセッションのID。
`skillsInvoked`	文字列の配列	アクションを開始したメッセージの処理中に呼び出されたすべてのスキルの一覧を示す文字列の配列 (たとえば '`main skill`や '`actions skill` など)。
`stepsVisited`	オブジェクト[]	`stepId`と '`stepTitle`2つのプロパティを持つオブジェクトで、ユーザがメッセージの処理中に訪れたステップを列挙している。
`subaction`	ストリング	処理中にアクションが呼び出した他のアクションの名前。

セッション開始

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

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


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