REST Resource: projects.locations.collections.engines.sessions

資源：工作階段

外部工作階段 Proto 定義。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "userPseudoId": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "labels": [
    string
  ],
  "startTime": string,
  "endTime": string,
  "isPinned": boolean
}
欄位
name

string

不可變動。完整名稱 projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

(選用步驟) 工作階段的顯示名稱。

這個欄位用於在 UI 中識別工作階段。根據預設，顯示名稱是工作階段中的第一個查詢文字。
state

enum (State)

工作階段的狀態。
userPseudoId

string

用於追蹤使用者的專屬 ID。
turns[]

object (Turn)

轉彎。
labels[]

string

(選用步驟) 工作階段的標籤。可在 ListSessionsRequest 中設為篩選條件。
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"。
isPinned

boolean

(選用步驟) 工作階段是否已釘選，釘選的工作階段會顯示在工作階段清單頂端。

方法

addContextFile

 上傳內容檔案，做為工作階段內輔助通話的來源。

create

 建立工作階段。

delete

 刪除工作階段。

get

 取得工作階段。

list

 依父項 DataStore 列出所有工作階段。

patch

 更新工作階段。