REST Resource: projects.locations.collections.dataStores.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

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

狀態

列舉工作階段的狀態。

列舉
STATE_UNSPECIFIED 未指定狀態。
IN_PROGRESS 目前工作階段已開啟。

Turn

代表一輪對話，包括使用者的查詢和服務的回覆。

JSON 表示法 
{
  "query": {
    object (Query)
  },
  "answer": string,
  "assistAnswer": string,
  "detailedAnswer": {
    object (Answer)
  },
  "detailedAssistAnswer": {
    object (AssistAnswer)
  },
  "queryConfig": {
    string: string,
    ...
  }
}
欄位
query

object (Query)

(選用步驟) 使用者查詢。如果這輪對話只是重新生成另一輪對話的答案，可能不會設定這項屬性
answer

string

(選用步驟) 使用者查詢的答案資源名稱。

只有在這一輪中生成答案 (呼叫 /answer API) 時，才需要設定。
assistAnswer

string

僅供輸出。使用者查詢的 Google 助理回覆資源名稱。

只有在這一輪中發生輔助呼叫 (/assist API 呼叫) 時，才需要設定。

格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}。如要取得工作階段的所有 AssistAnswers，請將 GetSessionRequest.include_answer_details 設為 true。或者，如要取得個別的 AssistAnswer 資源，請使用 AssistAnswerService.GetAssistAnswer API。
detailedAnswer

object (Answer)

僅供輸出。在 ConversationalSearchService.GetSession API 中，如果 GetSessionRequest.include_answer_details 設為 true，系統會在取得答案查詢工作階段時填入這個欄位。
detailedAssistAnswer

object (AssistAnswer)

僅供輸出。在 ConversationalSearchService.GetSession API 中，如果 GetSessionRequest.include_answer_details 設為 true，這個欄位會在取得助理工作階段時填入。
queryConfig

map (key: string, value: string)

(選用步驟) 代表與查詢設定相關的中繼資料，例如使用的 LLM 模型和版本、模型參數 (溫度、基礎參數等)。前置字串「google.」已預留給 Google 開發的功能。

查詢

定義使用者輸入的查詢。

JSON 表示法 
{
  "queryId": string,

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
欄位
queryId

string

僅供輸出。查詢的專屬 ID。
聯集欄位 content。查詢內容。content 只能是下列其中一項：
text

string

純文字。

方法

create

 建立工作階段。

delete

 刪除工作階段。

get

 取得工作階段。

list

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

patch

 更新工作階段。