Method: projects.locations.apps.sessions.streamRunSession

與 CES 代理啟動單一回合互動。使用伺服器端串流,在生成結果時提供增量結果和部分回覆。

根據預設,系統會在完整回覆 (例如回呼訊息或完整 LLM 回覆) 產生後,立即傳送給用戶端。如要直接從模型串流個別文字區塊,請將 enableTextStreaming 設為 true。

HTTP 要求

POST https://ces.googleapis.com/v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:streamRunSession

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
config.session

string

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

要求主體

要求主體包含下列結構的資料:

JSON 表示法
{
  "config": {
    "session": string,
    "inputAudioConfig": {
      "audioEncoding": enum (AudioEncoding),
      "sampleRateHertz": integer,
      "noiseSuppressionLevel": string
    },
    "outputAudioConfig": {
      "audioEncoding": enum (AudioEncoding),
      "sampleRateHertz": integer
    },
    "historicalContexts": [
      {
        "role": string,
        "chunks": [
          {
            object (Chunk)
          }
        ],
        "eventTime": string
      }
    ],
    "entryAgent": string,
    "deployment": string,
    "timeZone": string,
    "useToolFakes": boolean,
    "remoteDialogflowQueryParameters": {
      "webhookHeaders": {
        string: string,
        ...
      },
      "payload": {
        object
      },
      "endUserMetadata": {
        object
      }
    },
    "enableTextStreaming": boolean,
    "includeLlmThoughtSummary": boolean,
    "excludeDiagnosticInfo": boolean,
    "includeProgressUpdate": boolean
  },
  "inputs": [
    {
      object (SessionInput)
    }
  ]
}
欄位
config.inputAudioConfig

object (InputAudioConfig)

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

config.outputAudioConfig

object (OutputAudioConfig)

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

config.historicalContexts[]

object (Message)

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

config.entryAgent

string

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

config.deployment

string

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

config.timeZone

string

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

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

config.useToolFakes

boolean

選用。是否要在工作階段使用工具假資料。如果設定這個欄位,代理會嘗試使用工具假資料,而非呼叫實際工具。

config.remoteDialogflowQueryParameters

object (SessionConfig.RemoteDialogflowQueryParameters)

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

config.enableTextStreaming

boolean

選用。是否在模型生成文字輸出內容時,逐步串流至用戶端。預設值為 false。

  • 停用時,模型的文字輸出內容會經過緩衝處理,傳送至用戶端的每個文字輸出內容都是完整句子。用戶端可以將每個文字輸出內容顯示在新的一行。
  • 啟用後,每個文字輸出內容可能只包含部分句子。用戶端應串連連續的文字輸出內容,以呈現完整回覆。

注意:這項功能僅適用於使用 sessions.streamRunSession 或 BidiRunSession 的文字 (非語音) 工作階段。

config.includeLlmThoughtSummary

boolean

選用。是否在工作階段輸出內容中,加入 LLM 推論摘要。

config.excludeDiagnosticInfo

boolean

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

config.includeProgressUpdate

boolean

選用。是否要向用戶端提供中繼處理更新。如果啟用,系統會在 SessionOutput.progress內傳回更新。

inputs[]

object (SessionInput)

這是必要旗標,工作階段的輸入內容。

回應主體

如果成功,回應主體會包含 RunSessionResponse 執行個體串流。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

詳情請參閱Authentication Overview。

IAM 權限

需要 session 資源的下列 IAM 權限:

  • ces.sessions.runSession

詳情請參閱 IAM 說明文件。