REST Resource: projects.locations.apps.conversations

資源：Conversation

對話是指使用者與 CES 應用程式之間的互動。

JSON 表示法 
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "turns": [
    {
      object (Conversation.Turn)
    }
  ],
  "turnCount": integer,
  "channelType": enum (Conversation.ChannelType),
  "source": enum (Conversation.Source),
  "inputTypes": [
    enum (Conversation.InputType)
  ],
  "entryAgent": string,
  "deployment": string,
  "appVersion": string,
  "languageCode": string,
  "messages": [
    {
      object (Message)
    }
  ]
}
欄位
name

string

ID。對話的專屬 ID。格式：projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
startTime

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"。
endTime

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"。
turns[]

object (Conversation.Turn)

這是必要旗標，對話中的輪流發言。
turnCount

integer

僅供輸出。對話中的互動次數。
channelType
(deprecated)

enum (Conversation.ChannelType)

已淘汰。請改用 inputTypes。
source

enum (Conversation.Source)

僅供輸出。指出對話來源。
inputTypes[]

enum (Conversation.InputType)

僅供輸出。對話的輸入類型。
entryAgent

string

僅供輸出。最初處理對話的服務專員。如未指定，則由根代理程式處理對話。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment

string

僅供輸出。用於處理對話的應用程式部署作業。格式：projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
appVersion

string

僅供輸出。用於處理對話的應用程式版本。格式：projects/{project}/locations/{location}/apps/{app}/versions/{version}
languageCode

string

僅供輸出。對話的語言代碼。
messages[]
(deprecated)

object (Message)

已淘汰，請改用回合。

Conversation.Turn

對話中單一輪次的相關資訊。

JSON 表示法 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "rootSpan": {
    object (Span)
  },
  "userIntendedText": string
}
欄位
messages[]

object (Message)

選用。對話回合中的訊息清單，包括使用者輸入內容、代理程式回覆，以及處理期間的中間事件。
rootSpan

object (Span)

選用。動作處理的根範圍。
userIntendedText

string

選用。模擬來電者 (Polysynth) 的預期真值文字。只有在啟用字詞錯誤率指標時才會填入。

時距

跨度是要求處理期間的工作單元或單一作業。

JSON 表示法 
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "duration": string,
  "attributes": {
    object
  },
  "childSpans": [
    {
      object (Span)
    }
  ]
}
欄位
name

string

僅供輸出。時距的名稱。
startTime

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"。
endTime

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"。
duration

string (Duration format)

僅供輸出。時距長度。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
attributes

object (Struct format)

僅供輸出。與範圍相關聯的鍵/值屬性。
childSpans[]

object (Span)

僅供輸出。這個範圍下巢狀的子範圍。

Conversation.ChannelType

對話的管道類型。

列舉
CHANNEL_TYPE_UNSPECIFIED 未指定管道類型。
TEXT 對話只包含使用者和代理程式之間的訊息。
AUDIO 對話包含使用者和服務專員之間的語音訊息。
MULTIMODAL 使用者和代理程式之間的對話多模態訊息 (例如圖片)。

Conversation.Source

對話來源。

列舉
SOURCE_UNSPECIFIED 未指定來源。
LIVE 對話來自真人使用者。
SIMULATOR 對話來自模擬器。
EVAL 對話來自評估作業。
AGENT_TOOL 對話來自代理工具。代理工具會在另一個工作階段中執行代理，並保留該工作階段以供測試和偵錯。

Conversation.InputType

輸入訊息的類型。

列舉
INPUT_TYPE_UNSPECIFIED 未指定輸入類型。
INPUT_TYPE_TEXT 輸入文字。
INPUT_TYPE_EVENT 活動輸入。
INPUT_TYPE_AUDIO 音訊輸入。
INPUT_TYPE_IMAGE 輸入圖片。
INPUT_TYPE_BLOB Blob 輸入。
INPUT_TYPE_TOOL_RESPONSE 用戶端函式工具回應輸入內容。
INPUT_TYPE_VARIABLES 輸入變數。

方法

batchDelete

 批次刪除指定對話。

delete

 刪除指定對話。

get

 取得指定對話的詳細資料。

list

 列出指定應用程式中的對話。