Package google.cloud.ces.v1

索引

AgentService

這項服務可管理 Gemini Enterprise for Customer Engagement (CES) 中的代理相關資源。

BatchDeleteConversations

rpc BatchDeleteConversations(BatchDeleteConversationsRequest) returns (Operation)

批次刪除指定的對話。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.conversations.delete

詳情請參閱 IAM 說明文件。
CreateAgent

rpc CreateAgent(CreateAgentRequest) returns (Agent)

在指定應用程式中建立新代理程式。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.agents.create

詳情請參閱 IAM 說明文件。
CreateApp

rpc CreateApp(CreateAppRequest) returns (Operation)

在指定專案和位置建立新應用程式。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.apps.create

詳情請參閱 IAM 說明文件。
CreateAppVersion

rpc CreateAppVersion(CreateAppVersionRequest) returns (AppVersion)

在指定應用程式中建立新版本。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.appVersions.create

詳情請參閱 IAM 說明文件。
CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

在指定應用程式中建立新的部署作業。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.deployments.create

詳情請參閱 IAM 說明文件。
CreateExample

rpc CreateExample(CreateExampleRequest) returns (Example)

在指定應用程式中建立新範例。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.examples.create

詳情請參閱 IAM 說明文件。
CreateGuardrail

rpc CreateGuardrail(CreateGuardrailRequest) returns (Guardrail)

在指定應用程式中建立新的防護措施。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.guardrails.create

詳情請參閱 IAM 說明文件。
CreateTool

rpc CreateTool(CreateToolRequest) returns (Tool)

在指定應用程式中建立新工具。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.tools.create

詳情請參閱 IAM 說明文件。
CreateToolset

rpc CreateToolset(CreateToolsetRequest) returns (Toolset)

在指定應用程式中建立新工具集。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.toolsets.create

詳情請參閱 IAM 說明文件。
DeleteAgent

rpc DeleteAgent(DeleteAgentRequest) returns (Empty)

刪除指定的代理程式。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.agents.delete

詳情請參閱 IAM 說明文件。
DeleteApp

rpc DeleteApp(DeleteAppRequest) returns (Operation)

刪除指定的應用程式。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.apps.delete

詳情請參閱 IAM 說明文件。
DeleteAppVersion

rpc DeleteAppVersion(DeleteAppVersionRequest) returns (Empty)

刪除指定的應用程式版本。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.appVersions.delete

詳情請參閱 IAM 說明文件。
DeleteConversation

rpc DeleteConversation(DeleteConversationRequest) returns (Empty)

刪除指定的對話。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.conversations.delete

詳情請參閱 IAM 說明文件。
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

刪除指定的部署作業。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.deployments.delete

詳情請參閱 IAM 說明文件。
DeleteExample

rpc DeleteExample(DeleteExampleRequest) returns (Empty)

刪除指定的範例。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.examples.delete

詳情請參閱 IAM 說明文件。
DeleteGuardrail

rpc DeleteGuardrail(DeleteGuardrailRequest) returns (Empty)

刪除指定的防護措施。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.guardrails.delete

詳情請參閱 IAM 說明文件。
DeleteTool

rpc DeleteTool(DeleteToolRequest) returns (Empty)

刪除指定的工具。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.tools.delete

詳情請參閱 IAM 說明文件。
DeleteToolset

rpc DeleteToolset(DeleteToolsetRequest) returns (Empty)

刪除指定的工具組。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.toolsets.delete

詳情請參閱 IAM 說明文件。
ExportApp

rpc ExportApp(ExportAppRequest) returns (Operation)

匯出指定的應用程式。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.apps.export

詳情請參閱 IAM 說明文件。
GetAgent

rpc GetAgent(GetAgentRequest) returns (Agent)

取得指定代理程式的詳細資料。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.agents.get

詳情請參閱 IAM 說明文件。
GetApp

rpc GetApp(GetAppRequest) returns (App)

取得指定應用程式的詳細資料。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.apps.get

詳情請參閱 IAM 說明文件。
GetAppVersion

rpc GetAppVersion(GetAppVersionRequest) returns (AppVersion)

取得指定應用程式版本的詳細資料。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.appVersions.get

詳情請參閱 IAM 說明文件。
GetChangelog

rpc GetChangelog(GetChangelogRequest) returns (Changelog)

取得指定的異動記錄。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.changelogs.get

詳情請參閱 IAM 說明文件。
GetConversation

rpc GetConversation(GetConversationRequest) returns (Conversation)

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

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.conversations.get

詳情請參閱 IAM 說明文件。
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

取得指定部署作業的詳細資料。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.deployments.get

詳情請參閱 IAM 說明文件。
GetExample

rpc GetExample(GetExampleRequest) returns (Example)

取得指定範例的詳細資料。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.examples.get

詳情請參閱 IAM 說明文件。
GetGuardrail

rpc GetGuardrail(GetGuardrailRequest) returns (Guardrail)

取得指定防護措施的詳細資料。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.guardrails.get

詳情請參閱 IAM 說明文件。
GetTool

rpc GetTool(GetToolRequest) returns (Tool)

取得指定工具的詳細資料。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.tools.get

詳情請參閱 IAM 說明文件。
GetToolset

rpc GetToolset(GetToolsetRequest) returns (Toolset)

取得指定工具集的詳細資料。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.toolsets.get

詳情請參閱 IAM 說明文件。
ImportApp

rpc ImportApp(ImportAppRequest) returns (Operation)

匯入指定的應用程式。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.apps.import

詳情請參閱 IAM 說明文件。
ListAgents

rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse)

列出指定應用程式中的代理程式。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.agents.list

詳情請參閱 IAM 說明文件。
ListAppVersions

rpc ListAppVersions(ListAppVersionsRequest) returns (ListAppVersionsResponse)

列出指定應用程式中的所有應用程式版本。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.appVersions.list

詳情請參閱 IAM 說明文件。
ListApps

rpc ListApps(ListAppsRequest) returns (ListAppsResponse)

列出指定專案和位置中的應用程式。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.apps.list

詳情請參閱 IAM 說明文件。
ListChangelogs

rpc ListChangelogs(ListChangelogsRequest) returns (ListChangelogsResponse)

列出指定應用程式的變更記錄。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.changelogs.list

詳情請參閱 IAM 說明文件。
ListConversations

rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse)

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

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.conversations.list

詳情請參閱 IAM 說明文件。
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

列出指定應用程式中的部署作業。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.deployments.list

詳情請參閱 IAM 說明文件。
ListExamples

rpc ListExamples(ListExamplesRequest) returns (ListExamplesResponse)

列出指定應用程式中的範例。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.examples.list

詳情請參閱 IAM 說明文件。
ListGuardrails

rpc ListGuardrails(ListGuardrailsRequest) returns (ListGuardrailsResponse)

列出指定應用程式中的防護措施。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.guardrails.list

詳情請參閱 IAM 說明文件。
ListTools

rpc ListTools(ListToolsRequest) returns (ListToolsResponse)

列出指定應用程式中的工具。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.tools.list

詳情請參閱 IAM 說明文件。
ListToolsets

rpc ListToolsets(ListToolsetsRequest) returns (ListToolsetsResponse)

列出指定應用程式中的工具集。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.toolsets.list

詳情請參閱 IAM 說明文件。
RestoreAppVersion

rpc RestoreAppVersion(RestoreAppVersionRequest) returns (Operation)

還原指定的應用程式版本。系統會根據目前的草稿應用程式建立新的應用程式版本，並以指定的應用程式版本覆寫目前的草稿。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.appVersions.restore

詳情請參閱 IAM 說明文件。
UpdateAgent

rpc UpdateAgent(UpdateAgentRequest) returns (Agent)

更新指定的代理程式。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.agents.update

詳情請參閱 IAM 說明文件。
UpdateApp

rpc UpdateApp(UpdateAppRequest) returns (App)

更新指定的應用程式。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.apps.update

詳情請參閱 IAM 說明文件。
UpdateAppVersion

rpc UpdateAppVersion(UpdateAppVersionRequest) returns (AppVersion)

更新指定的應用程式版本。

授權範圍

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

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

詳情請參閱Authentication Overview。
UpdateDeployment

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

更新指定的部署作業。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.deployments.update

詳情請參閱 IAM 說明文件。
UpdateExample

rpc UpdateExample(UpdateExampleRequest) returns (Example)

更新指定的範例。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.examples.update

詳情請參閱 IAM 說明文件。
UpdateGuardrail

rpc UpdateGuardrail(UpdateGuardrailRequest) returns (Guardrail)

更新指定的防護措施。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.guardrails.update

詳情請參閱 IAM 說明文件。
UpdateTool

rpc UpdateTool(UpdateToolRequest) returns (Tool)

更新指定的工具。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.tools.update

詳情請參閱 IAM 說明文件。
UpdateToolset

rpc UpdateToolset(UpdateToolsetRequest) returns (Toolset)

更新指定的工具集。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • ces.toolsets.update

詳情請參閱 IAM 說明文件。

SessionService

工作階段服務提供與 CES 代理互動的 API。

BidiRunSession

rpc BidiRunSession(BidiSessionClientMessage) returns (BidiSessionServerMessage)

與 CES 代理建立雙向串流連線。代理程式會處理持續輸入的多模態內容 (例如文字、音訊)，並生成即時多模態輸出串流。

--- Client Request Stream --- The client streams requests in the following order:

  1. 初始化：第一則訊息必須包含 SessionConfig。如果是音訊工作階段，也應包含 InputAudioConfig 和 OutputAudioConfig，以定義音訊處理和合成參數。

  2. 互動：後續訊息串流 SessionInput，包含即時使用者輸入內容資料。

  3. 終止：如果沒有更多使用者輸入內容，用戶端應半關閉串流。收到代理程式傳送的 EndSession 或 GoAway 時，也應半關閉。

--- 伺服器回應串流 --- 每次互動時，代理程式會依下列順序串流傳送訊息：

  1. 語音辨識 (前 N 則訊息)：包含 RecognitionResult，代表目前擷取到的串連使用者語音片段。只有音訊通話會填入這項資料。

  2. 回覆 (接下來的 M 則訊息)：包含 SessionOutput，以各種模式 (例如文字、音訊) 傳送服務專員的回覆。

  3. 回合完成 (回合的最後一則訊息)：包含 SessionOutput，且 turn_completed 設為 true。這表示目前回合已結束，並包含 DiagnosticInfo 和執行作業詳細資料。

--- 音訊廣告素材最佳做法 --- 1. 串流：持續串流 audio data，即使在無聲期間也一樣。建議的區塊大小：40 到 120 毫秒 (兼顧延遲時間和效率)。

  1. 播放和中斷：收到訊息時播放 audio responses。如果收到 InterruptionSignal (例如使用者插話或新服務專員回覆)，請立即停止播放。
授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • ces.sessions.bidiRunSession

詳情請參閱 IAM 說明文件。
RunSession

rpc RunSession(RunSessionRequest) returns (RunSessionResponse)

在工作階段中，與 CES 代理啟動單回合互動。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • ces.sessions.runSession

詳情請參閱 IAM 說明文件。
StreamRunSession

rpc StreamRunSession(RunSessionRequest) returns (RunSessionResponse)

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

根據預設，完整的回覆 (例如來自回呼的訊息或完整的 LLM 回覆) 會在可用時立即傳送給用戶端。如要直接從模型啟用個別文字區塊的串流功能，請將 enable_text_streaming 設為 true。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • ces.sessions.runSession

詳情請參閱 IAM 說明文件。

ToolService

工具服務提供 API，可與 CES 工具互動。

ExecuteTool

rpc ExecuteTool(ExecuteToolRequest) returns (ExecuteToolResponse)

使用指定引數執行指定工具。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.tools.execute

詳情請參閱 IAM 說明文件。
RetrieveToolSchema

rpc RetrieveToolSchema(RetrieveToolSchemaRequest) returns (RetrieveToolSchemaResponse)

擷取指定工具的結構定義。系統會針對工具的指定執行個體即時計算結構定義。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • ces.tools.get

詳情請參閱 IAM 說明文件。
RetrieveTools

rpc RetrieveTools(RetrieveToolsRequest) returns (RetrieveToolsResponse)

擷取指定工具集中包含的工具清單。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 toolset 資源的下列 IAM 權限：

  • ces.toolsets.get

詳情請參閱 IAM 說明文件。

WidgetService

提供 API，讓小工具與 CES API 互動。

GenerateChatToken

rpc GenerateChatToken(GenerateChatTokenRequest) returns (GenerateChatTokenResponse)

為即時通訊小工具產生工作階段範圍權杖，以便透過 Session API 進行驗證。

授權範圍

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

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

詳情請參閱Authentication Overview。

動作

工具要使用的動作設定。注意：這可以是動作或作業。詳情請參閱 https://cloud.google.com/integration-connectors/docs/entities-operation-action。

欄位
input_fields[]

string

選用。做為作業輸入內容的實體欄位。如未指定任何欄位，系統會使用實體的所有欄位。
output_fields[]

string

選用。作業要傳回的實體欄位。如未指定任何欄位，系統會傳回實體的所有欄位。
聯集欄位 action_spec。工具要使用的動作設定規格。action_spec 只能是下列其中一個設定：
connection_action_id

string

工具要使用的「連結」動作 ID。
entity_operation

Action.EntityOperation

工具要使用的實體作業設定。

EntityOperation

實體 CRUD 作業規格。

欄位
entity_id

string

這是必要旗標，實體的 ID。
operation

Action.EntityOperation.OperationType

這是必要旗標，要在實體上執行的作業。

OperationType

要在實體上執行的作業。

列舉
OPERATION_TYPE_UNSPECIFIED 未指定作業類型。無效，ConnectorTool 建立/更新作業將會失敗。
LIST 清單作業。
GET 取得作業。
CREATE 建立作業。
UPDATE 更新作業。
DELETE 刪除作業。

代理

代理程式是提供指令給大型語言模型 (LLM) 以執行特定工作的基本構成元素。

欄位
name

string

ID。代理程式的專屬 ID。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name

string

這是必要旗標，代理程式的顯示名稱。
description

string

選用。使用者可理解的代理程式說明。
model_settings

ModelSettings

選用。LLM 模型的設定。
instruction

string

選用。給大型語言模型模型的指令，引導代理的行為。
tools[]

string

選用。代理可用的工具清單。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
child_agents[]

string

選用。代理程式樹狀結構中的子項代理程式清單。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
before_agent_callbacks[]

Callback

選用。在呼叫代理程式前執行的回呼。系統會按照清單中的順序，依序執行提供的回呼。如果回呼傳回覆寫的回應，執行作業就會停止，並略過所有其餘回呼。
after_agent_callbacks[]

Callback

選用。呼叫代理程式後要執行的回呼。系統會按照清單中的順序，依序執行提供的回呼。如果回呼傳回覆寫的回應，執行作業就會停止，並略過所有其餘回呼。
before_model_callbacks[]

Callback

選用。在呼叫模型前執行的回呼。如果多次呼叫模型，回呼就會執行多次。系統會按照清單中的順序，依序執行提供的回呼。如果回呼傳回覆寫的回應，執行作業就會停止，並略過所有其餘回呼。
after_model_callbacks[]

Callback

選用。模型呼叫後要執行的回呼。如果多次呼叫模型，回呼就會執行多次。系統會按照清單中的順序，依序執行提供的回呼。如果回呼傳回覆寫的回應，執行作業就會停止，並略過所有其餘回呼。
before_tool_callbacks[]

Callback

選用。在叫用工具前執行的回呼。如果有多個工具呼叫，回呼就會執行多次。系統會按照清單中的順序，依序執行提供的回呼。如果回呼傳回覆寫的回應，執行作業就會停止，並略過所有其餘回呼。
after_tool_callbacks[]

Callback

選用。工具叫用後要執行的回呼。如果有多個工具呼叫，回呼就會執行多次。系統會按照清單中的順序，依序執行提供的回呼。如果回呼傳回覆寫的回應，執行作業就會停止，並略過所有其餘回呼。
create_time

Timestamp

僅供輸出。建立代理程式的時間戳記。
update_time

Timestamp

僅供輸出。上次更新代理程式的時間戳記。
guardrails[]

string

選用。代理的防護措施清單。格式：projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag

string

Etag 用於確保物件在讀取 - 修改 - 寫入作業期間未變更。如果 etag 為空，更新作業會覆寫任何並行變更。
toolsets[]

Agent.AgentToolset

選用。代理的工具集清單。
generated_summary

string

僅供輸出。如果代理是由 LLM 助理產生，這個欄位會包含生成作業的描述性摘要。
transfer_rules[]

TransferRule

選用。代理程式轉移規則。如果有多項規則相符，系統會使用清單中的第一項規則。
validation_errors[]

string

僅供輸出。代理程式設定錯誤或有誤，可能影響代理程式品質。
聯集欄位 agent_type。代理程式類型。agent_type 只能是下列其中一個設定：
llm_agent

Agent.LlmAgent

選用。預設代理程式類型。
remote_dialogflow_agent

Agent.RemoteDialogflowAgent

選用。用於執行代理的遠端 Dialogflow 代理。如果設定這個欄位，系統會忽略所有其他代理程式層級的屬性。

注意：如果 Dialogflow 代理程式與應用程式位於不同專案，請將 roles/dialogflow.client 授予 CES 服務代理程式 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com。
remote_a2a_agent

Agent.RemoteA2aAgent

選用。用於代理執行的遠端 A2A 代理。

AgentToolset

包含所選工具的工具集。

欄位
toolset

string

這是必要旗標，工具集的資源名稱。格式：projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]

string

選用。用於篩選工具集的工具 ID。

LlmAgent

這個類型沒有任何欄位。

預設代理程式類型。代理會使用代理中指定的指令和回呼，透過大型語言模型執行工作。

RemoteA2aAgent

這個代理會將執行作業轉移至遠端 A2A 代理。

欄位
a2a_config

RemoteA2aConfig

這是必要旗標，A2A 連線設定。

RemoteDialogflowAgent

這個代理會將執行作業轉移至遠端 Dialogflow CX 代理。Dialogflow 代理程式會處理後續的使用者查詢，直到工作階段或流程結束，控制權才會轉移回父項 CES 代理程式。

欄位
agent

string

這是必要旗標，Dialogflow 代理資源名稱。格式：projects/{project}/locations/{location}/agents/{agent}
flow_id

string

選用。Dialogflow 代理程式中流程的流程 ID。
environment_id

string

選用。用於執行代理程式的 Dialogflow 代理程式環境 ID。如未指定，則會使用草稿環境。
input_variable_mapping

map<string, string>

選用。將應用程式變數名稱對應至要傳送給 Dialogflow 代理程式做為輸入內容的 Dialogflow 工作階段參數名稱。
output_variable_mapping

map<string, string>

選用。Dialogflow 工作階段參數名稱與應用程式變數名稱的對應關係，Dialogflow 代理執行完畢後，會將這些名稱傳回 CES 代理。
respect_response_interruption_settings

bool

選用。指出是否要遵守 Dialogflow 代理程式中設定的訊息層級中斷設定。

  • 如果為 false：Dialogflow 代理程式的所有回應訊息都會遵循應用程式層級的插話設定。
  • 若為 true：只有 allow_playback_interruption 設為 true 的回覆訊息可中斷，所有其他訊息則會遵循應用程式層級的插話設定。
language_code_variable

string

選用。變數名稱，其中包含要用於 Dialogflow 會話的語言代碼。如未指定，系統會使用 Dialogflow 代理程式的預設語言代碼。

AgentCard

AgentCard 會傳達遠端服務專員的重要資訊。這是 A2A 通訊協定中定義的 AgentCard 簡化版本 https://a2a-protocol.org/dev/specification/#441-agentcard

欄位
name

string

這是必要旗標，人類可讀的代理名稱。
description

string

這是必要旗標，代理的行動/解決方案空間說明。
supported_interfaces[]

AgentInterface

這是必要旗標，支援的介面排序清單。系統會優先使用第一個項目。
version

string

這是必要旗標，代理程式的版本。
skills[]

AgentSkill

這是必要旗標，技能代表代理可執行的能力單位。這可能有點抽象，但代表代理程式極有可能成功執行的動作。

AgentInterface

宣告目標網址、傳輸和通訊協定版本的組合，以便與代理程式互動。這項功能可讓代理程式透過多種通訊協定繫結機制，公開相同功能。

欄位
url

string

這是必要旗標，這個介面的網址。必須是正式環境中有效的絕對 HTTPS 網址。例如：「https://api.example.com/a2a/v1」、「https://grpc.example.com/a2a」
protocol_binding

string

這是必要旗標，這個網址支援的通訊協定繫結。這是開放式表單字串，可輕鬆擴充其他通訊協定繫結。官方支援的核心通訊協定為 JSONRPC、GRPC 和 HTTP+JSON。
tenant

string

呼叫代理程式時，要求中使用的租戶 ID。
protocol_version

string

這是必要旗標，這個介面公開的 A2A 通訊協定版本。請使用每個主要版本的最新支援子版本。例如：「0.3」、「1.0」

AgentRegistryDeployment

Agent Registry 部署作業的設定和狀態。

欄位
agent_registry_service_name

string

選用。僅供輸出。已部署的 Agent Registry 服務資源名稱。格式：projects/{project}/locations/{location}/services/{service}

AgentSkill

代表代理可執行的不同功能。

欄位
id

string

這是必要旗標，代理程式技能的專屬 ID。
name

string

這是必要旗標，使用者可解讀的技能名稱。
description

string

這是必要旗標，技能的詳細說明。
tags[]

string

這是必要旗標，一組描述技能功能的關鍵字。
examples[]

string

這項技能可處理的提示或情境範例。
input_modes[]

string

這項技能支援的輸入媒體類型組合，會覆寫代理程式的預設值。
output_modes[]

string

這項技能支援的輸出媒體類型組合，會覆寫代理程式的預設值。

AgentTool

代表可讓代理呼叫其他代理的工具。

欄位
name

string

這是必要旗標，代理程式工具的名稱。
description

string

選用。工具用途說明。
agent

string

選用。做為工具進入點的代理資源名稱。格式：projects/{project}/locations/{location}/agents/{agent}

AgentTransfer

代表將對話轉移給其他服務專員的事件。

欄位
target_agent

string

這是必要旗標，要將對話轉移給哪個服務專員。代理人會接手處理後續對話。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name

string

僅供輸出。代理程式的顯示名稱。

AmbientSoundConfig

設定要與合成的服務專員回覆內容一起播放的環境音效，提升對話的自然程度。

欄位
volume_gain_db

double

選用。環境噪音支援的正常原生音量增益 (以分貝為單位)，範圍為 [-96.0, 16.0]。如果設為 0.0 (dB) 或不予設定，系統會以正常原生訊號振幅播放。如果設為 -6.0 (dB)，系統會以約為正常原生訊號振幅的一半振幅播放。如果設為 +6.0 (dB)，系統會以約為正常原生訊號振幅的兩倍振幅播放。強烈建議您不要設定超過 +10 (dB) 的值，因為在超過這個值之後，通常就無法有效提高音量。
聯集欄位 source。與合成的服務專員回覆內容一起播放的環境噪音，可提升對話的自然度。source 只能是下列其中一個設定：
prebuilt_ambient_noise
(deprecated)

AmbientSoundConfig.PrebuiltAmbientNoise

選用。已淘汰：已淘汰 prebuilt_ambient_noise，改用 prebuilt_ambient_sound。
gcs_uri

string

選用。環境噪音，以單聲道 16 kHz WAV 檔案的形式儲存在 Cloud Storage 中。

注意：請確認 CES 服務代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com 具有 Cloud Storage 物件的 storage.objects.get 權限。
prebuilt_ambient_sound

string

選用。預建環境音效的名稱。有效值包括：-「coffee_shop」-「keyboard」-「keypad」-「hum」-「office_1」-「office_2」-「office_3」-「room_1」-「room_2」-「room_3」-「room_4」-「room_5」-「air_conditioner」

PrebuiltAmbientNoise

內建環境噪音。

列舉
PREBUILT_AMBIENT_NOISE_UNSPECIFIED 不指定。
RETAIL_STORE 零售商店的環境噪音。
CONVENTION_HALL 會議廳的環境噪音。
OUTDOOR 街道的環境噪音。

ApiAuthentication

API 呼叫需要驗證資訊。

欄位
聯集欄位 auth_config。驗證設定。auth_config 只能是下列其中一個設定：
api_key_config

ApiKeyConfig

選用。API 金鑰驗證的設定。
oauth_config

OAuthConfig

選用。OAuth 的設定。
service_agent_id_token_auth_config

ServiceAgentIdTokenAuthConfig

選用。從 CES 服務代理程式產生的 ID 權杖驗證設定。
service_account_auth_config

ServiceAccountAuthConfig

選用。服務帳戶驗證的設定。
bearer_token_config

BearerTokenConfig

選用。不記名權杖驗證的設定。

ApiKeyConfig

使用 API 金鑰進行驗證的設定。

欄位
key_name

string

這是必要旗標，API 金鑰的參數名稱或標頭名稱。例如：如果 API 要求是「https://example.com/act?X-Api-Key=」，則「X-Api-Key」就是參數名稱。
api_key_secret_version

string

這是必要旗標，儲存 API 金鑰的 SecretManager 密鑰版本資源名稱。格式：projects/{project}/secrets/{secret}/versions/{version}

注意：請將 roles/secretmanager.secretAccessor 角色授予 CES 服務代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com。
request_location

ApiKeyConfig.RequestLocation

這是必要旗標，要求中的金鑰位置。

RequestLocation

要求中 API 金鑰的位置。

列舉
REQUEST_LOCATION_UNSPECIFIED 不明。請勿使用這個值。
HEADER 代表 HTTP 標頭中的金鑰。
QUERY_STRING 代表查詢字串中的鍵。

應用程式

應用程式是代理程式群組的頂層容器，包括根層級代理程式和子代理程式，以及相關聯的設定。這些代理會互相合作，在應用程式的脈絡中達成特定目標。

欄位
name

string

ID。應用程式的專屬 ID。格式：projects/{project}/locations/{location}/apps/{app}
display_name

string

這是必要旗標，應用程式的顯示名稱。
description

string

選用。應用程式的說明，方便使用者閱讀。
pinned

bool

選用。應用程式是否已釘選在應用程式清單中。
root_agent

string

選用。根代理程式是應用程式的進入點。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
language_settings

LanguageSettings

選用。應用程式的語言設定。
time_zone_settings

TimeZoneSettings

選用。應用程式的時區設定。
audio_processing_config

AudioProcessingConfig

選用。應用程式的音訊處理設定。
logging_settings

LoggingSettings

選用。應用程式的記錄設定。
error_handling_settings

ErrorHandlingSettings

選用。應用程式的錯誤處理設定。
model_settings

ModelSettings

選用。應用程式的預設 LLM 模型設定。個別資源 (例如代理程式、安全防護措施) 可視需要覆寫這些設定。
tool_execution_mode

App.ToolExecutionMode

選用。應用程式的工具執行模式。如未提供，則預設為 PARALLEL。
evaluation_metrics_thresholds

EvaluationMetricsThresholds

選用。應用程式的評估門檻。
variable_declarations[]

App.VariableDeclaration

選用。變數的宣告。
predefined_variable_declarations[]

App.VariableDeclaration

僅供輸出。應用程式的預先定義變數宣告。
global_instruction

string

選用。應用程式中所有代理程式的指令。您可以使用這項指令，為所有代理程式設定穩定的身分或個性。
guardrails[]

string

選用。應用程式的防護措施清單。格式：projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
data_store_settings

DataStoreSettings

選用。應用程式的資料儲存庫設定。
default_channel_profile

ChannelProfile

選用。應用程式使用的預設管道設定檔。
metadata

map<string, string>

選用。應用程式的中繼資料。這個欄位可用於儲存與應用程式詳細資料或預期用途相關的其他資訊。
create_time

Timestamp

僅供輸出。應用程式的建立時間戳記。
update_time

Timestamp

僅供輸出。應用程式上次更新的時間戳記。
etag

string

僅供輸出。Etag 用於確保物件在讀取 - 修改 - 寫入作業期間未變更。如果 etag 為空，更新作業會覆寫任何並行變更。
deployment_count

int32

僅供輸出。應用程式中的部署數量。
client_certificate_settings

ClientCertificateSettings

選用。應用程式的預設用戶端憑證設定。
vpc_sc_settings

VpcScSettings

選用。應用程式的 VPC-SC 設定。
locked

bool

選用。指出應用程式是否已鎖定，無法進行變更。如果應用程式已鎖定，系統會拒絕修改應用程式資源。
validation_errors[]

string

僅供輸出。應用程式中的設定錯誤或警告。
dashboard_settings

DashboardSettings

選用。應用程式專屬的資訊主頁設定，用於連結及設定 Contact Center Insights 資訊主頁。

ToolExecutionMode

定義代理同時選取多個工具時的工具執行行為。

列舉
TOOL_EXECUTION_MODE_UNSPECIFIED 未指定工具執行模式。預設值為 PARALLEL。
PARALLEL 如果選取多項工具，系統會平行執行這些工具，並使用相同的 ToolContext。
SEQUENTIAL 如果選取多個工具，系統會依序執行。只有在前一個工具完成後，下一個工具才會執行，且可以查看前一個工具更新的 ToolContext。

VariableDeclaration

定義變數的結構和中繼資料。

欄位
name

string

這是必要旗標，變數名稱。名稱只能使用英文字母、數字或底線，開頭須為英文字母或底線。
description

string

這是必要旗標，變數的說明。
schema

Schema

這是必要旗標，變數的結構定義。

AppSnapshot

應用程式的快照。

欄位
app

App

選用。應用程式的基本設定。
agents[]

Agent

選用。應用程式中的代理程式清單。
tools[]

Tool

選用。應用程式中的工具清單。
examples[]

Example

選用。應用程式中的範例清單。
guardrails[]

Guardrail

選用。應用程式中的防護措施清單。
toolsets[]

Toolset

選用。應用程式中的工具集清單。

AppVersion

在 Customer Engagement Suite (CES) 中，應用程式版本是應用程式在特定時間點的快照。建立後即無法變更。

欄位
name

string

ID。應用程式版本的專屬 ID。格式：projects/{project}/locations/{location}/apps/{app}/versions/{version}
display_name

string

選用。應用程式版本的顯示名稱。
description

string

選用。應用程式版本的說明。
creator

string

僅供輸出。建立應用程式版本的使用者電子郵件。
create_time

Timestamp

僅供輸出。應用程式版本建立時間的時間戳記。
update_time

Timestamp

僅供輸出。上次更新應用程式版本的時間戳記。
snapshot

AppSnapshot

僅供輸出。建立版本時的應用程式快照。
etag

string

僅供輸出。Etag 用於確保物件在讀取 - 修改 - 寫入作業期間未變更。如果 etag 為空，更新作業會覆寫任何並行變更。

AudioEncoding

AudioEncoding 會指定音訊資料的編碼格式。

列舉
AUDIO_ENCODING_UNSPECIFIED 未指定音訊編碼。
LINEAR16 16 位元線性 PCM 音訊編碼。
MULAW 使用 G.711 PCMU/mu-law 來壓縮 14 位元音訊樣本，並在傳輸後將其擴展的 8 位元樣本。
ALAW 使用 G.711 PCMU/A-law 壓縮 14 位元音訊樣本的 8 位元樣本。

AudioProcessingConfig

輸入和輸出音訊的處理和傳送方式設定。

欄位
synthesize_speech_configs

map<string, SynthesizeSpeechConfig>

選用。代理程式回應的合成方式設定，從語言代碼對應至 SynthesizeSpeechConfig。

如果找不到指定語言代碼的設定，系統會使用根語言代碼的設定。舉例來說，如果地圖包含「en-us」和「en」，且指定的語言代碼為「en-gb」，則會使用「en」設定。

注意：語言代碼不區分大小寫。
barge_in_config

BargeInConfig

選用。設定使用者插話活動的服務專員行為。
inactivity_timeout

Duration

選用。代理程式提示使用者重新互動前，使用者無活動 (沒有語音或互動) 的時間長度。如果不設定，服務專員就不會提示使用者重新參與。
ambient_sound_config

AmbientSoundConfig

選用。設定要與合成的服務專員回覆內容一起播放的環境音效，提升對話的自然程度。
custom_voice_samples[]

CustomVoiceSample

選用。設定語音複製功能的自訂語音樣本。

AudioRecordingConfig

設定音訊互動的記錄方式。

欄位
gcs_bucket

string

選用。用於儲存通話錄音的 Cloud Storage bucket。URI 開頭必須是「gs://」。

請選擇符合資料落地要求的 bucket 位置。

注意：如果 Cloud Storage bucket 與應用程式位於不同專案，請將 storage.objects.create 權限授予 CES 服務代理程式 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com。
gcs_path_prefix

string

選用。音訊錄音的 Cloud Storage 路徑前置字串。

這個前置字串可包含下列預留位置，系統會在放送時動態替換： - $project：專案 ID - $location：應用程式位置 - $app：應用程式 ID - $date：工作階段日期，格式為 YYYY-MM-DD - $session：工作階段 ID

如未指定路徑前置字元，系統會使用預設前置字元 $project/$location/$app/$date/$session/。

BargeInConfig

設定如何處理使用者插話活動。

欄位
disable_barge_in
(deprecated)

bool

選用。已淘汰：已淘汰 ChannelProfile 中的 disable_barge_in，改用 disable_barge_in_control。

禁止使用者在代理程式說話時插話。設為 true 時，系統會忽略代理程式回覆播放期間的使用者輸入內容。
barge_in_awareness

bool

選用。啟用後，代理程式會根據使用者未聽完先前代理程式訊息的假設，調整下一次的回覆。如果代理程式回覆會以視覺化方式顯示，則不應使用這項功能。

BatchDeleteConversationsRequest

AgentService.BatchDeleteConversations 的要求訊息。

欄位
parent

string

這是必要旗標，要刪除對話的應用程式資源名稱。格式：projects/{project}/locations/{location}/apps/{app}
conversations[]

string

這是必要旗標，要刪除的對話資源名稱。

BatchDeleteConversationsResponse

AgentService.BatchDeleteConversations 的回應訊息。

欄位
deleted_conversations[]

string

已成功刪除的對話清單。
failed_conversations[]

string

無法刪除的對話清單。
error_messages[]

string

選用。與刪除失敗的對話相關聯的錯誤訊息清單。

BearerTokenConfig

使用不記名權杖進行驗證的設定。

欄位
token

string

這是必要旗標，不記名權杖。格式必須為 $context.variables.<name_of_variable>。

BidiSessionClientMessage

用戶端為 SessionService.BidiRunSession 方法傳送的頂層訊息。

欄位
聯集欄位 message_type。訊息類型。message_type 只能是下列其中一個設定：
config

SessionConfig

選用。工作階段的初始設定訊息。
realtime_input

SessionInput

選用。工作階段的即時輸入內容。

BidiSessionServerMessage

從 SessionService.BidiRunSession 方法傳回的頂層訊息。

欄位
聯集欄位 message_type。訊息類型。message_type 只能是下列其中一個設定：
session_output

SessionOutput

選用。CES 代理的處理結果。
recognition_result

RecognitionResult

選用。音訊輸入內容的即時語音辨識結果。
interruption_signal

InterruptionSignal

選用。表示服務專員的語音回覆已中斷。
end_session

EndSession

選用。表示工作階段已結束。
go_away

GoAway

選用。表示伺服器即將中斷連線，用戶端應半關閉並重新啟動連線。

BigQueryExportSettings

用於說明應用程式 BigQuery 匯出行為的設定。

欄位
enabled

bool

選用。指出是否已啟用 BigQuery 匯出功能。
project

string

選用。要匯出資料的 BigQuery 資料集專案 ID。

注意：如果 BigQuery 資料集與應用程式位於不同專案，請將 roles/bigquery.admin 角色授予 CES 服務代理程式 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com。
dataset

string

選用。要匯出資料的 BigQuery 資料集 ID。

Blob

代表對話中的 Blob 輸入或輸出內容。

欄位
mime_type

string

這是必要旗標，來源資料的 IANA 標準 MIME 類型。
data

bytes

這是必要旗標，Blob 的原始位元組。

回撥電話

回呼會定義在代理互動的各個階段執行的自訂邏輯。

欄位
description

string

選用。使用者可理解的回呼說明。
disabled

bool

選用。回呼是否已停用。代理程式會忽略已停用的回呼。
proactive_execution_enabled

bool

選用。如果啟用這項功能，系統也會對中繼模型輸出內容執行回呼。這項設定只會影響模型回呼後續作業。請謹慎啟用。通常在收到所有模型回覆後，才需要執行模型回呼。啟用主動執行功能可能會對執行成本和延遲時間造成負面影響，因此只應在極少數情況下啟用。
聯集欄位 callback。要執行的回呼。callback 只能是下列其中一個設定：
python_code

string

這是必要旗標，要為回呼執行的 Python 程式碼。

變更記錄

更新記錄代表對應用程式或應用程式內資源所做的變更。

欄位
name

string

ID。變更記錄的專屬 ID。格式：projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}
author

string

僅供輸出。變更作者的電子郵件地址。
display_name

string

僅供輸出。變更的顯示名稱。通常應為變更的資源顯示名稱。
description

string

僅供輸出。變更說明，通常會擷取資源中變更的欄位。
resource

string

僅供輸出。變更的資源。
resource_type

string

僅供輸出。變更的資源類型。
action

string

僅供輸出。對資源執行的動作。
original_resource

Struct

僅供輸出。變更前的原始資源。
new_resource

Struct

僅供輸出。變更後的新資源。
dependent_resources[]

Struct

僅供輸出。已變更的依附資源。
create_time

Timestamp

僅供輸出。變更時間。
sequence_number

int64

僅供輸出。變更記錄中單調遞增的序號。

ChannelProfile

ChannelProfile 會設定代理程式在特定通訊管道 (例如網頁 UI 或電話) 中的行為。

欄位
profile_id

string

選用。頻道設定檔的專屬 ID。
channel_type

ChannelProfile.ChannelType

選用。管道設定檔的類型。
persona_property

ChannelProfile.PersonaProperty

選用。頻道個人資料的 persona 屬性。
web_widget_config

ChannelProfile.WebWidgetConfig

選用。網頁小工具的設定。
whatsapp_config

ChannelProfile.WhatsAppConfig

選用。WhatsApp 部署作業專用設定。
instagram_config

ChannelProfile.InstagramConfig

選用。Instagram 部署作業專用設定。
disable_dtmf

bool

選用。是否要停用雙音多頻 (DTMF)。
disable_barge_in_control

bool

選用。是否要在對話中停用使用者插話控制項。- true：代理程式說話時，系統會停用使用者中斷功能。- false：代理程式會保留自動控制權，決定使用者何時可以中斷。
noise_suppression_level

string

選用。頻道設定檔的雜訊抑制等級。可用值為「low」、「moderate」、「high」、「very_high」。

ChannelType

管道設定檔的類型。

列舉
UNKNOWN 管道類型不明。
WEB_UI 網頁 UI 管道。
API API 管道。
TWILIO Twilio 管道。
GOOGLE_TELEPHONY_PLATFORM Google Telephony Platform 管道。
CONTACT_CENTER_AS_A_SERVICE Contact Center as a Service (CCaaS) 管道。
CONTACT_CENTER_AS_A_SERVICE_CHAT Contact Center as a Service (CCaaS Chat) 管道。
FIVE9 Five9 頻道。
CONTACT_CENTER_INTEGRATION 第三方客服中心整合管道。
WHATSAPP WhatsApp 頻道。
INSTAGRAM Instagram 頻道。

InstagramConfig

Instagram 部署作業專用設定。

欄位
instagram_account_id

string

這是必要旗標，Instagram 帳戶 ID。
display_name

string

僅供輸出。系統擷取的 Meta 商家專頁名稱。
thumbnail_url

string

僅供輸出。擷取的 Meta 商家檔案縮圖網址。
description

string

僅供輸出。Meta 企業專頁或個人資料的說明。

PersonaProperty

代表頻道的角色屬性。

欄位
persona

ChannelProfile.PersonaProperty.Persona

選用。頻道的角色。

角色

頻道的角色。

列舉
UNKNOWN UNKNOWN persona。
CONCISE 代理會簡明扼要地回覆
CHATTY 代理人提供額外背景資訊、說明和詳細資料

WebWidgetConfig

網頁小工具的設定訊息。

欄位
modality

ChannelProfile.WebWidgetConfig.Modality

選用。網頁小工具的模式。
theme

ChannelProfile.WebWidgetConfig.Theme

選用。網頁小工具的主題。
web_widget_title

string

選用。網頁小工具的標題。
security_settings

ChannelProfile.WebWidgetConfig.SecuritySettings

選用。網頁小工具的安全性設定。

模態

網頁小工具的模式。

列舉
MODALITY_UNSPECIFIED 不明模式。
CHAT_AND_VOICE 小工具支援即時通訊和語音輸入。
VOICE_ONLY 小工具僅支援語音輸入。
CHAT_ONLY 小工具僅支援輸入文字。
CHAT_VOICE_AND_VIDEO 小工具支援文字、語音和視訊輸入。

SecuritySettings

網頁小工具的安全設定。

欄位
enable_public_access

bool

選用。指出是否已啟用公開存取網頁小工具。如果true，網頁小工具就會公開。如為 false，網頁小工具必須與您自己的驗證和授權系統整合，才能傳回存取 CES 代理程式的有效憑證。
enable_origin_check

bool

選用。指出是否已啟用網頁小工具的來源檢查。如果是 true，網頁小工具會檢查載入網頁小工具的網站來源，只允許在相同來源或任何允許的來源中載入。
allowed_origins[]

string

選用。允許代管網頁小工具的來源。來源定義於 RFC 6454。如果留空，系統會允許所有來源。最多只能有 100 個來源，例如：「https://example.com」
enable_recaptcha

bool

選用。指出是否已啟用網頁小工具的 reCAPTCHA 驗證。

主題

網頁小工具的主題。

列舉
THEME_UNSPECIFIED 不明主題。
LIGHT 淺色主題。
DARK 深色主題。

WhatsAppConfig

WhatsApp 部署作業專用設定。

欄位
waba_id

string

這是必要旗標，WhatsApp Business 帳戶 ID。
phone_number_id

string

這是必要旗標，Meta 電話號碼 ID。
phone_number

string

選用。電話號碼，格式為 E.164。
display_name

string

僅供輸出。系統擷取的 Meta 商家專頁名稱。
thumbnail_url

string

僅供輸出。擷取的 Meta 商家檔案縮圖網址。
description

string

僅供輸出。Meta 企業專頁或個人資料的說明。

Chunk

訊息中的一組內容。

欄位
聯集欄位 data。資料區塊。data 只能是下列其中一個設定：
text

string

選用。文字資料。
transcript

string

選用。與音訊相關的轉錄稿。
blob

Blob

選用。Blob 資料。
payload

Struct

選用。自訂酬載資料。
image

Image

選用。圖片資料。
tool_call

ToolCall

選用。工具執行要求。
tool_response

ToolResponse

選用。工具執行回應。
agent_transfer

AgentTransfer

選用。代理程式轉移事件。
updated_variables

Struct

結構體代表對話中更新的變數，並以變數名稱做為鍵。
default_variables

Struct

結構體代表對話開始時的預設變數，並以變數名稱做為鍵。

參考資料

與服務專員回覆相關的引用內容。

欄位
cited_chunks[]

Citations.CitedChunk

列出引用的資訊。
inline_citations[]

Citations.InlineCitation

選用。服務專員回覆中的文內引用清單。

CitedChunk

引用的資訊。

欄位
uri

string

用於引用的 URI。
title

string

所引用文件的標題。
text

string

用於引用的文字。
requires_attribution

bool

這項引用內容是否需要向使用者顯示出處。

InlineCitation

回覆文字中的內文引用。

欄位
start_index

int32

代理回覆中文字區段的起始索引 (以位元組為單位)。
end_index

int32

代理回覆中文字片段的結尾索引 (以位元組為單位)。
cited_chunk_indices[]

int32

支援這個文字片段的引用區塊索引。索引是指 cited_chunks 中的元素。

ClientCertificateSettings

自訂用戶端憑證的設定。

欄位
tls_certificate

string

這是必要旗標，以 PEM 格式編碼的 TLS 憑證。這個字串必須包含開頭標題和結尾頁尾行。
private_key

string

這是必要旗標，儲存 PEM 格式編碼私密金鑰的 SecretManager 密鑰版本資源名稱。格式：projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

選用。SecretManager Secret 版本資源的名稱，用於儲存解密私密金鑰的通關密語。如果私密金鑰未加密，則應保持未設定狀態。格式：projects/{project}/secrets/{secret}/versions/{version}

ClientFunction

代表代理可叫用的用戶端函式。代理程式選擇工具後，控制權會交給用戶端。用戶端負責執行函式，並以 ToolResponse 形式傳回結果，繼續與代理程式互動。

欄位
name

string

這是必要旗標，函式名稱。
description

string

選用。函式說明。
parameters

Schema

選用。函式參數的結構定義。
response

Schema

選用。函式回應的結構定義。

CloudLoggingSettings

用於說明應用程式 Cloud Logging 行為的設定。

欄位
enable_cloud_logging

bool

選用。是否要為工作階段啟用 Cloud Logging。

CodeBlock

要執行的程式碼區塊，而非實際的工具呼叫。

欄位
python_code

string

這是必要旗標，在工具模擬模式中呼叫的 Python 程式碼。預期的 Python 函式簽章 - 如要擷取所有工具呼叫： def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: 如要擷取特定工具呼叫： def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: 如果函式傳回 None，系統會改為叫用實際工具。

ConnectorTool

ConnectorTool 可連線至不同整合服務。詳情請參閱：https://cloud.google.com/integration-connectors/docs/overview。

欄位
connection

string

這是必要旗標，所參照 Integration Connectors 連線的完整資源名稱。格式：projects/{project}/locations/{location}/connections/{connection}
action

Action

這是必要旗標，工具要執行的動作。
auth_config

EndUserAuthConfig

選用。設定 Integration Connectors 處理驗證的方式。根據預設，管理員驗證會傳遞至 Integration Connectors API 要求。您可以透過不同的使用者驗證設定覆寫這項設定。注意：連線必須啟用驗證覆寫功能，才能在此指定 EUC 設定，否則 ConnectorTool 建立作業會失敗。詳情請參閱 https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override。
name

string

選用。代理可使用的工具名稱，用來決定是否呼叫這個 ConnectorTool。
description

string

選用。代理可使用這項工具說明，判斷是否要呼叫這個 ConnectorTool。

ConnectorToolset

這組工具可從 Integration Connectors 連線產生工具。

欄位
connection

string

這是必要旗標，所參照 Integration Connectors 連線的完整資源名稱。格式：projects/{project}/locations/{location}/connections/{connection}
auth_config

EndUserAuthConfig

選用。設定 Integration Connectors 處理驗證的方式。根據預設，管理員驗證會傳遞至 Integration Connectors API 要求。您可以透過不同的使用者驗證設定覆寫這項設定。注意：連線必須啟用驗證覆寫功能，才能在此指定 EUC 設定，否則工具集建立作業會失敗。詳情請參閱：https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connector_actions[]

Action

這是必要旗標，要產生工具的連接器動作/實體作業清單。

對話

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

欄位
name

string

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

Timestamp

僅供輸出。對話的建立時間戳記。
end_time

Timestamp

僅供輸出。對話完成時的時間戳記。
turns[]

Conversation.Turn

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

int32

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

Conversation.ChannelType

已淘汰。請改用 input_types。
source

Conversation.Source

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

Conversation.InputType

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

string

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

string

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

string

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

string

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

Message

已淘汰，請改用回合。

ChannelType

對話的管道類型。

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

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 輸入變數。

來源

對話來源。

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

Turn

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

欄位
messages[]

Message

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

Span

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

string

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

ConversationLoggingSettings

設定，用於說明應用程式的對話記錄行為。

欄位
disable_conversation_logging

bool

選用。是否要停用工作階段的對話記錄功能。
retention_window

Duration

選用。控制對話的保留期。如未設定，對話會保留 365 天。

CreateAgentRequest

欄位
parent

string

這是必要旗標，要在其中建立代理程式的應用程式資源名稱。
agent_id

string

選用。代理程式要使用的 ID，會成為代理程式資源名稱的最終元件。如未提供，系統會自動為代理程式指派專屬 ID。
agent

Agent

這是必要旗標，要建立的代理。

CreateAppRequest

AgentService.CreateApp 的要求訊息。

欄位
parent

string

這是必要旗標，要在其中建立應用程式的位置資源名稱。
app_id

string

選用。應用程式要使用的 ID，會成為應用程式資源名稱的最終元件。如未提供，系統會自動為應用程式指派專屬 ID。
app

App

這是必要旗標，要建立的應用程式。

CreateAppVersionRequest

AgentService.CreateAppVersion 的要求訊息

欄位
parent

string

這是必要旗標，要在其中建立應用程式版本的應用程式資源名稱。
app_version_id

string

選用。應用程式版本要使用的 ID，會成為應用程式版本資源名稱的最後一個元件。如未提供，系統會自動為應用程式版本指派專屬 ID。
app_version

AppVersion

這是必要旗標，要建立的應用程式版本。

CreateDeploymentRequest

AgentService.CreateDeployment 的要求訊息。

欄位
parent

string

這是必要旗標，上層應用程式。格式：projects/{project}/locations/{location}/apps/{app}
deployment_id

string

選用。要用於部署作業的 ID，會成為部署作業資源名稱的最終元件。如未提供，系統會自動為部署作業指派專屬 ID。
deployment

Deployment

這是必要旗標，要建立的部署作業。

CreateExampleRequest

AgentService.CreateExample 的要求訊息。

欄位
parent

string

這是必要旗標，要在其中建立範例的應用程式資源名稱。
example_id

string

選用。範例要使用的 ID，會成為範例資源名稱的最終元件。如未提供，系統會自動為範例指派專屬 ID。
example

Example

這是必要旗標，要建立的範例。

CreateGuardrailRequest

AgentService.CreateGuardrail 的要求訊息。

欄位
parent

string

這是必要旗標，要建立防護措施的應用程式資源名稱。
guardrail_id

string

選用。用於防護措施的 ID，會成為防護措施資源名稱的最終元件。如未提供，系統會自動為防護措施指派專屬 ID。
guardrail

Guardrail

這是必要旗標，要建立的防護措施。

CreateToolRequest

AgentService.CreateTool 的要求訊息。

欄位
parent

string

這是必要旗標，要在其中建立工具的應用程式資源名稱。
tool_id

string

選用。工具使用的 ID，會成為工具資源名稱的最終元件。如未提供，系統會自動為工具指派專屬 ID。
tool

Tool

這是必要旗標，用來建立內容的工具。

CreateToolsetRequest

AgentService.CreateToolset 的要求訊息。

欄位
parent

string

這是必要旗標，要在其中建立工具組的應用程式資源名稱。
toolset_id

string

選用。工具集使用的 ID，會成為工具集資源名稱的最終元件。如未提供，系統會自動為工具集指派專屬 ID。
toolset

Toolset

這是必要旗標，創作工具組。

CustomVoiceSample

用於語音複製的自訂語音樣本設定。

欄位
name

string

選用。自訂語音樣本的使用者定義名稱。
voice_sample_gcs_uri

string

選用。用於語音複製的音訊樣本 Cloud Storage URI。音訊樣本應為單聲道、24kHz 的 WAV 檔案。
consent_audio_gcs_uri

string

選用。同意複製語音。
voice_instruction

string

選用。以自然語言指定語音風格、語氣、節奏或發音。
preview_audio_content

bytes

僅供輸出。自訂語音的合成預覽音訊，格式為標準 WAV (LINEAR16、24kHz、16 位元、單聲道)。
preview_text

string

選用。用於合成 Custom Voice 預覽音訊的文字。
warnings[]

CustomVoiceSample.Warning

僅供輸出。語音複製處理期間遇到的警告訊息 (例如音訊音量偏低)。
voice_instruction_mode

CustomVoiceSample.VoiceInstructionMode

選用。語音樣本的指令模式。如未指定，則預設為 NO_INSTRUCTION。

VoiceInstructionMode

語音樣本的指令模式。

列舉
VOICE_INSTRUCTION_MODE_UNSPECIFIED 未指定指令模式，預設值為 NO_INSTRUCTION。
NO_INSTRUCTION 不會使用語音指令。
GENERATE_INSTRUCTION AI 會根據音訊樣本自動生成語音指令。
CUSTOM_INSTRUCTION 使用者提供的自訂語音指令。

警告

處理語音樣本時出現警告訊息。

欄位
message

string

僅供輸出。使用者可理解的警告說明。
type

CustomVoiceSample.Warning.WarningType

僅供輸出。警告類型。

WarningType

處理語音樣本時遇到的警告類型。

列舉
WARNING_TYPE_UNSPECIFIED 未指定警示類型。
LOW_AUDIO_LEVEL 語音樣本的音訊音量過低 (例如 RMS 振幅偏低)。

DashboardSettings

與應用程式相關聯的資訊主頁設定，會顯示在「監控」檢視畫面中。

欄位
default_dashboard

string

選用。與應用程式相關聯的預設 Contact Center Insights 資訊主頁資源名稱。使用者瀏覽應用程式的「監控」檢視畫面時，系統會顯示這個資訊主頁。

格式：projects/{project}/locations/{location}/dashboards/{dashboard}

DataStore

Vertex AI Search 中的資料儲存庫資源。

欄位
name

string

這是必要旗標，DataStore 的完整資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type

DataStore.DataStoreType

僅供輸出。資料儲存庫類型。這個欄位為唯讀，由伺服器填入。
document_processing_mode

DataStore.DocumentProcessingMode

僅供輸出。資料儲存庫連線的文件處理模式。僅適用於 PUBLIC_WEB 和 UNSTRUCTURED 資料儲存庫。
display_name

string

僅供輸出。資料儲存庫的顯示名稱。
create_time

Timestamp

僅供輸出。資料儲存庫的建立時間戳記。
connector_config

DataStore.ConnectorConfig

僅供輸出。資料儲存庫連線的連接器設定。

ConnectorConfig

資料儲存庫連線的連接器設定。

欄位
collection

string

資料儲存庫所屬集合的資源名稱。
collection_display_name

string

資料儲存庫所屬集合的顯示名稱。
data_source

string

資料來源的名稱。例如：salesforce、jira、confluence、bigquery。

DataStoreType

資料儲存庫類型。

列舉
DATA_STORE_TYPE_UNSPECIFIED 不指定。這個值表示未指定資料儲存庫類型，因此搜尋時不會使用。
PUBLIC_WEB 包含公開網路內容的資料儲存庫。
UNSTRUCTURED 包含非結構化私人資料的資料儲存庫。
FAQ 包含結構化資料的資料儲存庫，這些資料會做為常見問題。
CONNECTOR 資料儲存庫，可做為第一方或第三方服務的連接器。

DocumentProcessingMode

資料儲存庫的文件處理模式。

列舉
DOCUMENT_PROCESSING_MODE_UNSPECIFIED 不指定。
DOCUMENTS 文件會以文件形式處理。
CHUNKS 文件會轉換為區塊。

DataStoreSettings

應用程式的資料儲存庫相關設定。

欄位
engines[]

DataStoreSettings.Engine

僅供輸出。應用程式的引擎。

引擎

資料儲存庫連結的引擎。請參閱 Vertex AI Search：https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction。

欄位
name

string

僅供輸出。引擎的資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type

DataStoreSettings.Engine.Type

僅供輸出。引擎類型。

類型

引擎類型。請參閱 https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType 和 https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest 的說明文件。

列舉
TYPE_UNSPECIFIED 未指定引擎類型。
ENGINE_TYPE_CHAT 即時通訊引擎類型。應用程式的 SOLUTION_TYPE_CHAT 引擎。新增至應用程式的所有連接器資料儲存庫都會新增至這個引擎。

DataStoreTool

從 Vertex AI Search 資料存放區或引擎擷取資料，做為回覆內容的依據。接受資料儲存庫或引擎，但不能同時接受兩者。請參閱 Vertex AI Search：https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction。

欄位
name

string

這是必要旗標，資料儲存庫工具名稱。
description

string

選用。工具說明。
boost_specs[]

DataStoreTool.BoostSpecs

選用。增強規格，以提升特定文件的優先順位。
modality_configs[]

DataStoreTool.ModalityConfig

選用。資料儲存庫的形態設定。
filter_parameter_behavior

DataStoreTool.FilterParameterBehavior

選用。篩選器參數的行為。
聯集欄位 search_source。定義搜尋來源，可以是單一資料儲存庫或引擎。search_source 只能是下列其中一個設定：
data_store_source

DataStoreTool.DataStoreSource

選用。在單一特定 DataStore 中搜尋。
engine_source

DataStoreTool.EngineSource

選用。在引擎內搜尋 (可能跨多個資料儲存區)。

BoostSpec

增強規格，以提升特定文件的優先順位。

欄位
condition_boost_specs[]

DataStoreTool.BoostSpec.ConditionBoostSpec

這是必要旗標，增強規格清單。

ConditionBoostSpec

增強條件的規格。

欄位
condition

string

這是必要旗標，指定加成條件的運算式。語法與篩選運算式語法相同。目前僅支援 BCP-47 語言代碼清單。示例：如要提升英文或法文的建議：(lang_code: ANY("en", "fr"))
boost

float

選用。增幅強度，應介於 [-1, 1] 之間。如果設為負值，即代表降低排名。預設值為 0.0。

設為 1.0 可大幅提高建議的排名。不過，這並不代表經過增強的建議一定會顯示在搜尋結果頂端。

設為 -1.0 會大幅降低建議的排名。不過，系統仍可能會顯示其他相關建議。

設為 0.0 表示不套用任何增幅。系統會忽略提升條件。
boost_control_spec

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec

選用。複雜的自訂排名規格，可根據客戶定義的屬性值進行排名。

BoostControlSpec

根據顧客指定的屬性值，自訂排序的規格。與上述簡單的 (條件、提升) 組合相比，這項功能提供更多控制選項，可自訂排名。

欄位
field_name

string

選用。系統會根據這個欄位的值決定加成金額。
attribute_type

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType

選用。用來決定加成金額的屬性類型。屬性值可從指定 field_name 的欄位值衍生而來。如果是數值，則很簡單，也就是 attribute_value = numerical_field_value。不過，如果是新鮮度，attribute_value = (time.now() - datetime_field_value)。
interpolation_type

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType

選用。要套用的插補類型，用於連結下列控制點。
control_points[]

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint

選用。用來定義曲線的控制點。單調函式 (透過上述 interpolation_type 定義) 會通過這裡列出的控制點。

AttributeType

要套用自訂排序的屬性(或函式)。

列舉
ATTRIBUTE_TYPE_UNSPECIFIED 未指定 AttributeType。
NUMERICAL 系統會根據數值欄位的值，動態更新加成金額。在本例中，控制點的 attribute_value (x 值) 會是指定 boost_amount 的數值欄位實際值。
FRESHNESS 在新鮮度用途中，屬性值會是目前時間與指定日期時間欄位中日期之間的時間長度。值的格式必須為 XSD dayTimeDuration 值 (ISO 8601 時間長度值的受限子集)。這個模式為：[nD][T[nH][nM][nS]]。例如：5D、3DT12H30M、T24H。

ControlPoint

用來定義曲線的控制點。透過這些控制點定義的曲線只能單調遞增或遞減(可接受常數值)。

欄位
attribute_value

string

選用。可以是下列任一項：1. 數值欄位值。2. 新鮮度時間長度規格：值必須格式化為 XSD dayTimeDuration 值 (ISO 8601 時間長度值的受限子集)。格式為：[nD][T[nH][nM][nS]]。
boost_amount

float

選用。如果 attribute_value 評估結果為上述指定值，則分數的提升幅度介於 -1 到 1 之間。

InterpolationType

要套用的插補類型。預設值為線性 (分段線性)。

列舉
INTERPOLATION_TYPE_UNSPECIFIED 未指定插補類型。在本例中，預設值為「線性」。
LINEAR 系統會套用分段線性插值。

BoostSpecs

增強規格，以提升特定文件的排名。詳情請參閱 https://cloud.google.com/generative-ai-app-builder/docs/boosting。

欄位
data_stores[]

string

這是必要旗標，套用升級設定的資料儲存庫。DataStore 的完整資源名稱，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}。
spec[]

DataStoreTool.BoostSpec

這是必要旗標，增強規格清單。

DataStoreSource

設定在特定 DataStore 中搜尋。

欄位
filter

string

選用。DataStore 的篩選器規格。詳情請參閱：https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
data_store

DataStore

選用。資料儲存庫。

EngineSource

設定在引擎內搜尋，可能指定特定資料儲存區。

欄位
engine

string

這是必要旗標，引擎的完整資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
data_store_sources[]

DataStoreTool.DataStoreSource

選用。用於指定引擎中的特定 DataStore。如果留空，搜尋範圍會擴及與引擎相關聯的所有 DataStore。
filter

string

選用。套用至整個引擎搜尋的篩選器。如果提供「data_store_sources」，則不相關且不會使用。詳情請參閱：https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

FilterParameterBehavior

篩選器參數行為。

列舉
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED 預設篩選器行為。為連接器資料存放區加入篩選器參數。如果是其餘資料儲存區類型，則會省略篩選器輸入參數。
ALWAYS_INCLUDE 一律為所有資料存放區類型加入篩選器參數。
NEVER_INCLUDE 無論資料存放區類型為何，篩選參數一律不會納入工具參數清單。

GroundingConfig

接地設定。

欄位
grounding_level

float

選用。根據擷取的來源，答案的真實性門檻。可設定的值範圍為 [1, 5]。這個層級會用來設定回覆內容依據程度的門檻，也就是說，如果回覆內容依據程度的分數低於門檻，系統只會傳回相關的程式碼片段。

舉例來說，如果層級為 3，回應的根據事實程度分數就必須達到 3 分以上，系統才會傳回回應。
disabled

bool

選用。是否停用基礎模型。

ModalityConfig

如果指定，系統會為指定模式套用指定設定。

欄位
modality_type

DataStoreTool.ModalityConfig.ModalityType

這是必要旗標，模式類型。
rewriter_config

DataStoreTool.RewriterConfig

選用。重寫器設定。
summarization_config

DataStoreTool.SummarizationConfig

選用。摘要設定。
grounding_config

DataStoreTool.GroundingConfig

選用。基礎設定。
snippets_config

DataStoreTool.SnippetsConfig

選用。程式碼片段設定。

ModalityType

模式類型。

列舉
MODALITY_TYPE_UNSPECIFIED 未指定模態類型。
TEXT 文字模態。
AUDIO 音訊模式。

RewriterConfig

重寫器設定。

欄位
model_settings

ModelSettings

這是必要旗標，LLM 模型的設定。
prompt

string

選用。提示定義。如未設定，系統會使用預設提示。
disabled

bool

選用。重寫器是否已停用。

SnippetsConfig

程式碼片段設定。

欄位
enable_snippets

bool

選用。是否啟用摘要。
max_snippets

int32

選用。每項查詢要傳回的摘要數量。如未設定，系統預設會傳回服務中的所有程式碼片段。

SummarizationConfig

摘要設定。

欄位
model_settings

ModelSettings

選用。LLM 模型的設定。
prompt

string

選用。提示定義。如未設定，系統會使用預設提示。
disabled

bool

選用。摘要功能是否已停用。

DeleteAgentRequest

AgentService.DeleteAgent 的要求訊息。

欄位
name

string

這是必要旗標，要刪除的代理程式資源名稱。
force

bool

選用。指出是否要強制刪除代理程式，即使其他應用程式/代理程式/範例仍參照該代理程式也一樣。

  • 如果 force = false，且其他代理程式/範例參照該項目，系統就會無法刪除。
  • 如果 force = true，請刪除代理，並從所有參照應用程式/代理/範例中移除。
etag

string

選用。代理程式目前的 ETag。如果未提供 etag，刪除作業會覆寫任何並行變更。如果提供的 etag 與代理程式目前的 etag 不符，系統會封鎖刪除作業，並傳回 ABORTED 錯誤。

DeleteAppRequest

AgentService.DeleteApp 的要求訊息。

欄位
name

string

這是必要旗標，要刪除的應用程式資源名稱。
etag

string

選用。應用程式目前的 etag。如果未提供 etag，刪除作業會覆寫任何並行變更。如果提供的 etag 與應用程式目前的 etag 不符，系統會封鎖刪除作業，並傳回 ABORTED 錯誤。

DeleteAppVersionRequest

AgentService.DeleteAppVersion 的要求訊息。

欄位
name

string

這是必要旗標，要刪除的應用程式版本資源名稱。
etag

string

選用。應用程式版本的目前 ETag。如果未提供 etag，刪除作業會覆寫任何並行變更。如果提供的 etag 與應用程式版本的目前 etag 不符，系統會封鎖刪除作業，並傳回 ABORTED 錯誤。

DeleteConversationRequest

AgentService.DeleteConversation 的要求訊息。

欄位
name

string

這是必要旗標，要刪除的對話資源名稱。
source
(deprecated)

Conversation.Source

選用。指出對話來源。如未設定，系統預設會套用 Source.Live。

DeleteDeploymentRequest

AgentService.DeleteDeployment 的要求訊息。

欄位
name

string

這是必要旗標，要刪除的部署作業名稱。格式：projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
etag

string

選用。部署作業的 etag。如果提供的 etag 與部署作業目前的 etag 不符，系統會封鎖刪除作業，並傳回 ABORTED 錯誤。

DeleteExampleRequest

AgentService.DeleteExample 的要求訊息。

欄位
name

string

這是必要旗標，要刪除的範例資源名稱。
etag

string

選用。範例目前的 etag。如果未提供 etag，刪除作業會覆寫任何並行變更。如果提供的 etag 與範例目前的 etag 不符，系統會封鎖刪除作業，並傳回 ABORTED 錯誤。

DeleteGuardrailRequest

AgentService.DeleteGuardrail 的要求訊息。

欄位
name

string

這是必要旗標，要刪除的防護措施資源名稱。
force

bool

選用。指出是否要強制刪除防護措施，即使應用程式/代理程式仍參照該措施也一樣。

  • 如果設為 force = false，只要有任何應用程式/代理程式仍參照防護措施，系統就會刪除失敗。
  • 如果force = true，系統會移除應用程式/代理程式的所有現有參照，並刪除防護措施。
etag

string

選用。防護措施目前的 ETag。如果未提供 etag，刪除作業會覆寫任何並行變更。如果提供的 etag 與防護措施目前的 etag 不符，系統會封鎖刪除作業，並傳回 ABORTED 錯誤。

DeleteToolRequest

AgentService.DeleteTool 的要求訊息。

欄位
name

string

這是必要旗標，要刪除的工具資源名稱。
force

bool

選用。指出是否要強制刪除工具，即使代理/範例仍參照該工具也一樣。

  • 如果 force = false，只要有任何代理仍參照該工具，刪除作業就會失敗。
  • 如果刪除force = true，系統會移除所有現有代理程式參照，並刪除該工具。
etag

string

選用。工具目前的 etag。如果未提供 etag，刪除作業會覆寫任何並行變更。如果提供的 etag 與工具目前的 etag 不符，系統會封鎖刪除作業，並傳回 ABORTED 錯誤。

DeleteToolsetRequest

AgentService.DeleteToolset 的要求訊息。

欄位
name

string

這是必要旗標，要刪除的工具集資源名稱。
force

bool

選用。指出是否要強制刪除工具集，即使應用程式/代理程式仍參照該工具集也一樣。

  • 如果 force = false，只要有任何代理程式仍參照工具集，刪除作業就會失敗。
  • 如果刪除 force = true，系統會移除代理程式的所有現有參照，並刪除工具集。
etag

string

選用。工具集的目前 ETag。如果未提供 etag，刪除作業會覆寫任何並行變更。如果提供的 etag 與工具組目前的 etag 不符，系統會封鎖刪除作業，並傳回 ABORTED 錯誤。

DeployChannelResponse

AgentService.DeployChannel 的回應訊息。

欄位
deployment

Deployment

建立的部署作業。

部署作業

部署作業代表應用程式不可變動且可查詢的版本，用於透過特定管道設定檔部署應用程式版本。

欄位
name

string

ID。部署作業的資源名稱。格式：projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
display_name

string

這是必要旗標，部署作業的顯示名稱。
app_version

string

選用。要部署的應用程式版本資源名稱。格式：projects/{project}/locations/{location}/apps/{app}/versions/{version} 使用 projects/{project}/locations/{location}/apps/{app}/versions/- 即可使用草稿應用程式。
channel_profile

ChannelProfile

這是必要旗標，部署作業中使用的管道設定檔。
create_time

Timestamp

僅供輸出。建立這項部署作業的時間戳記。
update_time

Timestamp

僅供輸出。上次更新這個部署作業的時間戳記。
etag

string

僅供輸出。Etag 用於確保物件在讀取 - 修改 - 寫入作業期間未變更。如果 etag 為空，更新作業會覆寫任何並行變更。
experiment_config

ExperimentConfig

選用。部署作業的實驗設定。
whatsapp_credentials

WhatsAppCredentials

選用。僅限輸入。設定 WhatsApp 管道設定檔時，需要使用臨時 WhatsApp 憑證。
instagram_credentials

InstagramCredentials

選用。僅限輸入。設定 Instagram 管道個人資料時，必須使用暫時性 Instagram 憑證。
model_settings

ModelSettings

選用。部署作業的模型設定。覆寫在應用程式/代理程式層級設定的模型設定。注意：部署層級的模型設定覆寫功能目前僅開放給允許清單中的使用者。如要啟用這個欄位，請與 CXAS 團隊聯絡。
modality

Deployment.Modality

選用。部署作業的形態。注意：部署層級的模式覆寫功能僅限許可清單中的使用者。如要啟用這個欄位，請與 CXAS 團隊聯絡。
agent_registry_deployment

AgentRegistryDeployment

選用。將這個部署項目部署至 Agent Registry 的設定。如果存在，這個部署作業就會發布至 Agent Registry。

模態

部署作業的形態。

列舉
MODALITY_UNSPECIFIED 不明模式。
MODALITY_TEXT 文字模態。
MODALITY_VOICE 語音模態。
MODALITY_VIDEO 影片模態。

EndSession

表示工作階段已終止，可能是因為順利完成 (例如使用者說「再見！」) 或提報給專員。

工作階段終止後，代理程式不會再處理任何輸入內容，且用戶端應在收到代理程式的所有剩餘回應後，半關閉並中斷連線。

欄位
metadata

Struct

選用。提供工作階段結束信號的額外資訊，例如結束工作階段的原因。

EndUserAuthConfig

用於連線呼叫的使用者驗證設定。欄位值必須是內容變數的名稱，格式為 $context.variables.<name_of_variable>。

欄位
聯集欄位 auth_config。驗證設定。auth_config 只能是下列其中一個設定：
oauth2_auth_code_config

EndUserAuthConfig.Oauth2AuthCodeConfig

OAuth 2.0 授權碼驗證。
oauth2_jwt_bearer_config

EndUserAuthConfig.Oauth2JwtBearerConfig

JWT 設定檔 OAuth 2.0 授權許可驗證。

Oauth2AuthCodeConfig

OAuth 2.0 授權碼驗證設定。

欄位
oauth_token

string

這是必要旗標，要傳遞的 OAuth 權杖參數名稱。格式必須為 $context.variables.<name_of_variable>。

Oauth2JwtBearerConfig

JWT 設定檔 OAuth 2.0 授權授予驗證設定。

欄位
issuer

string

這是必要旗標，要傳遞的核發者參數名稱。格式必須為 $context.variables.<name_of_variable>。
subject

string

這是必要旗標，要傳送的主體參數名稱。格式必須為 $context.variables.<name_of_variable>。
client_key

string

這是必要旗標，要傳遞的用戶端參數名稱。格式必須為 $context.variables.<name_of_variable>。

EndpointControlPolicy

定義專案/位置層級的端點控制政策。

欄位
enforcement_scope

EndpointControlPolicy.EnforcementScope

選用。強制執行這項政策 allowed_origins 清單的範圍。
allowed_origins[]

string

選用。應用程式中的工具可直接呼叫的允許 HTTP(s) 來源。強制執行取決於 enforcement_scope 的值和專案的 VPC-SC 狀態。如未提供通訊埠號碼，系統會允許所有通訊埠。否則通訊埠號碼必須完全相符。舉例來說，「https://example.com」會比對「https://example.com:443」和任何其他連接埠。「https://example.com:443」只會比對「https://example.com:443」。

EnforcementScope

定義這項政策允許的來源清單強制執行的範圍。

列舉
ENFORCEMENT_SCOPE_UNSPECIFIED 不明。這項政策會視為 VPCSC_ONLY。
VPCSC_ONLY 只有在 VPC-SC 處於啟用狀態時，這項政策才會生效。
ALWAYS 無論 VPC-SC 狀態為何，這項政策一律適用。

ErrorHandlingSettings

設定，用於說明應用程式中應如何處理錯誤。

欄位
error_handling_strategy

ErrorHandlingSettings.ErrorHandlingStrategy

選用。用於錯誤處理的策略。
fallback_response_config

ErrorHandlingSettings.FallbackResponseConfig

選用。用於處理備援回應的設定。
end_session_config

ErrorHandlingSettings.EndSessionConfig

選用。設定在發生系統錯誤 (例如 LLM 錯誤) 時結束工作階段。

EndSessionConfig

設定在發生系統錯誤 (例如 LLM 錯誤) 時結束工作階段。

欄位
escalate_session

bool

選用。是否要在 EndSession 中升級工作階段。如果工作階段已升級，metadata in EndSession 會包含 session_escalated = true。詳情請參閱 https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent。

ErrorHandlingStrategy

定義錯誤處理策略。

列舉
ERROR_HANDLING_STRATEGY_UNSPECIFIED 未指定錯誤處理策略。
NONE 未啟用任何特定處理方式。
FALLBACK_RESPONSE 如果發生系統錯誤 (例如 LLM 錯誤)，系統會向使用者傳回備援訊息。
END_SESSION 如果發生系統錯誤 (例如 LLM 錯誤)，系統會發出 EndSession 信號。

FallbackResponseConfig

用於處理備援回應的設定。

欄位
custom_fallback_messages

map<string, string>

選用。系統發生錯誤 (例如 LLM 錯誤) 時的備用訊息，會依支援的語言代碼對應。
max_fallback_attempts

int32

選用。代理程式發出 EndSession 信號前，最多可嘗試回溯的次數。

EvaluationMetricsThresholds

評估作業中指標的門檻設定。

欄位
golden_evaluation_metrics_thresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds

選用。黃金評估指標門檻。
hallucination_metric_behavior
(deprecated)

EvaluationMetricsThresholds.HallucinationMetricBehavior

選用。已淘汰：請改用 golden_hallucination_metric_behavior。目前黃金評估作業會使用幻覺指標行為。
golden_hallucination_metric_behavior

EvaluationMetricsThresholds.HallucinationMetricBehavior

選用。標準答案評估的錯覺指標行為。
scenario_hallucination_metric_behavior

EvaluationMetricsThresholds.HallucinationMetricBehavior

選用。情境評估的錯覺指標行為。

GoldenEvaluationMetricsThresholds

黃金評估的設定。

欄位
turn_level_metrics_thresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds

選用。回合層級指標的門檻。
expectation_level_metrics_thresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds

選用。期望等級指標門檻。
tool_matching_settings

EvaluationMetricsThresholds.ToolMatchingSettings

選用。工具比對設定。額外工具呼叫是指執行作業中出現的工具呼叫，但與黃金期望中的任何工具呼叫都不相符。

ExpectationLevelMetricsThresholds

期望等級指標門檻。

欄位
tool_invocation_parameter_correctness_threshold

float

選用。個別工具叫用參數正確性的成功門檻。必須是介於 0 到 1 之間的浮點數。預設值為 1.0。

TurnLevelMetricsThresholds

開啟層級指標門檻。

欄位
semantic_similarity_channel

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel

選用。用於評估的語意相似度管道。
semantic_similarity_success_threshold

int32

選用。語意相似度的成功門檻。必須是介於 0 到 4 之間的整數。預設值為 >= 3。
overall_tool_invocation_correctness_threshold

float

選用。整體工具叫用正確率的成功門檻。必須是介於 0 到 1 之間的浮點數。預設值為 1.0。

SemanticSimilarityChannel

要使用的語意相似度管道。

列舉
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED 未指定指標。預設值為 TEXT。
TEXT 使用文字語意相似度。
AUDIO 使用音訊語意相似度。

HallucinationMetricBehavior

幻覺指標行為。無論行為為何，系統一律會計算指標。不同之處在於，如果停用指標，系統就不會使用該指標計算整體評估分數。

列舉
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED 未指定幻覺指標行為。
DISABLED 停用錯覺指標。
ENABLED 啟用錯覺指標。

ToolMatchingSettings

比對工具呼叫的設定。

欄位
extra_tool_call_behavior

EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior

選用。額外工具呼叫的行為。預設值為 FAIL。

ExtraToolCallBehavior

定義遇到額外工具呼叫時的行為。額外工具呼叫是指執行作業中出現的工具呼叫，但與黃金期望中的任何工具呼叫都不相符。

列舉
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED 未指定行為。預設值為 FAIL。
FAIL 如果遇到額外的工具呼叫，請讓評估失敗。
ALLOW 允許額外的工具呼叫。

事件

事件輸入。

欄位
event

string

這是必要旗標，活動名稱。
variables

Struct

選用。與事件相關聯的其他變數。

範例

範例代表使用者與代理之間的對話範例。

欄位
name

string

ID。範例的專屬 ID。格式：projects/{project}/locations/{location}/apps/{app}/examples/{example}
display_name

string

這是必要旗標，範例的顯示名稱。
description

string

選用。使用者可理解的範例說明。
entry_agent

string

選用。最初處理對話的服務專員。如未指定，範例會代表由根代理程式處理的對話。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]

Message

選用。構成對話的一系列訊息。
create_time

Timestamp

僅供輸出。建立範例的時間戳記。
update_time

Timestamp

僅供輸出。範例上次更新的時間戳記。
invalid

bool

僅供輸出。如果參照資源遭到刪除，範例可能會失效。系統不會將無效範例做為少量樣本。
etag

string

Etag 用於確保物件在讀取 - 修改 - 寫入作業期間未變更。如果 etag 為空，更新作業會覆寫任何並行變更。

ExecuteToolRequest

ToolService.ExecuteTool 的要求訊息。

欄位
parent

string

這是必要旗標，工具/工具集所屬應用程式的資源名稱。格式：projects/{project}/locations/{location}/apps/{app}
args

Struct

選用。工具的輸入參數和值，格式為 JSON 物件。
mock_config

MockConfig

選用。工具執行的模擬設定。如果設定這個欄位，呼叫其他工具的工具會根據提供的模式和回應進行模擬。
聯集欄位 tool_identifier。要執行的工具 ID。可以是持續性工具，也可以是工具集中的工具。tool_identifier 只能是下列其中一個設定：
tool

string

選用。要執行的工具名稱。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

選用。要執行的工具集工具。工具集中只能有一個工具符合述詞。否則會傳回錯誤。
聯集欄位 tool_execution_context。工具執行時提供的額外脈絡資訊 tool_execution_context 只能是下列之一：
variables

Struct

選用。工具執行時可用的變數。
context

Struct

選用。要傳遞至 Python 工具的 [ToolCallContext](詳情請參閱 https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment)。

ExecuteToolResponse

ToolService.ExecuteTool 的回應訊息。

欄位
response

Struct

JSON 物件格式的工具執行結果。使用「output」鍵指定工具回應，並使用「error」鍵指定錯誤詳細資料 (如有)。如果未指定「output」和「error」鍵，系統會將整個「response」視為工具執行結果。
variables

Struct

工具執行完畢時的變數值。
citations

Citations

提供工具執行來源資訊的引文。
google_search_suggestions

GoogleSearchSuggestions

在工具執行期間呼叫 Google 搜尋工具後，Google 搜尋傳回的建議。
聯集欄位 tool_identifier。已執行的工具 ID。tool_identifier 只能是下列其中一個設定：
tool

string

執行的工具名稱。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

執行的工具集工具。

ExecutionType

工具或工具組的執行類型。

列舉
EXECUTION_TYPE_UNSPECIFIED 未指定執行類型。如未指定，預設值為 SYNCHRONOUS。
SYNCHRONOUS 這項工具會同步執行。工作階段會遭到封鎖，直到工具傳回為止。
ASYNCHRONOUS 這項工具會以非同步方式執行。工具執行期間，工作階段會繼續進行。

ExperimentConfig

實驗部署作業。

欄位
version_release

ExperimentConfig.VersionRelease

選用。實驗的發布版本。

狀態

實驗狀態。

列舉
STATE_UNSPECIFIED 未指定狀態。
PENDING 已淘汰：系統不再使用這個狀態。
RUNNING 執行狀態。實驗正在執行中，且有效。
DONE 已淘汰：系統不再使用這個狀態。
EXPIRED 已淘汰：系統不再使用這個狀態。

VersionRelease

實驗的發布版本。

欄位
state

ExperimentConfig.State

選用。版本發布狀態。
traffic_allocations[]

ExperimentConfig.VersionRelease.TrafficAllocation

選用。版本發布的流量分配。

TrafficAllocation

版本發布的流量分配。

欄位
id

string

選用。流量分配的 ID。自由格式字串，最多 128 個半形字元。
traffic_percentage

int32

選用。流量分配的流量百分比。必須介於 0 至 100 之間。
app_version

string

選用。流量分配的應用程式版本。格式：projects/{project}/locations/{location}/apps/{app}/versions/{version}

ExportAppRequest

AgentService.ExportApp 的要求訊息。

欄位
name

string

這是必要旗標，要匯出應用程式的資源名稱。
export_format

ExportAppRequest.ExportFormat

這是必要旗標，匯出應用程式的格式。
gcs_uri

string

選用。要匯出應用程式的 Google Cloud Storage URI。這個 URI 的格式必須為 gs://<bucket-name>/<object-name>。匯出的應用程式封存檔會直接寫入指定的 GCS 物件。
app_version

string

選用。要匯出應用程式版本的資源名稱。格式：projects/{project}/locations/{location}/apps/{app}/versions/{version}。

ExportFormat

應用程式的匯出格式。

列舉
EXPORT_FORMAT_UNSPECIFIED 未指定匯出格式。
JSON 匯出格式為 JSON。
YAML 匯出格式為 YAML。

ExportAppResponse

AgentService.ExportApp 的回應訊息。

欄位
聯集欄位 app。匯出的應用程式。app 只能是下列之一：
app_content

bytes

應用程式資料夾壓縮為 ZIP 檔案。
app_uri

string

應用程式匯出至的 Google Cloud Storage URI。

ExpressionCondition

根據工作階段狀態的運算式條件。

欄位
expression

string

這是必要旗標，cloud.api.Expression 條件的字串表示法。

FileSearchTool

檔案搜尋工具可讓代理程式搜尋應用程式/代理程式開發人員上傳的檔案。這項功能提供預設設定，可對上傳的檔案進行相對優質的搜尋，並摘要擷取的結果。

欄位
corpus_type

FileSearchTool.CorpusType

選用。語料庫類型。預設值為 FULLY_MANAGED。
name

string

這是必要旗標，工具名稱。
description

string

選用。工具說明。
file_corpus

string

選用。檔案儲存的語料庫。格式：projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

CorpusType

Vertex RAG 語料庫的類型。

列舉
CORPUS_TYPE_UNSPECIFIED 未指定語料庫類型。
USER_OWNED 語料庫是由使用者建立及擁有。
FULLY_MANAGED 代理程式會建立語料庫。

GenerateChatTokenRequest

WidgetService.GenerateChatToken 的要求訊息。

欄位
name

string

這是必要旗標，要產生對話權杖的工作階段名稱。格式：projects/{project}/locations/{location}/apps/{app}/sessions/{session}
deployment

string

這是必要旗標，工作階段要使用的應用程式部署作業。格式：projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptcha_token

string

選用。用戶端即時通訊小工具產生的 reCAPTCHA 權杖。
live_handoff_enabled

bool

選用。指出工作階段是否已啟用即時轉接功能。

GenerateChatTokenResponse

WidgetService.GenerateChatToken 的回應訊息。

欄位
chat_token

string

聊天小工具的工作階段範圍權杖，用於向 Session API 驗證。
expire_time

Timestamp

聊天權杖的到期時間。

GetAgentRequest

AgentService.GetAgent 的要求訊息。

欄位
name

string

這是必要旗標，要擷取的代理程式資源名稱。

GetAppRequest

AgentService.GetApp 的要求訊息。

欄位
name

string

這是必要旗標，要擷取的應用程式資源名稱。

GetAppVersionRequest

AgentService.GetAppVersion 的要求訊息。

欄位
name

string

這是必要旗標，要擷取的應用程式版本資源名稱。

GetChangelogRequest

AgentService.GetChangelog 的要求訊息。

欄位
name

string

這是必要旗標，要擷取的變更記錄資源名稱。

GetConversationRequest

AgentService.GetConversation 的要求訊息。

欄位
name

string

這是必要旗標，要擷取的對話資源名稱。
source
(deprecated)

Conversation.Source

選用。指出對話來源。如未設定，系統會搜尋所有來源。

GetDeploymentRequest

AgentService.GetDeployment 的要求訊息。

欄位
name

string

這是必要旗標，部署作業的名稱。格式：projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

GetExampleRequest

AgentService.GetExample 的要求訊息。

欄位
name

string

這是必要旗標，要擷取範例的資源名稱。

GetGuardrailRequest

AgentService.GetGuardrail 的要求訊息。

欄位
name

string

這是必要旗標，要擷取防護措施的資源名稱。

GetToolRequest

AgentService.GetTool 的要求訊息。

欄位
name

string

這是必要旗標，要擷取的工具資源名稱。

GetToolsetRequest

AgentService.GetToolset 的要求訊息。

欄位
name

string

這是必要旗標，要擷取的工具集資源名稱。

GoAway

這個類型沒有任何欄位。

表示伺服器即將中斷連線，用戶端應半關閉並重新啟動連線。

GoogleSearchSuggestions

Google Search Tool提供的搜尋建議。

欄位
htmls[]

string

符合規定的搜尋建議 HTML 和 CSS 樣式。系統會根據裝置設定自動調整提供的 HTML 和 CSS，並以 @media(prefers-color-scheme) 指示的淺色或深色模式顯示。
web_search_queries[]

WebSearchQuery

用於執行 Google 搜尋的查詢清單，以及構成搜尋建議的搜尋結果 URI。

GoogleSearchTool

代表執行 Google 網頁搜尋以進行基礎搜尋的工具。請參閱 https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search。

欄位
name

string

這是必要旗標，工具名稱。
description

string

選用。工具用途說明。
context_urls[]

string

選用。系統會直接從這些網址擷取內容，做為背景資訊和基準。例如：「https://example.com/path.html」。最多只能有 20 個網址。
preferred_domains[]

string

選用。指定要限制搜尋結果的網域。例如：「example.com」、「another.site」。最多可以指定 20 個網域。
exclude_domains[]

string

選用。要從搜尋結果中排除的網域清單。例如：「example.com」。最多可排除 2000 個網域。
prompt_config

GoogleSearchTool.PromptConfig

選用。傳遞給規劃工具的提示指令，說明如何處理文字和語音的搜尋結果。

PromptConfig

模型在處理或摘要 Google 搜尋結果時使用的提示設定。

欄位
text_prompt

string

選用。定義在對話中與代理互動時，用於系統指令的提示詞。如未設定，系統會使用預設提示。
voice_prompt

string

選用。定義在語音對話中與代理互動時，用於系統指令的提示。如未設定，系統會使用預設提示。

護欄

防護機制包含一系列檢查和平衡措施，可確保代理安全無虞。

欄位
name

string

ID。防護措施的專屬 ID。格式：projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
display_name

string

這是必要旗標，防護措施的顯示名稱。
description

string

選用。防護措施說明。
enabled

bool

選用。是否啟用防護措施。
action

TriggerAction

選用。防護機制觸發時要採取的動作。
create_time

Timestamp

僅供輸出。建立防護措施的時間戳記。
update_time

Timestamp

僅供輸出。上次更新防護措施的時間戳記。
etag

string

Etag 用於確保物件在讀取 - 修改 - 寫入作業期間未變更。如果 etag 為空，更新作業會覆寫任何並行變更。
聯集欄位 guardrail_type。防護機制類型。guardrail_type 只能是下列其中一個設定：
content_filter

Guardrail.ContentFilter

選用。禁止在對話中使用特定內容的防護措施。
llm_prompt_security

Guardrail.LlmPromptSecurity

選用。如果系統根據 LLM 分類判斷提示詞不安全，就會封鎖對話。
llm_policy

Guardrail.LlmPolicy

選用。如果 LLM 根據分類結果判斷回覆內容違反政策，就會啟動安全防護機制，封鎖對話。
model_safety

Guardrail.ModelSafety

選用。如果根據模型安全設定，LLM 回覆內容不安全，就會封鎖對話。
code_callback

Guardrail.CodeCallback

選用。根據回呼執行結果，可能封鎖對話的防護措施。
supervisor

Guardrail.Supervisor

選用。執行主管介入的防護機制。

CodeCallback

根據提供的程式碼回呼封鎖對話的防護措施。

欄位
before_agent_callback

Callback

選用。在呼叫代理程式前執行的回呼。每個回呼函式都應傳回至少包含下列項目的結構 (例如字典或物件)：-「decision」：可以是「OK」或「TRIGGER」。-「reason」：說明決定的字串。「觸發」決定可能會停止後續處理程序。
after_agent_callback

Callback

選用。呼叫代理程式後要執行的回呼。每個回呼函式都應傳回至少包含下列項目的結構 (例如字典或物件)：-「decision」：可以是「OK」或「TRIGGER」。-「reason」：說明決定的字串。「觸發」決定可能會停止後續處理程序。
before_model_callback

Callback

選用。在呼叫模型前執行的回呼。如果多次呼叫模型，回呼就會執行多次。每個回呼函式都應傳回至少包含下列項目的結構 (例如字典或物件)：-「decision」：可以是「OK」或「TRIGGER」。-「reason」：說明決定的字串。「觸發」決定可能會停止後續處理程序。
after_model_callback

Callback

選用。呼叫模型後要執行的回呼。如果多次呼叫模型，回呼就會執行多次。每個回呼函式都應傳回至少包含下列項目的結構 (例如字典或物件)：-「decision」：可以是「OK」或「TRIGGER」。-「reason」：說明決定的字串。「觸發」決定可能會停止後續處理程序。

ContentFilter

禁止在對話中使用特定內容的防護措施。

欄位
banned_contents[]

string

選用。禁用詞組清單。適用於使用者輸入內容和代理回覆。
banned_contents_in_user_input[]

string

選用。禁用詞組清單。僅適用於使用者輸入內容。
banned_contents_in_agent_response[]

string

選用。禁用詞組清單。僅適用於代理程式回覆。
match_type

Guardrail.ContentFilter.MatchType

這是必要旗標，內容篩選器的比對類型。
disregard_diacritics

bool

選用。如果是 true，比對時會忽略變音符號。

MatchType

內容篩選器的比對類型。

列舉
MATCH_TYPE_UNSPECIFIED 未指定比對類型。
SIMPLE_STRING_MATCH 系統會逐一比對子字串中的字元。
WORD_BOUNDARY_STRING_MATCH 只有在文字中找到的模式前後有字詞分隔符時，內容才會相符。遭禁用的詞組也可以包含字詞分隔符。
REGEXP_MATCH 系統會使用規則運算式語法比對內容。

LlmPolicy

如果 LLM 根據分類結果判斷回覆內容違反政策，就會啟動安全防護機制，封鎖對話。

欄位
max_conversation_messages

int32

選用。檢查這項政策時，請考量對話中的最後「n」則訊息。如未設定，系統會使用預設值 10。
model_settings

ModelSettings

選用。模型設定。
prompt

string

這是必要旗標，政策提示。
policy_scope

Guardrail.LlmPolicy.PolicyScope

這是必要旗標，定義在對話期間套用政策檢查的時機。如果設為「POLICY_SCOPE_UNSPECIFIED」，系統會將政策套用至使用者輸入內容。將政策套用至代理程式回覆時，代理程式回覆前會出現額外延遲。
fail_open

bool

選用。如果在政策檢查期間發生錯誤，請採取「失敗開放」做法，不要觸發防護機制。
allow_short_utterance

bool

選用。根據預設，系統會略過簡短語音的 LLM 政策檢查。啟用這項設定後，系統會對所有語音輸入內容 (包括通常會略過的內容) 進行政策檢查。

PolicyScope

定義在對話期間套用政策檢查的時機。

列舉
POLICY_SCOPE_UNSPECIFIED 未指定政策範圍。
USER_QUERY 系統會在使用者輸入內容時觸發政策檢查。
AGENT_RESPONSE 系統會在服務專員回覆時觸發政策檢查。套用這項政策範圍後，代理程式的回覆時間會進一步延遲。
USER_QUERY_AND_AGENT_RESPONSE 系統會在使用者輸入內容和代理回覆時觸發政策檢查。套用這項政策範圍後，代理程式的回覆時間會進一步延遲。

LlmPromptSecurity

如果輸入內容經 LLM 分類後判定為不安全，這項防護措施就會封鎖對話。

欄位
fail_open

bool

選用。決定防護機制遇到 LLM 錯誤時的行為。- 如果為 true：系統會略過防護措施。- 如果為 false (預設值)：觸發/封鎖防護措施。

注意：如果提供自訂政策，系統會忽略這個欄位，改用政策的「fail_open」設定。
聯集欄位 security_config。定義安全性設定模式。使用者必須選擇下列其中一種設定。security_config 只能是下列其中一個設定：
default_settings

Guardrail.LlmPromptSecurity.DefaultSecuritySettings

選用。使用系統預先定義的預設安全性設定。如要選取這個模式，請在要求中加入空白的「default_settings」訊息。其中的「default_prompt_template」欄位會由伺服器在回應中填入。
custom_policy

Guardrail.LlmPolicy

選用。使用使用者定義的 LlmPolicy 設定安全防護機制。

DefaultSecuritySettings

預設系統安全設定的設定。

欄位
default_prompt_template

string

僅供輸出。系統使用的預設提示詞範本。這個欄位僅供顯示，向使用者說明系統預設使用的提示。這是 OUTPUT_ONLY。

ModelSafety

模型安全設定覆寫。設定後，系統會覆寫預設設定，並在回應內容不安全時觸發安全防護措施。

欄位
safety_settings[]

Guardrail.ModelSafety.SafetySetting

這是必要旗標，安全性設定清單。

HarmBlockThreshold

封鎖的機率門檻等級。

列舉
HARM_BLOCK_THRESHOLD_UNSPECIFIED 未指定危害封鎖門檻。
BLOCK_LOW_AND_ABOVE 封鎖低門檻以上的內容 (即封鎖更多內容)。
BLOCK_MEDIUM_AND_ABOVE 封鎖有害機率中等以上的內容。
BLOCK_ONLY_HIGH 僅封鎖有害機率高的內容 (即減少封鎖)。
BLOCK_NONE 不封鎖任何內容。
OFF 關閉安全篩選器。

HarmCategory

危害類別。

列舉
HARM_CATEGORY_UNSPECIFIED 未指定危害類別。
HARM_CATEGORY_HATE_SPEECH 有害類別為仇恨言論。
HARM_CATEGORY_DANGEROUS_CONTENT 危害類別為危險內容。
HARM_CATEGORY_HARASSMENT 傷害類別為騷擾。
HARM_CATEGORY_SEXUALLY_EXPLICIT 危害類別為情色露骨內容。
HARM_CATEGORY_PROFANITY 有害類別為不雅用語。
HARM_CATEGORY_TOXIC 有害類別為惡意內容。

SafetySetting

安全性設定。

欄位
category

Guardrail.ModelSafety.HarmCategory

這是必要旗標，有害類別。
threshold

Guardrail.ModelSafety.HarmBlockThreshold

這是必要旗標，有害內容封鎖門檻。

主管

執行主管介入的防護機制。

欄位
type

Guardrail.Supervisor.Type

選用。監督員類型。
detection_mode

Guardrail.Supervisor.DetectionMode

選用。監督員的偵測模式。

DetectionMode

監督員的偵測模式。

列舉
DETECTION_MODE_UNSPECIFIED 未指定偵測模式。預設值為 NON_BLOCKING。
NON_BLOCKING 非封鎖偵測模式。進行主管偵測時，系統不會封鎖回覆。
BLOCKING 阻擋偵測模式。如果系統正在偵測主管，就會封鎖回應。

類型

主管類型。

列舉
TYPE_UNSPECIFIED 未指定類型。
INVALID_TEXT 文字問題類型無效。
LANGUAGE_SHIFT 語言轉換問題類型。
SPEAKER_SHIFT 講者轉移問題類型。
AUDIO_MISMATCH 音訊不符問題類型。
MISSING_TOOL_CALL 缺少工具呼叫問題類型。
CUSTOM 自訂問題類型。
CHOPPY_AUDIO 聲音斷斷續續問題類型。
PROFANITY 代理商不雅用語問題類型。

圖片

代表對話中的圖片輸入或輸出內容。

欄位
mime_type

string

這是必要旗標，來源資料的 IANA 標準 MIME 類型。支援的圖片類型包括： * image/png * image/jpeg * image/webp
data

bytes

這是必要旗標，圖片的原始位元組。
alt_text

string

選用。圖片的替代文字。

ImportAppRequest

AgentService.ImportApp 的要求訊息。

欄位
parent

string

這是必要旗標，要匯入應用程式的位置的上層資源名稱。
display_name

string

選用。要匯入的應用程式顯示名稱。* 如果應用程式是在匯入時建立，且已指定顯示名稱，匯入的應用程式就會使用這個顯示名稱。如果系統偵測到與現有應用程式發生衝突，會在顯示名稱後方加上時間戳記，確保名稱不重複。* 如果應用程式是重新匯入，則不應設定這個欄位。在重新匯入期間提供顯示名稱會導致 INVALID_ARGUMENT 錯誤。
app_id

string

選用。要用於匯入應用程式的 ID。* 如未指定，系統會自動為應用程式指派專屬 ID。* 否則，匯入的應用程式會將這個 ID 做為資源名稱的最後一個元件。如果專案中指定位置已有相同 ID 的應用程式，系統會替換現有應用程式的內容。
import_options

ImportAppRequest.ImportOptions

選用。控管應用程式匯入程序的選項。
ignore_app_lock

bool

選用。匯入期間，用於覆寫應用程式鎖定的旗標。如果設為 true，匯入程序會忽略應用程式鎖定。
聯集欄位 app。要匯入的應用程式。app 只能是下列其中一個設定：
gcs_uri

string

要匯入應用程式的 Google Cloud Storage URI。這個 URI 的格式必須為 gs://<bucket-name>/<object-name>。
app_content

bytes

代表壓縮 ZIP 檔案的原始位元組，其中包含應用程式資料夾結構。
聯集欄位 json_patch。要套用至匯入應用程式的 JSON 修補程式。json_patch 只能是下列之一：
json_patch_content

string

選用。以 JSON 字串形式修補內容。
json_patch_gcs_uri

string

選用。指向含有修補程式的 JSON 檔案的 Cloud Storage URI。

ImportOptions

應用程式匯入程序的設定選項。這些選項可控管匯入作業的行為，尤其是在與現有應用程式資料發生衝突時。

欄位
conflict_resolution_strategy

ImportAppRequest.ImportOptions.ConflictResolutionStrategy

選用。匯入時解決衝突的策略。
validate_only

bool

選用。用於模擬執行匯入程序的旗標。如果設為 true，匯入程序只會執行驗證，不會對現有應用程式進行任何變更，也不會建立新應用程式。

ConflictResolutionStrategy

定義處理衝突的策略，例如應用程式 ID 相同，或匯入的資源 (例如代理程式、工具等) 與應用程式中的現有資源顯示名稱相同。

列舉
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED 未指定衝突解決策略。
REPLACE 以匯入的資料取代現有資料。如果已有app_id名稱相同的應用程式，系統會根據匯入的應用程式更新內容。- 匯入應用程式中與現有資源顯示名稱相同的資源 (應用程式、代理程式、工具、範例、防護措施、工具集)，會覆寫現有資源。- 系統會建立具有新顯示名稱的匯入資源。- 如果匯入的應用程式中沒有相符的顯示名稱，現有資源將維持不變。
OVERWRITE 以匯入的資料覆寫現有資料。如果已有app_id名稱相同的應用程式，系統會以匯入的應用程式覆寫其內容。- 應用程式中的現有資源 (代理程式、工具、範例、防護措施、工具集) 將會遭到刪除。- 匯入的資源會建立為新資源。

ImportAppResponse

AgentService.ImportApp 的回應訊息。

欄位
name

string

匯入應用程式的資源名稱。
warnings[]

string

匯入程序期間產生的警告訊息。如果特定資源發生錯誤，系統不會將這些資源納入匯入的應用程式，並在此處提及錯誤。

InputAudioConfig

InputAudioConfig 會設定 CES 代理程式應如何解讀傳入的音訊資料。

欄位
audio_encoding

AudioEncoding

這是必要旗標，輸入音訊資料的編碼。
sample_rate_hertz

int32

這是必要旗標，輸入音訊資料的取樣率 (以赫茲為單位)。
noise_suppression_level

string

選用。是否要對輸入音訊啟用雜訊抑制功能。可用值為「low」、「moderate」、「high」、「very_high」。

InstagramCredentials

用於 Instagram 原生整合的暫時性 Meta 憑證。

欄位
auth_code

string

這是必要旗標，內嵌註冊流程提供的 Meta 授權碼。
conversation_profile_id

string

選用。部署作業要使用的對話設定檔 ID。

InterruptionSignal

表示服務專員的語音回覆已中斷。用戶端應立即停止任何目前的音訊播放作業 (例如，由於使用者插話或產生新的服務專員回覆)。

欄位
barge_in

bool

中斷是否是由使用者插話事件所致。

LanguageSettings

應用程式的語言設定。

欄位
default_language_code

string

選用。應用程式的預設語言代碼。
supported_language_codes[]

string

選用。應用程式支援的語言代碼清單 (不含 default_language_code)。
enable_multilingual_support

bool

選用。啟用多語言支援。如果設為 true，應用程式中的代理程式會使用預先建構的指令，提升處理多語言輸入內容的效率。
fallback_action
(deprecated)

string

選用。已淘汰：系統不再支援這項功能。請改用 enable_multilingual_support，提升多語言輸入的處理效果。當服務專員收到不支援的語言輸入內容時，應執行的動作。

可以是預先定義的動作或自訂工具呼叫。有效值包括：- 工具的完整資源名稱，可觸發特定工具執行作業。- 預先定義的系統動作，例如「升級」或「結束」，這會觸發含有相應 metadata 的 EndSession 信號，以終止對話。

ListAgentsRequest

AgentService.ListAgents 的要求訊息。

欄位
parent

string

這是必要旗標，要列出代理程式的應用程式資源名稱。
page_size

int32

選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定，伺服器會選取適當的預設值。
page_token

string

選用。先前清單 AgentService.ListAgents 呼叫傳回的 next_page_token 值。
filter

string

選用。列出代理時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。
order_by

string

選用。要排序的欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。

ListAgentsResponse

AgentService.ListAgents 的回應訊息。

欄位
agents[]

Agent

代理程式清單。
next_page_token

string

可做為 ListAgentsRequest.page_token 傳送的權杖，用於擷取後續網頁。如果沒有這個欄位，表示沒有後續頁面。

ListAppVersionsRequest

AgentService.ListAppVersions 的要求訊息。

欄位
parent

string

這是必要旗標，要列出應用程式版本的應用程式資源名稱。
page_size

int32

選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定，伺服器會選取適當的預設值。
page_token

string

選用。先前清單 AgentService.ListAppVersions 呼叫傳回的 next_page_token 值。
filter

string

選用。列出應用程式版本時要套用的篩選條件。詳情請參閱 https://google.aip.dev/160。
order_by

string

選用。要排序的欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。

ListAppVersionsResponse

AgentService.ListAppVersions 的回應訊息。

欄位
app_versions[]

AppVersion

應用程式版本清單。
next_page_token

string

可做為 ListAppVersionsRequest.page_token 傳送的權杖，用於擷取後續網頁。如果沒有這個欄位，表示沒有後續頁面。

ListAppsRequest

AgentService.ListApps 的要求訊息。

欄位
parent

string

這是必要旗標，要列出應用程式的位置資源名稱。
page_size

int32

選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定，伺服器會選取適當的預設值。
page_token

string

選用。先前清單 AgentService.ListApps 呼叫傳回的 next_page_token 值。
filter

string

選用。列出應用程式時要套用的篩選條件。詳情請參閱 https://google.aip.dev/160。
order_by

string

選用。要排序的欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。

ListAppsResponse

AgentService.ListApps 的回應訊息。

欄位
apps[]

App

應用程式清單。
next_page_token

string

可做為 ListAppsRequest.page_token 傳送的權杖，用於擷取後續網頁。如果沒有這個欄位，表示沒有後續頁面。
unreachable[]

string

未排序的清單。無法連線的位置。

ListChangelogsRequest

AgentService.ListChangelogs 的要求訊息。

欄位
parent

string

這是必要旗標，要列出變更記錄的應用程式資源名稱。
page_size

int32

選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定，伺服器會選取適當的預設值。
page_token

string

選用。先前清單 AgentService.ListChangelogs 呼叫傳回的 next_page_token 值。
filter

string

選用。列出變更記錄時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。

篩選器字串可用於依 action、resource_type、resource_name、author 和 create_time 篩選。: 比較子可用於字串欄位的不區分大小寫部分比對，而 = 則會執行區分大小寫的完全比對。

例如：* action:update (不區分大小寫的部分相符) * action="Create" (區分大小寫的完全相符) * resource_type:agent * resource_name:my-agent * author:me@example.com * create_time > "2025-01-01T00:00:00Z" * create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool
order_by

string

選用。要排序的欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。

ListChangelogsResponse

AgentService.ListChangelogs 的回應訊息。

欄位
changelogs[]

Changelog

變更記錄清單。
next_page_token

string

可做為 ListChangelogsRequest.page_token 傳送的權杖，用於擷取後續網頁。如果沒有這個欄位，表示沒有後續頁面。

ListConversationsRequest

AgentService.ListConversations 的要求訊息。

欄位
parent

string

這是必要旗標，要列出對話的應用程式資源名稱。
page_size

int32

選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定，伺服器會選取適當的預設值。
page_token

string

選用。先前清單 AgentService.ListConversations 呼叫傳回的 next_page_token 值。
filter

string

選用。列出對話時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。
source

Conversation.Source

選用。指出對話來源。如未設定，系統預設會套用 Source.Live。將淘汰，改用 sources 欄位。
sources[]

Conversation.Source

選用。指出對話的來源。如未設定，系統預設會套用所有可用來源。

ListConversationsResponse

AgentService.ListConversations 的回應訊息。

欄位
conversations[]

Conversation

對話清單。
next_page_token

string

可做為 ListConversationsRequest.page_token 傳送的權杖，用於擷取後續網頁。如果沒有這個欄位，表示沒有後續頁面。

ListDeploymentsRequest

AgentService.ListDeployments 的要求訊息。

欄位
parent

string

這是必要旗標，上層應用程式。格式：projects/{project}/locations/{location}/apps/{app}
page_size

int32

選用。要傳回的部署作業數量上限。服務傳回的產品數量可能會少於這個值。如未指定，最多將傳回 50 個部署作業。許可的最大值為 1000；超出的數值將一律指定為 1000。
page_token

string

選用。屬於接收自前一個 ListDeployments 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至 ListDeployments 的所有其他參數須與提供網頁權杖的呼叫相符。
order_by

string

選用。要排序的欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。

ListDeploymentsResponse

AgentService.ListDeployments 的回應訊息。

欄位
deployments[]

Deployment

部署作業清單。
next_page_token

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListExamplesRequest

AgentService.ListExamples 的要求訊息。

欄位
parent

string

這是必要旗標，要列出範例的應用程式資源名稱。
page_size

int32

選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定，伺服器會選取適當的預設值。
page_token

string

選用。先前清單 AgentService.ListExamples 呼叫傳回的 next_page_token 值。
filter

string

選用。列出範例時要套用的篩選條件。詳情請參閱 https://google.aip.dev/160。
order_by

string

選用。要排序的欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。

ListExamplesResponse

AgentService.ListExamples 的回應訊息。

欄位
examples[]

Example

範例清單。
next_page_token

string

可做為 ListExamplesRequest.page_token 傳送的權杖，用於擷取後續網頁。如果沒有這個欄位，表示沒有後續頁面。

ListGuardrailsRequest

AgentService.ListGuardrails 的要求訊息。

欄位
parent

string

這是必要旗標，要列出防護措施的應用程式資源名稱。
page_size

int32

選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定，伺服器會選取適當的預設值。
page_token

string

選用。先前清單 AgentService.ListGuardrails 呼叫傳回的 next_page_token 值。
filter

string

選用。列出防護措施時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。
order_by

string

選用。要排序的欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。

ListGuardrailsResponse

AgentService.ListGuardrails 的回應訊息。

欄位
guardrails[]

Guardrail

防護機制清單。
next_page_token

string

可做為 ListGuardrailsRequest.page_token 傳送的權杖，用於擷取後續網頁。如果沒有這個欄位，表示沒有後續頁面。

ListToolsRequest

AgentService.ListTools 的要求訊息。

欄位
parent

string

這是必要旗標，要列出工具的應用程式資源名稱。
page_size

int32

選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定，伺服器會選取適當的預設值。
page_token

string

選用。先前清單 AgentService.ListTools 呼叫傳回的 next_page_token 值。
filter

string

選用。列出工具時要套用的篩選條件。使用「include_system_tools=true」在回覆中納入系統工具。詳情請參閱 https://google.aip.dev/160。
order_by

string

選用。要排序的欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。

ListToolsResponse

AgentService.ListTools 的回應訊息。

欄位
tools[]

Tool

工具清單。
next_page_token

string

可做為 ListToolsRequest.page_token 傳送的權杖，用於擷取後續網頁。如果沒有這個欄位，表示沒有後續頁面。

ListToolsetsRequest

AgentService.ListToolsets 的要求訊息。

欄位
parent

string

這是必要旗標，要列出工具集的應用程式資源名稱。
page_size

int32

選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定，伺服器會選取適當的預設值。
page_token

string

選用。先前清單 AgentService.ListToolsets 呼叫傳回的 next_page_token 值。
filter

string

選用。列出工具集時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。
order_by

string

選用。要排序的欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。

ListToolsetsResponse

AgentService.ListToolsets 的回應訊息。

欄位
toolsets[]

Toolset

工具集清單。
next_page_token

string

可做為 ListToolsetsRequest.page_token 傳送的權杖，用於擷取後續網頁。如果沒有這個欄位，表示沒有後續頁面。

LoggingSettings

用於說明應用程式記錄行為的設定。

欄位
redaction_config

RedactionConfig

選用。如何遮蓋機密資料的設定。
audio_recording_config

AudioRecordingConfig

選用。設定如何錄製語音互動。音訊會根據 RedactionConfig 中的設定進行編輯。
unredacted_audio_recording_config

AudioRecordingConfig

選用。設定額外錄製未經過編輯的音訊。這項功能可用於在音訊編輯enabled時保留原始音訊副本，通常是為了稽核或監控。
bigquery_export_settings

BigQueryExportSettings

選用。設定應用程式的 BigQuery 匯出行為。對話資料會根據 RedactionConfig 中的設定進行編輯。
unredacted_bigquery_export_settings

BigQueryExportSettings

選用。設定應用程式的 BigQuery 匯出行為。如果啟用這項功能，系統會將未經過編輯的對話資料匯出至 BigQuery 資料表。
cloud_logging_settings

CloudLoggingSettings

選用。用於說明應用程式 Cloud Logging 行為的設定。
conversation_logging_settings

ConversationLoggingSettings

選用。設定，用於說明應用程式的對話記錄行為。
evaluation_audio_recording_config

AudioRecordingConfig

選用。設定如何記錄音訊互動以供評估。根據預設，評估工作階段不會啟用音訊錄音功能。
metric_analysis_settings

MetricAnalysisSettings

選用。設定，用於說明應用程式的 LLM 分析管道對話資料收集行為。

McpTool

MCP 工具。詳情請參閱 https://modelcontextprotocol.io/specification/2025-06-18/server/tools。

欄位
name

string

這是必要旗標，MCP 工具的名稱。
name_override

string

選用。MCP 工具的名稱覆寫。如果名稱遭工具集覆寫，系統就會填入這個欄位。
description

string

選用。MCP 工具的說明。
input_schema

Schema

選用。MCP 工具輸入引數的結構定義。
output_schema

Schema

選用。MCP 工具輸出引數的結構定義。
server_address

string

這是必要旗標，MCP 伺服器的伺服器位址，例如「https://example.com/mcp/」。如果伺服器是使用 MCP SDK 建構，網址應加上「/mcp/」後置字串。僅支援以可串流 HTTP 傳輸為基礎的伺服器。這與 McpToolset 中的 server_address 相同。詳情請參閱 https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http。
api_authentication

ApiAuthentication

選用。執行工具時，必須提供 MCP 伺服器的驗證資訊。如果是持有人權杖驗證，權杖僅適用於工具執行，不適用於列出工具。這表示工具必須未經授權即可列出。
tls_config

TlsConfig

選用。TLS 設定。包含用戶端應信任的自訂伺服器憑證。
service_directory_config

ServiceDirectoryConfig

選用。VPC-SC 的 Service Directory 設定，用於解析範圍內的服務名稱。
custom_headers

map<string, string>

選用。要透過要求傳送至 MCP 伺服器的自訂標頭。值必須採用 $context.variables.<name_of_variable> 格式，且可在工作階段變數中設定。詳情請參閱 https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection。
state

McpTool.State

僅供輸出。外部伺服器上工具的動態可用性狀態。

狀態

代表工具的動態可用性狀態。

列舉
STATE_UNSPECIFIED 預設狀態。
ACTIVE 工具可供使用，且伺服器主動提供。
INACTIVE 工具已設定或釘選，但伺服器目前未提供。
STALE 伺服器上已有這項工具，但版本不符。

McpToolDefinition

工具核心定義元素的容器，可做為快照。快照中的結構定義會照常使用，無法覆寫。

欄位
description

string

僅供輸出。MCP 工具的說明。這項設定可由 McpToolOverride 中的 description_override 覆寫。
input_schema

Schema

僅供輸出。MCP 工具輸入引數的結構定義。
output_schema

Schema

僅供輸出。MCP 工具輸出引數的結構定義。

McpToolOverride

與工具集中的特定工具相關聯的覆寫。這項功能可「釘選」或「覆寫」外部動態伺服器的工具定義。

欄位
tool

string

這是必要旗標，MCP 伺服器發出的工具原始名稱。
name_override

string

選用。如果存在，這個工具會在代理程式中使用這個名稱，而非原始名稱。如果 MCP 伺服器提供的工具名稱不佳，這項功能主要會做為別名使用。
description_override

string

選用。如果有的話，這項工具會使用這項說明，而非伺服器提供的原始說明。
snapshot

McpToolDefinition

僅供輸出。如果這個工具存在，就會「固定」，並在伺服器暫時無法使用或沒有覆寫時，使用快照值做為備用值。

McpToolset

工具集，內含 MCP 伺服器提供的工具清單。

欄位
server_address

string

這是必要旗標，MCP 伺服器的位址，例如「https://example.com/mcp/」。如果伺服器是使用 MCP SDK 建構，網址應加上「/mcp/」後置字串。僅支援以可串流 HTTP 傳輸為基礎的伺服器。詳情請參閱 https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http。
api_authentication

ApiAuthentication

選用。存取工具及針對 MCP 伺服器執行工具時，必須提供驗證資訊。如果是持有人權杖驗證，權杖僅適用於工具執行，不適用於列出工具。這表示工具必須未經授權即可列出。
service_directory_config

ServiceDirectoryConfig

選用。VPC-SC 的 Service Directory 設定，用於解析範圍內的服務名稱。
tls_config

TlsConfig

選用。TLS 設定。包含用戶端應信任的自訂伺服器憑證。
custom_headers

map<string, string>

選用。要透過要求傳送至 MCP 伺服器的自訂標頭。值必須採用 $context.variables.<name_of_variable> 格式，且可在工作階段變數中設定。詳情請參閱 https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection。
tool_overrides[]

McpToolOverride

選用。這個工具組中個別工具的覆寫。這樣就能覆寫特定詳細資料 (例如說明、名稱)，或固定工具的狀態，避免工具完全動態。

訊息

對話中的訊息。

欄位
role

string

選用。對話中的角色，例如使用者、代理。
chunks[]

Chunk

選用。訊息內容，以一系列區塊表示。
event_time

Timestamp

選用。傳送或接收訊息時的時間戳記。如果訊息屬於 example，則不應使用。

MetricAnalysisSettings

設定，用於說明 LLM 分析指標管道的對話資料收集行為。

欄位
llm_metrics_opted_out

bool

選用。是否要收集對話資料，以取得 LLM 分析指標。如果為 true，系統就不會收集對話資料，用於 LLM 分析指標；否則系統會收集對話資料。

MockConfig

工作階段的模擬工具呼叫設定。

欄位
mocked_tool_calls[]

MockedToolCall

選用。在工作階段期間模擬的所有工具呼叫。
unmatched_tool_call_behavior

MockConfig.UnmatchedToolCallBehavior

這是必要旗標，工具呼叫的行為，與 mocked_tool_calls 中任何引數模式都不相符。

UnmatchedToolCallBehavior

如果工具呼叫與任何模擬工具呼叫都不相符，該怎麼辦？

列舉
UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED 預設值。這個值不會使用。
FAIL 針對不符合模擬預期輸入模式的任何工具呼叫擲回錯誤。
PASS_THROUGH 如果工具呼叫不相符，請將工具呼叫傳遞至實際工具。

MockedToolCall

模擬工具呼叫。

表示目標工具 + 用於比對該工具引數 / 輸入內容的模式。如果模式相符，系統就會傳回模擬回應。

欄位
tool
(deprecated)

string

選用。已淘汰，請改用 tool_identifier。
expected_args_pattern

Struct

這是必要旗標，用來比對所有已調度工具呼叫的 args / inputs。如果工具呼叫輸入內容符合這個模式，系統就會傳回模擬輸出內容。
mock_response

Struct

選用。如果工具呼叫引數 / 輸入內容符合模式，要傳回的模擬回應 / 輸出內容。
聯集欄位 tool_identifier。要模擬的工具 ID。tool_identifier 只能是下列其中一個設定：
tool_id

string

選用。要模擬的工具名稱。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset

ToolsetTool

選用。要模擬的工具集。

ModelSettings

模型設定包含 LLM 模型的各種設定。

欄位
model

string

選用。代理程式應使用的 LLM 模型。如未設定，代理程式會沿用上層代理程式的模型。
thinking_level

ModelSettings.ThinkingLevel

選用。模型的思考程度。
temperature

double

選用。如果設定了這個值，系統就會將其用於 LLM 模型。溫度參數會決定模型回覆的隨機程度。溫度越低，生成的回覆就越容易預測。溫度越高，生成的回覆就越有創意。

ThinkingLevel

模型的思考程度設定。

列舉
THINKING_LEVEL_UNSPECIFIED 未指定思考程度。
DEFAULT 預設思考程度。
LOW 思考程度較低。
MEDIUM 中度思考程度。
HIGH 深度思考程度。

OAuthConfig

使用 OAuth 驗證的設定。

欄位
oauth_grant_type

OAuthConfig.OauthGrantType

這是必要旗標，OAuth 授權類型。
client_id

string

這是必要旗標，OAuth 供應商提供的用戶端 ID。
client_secret_version

string

這是必要旗標，儲存用戶端密鑰的 SecretManager 密鑰版本資源名稱。格式：projects/{project}/secrets/{secret}/versions/{version}

注意：請將 roles/secretmanager.secretAccessor 角色授予 CES 服務代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com。
token_endpoint

string

這是必要旗標，OAuth 供應商的權杖端點，用於交換存取權杖。
scopes[]

string

選用。要授予的 OAuth 範圍。

OauthGrantType

OAuth 授權類型。系統僅支援用戶端憑證授權。

列舉
OAUTH_GRANT_TYPE_UNSPECIFIED 不明。預設值為 CLIENT_CREDENTIAL。
CLIENT_CREDENTIAL 代表用戶端憑證流程。

OpenApiTool

由 OpenAPI 結構定義的遠端 API 工具。

欄位
open_api_schema

string

這是必要旗標，JSON 或 YAML 格式的 OpenAPI 結構定義。
name

string

選用。工具名稱。如未提供，工具名稱會從 OpenAPI 結構定義的 operation.operationId 推導而來。
description

string

選用。工具說明。如未提供，工具說明會從 OpenAPI 結構定義 (operation.description 或 operation.summary) 衍生。
api_authentication

ApiAuthentication

選用。API 要求的驗證資訊。
tls_config

TlsConfig

選用。TLS 設定。包含用戶端信任的自訂伺服器憑證。
service_directory_config

ServiceDirectoryConfig

選用。Service Directory 設定。
ignore_unknown_fields

bool

選用。設為 True 時，代理會忽略 API 回應中的不明欄位。
url

string

選用。開放式 API 架構的伺服器網址。如果結構定義包含伺服器網址，則只有在匯出程序期間，環境依附元件中的工具才會設定這個欄位。在匯入過程中，如果環境依附元件中存在這個網址，且結構定義含有 $env_var 預留位置，系統就會取代結構定義中的預留位置。

OpenApiToolset

工具集，內含 OpenAPI 結構定義所定義的工具清單。

欄位
open_api_schema

string

這是必要旗標，工具集的 OpenAPI 結構定義。
api_authentication

ApiAuthentication

選用。API 要求的驗證資訊。
tls_config

TlsConfig

選用。TLS 設定。包含自訂伺服器憑證
service_directory_config

ServiceDirectoryConfig

選用。Service Directory 設定。
ignore_unknown_fields

bool

選用。如果為 true，對於 OpenAPI 結構定義中定義的所有作業，代理程式都會忽略 API 回應中的不明欄位。
url

string

選用。開放式 API 架構的伺服器網址。如果結構定義包含伺服器網址，則只有在匯出程序期間的環境依附元件中，才會設定這個欄位。在匯入過程中，如果環境依附元件中存在這個網址，且結構定義含有 $env_var 預留位置，系統就會取代結構定義中的預留位置。

OperationMetadata

代表長時間執行的作業中繼資料。

欄位
create_time

Timestamp

僅供輸出。作業的建立時間。
end_time

Timestamp

僅供輸出。作業完成的時間。
status_message

string

僅供輸出。作業的人類可讀狀態 (如有)。
requested_cancellation

bool

僅供輸出。判斷使用者是否要求取消作業。成功取消的作業會擁有 google.longrunning.Operation.error 值，且 google.rpc.Status.code 為 1 (也就是 Code.CANCELLED)。

OutputAudioConfig

OutputAudioConfig 會設定 CES 代理程式應如何合成外送音訊回覆。

欄位
audio_encoding

AudioEncoding

這是必要旗標，輸出音訊資料的編碼。
sample_rate_hertz

int32

這是必要旗標，輸出音訊資料的取樣率 (以赫茲為單位)。

PythonCodeCondition

用來評估條件的 Python 程式碼區塊。

欄位
python_code

string

這是必要旗標，要執行的 Python 程式碼。

PythonFunction

Python 函式工具。

欄位
name

string

選用。要執行的 Python 函式名稱。必須與 Python 程式碼中定義的 Python 函式名稱相符。區分大小寫，如未提供名稱，系統會使用 Python 程式碼中定義的第一個函式。
python_code

string

選用。工具要執行的 Python 程式碼。
description

string

僅供輸出。Python 函式的說明，從 Python 程式碼的 docstring 剖析而來。
service_directory_config

ServiceDirectoryConfig

選用。工具的 Service Directory 設定。

RecognitionResult

音訊輸入內容的語音辨識結果。

欄位
transcript

string

選用。在目前回合中擷取的使用者語音片段串連。

RedactionConfig

設定如何處理私密/機密資料。

欄位
enable_redaction

bool

選用。如為 true，系統會在各種記錄情境中套用遮蓋功能，包括對話記錄、Cloud Logging 和音訊錄音。
inspect_template

string

選用。DLP檢查範本名稱，設定機密資料類型偵測功能。

格式：projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentify_template

string

選用。DLP 去識別化範本名稱，用於指示如何將內容去識別化。

格式：projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

RemoteA2aConfig

用於連線至遠端 A2A 代理的共用設定。

欄位
api_authentication

ApiAuthentication

選用。呼叫遠端代理程式的驗證設定。如果登錄參照已處理驗證，則為選用。
input_variable_mapping

map<string, string>

選用。將遠端代理程式的輸入變數名稱對應至 GECX 變數名稱。
output_variable_mapping

map<string, string>

選用。將遠端代理程式的輸出變數名稱對應至 GECX 變數名稱。
streaming_enabled

bool

選用。遠端代理程式是否已啟用串流功能。
context_id

string

選用。如果不是空白，與遠端 A2A 代理程式的互動就會使用這個內容 ID。這個 context_id 欄位可以參照工作階段變數，例如 $context.variables.order_agent_session_id。
聯集欄位 agent_spec。遠端代理程式的規格。agent_spec 只能是下列其中一個設定：
agent_card

AgentCard

選用。內嵌定義的完整代理程式資訊卡。
agent_registry

string

選用。Agent Registry 中的代理參照。格式：projects/{project}/locations/{location}/agents/{agent}

RemoteAgentTool

代表可讓代理呼叫其他遠端代理的工具。

欄位
name

string

這是必要旗標，工具名稱。
description

string

這是必要旗標，工具說明。
agent_card

AgentCard

這是必要旗標，這個工具叫用的遠端代理程式代理程式卡。
api_authentication

ApiAuthentication

選用。呼叫遠端代理程式的驗證設定。
stateful_agent

bool

選用。啟用後，CXAS 應用程式與遠端服務專員之間的互動會共用相同脈絡。如果遠端服務專員傳回 context_id，系統會為這個遠端服務專員工具的工作階段保留該 ID。
input_variable_mapping

map<string, string>

選用。將遠端代理程式的輸入變數名稱對應至 GECX 變數名稱。
output_variable_mapping

map<string, string>

選用。將遠端代理程式的輸出變數名稱對應至 GECX 變數名稱。

RestoreAppVersionRequest

AgentService.RestoreAppVersion 的要求訊息

欄位
name

string

這是必要旗標，要還原的應用程式版本資源名稱。

RestoreAppVersionResponse

這個類型沒有任何欄位。

AgentService.RestoreAppVersion 的回應訊息

RetrieveToolSchemaRequest

ToolService.RetrieveToolSchema 的要求訊息。

欄位
parent

string

這是必要旗標，工具/工具集所屬應用程式的資源名稱。格式：projects/{project}/locations/{location}/apps/{app}
聯集欄位 tool_identifier。要擷取結構定義的工具 ID。可以是持續性工具，也可以是工具集中的工具。tool_identifier 只能是下列其中一個設定：
tool

string

選用。要擷取結構定義的工具名稱。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

選用。要擷取結構定義的工具集工具。工具集中只能有一個工具符合述詞。否則會傳回錯誤。

RetrieveToolSchemaResponse

ToolService.RetrieveToolSchema 的回應訊息。

欄位
input_schema

Schema

工具輸入參數的結構定義。
output_schema

Schema

工具輸出參數的結構定義。
聯集欄位 tool_identifier。結構定義適用的工具 ID。tool_identifier 只能是下列其中一個設定：
tool

string

結構定義適用的工具名稱。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

結構定義適用的工具集工具。

RetrieveToolsRequest

ToolService.RetrieveTools 的要求訊息。

欄位
toolset

string

這是必要旗標，要擷取工具的工具集名稱。格式：projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]

string

選用。要從工具集擷取的工具 ID。如果留空，系統會傳回工具組中的所有工具。
bypass_persistence_config

bool

選用。如果為 true，傳回的工具會直接從伺服器取得原始說明和結構定義，略過任何儲存的持續性設定 (覆寫/快照)。

RetrieveToolsResponse

ToolService.RetrieveTools 的回應訊息。

欄位
tools[]

Tool

指定工具集中包含的工具清單。

RunSessionRequest

SessionService.RunSession 的要求訊息。

欄位
config

SessionConfig

這是必要旗標，工作階段的設定。
inputs[]

SessionInput

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

RunSessionResponse

SessionService.RunSession 的回應訊息。

欄位
outputs[]

SessionOutput

工作階段的輸出內容。

結構定義

代表 OpenAPI 3.0 結構定義物件的選取子集。

欄位
type

Schema.Type

這是必要旗標，資料類型。
properties

map<string, Schema>

選用。Type.OBJECT 的屬性。
required[]

string

選用。Type.OBJECT 的必要屬性。
description

string

選用。資料說明。
items

Schema

選用。Type.ARRAY 元素的結構定義。
nullable

bool

選用。指出值是否可能為空值。
unique_items

bool

選用。指出陣列中的項目不得重複。僅適用於 TYPE.ARRAY。
prefix_items[]

Schema

選用。Type.ARRAY 初始元素的結構定義。
additional_properties

Schema

選用。可以是布林值或物件，用於控管其他屬性的存在。
any_of[]

Schema

選用。系統應根據清單中的任何 (一或多個) 子結構定義驗證值。
enum[]

string

選用。可能的值為列舉格式的基本類型元素。範例：1. 我們可以將方向定義為：{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. 我們可以將公寓號碼定義為：{type:INTEGER, format:enum, enum:["101", "201", "301"]}
default

Value

選用。資料的預設值。
ref

string

選用。允許在結構定義節點之間建立間接參照。此值應為根 defs 子項的有效參照。

舉例來說，下列結構定義會定義對名為「Pet」的結構定義節點的參照：

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

「pet」屬性的值是參照名為「Pet」的結構定義節點。詳情請參閱 https://json-schema.org/understanding-json-schema/structuring。
defs

map<string, Schema>

選用。供 ref 使用的定義對應表。只能在結構定義的根層級使用。
title

string

選用。架構的標題。
min_items

int64

選用。Type.ARRAY 的元素數量下限。
max_items

int64

選用。Type.ARRAY 的元素數量上限。
minimum

double

選用。Type.INTEGER 和 Type.NUMBER 的最小值。
maximum

double

選用。Type.INTEGER 和 Type.NUMBER 的最大值。

類型

OpenAPI 資料型別。

列舉
TYPE_UNSPECIFIED 未指定類型。
STRING 字串類型。
INTEGER 整數類型。
NUMBER 數字類型。
BOOLEAN 布林值型別。
OBJECT 物件類型。
ARRAY 陣列類型。

SecuritySettings

CES 的專案/位置層級安全性設定。

欄位
name

string

ID。安全設定的專屬 ID。格式：projects/{project}/locations/{location}/securitySettings
endpoint_control_policy

EndpointControlPolicy

選用。端點控制相關設定。
create_time

Timestamp

僅供輸出。建立安全性設定的時間。
update_time

Timestamp

僅供輸出。安全性設定的上次更新時間。
etag

string

僅供輸出。安全性設定的 Etag。

ServiceAccountAuthConfig

使用自訂服務帳戶進行驗證的設定。

欄位
service_account

string

這是必要旗標，用於驗證的服務帳戶電子郵件地址。CES 會使用這個服務帳戶交換存取權杖，然後在要求的 Authorization 標頭中傳送存取權杖。

服務帳戶必須獲派 roles/iam.serviceAccountTokenCreator 角色，才能授予 CES 服務代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com。
scopes[]

string

選用。要授予的 OAuth 範圍。如未指定，系統會使用預設範圍 https://www.googleapis.com/auth/cloud-platform。

ServiceAgentIdTokenAuthConfig

這個類型沒有任何欄位。

使用服務代理程式產生的 ID 權杖進行驗證的設定。

ServiceDirectoryConfig

使用 Service Directory 的工具設定。

欄位
service

string

這是必要旗標，Service Directory 服務的名稱。格式：projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}。服務目錄的位置必須與應用程式的位置相同。

SessionConfig

工作階段的設定。

欄位
session

string

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

InputAudioConfig

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

OutputAudioConfig

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

Message

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

string

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

string

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

string

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

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

bool

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

SessionConfig.RemoteDialogflowQueryParameters

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

bool

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

bool

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

RemoteDialogflowQueryParameters

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

欄位
webhook_headers

map<string, string>

選用。要以 webhook_headers 形式在 QueryParameters 中傳送的 HTTP 標頭。
payload

Struct

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

Struct

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

SessionInput

工作階段的輸入內容。

欄位
will_continue

bool

選用。這個旗標用於指出目前訊息是否為雙向串流工作階段中較大輸入內容的片段。

設為 true 時，代理會延後處理，直到收到後續訊息 (will_continue 為 false)，或系統在音訊輸入中偵測到端點為止。

注意：這個欄位不適用於音訊和 DTMF 輸入內容，因為系統一律會根據終止信號自動處理這些內容。
聯集欄位 input_type。輸入內容的類型。input_type 只能是下列其中一個設定：
text

string

選用。來自使用者的文字資料。
dtmf

string

選用。使用者的 DTMF 數字。
audio

bytes

選用。來自使用者的音訊資料。
tool_responses

ToolResponses

選用。用戶端工具呼叫的執行結果。
image

Image

選用。來自使用者的圖片資料。
blob

Blob

選用。來自終端使用者的 Blob 資料。
variables

Struct

選用。工作階段的內容變數，以名稱做為鍵。CES 代理程式只會使用在應用程式中宣告的變數。

無法辨識的變數仍會以額外工作階段參數的形式傳送至 [Dialogflow 代理程式][Agent.RemoteDialogflowAgent]。
event

Event

選用。事件輸入。

SessionOutput

工作階段的輸出內容。

欄位
turn_index

int32

表示這個輸出內容所屬的對話輪次順序，從 1 開始。
turn_completed

bool

如果是 true，表示 CES 代理程式已偵測到目前對話回合結束，因此不會再提供這個回合的輸出內容。
diagnostic_info

SessionOutput.DiagnosticInfo

選用。診斷資訊包含處理輸入內容時的執行詳細資料。只有在每個回合的最後一個 SessionOutput (含 turn_completed=true) 中填入。
聯集欄位 output_type。輸出內容的類型。output_type 只能是下列其中一個設定：
text

string

CES 代理的輸出文字。
audio

bytes

從 CES 代理程式輸出音訊。
tool_calls

ToolCalls

要求客戶執行工具。
citations

Citations

引文：提供服務專員生成文字的來源資訊。
google_search_suggestions

GoogleSearchSuggestions

Google 搜尋因叫用 GoogleSearchTool 而傳回的建議。
end_session

EndSession

表示工作階段已結束。
payload

Struct

自訂酬載，內含 CES 代理的結構化輸出內容。
image

Image

CES 服務專員輸出的圖片。
progress

string

CES 服務專員傳送的中間進度更新。

DiagnosticInfo

包含處理期間的執行詳細資料。

欄位
messages[]

Message

處理期間發生的訊息清單。
root_span

Span

整個要求處理程序的追蹤記錄，以根範圍表示。這個時距可以包含特定作業的巢狀子時距。

時距

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

欄位
name

string

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

Timestamp

僅供輸出。時距的開始時間。
end_time

Timestamp

僅供輸出。時距的結束時間。
duration

Duration

僅供輸出。時距長度。
attributes

Struct

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

Span

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

SynthesizeSpeechConfig

設定代理程式回覆的統整方式。

欄位
voice

string

選用。語音的名稱。如未設定，服務會根據其他參數 (例如 language_code) 選擇語音。

如需可用語音清單，請參閱 Cloud Text-to-Speech 的「支援的語音和語言」。
speaking_rate

double

選用。語音速率/速度，範圍為 [0.25, 2.0]。1.0 為特定語音支援的正常原生速度。2.0 為兩倍速，0.5 為一半的速度。如果值超出 [0.25, 2.0] 範圍，系統會傳回錯誤。
model

string

選用。用於合成音訊的模型。目前支援的值：-「gemini-3.1-flash-tts-preview」。如果為空白，系統會使用 Chirp3-HD。
instruction

string

選用。使用生成模型合成語音時的指令。

SystemTool

預先定義的系統工具。

欄位
name

string

這是必要旗標，系統工具的名稱。
description

string

僅供輸出。系統工具的說明。

TimeZoneSettings

應用程式的時區設定。

欄位
time_zone

string

選用。應用程式的時區 (來自時區資料庫)，例如 America/Los_Angeles、Europe/Paris。

TlsConfig

TLS 設定。

欄位
ca_certs[]

TlsConfig.CaCert

這是必要旗標，指定允許用於 HTTPS 驗證的自訂 CA 憑證清單。

CaCert

CA 憑證。

欄位
display_name

string

這是必要旗標，允許使用的自訂 CA 憑證名稱。這可用於消除自訂 CA 憑證的歧義。
cert

bytes

這是必要旗標，用於 HTTPS 驗證的允許自訂 CA 憑證 (DER 格式)。這會覆寫預設的 SSL 信任存放區。如果這個值為空白或未指定，CES 會使用 Google 的預設信任存放區驗證憑證。注意：請確保 HTTPS 伺服器憑證是以「主體替代名稱」簽署。舉例來說，您可以使用下列指令自行簽署憑證：

   openssl x509 -req -days 200 -in example.com.csr \
     -signkey example.com.key \
     -out example.com.crt \
     -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

工具

工具代表 CES 代理可執行的動作，以達成特定目標。

欄位
name

string

ID。工具的資源名稱。格式：

  • projects/{project}/locations/{location}/apps/{app}/tools/{tool}，瞭解獨立工具。
  • projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}，適用於從工具集擷取的工具。

這些工具是動態的，且只能輸出內容，無法在需要工具的地方直接參照。
display_name

string

僅供輸出。工具的顯示名稱，會根據工具類型衍生而來。舉例來說，[ClientFunction][Tool.ClientFunction] 的顯示名稱是衍生自其 name 屬性。
execution_type

ExecutionType

選用。工具的執行作業類型。
timeout

Duration

選用。工具執行作業的逾時時間。如未設定，SYNCHRONOUS 工具的預設逾時時間為 30 秒，ASYNCHRONOUS 工具則為 60 秒。
create_time

Timestamp

僅供輸出。工具的建立時間戳記。
update_time

Timestamp

僅供輸出。工具上次更新的時間戳記。
etag

string

Etag 用於確保物件在讀取 - 修改 - 寫入作業期間未變更。如果 etag 為空，更新作業會覆寫任何並行變更。
generated_summary

string

僅供輸出。如果工具是由大型語言模型助理產生，這個欄位會包含生成內容的描述性摘要。
tool_fake_config

ToolFakeConfig

選用。模擬模式中工具行為的設定。
read_only

bool

僅供輸出。指出工具是否為唯讀。如果為 true，使用者就無法修改工具。
聯集欄位 tool_type。工具類型。tool_type 只能是下列其中一個設定：
client_function

ClientFunction

選用。用戶端函式。
open_api_tool

OpenApiTool

選用。開放式 API 工具。
google_search_tool

GoogleSearchTool

選用。Google 搜尋工具。
connector_tool

ConnectorTool

選用。Integration Connectors 工具。
data_store_tool

DataStoreTool

選用。資料儲存庫工具。
python_function

PythonFunction

選用。Python 函式工具。
mcp_tool

McpTool

選用。MCP 工具。MCP 工具無法直接建立或更新，而是由 MCP 工具集管理。
file_search_tool

FileSearchTool

選用。檔案搜尋工具。
system_tool

SystemTool

選用。系統工具。
agent_tool

AgentTool

選用。代理工具。
widget_tool

WidgetTool

選用。小工具工具。
remote_agent_tool

RemoteAgentTool

選用。遠端代理程式工具。

ToolCall

要求用戶端或代理人執行指定工具。

欄位
id

string

選用。工具呼叫的專屬 ID。如果已填入，用戶端應傳回執行結果，並在 ToolResponse 中提供相符的 ID。
display_name

string

僅供輸出。工具的顯示名稱。
args

Struct

選用。工具的輸入參數和值，格式為 JSON 物件。
parent_tool_call_id

string

僅供輸出。如果是由代表父項呼叫的子代理程式發出，則為導致此呼叫的工具呼叫 ID。如果是頂層呼叫，則為空白。讓用戶端將子代理程式的工作歸類在啟動工作的呼叫下，而非將每個步驟都視為同層級。
agent_name

string

僅供輸出。發出這通電話的代理名稱 (人類可讀)，例如「合約架構師」。如果是由根層級代理發出，則為空白。
聯集欄位 tool_identifier。要執行的工具 ID。可以是持續性工具，也可以是工具集中的工具。tool_identifier 只能是下列其中一個設定：
tool

string

選用。要執行的工具名稱。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

選用。要執行的工具集工具。

ToolCalls

要求用戶端執行工具並傳回執行結果，然後再繼續工作階段。

欄位
tool_calls[]

ToolCall

選用。要執行的工具呼叫清單。

ToolFakeConfig

模擬模式中工具行為的設定。

欄位
enable_fake_mode

bool

選用。工具是否使用模擬模式。
聯集欄位 tool_response。回應可以是靜態，也可以由 Python 函式提供。tool_response 只能是下列其中一個設定：
code_block

CodeBlock

選用。要執行的程式碼區塊，而非實際的工具呼叫。

ToolResponse

用戶端或代理程式中特定工具的執行結果。

欄位
id

string

選用。tool call 回應的相符 ID。
display_name

string

僅供輸出。工具的顯示名稱。
response

Struct

這是必要旗標，JSON 物件格式的工具執行結果。使用「output」鍵指定工具回應，並使用「error」鍵指定錯誤詳細資料 (如有)。如果未指定「output」和「error」鍵，系統會將整個「response」視為工具執行結果。
parent_tool_call_id

string

僅供輸出。如果是由代表父項呼叫的子代理程式發出，則為導致此呼叫的工具呼叫 ID。如果是頂層呼叫，則為空白。讓用戶端將子代理程式的工作歸類在啟動工作的呼叫下，而非將每個步驟都視為同層級。
agent_name

string

僅供輸出。發出這通電話的代理名稱 (人類可讀)，例如「合約架構師」。如果是由根層級代理發出，則為空白。
聯集欄位 tool_identifier。已執行的工具 ID。可以是持續性工具，也可以是工具集中的工具。tool_identifier 只能是下列其中一個設定：
tool

string

選用。要執行的工具名稱。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

選用。執行的工具集工具。

ToolResponses

用戶端要求工具呼叫的執行結果。

欄位
tool_responses[]

ToolResponse

選用。工具執行結果清單。

工具集

工具集代表一組可供代理使用的動態管理工具。

欄位
name

string

ID。工具組的專屬 ID。格式：projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
display_name

string

選用。工具集的顯示名稱。不得重複用於同一應用程式。
description

string

選用。工具集的說明。
timeout

Duration

選用。工具集執行作業的逾時時間。如未設定，SYNCHRONOUS 工具集的預設逾時時間為 30 秒，ASYNCHRONOUS 工具集則為 60 秒。
create_time

Timestamp

僅供輸出。建立工具集的時間戳記。
update_time

Timestamp

僅供輸出。上次更新工具集的時間戳記。
etag

string

ETag 用於確保物件在讀取 - 修改 - 寫入作業期間未變更。如果 etag 為空，更新作業會覆寫任何並行變更。
execution_type

ExecutionType

選用。工具集中工具的執行類型。
tool_fake_config

ToolFakeConfig

選用。模擬模式中工具行為的設定。
聯集欄位 toolset_type。工具組類型。toolset_type 只能是下列其中一個設定：
mcp_toolset

McpToolset

選用。工具集，內含 MCP 伺服器提供的工具清單。
open_api_toolset

OpenApiToolset

選用。工具集，內含 OpenAPI 結構定義所定義的工具清單。
connector_toolset

ConnectorToolset

選用。這組工具可從 Integration Connectors 連線產生工具。

ToolsetTool

從工具集建立的工具。

欄位
toolset

string

這是必要旗標，衍生這個工具的工具集資源名稱。格式：projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_id

string

選用。用於篩選工具的工具 ID，可擷取結構定義。

TransferRule

轉接至特定代理的規則。

欄位
child_agent

string

這是必要旗標，規則適用的子項代理程式資源名稱。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction

TransferRule.Direction

這是必要旗標，轉移方向。
聯集欄位 rule_type。規則類型。rule_type 只能是下列其中一個設定：
deterministic_transfer

TransferRule.DeterministicTransfer

選用。規則：符合條件時立即轉移給目標服務專員。
disable_planner_transfer

TransferRule.DisablePlannerTransfer

選用。這項規則會禁止規劃師轉移給目標服務專員。

DeterministicTransfer

確定性轉移規則。如果條件評估結果為 true，就會發生轉移。

欄位
聯集欄位 condition_type。要評估的條件。condition_type 只能是下列其中一個設定：
expression_condition

ExpressionCondition

選用。評估工作階段狀態條件的規則。如果條件評估結果為 true，就會進行轉移。
python_code_condition

PythonCodeCondition

選用。使用 Python 程式碼區塊評估條件的規則。如果條件評估結果為 true，就會進行轉移。

方向

轉移方向。

列舉
DIRECTION_UNSPECIFIED 未指定方向。
PARENT_TO_CHILD 從父項代理轉移至子項代理。
CHILD_TO_PARENT 從子代理轉移至上層代理。

DisablePlannerTransfer

這項規則會禁止規劃人員轉移給目標服務專員。

欄位
expression_condition

ExpressionCondition

這是必要旗標，如果條件評估結果為 true，規劃人員就無法轉移至目標代理。

TriggerAction

符合特定先決條件時採取的動作。

欄位
聯集欄位 action。要採取的行動。action 只能是下列其中一個設定：
respond_immediately

TriggerAction.RespondImmediately

選用。立即以預先設定的回覆內容回覆。
transfer_agent

TriggerAction.TransferAgent

選用。將對話轉移給其他服務專員。
generative_answer

TriggerAction.GenerativeAnswer

選用。使用生成式答案回覆。

GenerativeAnswer

代理程式會立即回覆生成式答案。

欄位
prompt

string

這是必要旗標，用於生成式答案的提示。

RespondImmediately

代理程式會立即回覆預先設定的回覆內容。

欄位
responses[]

TriggerAction.Response

這是必要旗標，代理可從中選擇罐頭回應。系統會隨機選擇回覆。

回應

代表代理的回覆。

欄位
text

string

這是必要旗標，服務專員回覆的文字。
disabled

bool

選用。是否停用回覆。代理不會使用已停用的回覆。

TransferAgent

服務專員會將對話轉移給其他服務專員。

欄位
agent

string

這是必要旗標，要轉移對話的代理程式名稱。代理程式必須與目前的代理程式位於相同應用程式。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}

UpdateAgentRequest

AgentService.UpdateAgent 的要求訊息。

欄位
agent

Agent

這是必要旗標，要更新的代理程式。
update_mask

FieldMask

選用。欄位遮罩用於控管要更新的欄位。如果沒有遮罩，系統會更新所有欄位。

UpdateAppRequest

AgentService.UpdateApp 的要求訊息。

欄位
app

App

這是必要旗標，要更新的應用程式。
update_mask

FieldMask

選用。欄位遮罩用於控管要更新的欄位。如果沒有遮罩，系統會更新所有欄位。

UpdateAppVersionRequest

AgentService.UpdateAppVersion 的要求訊息。

欄位
app_version

AppVersion

這是必要旗標，要更新的應用程式版本。
update_mask

FieldMask

選用。要更新的欄位清單。如果為空白，系統會更新 display_name 和 description 欄位。

UpdateDeploymentRequest

AgentService.UpdateDeployment 的要求訊息。

欄位
deployment

Deployment

這是必要旗標，要更新的部署作業。
update_mask

FieldMask

選用。要更新的欄位清單。

UpdateExampleRequest

AgentService.UpdateExample 的要求訊息。

欄位
example

Example

這是必要旗標，要更新的範例。
update_mask

FieldMask

選用。欄位遮罩用於控管要更新的欄位。如果沒有遮罩，系統會更新所有欄位。

UpdateGuardrailRequest

AgentService.UpdateGuardrail 的要求訊息。

欄位
guardrail

Guardrail

這是必要旗標，要更新的防護措施。
update_mask

FieldMask

選用。欄位遮罩用於控管要更新的欄位。如果沒有遮罩，系統會更新所有欄位。

UpdateToolRequest

AgentService.UpdateTool 的要求訊息。

欄位
tool

Tool

這是必要旗標，要更新的工具。
update_mask

FieldMask

選用。欄位遮罩用於控管要更新的欄位。如果沒有遮罩，系統會更新所有欄位。

UpdateToolsetRequest

AgentService.UpdateToolset 的要求訊息。

欄位
toolset

Toolset

這是必要旗標，要更新的工具集。
update_mask

FieldMask

選用。欄位遮罩用於控管要更新的欄位。如果沒有遮罩，系統會更新所有欄位。

VpcScSettings

應用程式的 VPC-SC 設定。

欄位
allowed_origins[]

string

選用。啟用 VPC Service Controls 時，應用程式中的 OpenAPI 工具可直接呼叫的允許 HTTP(s) 來源。這些字串必須與來源完全相符，包括指定的連接埠。例如「https://example.com」或「https://example.com:443」。這份清單目前不適用於可能會直接發出 HTTP 呼叫的 Python 工具。

WebSearchQuery

代表單一網頁搜尋查詢及其相關聯的搜尋 URI。

欄位
query

string

搜尋查詢文字。
uri

string

查詢的 Google 搜尋結果網頁 URI。

WhatsAppCredentials

用於 WhatsApp 原生整合的 Meta 臨時憑證。

欄位
auth_code

string

這是必要旗標，內嵌註冊流程提供的 Meta 授權碼。
pin

string

這是必要旗標，使用者為兩步驟驗證建立的 6 位數 PIN 碼。
phone_number

string

這是必要旗標，用來註冊 WhatsApp 的電話號碼。
business_account_id

string

這是必要旗標，要用於電話號碼的商家帳戶 ID。
waba_id

string

這是必要旗標，WhatsApp Business 帳戶 ID。
conversation_profile_id

string

選用。部署作業要使用的對話設定檔 ID。

WidgetTool

代表代理可叫用的小工具工具。代理程式選擇工具後，會將小工具傳回給用戶端。用戶端負責處理小工具，並產生下一個使用者查詢，以便繼續與代理互動。

欄位
name

string

這是必要旗標，小工具工具的顯示名稱。
description

string

選用。小工具工具的說明。
widget_type

WidgetTool.WidgetType

選用。小工具工具的類型。如未指定，預設類型為 CUSTOMIZED。
ui_config

Struct

選用。用於算繪小工具的設定。
data_mapping

WidgetTool.DataMapping

選用。這項對應會定義來源工具的資料如何對應至小工具的輸入參數。
text_response_config

WidgetTool.TextResponseConfig

選用。一律包含文字回覆的設定。
聯集欄位 input。小工具工具的輸入內容。input 只能是下列其中一個設定：
parameters

Schema

選用。小工具工具的輸入參數。

DataMapping

設定如何將來源工具的資料對應至小工具的輸入參數。

欄位
source_tool_name

string

選用。提供小工具資料的工具資源名稱 (例如搜尋工具或自訂函式)。格式：projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
field_mappings

map<string, string>

選用。小工具輸入參數欄位對應至來源工具相應輸出欄位的對應表。
python_function

PythonFunction

選用。Python 函式的設定，用於將來源工具的輸出內容轉換為小工具的輸入格式。
mode

WidgetTool.DataMapping.Mode

選用。資料對應模式。
python_script
(deprecated)

string

已淘汰：請改用 python_function。

模式

將來源工具的資料對應至小工具的策略。

列舉
MODE_UNSPECIFIED 未指定模式。
FIELD_MAPPING 使用 field_mappings 對應進行資料轉換。
PYTHON_SCRIPT 使用 python_script 轉換資料。

TextResponseConfig

隨小工具傳回的文字回覆設定。

欄位
type

WidgetTool.TextResponseConfig.Type

選用。提供文字回覆的策略。
static_text

string

選用。當類型為 STATIC 時要傳回的靜態文字回覆。
text_response_instruction

string

選用。指示 LLM 如何生成文字回覆。如果類型為 LLM_GENERATED，則做為文字回應參數的說明。

類型

定義如何生成文字回覆。

列舉
TYPE_UNSPECIFIED 未指定類型。
NONE LLM 會根據對話脈絡，動態決定是否要連同小工具生成文字回覆。
LLM_GENERATED 系統明確要求 LLM 生成文字回覆。
STATIC 系統一律會使用預先定義的靜態文字回覆。

WidgetType

所有可用的小工具類型。日後可能會在這個列舉中新增值。

列舉
WIDGET_TYPE_UNSPECIFIED 未指定的小工具類型。
CUSTOM 自訂小工具類型。
PRODUCT_DETAILS 產品詳細資料小工具。
QUICK_ACTIONS 快速操作小工具。
PRODUCT_COMPARISON 產品比較小工具。
ADVANCED_PRODUCT_DETAILS 進階產品詳細資料小工具。
SHORT_FORM 短篇表單小工具。
OVERALL_SATISFACTION 整體滿意度小工具。
ORDER_SUMMARY 訂單摘要小工具。
APPOINTMENT_DETAILS 預約詳細資料小工具。
APPOINTMENT_SCHEDULER 預約時間表小工具。
CONTACT_FORM 聯絡表單小工具。