REST Resource: projects.locations.brands.sessionRecords

資源:SessionRecord

代表單一工作階段記錄。

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)

僅供輸出。工作階段總時間長度。

以秒為單位的時間長度,最多 9 個小數位數,結尾為「s」。例如:"3.5s"。

upsellAttemptRecords[]

object (UpsellAttemptRecord)

僅供輸出。在工作階段期間執行的追加銷售。

audioRecording

string (bytes format)

僅供輸出。會議錄音。只有在呼叫 sessionRecords.get 時,系統才會填入這個欄位。

Base64 編碼字串。

trafficType

enum (TrafficType)

僅供輸出。工作階段的流量類型。

channelType

enum (ChannelType)

僅供輸出。工作階段使用的管道類型 (例如得來速、行動應用程式、電話)。

互動

代表對話中一個回合的單次互動。

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 流量來自 Food AI 控制台。

方法

delete

刪除 SessionRecord。

get

取得特定 SessionRecord。

list

列出特定品牌的 SessionRecord。