Gemini Enterprise for Customer Experience API

服务：ces.googleapis.com

如要调用此服务，我们建议您使用 Google 提供的客户端库。如果您的应用需要使用您自己的库来调用此服务，则在发出 API 请求时应使用以下信息。

发现文档

发现文档是用于说明和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。此服务提供了以下发现文档：

服务端点

服务端点是指定 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

方法
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
生成特定资源（例如
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
检索给定工具的架构。
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.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
为聊天 widget 生成会话范围的令牌，以便通过会话 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
列出与请求中指定的过滤条件匹配的操作。