Gemini Enterprise for Customer Experience API

• REST 資源：v1beta.projects.locations
• REST 資源：v1beta.projects.locations.apps
• REST 資源：v1beta.projects.locations.apps.agents
• REST 資源：v1beta.projects.locations.apps.assistantSessions
• REST 資源：v1beta.projects.locations.apps.changelogs
• REST 資源：v1beta.projects.locations.apps.conversations
• REST 資源：v1beta.projects.locations.apps.deployments
• REST 資源：v1beta.projects.locations.apps.deployments.message
• REST 資源：v1beta.projects.locations.apps.evaluationDatasets
• REST 資源：v1beta.projects.locations.apps.evaluationExpectations
• REST 資源：v1beta.projects.locations.apps.evaluationRuns
• REST 資源：v1beta.projects.locations.apps.evaluations
• REST 資源：v1beta.projects.locations.apps.evaluations.results
• REST 資源：v1beta.projects.locations.apps.examples
• REST 資源：v1beta.projects.locations.apps.guardrails
• REST 資源：v1beta.projects.locations.apps.message
• REST 資源：v1beta.projects.locations.apps.scheduledEvaluationRuns
• REST 資源：v1beta.projects.locations.apps.sessions
• REST 資源：v1beta.projects.locations.apps.tools
• REST 資源：v1beta.projects.locations.apps.toolsets
• REST 資源：v1beta.projects.locations.apps.versions
• REST 資源：v1beta.projects.locations.apps.versions.message
• REST 資源：v1beta.projects.locations.operations

服務：ces.googleapis.com

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

導覽文件

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

• https://ces.googleapis.com/$discovery/rest?version=v1beta

服務端點

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

• https://ces.googleapis.com

REST 資源：v1beta.projects.locations

方法
get	GET /v1beta/{name=projects/*/locations/*} 取得位置的相關資訊。
getSecuritySettings	GET /v1beta/{name=projects/*/locations/*/securitySettings} 擷取專案和位置的安全設定。
list	GET /v1beta/{name=projects/*}/locations 列出這項服務支援位置的相關資訊。
updateSecuritySettings	PATCH /v1beta/{securitySettings.name=projects/*/locations/*/securitySettings} 更新專案和位置的安全設定。

REST 資源：v1beta.projects.locations.apps

方法
chatAiAssistant	POST /v1beta/{app=projects/*/locations/*/apps/*}:chatAiAssistant 為指定的助理工作階段執行 AI 助理 Arc。
create	POST /v1beta/{parent=projects/*/locations/*}/apps 在指定專案和位置建立新的應用程式。
delete	DELETE /v1beta/{name=projects/*/locations/*/apps/*} 刪除指定的應用程式。
executeTool	POST /v1beta/{parent=projects/*/locations/*/apps/*}:executeTool 使用指定引數執行指定工具。
exportApp	POST /v1beta/{name=projects/*/locations/*/apps/*}:exportApp 匯出指定的應用程式。
generateAppResource	POST /v1beta/{parent=projects/*/locations/*/apps/*}:generateAppResource 生成特定資源 (例如
generateOnboardingSuggestions	POST /v1beta/{name=projects/*/locations/*/apps/*}:generateOnboardingSuggestions 為 Arc 零狀態生成個人化新手上路建議：根據應用程式中的助理工作階段記錄，將要求使用者分類 (新使用者/探索中/回訪者)，並傳回建議方塊 (繼續工作階段、繼續工作或開始新工作)，在傳送任何訊息前顯示。
get	GET /v1beta/{name=projects/*/locations/*/apps/*} 取得指定應用程式的詳細資料。
getExtendedAgentCard	GET /v1beta/{tenant=projects/*/locations/*/apps/*}/extendedAgentCard 取得已驗證代理的擴充代理資訊卡。
importApp	POST /v1beta/{parent=projects/*/locations/*}/apps:importApp 匯入指定的應用程式。
importEvaluations	POST /v1beta/{parent=projects/*/locations/*/apps/*}:importEvaluations 將評估結果匯入應用程式。
list	GET /v1beta/{parent=projects/*/locations/*}/apps 列出指定專案和位置中的應用程式。
patch	PATCH /v1beta/{app.name=projects/*/locations/*/apps/*} 更新指定的應用程式。
retrieveToolSchema	POST /v1beta/{parent=projects/*/locations/*/apps/*}:retrieveToolSchema 擷取指定工具的結構定義。
runAssistant	POST /v1beta/{app=projects/*/locations/*/apps/*}:runAssistant 為指定的助理工作階段執行助理代理。
runEvaluation	POST /v1beta/{app=projects/*/locations/*/apps/*}:runEvaluation 執行應用程式評估作業。
testPersonaVoice	POST /v1beta/{app=projects/*/locations/*/apps/*}:testPersonaVoice 測試角色的語音。

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

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

REST 資源：v1beta.projects.locations.apps.assistantSessions

方法
cancelAssistantTurn	POST /v1beta/{name=projects/*/locations/*/apps/*/assistantSessions/*}:cancelAssistantTurn 取消 Google 助理工作階段的進行中回合 (如有)：使用者明確停止與任何串流分離的回合。
create	POST /v1beta/{parent=projects/*/locations/*/apps/*}/assistantSessions 在指定應用程式中建立新的助理工作階段。
delete	DELETE /v1beta/{name=projects/*/locations/*/apps/*/assistantSessions/*} 刪除指定的助理工作階段。
get	GET /v1beta/{name=projects/*/locations/*/apps/*/assistantSessions/*} 取得指定助理工作階段的詳細資料。
list	GET /v1beta/{parent=projects/*/locations/*/apps/*}/assistantSessions 列出指定應用程式中的所有助理工作階段。
streamChatAiAssistant	POST /v1beta/{name=projects/*/locations/*/apps/*/assistantSessions/*}:streamChatAiAssistant 以串流方式為指定助理工作階段執行 AI 助理 Arc。

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

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

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

方法
batchDelete	POST /v1beta/{parent=projects/*/locations/*/apps/*}/conversations:batchDelete 批次刪除指定對話。
delete	DELETE /v1beta/{name=projects/*/locations/*/apps/*/conversations/*} 刪除指定對話。
generateEvaluation	POST /v1beta/{conversation=projects/*/locations/*/apps/*/conversations/*}:generateEvaluation 根據對話建立黃金評估。
get	GET /v1beta/{name=projects/*/locations/*/apps/*/conversations/*} 取得指定對話的詳細資料。
list	GET /v1beta/{parent=projects/*/locations/*/apps/*}/conversations 列出指定應用程式中的對話。

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

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

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

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

REST 資源：v1beta.projects.locations.apps.evaluationDatasets

方法
create	POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationDatasets 建立評估資料集。
delete	DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationDatasets/*} 刪除評估資料集。
get	GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationDatasets/*} 取得指定評估資料集的詳細資料。
list	GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationDatasets 列出指定應用程式中的所有評估資料集。
patch	PATCH /v1beta/{evaluationDataset.name=projects/*/locations/*/apps/*/evaluationDatasets/*} 更新評估資料集。

REST 資源：v1beta.projects.locations.apps.evaluationExpectations

方法
create	POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationExpectations 建立評估預期。
delete	DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationExpectations/*} 刪除評估預期。
get	GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationExpectations/*} 取得指定評估預期結果的詳細資料。
list	GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationExpectations 列出指定應用程式中的所有評估預期。
patch	PATCH /v1beta/{evaluationExpectation.name=projects/*/locations/*/apps/*/evaluationExpectations/*} 更新評估預期。

REST 資源：v1beta.projects.locations.apps.evaluationRuns

方法
delete	DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationRuns/*} 刪除評估執行作業。
export	POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationRuns:export 匯出評估執行作業。
get	GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationRuns/*} 取得指定評估執行的詳細資料。
list	GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationRuns 列出指定應用程式中的所有評估執行作業。

REST 資源：v1beta.projects.locations.apps.evaluations

方法
create	POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations 建立評估作業。
delete	DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*} 刪除評估作業。
export	POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations:export 匯出評估結果。
get	GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*} 取得指定評估作業的詳細資料。
list	GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations 列出指定應用程式中的所有評估。
patch	PATCH /v1beta/{evaluation.name=projects/*/locations/*/apps/*/evaluations/*} 更新評估作業。
uploadEvaluationAudio	POST /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}:uploadEvaluationAudio 上傳要用於黃金評估的音訊。

REST 資源：v1beta.projects.locations.apps.evaluations.results

方法
delete	DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*} 刪除評估結果。
export	POST /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results:export 匯出評估結果。
get	GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*} 取得指定評估結果的詳細資料。
list	GET /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results 列出指定評估作業的所有評估結果。
runEvaluationResultMetrics	POST /v1beta/{evaluationResultId=projects/*/locations/*/apps/*/evaluations/*/results/*}:runEvaluationResultMetrics 針對現有評估結果執行指標。

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

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

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

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

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

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

REST 資源：v1beta.projects.locations.apps.scheduledEvaluationRuns

方法
create	POST /v1beta/{parent=projects/*/locations/*/apps/*}/scheduledEvaluationRuns 建立排定的評估執行作業。
delete	DELETE /v1beta/{name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*} 刪除排定的評估作業。
get	GET /v1beta/{name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*} 取得指定排定評估執行的詳細資料。
list	GET /v1beta/{parent=projects/*/locations/*/apps/*}/scheduledEvaluationRuns 列出指定應用程式中所有排定的評估執行作業。
patch	PATCH /v1beta/{scheduledEvaluationRun.name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*} 更新排定的評估執行作業。

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

方法
generateChatToken	POST /v1beta/{name=projects/*/locations/*/apps/*/sessions/*}:generateChatToken 產生聊天小工具的工作階段範圍權杖，以便向 Session API 進行驗證。
runSession	POST /v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:runSession 在工作階段中，與 CES 代理啟動單一回合互動。
streamRunSession	POST /v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:streamRunSession 與 CES 代理啟動單一回合互動。

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

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

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

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

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

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

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

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

REST 資源：v1beta.projects.locations.operations

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