SessionConfig

工作階段的設定。

JSON 表示法
{
  "session": string,
  "inputAudioConfig": {
    object (InputAudioConfig)
  },
  "outputAudioConfig": {
    object (OutputAudioConfig)
  },
  "historicalContexts": [
    {
      object (Message)
    }
  ],
  "entryAgent": string,
  "deployment": string,
  "timeZone": string,
  "useToolFakes": boolean,
  "remoteDialogflowQueryParameters": {
    object (SessionConfig.RemoteDialogflowQueryParameters)
  },
  "enableTextStreaming": boolean,
  "excludeDiagnosticInfo": boolean
}
欄位
session

string

這是必要旗標,工作階段的專屬 ID。格式:projects/{project}/locations/{location}/apps/{app}/sessions/{session}

inputAudioConfig

object (InputAudioConfig)

選用。用於處理輸入音訊的設定。

outputAudioConfig

object (OutputAudioConfig)

選用。用於生成輸出音訊的設定。

historicalContexts[]

object (Message)

選用。工作階段的歷史脈絡,包括使用者輸入內容、服務專員回覆和其他訊息。通常 CES 代理程式會自動管理工作階段,因此用戶端不需要明確填入這個欄位。不過,用戶端可以選擇覆寫歷來脈絡,強制工作階段從特定狀態開始。

entryAgent

string

選用。處理工作階段的進入代理程式。如未指定,工作階段會由應用程式的 root agent 處理。格式:projects/{project}/locations/{location}/apps/{app}/agents/{agent}

deployment

string

選用。工作階段使用的應用程式部署作業。格式:projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

timeZone

string

選用。使用者的時區。如果提供時區,代理程式會將日期和時間相關變數轉換為該時區。否則,代理程式會使用 App.time_zone_settings 中指定的時區。

格式為 IANA 時區資料庫時區,例如「America/Los_Angeles」。

useToolFakes

boolean

選用。是否要為工作階段使用工具模擬。如果設定這個欄位,代理程式會嘗試使用工具模擬,而非呼叫實際工具。

remoteDialogflowQueryParameters

object (SessionConfig.RemoteDialogflowQueryParameters)

選用。當工作階段控制項轉移至遠端代理程式時,要傳送至遠端 Dialogflow 代理程式的 QueryParameters

enableTextStreaming

boolean

選用。是否要啟用模型串流文字輸出。根據預設,系統會先收集模型輸出的文字,再傳送給用戶端。注意:這項功能僅支援透過 StreamRunSessionBidiRunSession 進行的文字 (非語音) 對話。

excludeDiagnosticInfo

boolean

選用。是否要從工作階段輸出內容中排除診斷資訊。

SessionConfig.RemoteDialogflowQueryParameters

當工作階段控制項轉移至遠端代理程式時,要傳送至遠端 Dialogflow 代理程式的 QueryParameters

JSON 表示法
{
  "webhookHeaders": {
    string: string,
    ...
  },
  "payload": {
    object
  },
  "endUserMetadata": {
    object
  }
}
欄位
webhookHeaders

map (key: string, value: string)

選用。要以 QueryParameters 中的 webhookHeaders 傳送的 HTTP 標頭。

包含 "key": value 組合清單的物件,範例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

payload

object (Struct format)

選用。要在 QueryParameters 中傳送的酬載。

endUserMetadata

object (Struct format)

選用。要透過 QueryParameters 傳送的消費者中繼資料。