REST Resource: projects.locations.brands.sessionRecords

リソース: SessionRecord

1 つのセッション レコードを表します。

JSON 表現 
{
  "name": string,
  "sessionStartTime": string,
  "storeId": string,
  "laneId": string,
  "interactions": [
    {
      object (Interaction)
    }
  ],
  "outcomeLabel": string,
  "outcomeGroupLabel": string,
  "audioRecordingPath": string,
  "order": {
    object (Order)
  },
  "sessionDuration": string,
  "upsellAttemptRecords": [
    {
      object (UpsellAttemptRecord)
    }
  ],
  "audioRecording": string,
  "trafficType": enum (TrafficType),
  "channelType": enum (ChannelType)
}
フィールド
name

string

ID。SessionRecord のリソース名。形式: projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{sessionRecord}
sessionStartTime

string (Timestamp format)

出力専用。セッション開始時のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
storeId

string

変更不可。注文が行われた店舗の ID。
laneId

string

変更不可。注文セッションのレーン ID。
interactions[]

object (Interaction)

出力専用。会話のターン。
outcomeLabel

string

出力専用。注文の最終結果ラベル。
outcomeGroupLabel

string

出力専用。成果のグループラベル。
audioRecordingPath

string

出力専用。音声録音全体へのパス。
order

object (Order)

出力専用。セッション レコードに関連付けられた注文。
sessionDuration

string (Duration format)

出力専用。セッションの合計時間。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
upsellAttemptRecords[]

object (UpsellAttemptRecord)

出力専用。セッション中にアップセルが行われた。
audioRecording

string (bytes format)

出力専用。セッションの音声録音。このフィールドは、sessionRecords.get を呼び出す場合にのみ入力されます。

Base64 でエンコードされた文字列。
trafficType

enum (TrafficType)

出力専用。セッションのトラフィックの種類。
channelType

enum (ChannelType)

出力専用。セッションに使用されたチャネルのタイプ（ドライブスルー、モバイルアプリ、電話など）。

インタラクション

会話のターンにおける 1 回のインタラクションを表します。

JSON 表現 
{
  "turnPosition": string,

  // Union field interaction can be only one of the following:
  "userUtterance": {
    object (UserUtterance)
  },
  "agentUtterance": {
    object (AgentUtterance)
  },
  "resolveOrder": {
    object (ResolveOrder)
  },
  "submitOrder": {
    object (SubmitOrder)
  },
  "matchIntent": {
    object (MatchIntent)
  },
  "clientExecution": {
    object (ClientExecution)
  },
  "clientOrderUpdate": {
    object (ClientOrderUpdate)
  }
  // End of list of possible types for union field interaction.
}
フィールド
turnPosition

string (int64 format)

出力専用。会話内のターンの位置。
共用体フィールド interaction。インタラクションのタイプ。interaction は次のいずれかになります。
userUtterance

object (UserUtterance)

ユーザーの発話。
agentUtterance

object (AgentUtterance)

エージェントの発話。
resolveOrder

object (ResolveOrder)

エージェントによって実行された ResolveOrder 呼び出し
submitOrder

object (SubmitOrder)

エージェントが実行した SubmitOrder 呼び出し
matchIntent

object (MatchIntent)

エージェントによって実行された MatchIntent 呼び出し
clientExecution

object (ClientExecution)

エージェントによって実行された ClientExecution 呼び出し
clientOrderUpdate

object (ClientOrderUpdate)

クライアント側から始める注文ステータスの更新

UserUtterance

ユーザーの発話。

JSON 表現 
{
  "text": string,
  "createTime": string
}
フィールド
text

string

ユーザーの発話のテキスト。
createTime

string (Timestamp format)

出力専用。ユーザーの発話が発生したときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

AgentUtterance

エージェントの発話。

JSON 表現 
{
  "text": string,
  "createTime": string
}
フィールド
text

string

エージェントの発話のテキスト。
createTime

string (Timestamp format)

出力専用。エージェントの発話が発生したときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

ResolveOrder

注文解決のインタラクション。

JSON 表現 
{
  "input": {
    object (ResolveOrderInput)
  },
  "output": {
    object (ResolveOrderOutput)
  }
}
フィールド
input

object (ResolveOrderInput)

注文解決アクションの入力。
output

object (ResolveOrderOutput)

注文解決アクションの出力。

ResolveOrderInput

注文解決のやり取りの入力。

JSON 表現 
{
  "payload": {
    object
  }
}
フィールド
payload

object (Struct format)

注文解決のインタラクションのペイロード。

ResolveOrderOutput

注文解決のインタラクションの出力。

JSON 表現 
{
  "payload": {
    object
  }
}
フィールド
payload

object (Struct format)

注文解決のインタラクション出力のペイロード。

SubmitOrder

この型にはフィールドがありません。

注文送信のインタラクション。

MatchIntent

インテントの一致のインタラクション。

JSON 表現 
{
  "input": {
    object (MatchIntentInput)
  },
  "output": {
    object (MatchIntentOutput)
  }
}
フィールド
input

object (MatchIntentInput)

一致インテント インタラクションの入力。
output

object (MatchIntentOutput)

一致インテント インタラクションの出力。

MatchIntentInput

一致インテント インタラクションの入力。

JSON 表現 
{
  "payload": {
    object
  }
}
フィールド
payload

object (Struct format)

一致インテント インタラクション入力のペイロード。

MatchIntentOutput

一致インテント インタラクションの出力。

JSON 表現 
{
  "payload": {
    object
  }
}
フィールド
payload

object (Struct format)

一致インテント インタラクション出力のペイロード。

ClientExecution

クライアント実行のインタラクション。

JSON 表現 
{
  "toolName": string,
  "input": {
    object (ClientExecutionInput)
  },
  "output": {
    object (ClientExecutionOutput)
  }
}
フィールド
toolName

string

クライアント実行インタラクションのツール名。
input

object (ClientExecutionInput)

クライアント実行インタラクションの入力。
output

object (ClientExecutionOutput)

クライアント実行インタラクションの出力。

ClientExecutionInput

クライアント実行インタラクションの入力。

JSON 表現 
{
  "payload": {
    object
  }
}
フィールド
payload

object (Struct format)

クライアント実行インタラクション入力のペイロード。

ClientExecutionOutput

クライアント実行インタラクションの出力。

JSON 表現 
{
  "payload": {
    object
  }
}
フィールド
payload

object (Struct format)

クライアント実行インタラクション出力のペイロード。

ClientOrderUpdate

クライアント側から始める注文ステータスの更新。

JSON 表現 
{
  "order": {
    object (Order)
  }
}
フィールド
order

object (Order)

クライアントから送信された注文状態の更新。

UpsellAttemptRecord

アップセルの試行を表します。このデータは、コンソールの注文履歴にアップセル情報（アップセルの種類、ターン ID、アップセルが承認されたかどうか）を表示するために使用され、処理されたログに基づいて Spanner から入力されます。

JSON 表現 
{
  "turnId": integer,
  "upsellType": string,
  "accepted": boolean
}
フィールド
turnId

integer

出力専用。アップセルの機会が発生したターンの ID。
upsellType

string

出力専用。アップセル イベントのタイプ。
accepted

boolean

出力専用。アップセルが受け入れられたかどうか。

TrafficType

セッションのトラフィックの種類。これは、モニタリング、ロギング、オブザーバビリティの指標にラベルを付けるために使用されます。

列挙型
TRAFFIC_TYPE_UNSPECIFIED トラフィック タイプが指定されていません。
EXTERNAL トラフィックが外部クライアントからのものである。
INTEGRATION_TEST トラフィックが統合テストからのものである。
EVAL トラフィックは評価ツールからのものです。
PROBER トラフィックがプローバーからのものである。
MANUAL_TEST トラフィックが手動テストによるものである。
INTERNAL_TOOL トラフィックが内部ツールからのものである。
CONSOLE トラフィックはフード AI コンソールからのものです。

メソッド

delete

 SessionRecord を削除します。

get

 特定の SessionRecord を取得します。

list

 指定されたブランドの SessionRecord を一覧表示します。