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
导出指定的应用。
generateOnboardingSuggestions POST /v1/{name=projects/*/locations/*/apps/*}:generateOnboardingSuggestions
为 Arc 零状态生成个性化新手入门建议:根据请求用户在应用中的助理会话记录对其进行分类(新用户/探索用户/回访用户),并返回建议内容信息条(恢复会话、继续工作或开始新任务),以便在发送任何消息之前呈现。
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.assistantSessions

方法
cancelAssistantTurn POST /v1/{name=projects/*/locations/*/apps/*/assistantSessions/*}:cancelAssistantTurn
取消 Google 助理会话的正在进行的轮次(如有):用户明确停止与任何数据流分离运行的轮次。
streamChatAiAssistant POST /v1/{name=projects/*/locations/*/apps/*/assistantSessions/*}:streamChatAiAssistant
以流式传输的方式为指定的助理会话运行 AI 助理 Arc。

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
为聊天微件生成会话级令牌,以便向会话 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
列出与请求中指定的过滤条件匹配的操作。