Gemini Enterprise for Customer Experience API

服務：ces.googleapis.com

如要呼叫這項服務，建議您使用 Google 提供的用戶端程式庫。如果您的應用程式需要使用自己的程式庫呼叫這項服務，請在發出 API 要求時使用下列資訊。

導覽文件

導覽文件是一種機器可解讀的規格，用於說明和使用 REST API。此文件會用於建構用戶端程式庫、IDE 外掛程式，以及與 Google API 互動的其他工具。一項服務可能會提供多個探索文件。這項服務提供下列導覽文件：

服務端點

服務端點是能指定 API 服務網路位址的基準網址。一項服務可能有多個服務端點，而這項服務有下列服務端點，以及和該服務端點相關的所有 URI：

  • https://ces.googleapis.com

REST 資源：tasks

方法
cancel POST /tasks/{id}:cancel
取消進行中的工作。
get GET /tasks/{id}
取得工作的最新狀態。
list GET /tasks
列出符合指定篩選條件的工作。
subscribe GET /tasks/{id}:subscribe
訂閱非終端狀態的工作更新。

REST 資源：tasks.pushNotificationConfigs

方法
create POST /tasks/{taskId}/pushNotificationConfigs
為工作建立推播通知設定。
delete DELETE /tasks/{taskId}/pushNotificationConfigs/{id}
刪除工作推播通知設定。
get GET /tasks/{taskId}/pushNotificationConfigs/{id}
取得工作的推播通知設定。
list GET /tasks/{taskId}/pushNotificationConfigs
取得為工作設定的推播通知清單。

REST 資源：v1.projects.locations

方法
get GET /v1/{name=projects/*/locations/*}
取得位置的相關資訊。
list GET /v1/{name=projects/*}/locations
列出這項服務支援位置的相關資訊。

REST 資源：v1.projects.locations.apps

方法
create POST /v1/{parent=projects/*/locations/*}/apps
在指定專案和位置建立新應用程式。
delete DELETE /v1/{name=projects/*/locations/*/apps/*}
刪除指定的應用程式。
executeTool POST /v1/{parent=projects/*/locations/*/apps/*}:executeTool
使用指定引數執行指定工具。
exportApp POST /v1/{name=projects/*/locations/*/apps/*}:exportApp
匯出指定的應用程式。
get GET /v1/{name=projects/*/locations/*/apps/*}
取得指定應用程式的詳細資料。
getExtendedAgentCard GET /v1/{tenant=projects/*/locations/*/apps/*}/extendedAgentCard
取得已驗證代理程式的擴充代理程式資訊卡。
importApp POST /v1/{parent=projects/*/locations/*}/apps:importApp
匯入指定的應用程式。
list GET /v1/{parent=projects/*/locations/*}/apps
列出指定專案和位置中的應用程式。
patch PATCH /v1/{app.name=projects/*/locations/*/apps/*}
更新指定應用程式。
retrieveToolSchema POST /v1/{parent=projects/*/locations/*/apps/*}:retrieveToolSchema
擷取指定工具的結構定義。

REST 資源：v1.projects.locations.apps.agents

方法
create POST /v1/{parent=projects/*/locations/*/apps/*}/agents
在指定應用程式中建立新代理程式。
delete DELETE /v1/{name=projects/*/locations/*/apps/*/agents/*}
刪除指定的代理程式。
get GET /v1/{name=projects/*/locations/*/apps/*/agents/*}
取得指定代理程式的詳細資料。
list GET /v1/{parent=projects/*/locations/*/apps/*}/agents
列出指定應用程式中的代理程式。
patch PATCH /v1/{agent.name=projects/*/locations/*/apps/*/agents/*}
更新指定的代理程式。

REST 資源：v1.projects.locations.apps.changelogs

方法
get GET /v1/{name=projects/*/locations/*/apps/*/changelogs/*}
取得指定的異動記錄。
list GET /v1/{parent=projects/*/locations/*/apps/*}/changelogs
列出指定應用程式的變更記錄。

REST 資源：v1.projects.locations.apps.conversations

方法
batchDelete POST /v1/{parent=projects/*/locations/*/apps/*}/conversations:batchDelete
批次刪除指定的對話。
delete DELETE /v1/{name=projects/*/locations/*/apps/*/conversations/*}
刪除指定對話。
get GET /v1/{name=projects/*/locations/*/apps/*/conversations/*}
取得指定對話的詳細資料。
list GET /v1/{parent=projects/*/locations/*/apps/*}/conversations
列出指定應用程式中的對話。

REST 資源：v1.projects.locations.apps.deployments

方法
create POST /v1/{parent=projects/*/locations/*/apps/*}/deployments
在指定應用程式中建立新的部署作業。
delete DELETE /v1/{name=projects/*/locations/*/apps/*/deployments/*}
刪除指定的部署作業。
get GET /v1/{name=projects/*/locations/*/apps/*/deployments/*}
取得指定部署作業的詳細資料。
getExtendedAgentCard GET /v1/{tenant=projects/*/locations/*/apps/*/deployments/*}/extendedAgentCard
取得已驗證代理程式的擴充代理程式資訊卡。
list GET /v1/{parent=projects/*/locations/*/apps/*}/deployments
列出指定應用程式中的部署作業。
patch PATCH /v1/{deployment.name=projects/*/locations/*/apps/*/deployments/*}
更新指定的部署作業。

REST 資源：v1.projects.locations.apps.deployments.message

方法
send POST /v1/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:send
傳送訊息給服務專員。
stream POST /v1/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:stream
將串流訊息傳送給服務專員，方便即時互動和更新狀態。

REST 資源：v1.projects.locations.apps.examples

方法
create POST /v1/{parent=projects/*/locations/*/apps/*}/examples
在指定應用程式中建立新範例。
delete DELETE /v1/{name=projects/*/locations/*/apps/*/examples/*}
刪除指定範例。
get GET /v1/{name=projects/*/locations/*/apps/*/examples/*}
取得指定範例的詳細資料。
list GET /v1/{parent=projects/*/locations/*/apps/*}/examples
列出指定應用程式中的範例。
patch PATCH /v1/{example.name=projects/*/locations/*/apps/*/examples/*}
更新指定的範例。

REST 資源：v1.projects.locations.apps.guardrails

方法
create POST /v1/{parent=projects/*/locations/*/apps/*}/guardrails
在指定應用程式中建立新的防護措施。
delete DELETE /v1/{name=projects/*/locations/*/apps/*/guardrails/*}
刪除指定的防護措施。
get GET /v1/{name=projects/*/locations/*/apps/*/guardrails/*}
取得指定防護措施的詳細資料。
list GET /v1/{parent=projects/*/locations/*/apps/*}/guardrails
列出指定應用程式中的防護措施。
patch PATCH /v1/{guardrail.name=projects/*/locations/*/apps/*/guardrails/*}
更新指定的防護措施。

REST 資源：v1.projects.locations.apps.message

方法
send POST /v1/{tenant=projects/*/locations/*/apps/*}/message:send
傳送訊息給服務專員。
stream POST /v1/{tenant=projects/*/locations/*/apps/*}/message:stream
將串流訊息傳送給服務專員，方便即時互動和更新狀態。

REST 資源：v1.projects.locations.apps.sessions

方法
generateChatToken POST /v1/{name=projects/*/locations/*/apps/*/sessions/*}:generateChatToken
為即時通訊小工具產生工作階段範圍權杖，以便透過 Session API 進行驗證。
runSession POST /v1/{config.session=projects/*/locations/*/apps/*/sessions/*}:runSession
在工作階段中，與 CES 代理啟動單回合互動。
streamRunSession POST /v1/{config.session=projects/*/locations/*/apps/*/sessions/*}:streamRunSession
與 CES 代理啟動單回合互動。

REST 資源：v1.projects.locations.apps.tools

方法
create POST /v1/{parent=projects/*/locations/*/apps/*}/tools
在指定應用程式中建立新工具。
delete DELETE /v1/{name=projects/*/locations/*/apps/*/tools/*}
刪除指定工具。
get GET /v1/{name=projects/*/locations/*/apps/*/tools/*}
取得指定工具的詳細資料。
list GET /v1/{parent=projects/*/locations/*/apps/*}/tools
列出指定應用程式中的工具。
patch PATCH /v1/{tool.name=projects/*/locations/*/apps/*/tools/*}
更新指定工具。

REST 資源：v1.projects.locations.apps.toolsets

方法
create POST /v1/{parent=projects/*/locations/*/apps/*}/toolsets
在指定應用程式中建立新的工具集。
delete DELETE /v1/{name=projects/*/locations/*/apps/*/toolsets/*}
刪除指定的工具集。
get GET /v1/{name=projects/*/locations/*/apps/*/toolsets/*}
取得指定工具集的詳細資料。
list GET /v1/{parent=projects/*/locations/*/apps/*}/toolsets
列出指定應用程式中的工具集。
patch PATCH /v1/{toolset.name=projects/*/locations/*/apps/*/toolsets/*}
更新指定的工具集。
retrieveTools POST /v1/{toolset=projects/*/locations/*/apps/*/toolsets/*}:retrieveTools
擷取指定工具組中包含的工具清單。

REST 資源：v1.projects.locations.apps.versions

方法
create POST /v1/{parent=projects/*/locations/*/apps/*}/versions
在指定應用程式中建立新的應用程式版本。
delete DELETE /v1/{name=projects/*/locations/*/apps/*/versions/*}
刪除指定的應用程式版本。
get GET /v1/{name=projects/*/locations/*/apps/*/versions/*}
取得指定應用程式版本的詳細資料。
getExtendedAgentCard GET /v1/{tenant=projects/*/locations/*/apps/*/versions/*}/extendedAgentCard
取得已驗證代理程式的擴充代理程式資訊卡。
list GET /v1/{parent=projects/*/locations/*/apps/*}/versions
列出指定應用程式中的所有應用程式版本。
patch PATCH /v1/{appVersion.name=projects/*/locations/*/apps/*/versions/*}
更新指定的應用程式版本。
restore POST /v1/{name=projects/*/locations/*/apps/*/versions/*}:restore
還原指定的應用程式版本。

REST 資源：v1.projects.locations.apps.versions.message

方法
send POST /v1/{tenant=projects/*/locations/*/apps/*/versions/*}/message:send
傳送訊息給服務專員。
stream POST /v1/{tenant=projects/*/locations/*/apps/*/versions/*}/message:stream
將串流訊息傳送給服務專員，方便即時互動和更新狀態。

REST 資源：v1.projects.locations.operations

方法
cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
開始非同步取消長時間執行的作業。
delete DELETE /v1/{name=projects/*/locations/*/operations/*}
刪除長時間執行的作業。
get GET /v1/{name=projects/*/locations/*/operations/*}
取得長時間執行作業的最新狀態。
list GET /v1/{name=projects/*/locations/*}/operations
列出符合要求中指定篩選器的作業。