Data Analytics API with Gemini

借助 Gemini 的 Data Analytics API (geminidataanalytics.googleapis.com),您可以使用自然语言查询和分析数据,还可以创建和管理与受支持数据源中的数据互动的数据智能体。

此服务处于预览状态,受正式发布前产品条款约束。开发者应根据稳定性要求选择合适的端点路径:

  • v1beta:建议在预览期间集成到生产环境中。
  • v1alpha:用于测试抢先体验功能。这些功能可能会发生变化或被移除,因此可能需要更新您的代码。

详细了解 Google Cloud 产品发布阶段

如需详细的实施指南,请参阅 对话式分析 API 概览

服务:geminidataanalytics.googleapis.com

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

发现文档

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

服务端点

服务端点是指定 API 服务的网络地址的基本网址。一项服务可能有多个服务端点。此服务具有以下服务端点,下面的所有 URI 都与此服务端点相关:

  • https://geminidataanalytics.googleapis.com

REST 资源:v1beta.a2a.projects.locations.dataAgents.v1

方法
getCard GET /v1beta/a2a/{tenant=projects/*/locations/*/dataAgents/*}/v1/card
GetAgentCard 会返回代理的代理卡片。

REST 资源:v1beta.a2a.projects.locations.dataAgents.v1.message

方法
send POST /v1beta/a2a/{tenant=projects/*/locations/*/dataAgents/*}/v1/message:send
向代理发送消息。
stream POST /v1beta/a2a/{tenant=projects/*/locations/*/dataAgents/*}/v1/message:stream
SendStreamingMessage 是一种流式调用,它会返回任务更新事件流,直到任务处于中断或终止状态。

REST 资源:v1beta.projects.locations

方法
chat POST /v1beta/{parent=projects/*/locations/*}:chat
通过生成 Message 对象的数据流来回答数据问题。
get GET /v1beta/{name=projects/*/locations/*}
获取位置相关信息。
list GET /v1beta/{name=projects/*}/locations
列出有关此服务所支持位置的信息。
queryData POST /v1beta/{parent=projects/*/locations/*}:queryData
根据自然语言用户查询查询数据。

REST 资源:v1beta.projects.locations.conversations

方法
create POST /v1beta/{parent=projects/*/locations/*}/conversations
创建新对话以保留对话记录。
delete DELETE /v1beta/{name=projects/*/locations/*/conversations/*}
删除对话。
get GET /v1beta/{name=projects/*/locations/*/conversations/*}
使用对话 ID 和父级获取单个对话的详细信息。
list GET /v1beta/{parent=projects/*/locations/*}/conversations
列出给定父级的所有对话。

REST 资源:v1beta.projects.locations.conversations.messages

方法
list GET /v1beta/{parent=projects/*/locations/*/conversations/*}/messages
列出给定对话的所有消息。

REST 资源:v1beta.projects.locations.dataAgents

方法
create POST /v1beta/{parent=projects/*/locations/*}/dataAgents
在给定的项目和位置中创建新 DataAgent。
createSync POST /v1beta/{parent=projects/*/locations/*}/dataAgents:createSync
在给定的项目和位置中同步创建新 DataAgent。
delete DELETE /v1beta/{name=projects/*/locations/*/dataAgents/*}
删除单个 DataAgent。
deleteSync DELETE /v1beta/{name=projects/*/locations/*/dataAgents/*}:deleteSync
同步删除单个 DataAgent。
get GET /v1beta/{name=projects/*/locations/*/dataAgents/*}
获取单个 DataAgent 的详细信息。
getIamPolicy POST /v1beta/{resource=projects/*/locations/*/dataAgents/*}:getIamPolicy
获取 DataAgent 的 IAM 政策
list GET /v1beta/{parent=projects/*/locations/*}/dataAgents
列出给定项目和位置中的 DataAgent。
listAccessible GET /v1beta/{parent=projects/*/locations/*}/dataAgents:listAccessible
列出给定项目和位置中调用方可访问的 DataAgent。
patch PATCH /v1beta/{dataAgent.name=projects/*/locations/*/dataAgents/*}
更新单个 DataAgent 的参数。
setIamPolicy POST /v1beta/{resource=projects/*/locations/*/dataAgents/*}:setIamPolicy
为 DataAgent 设置 IAM 政策。
updateSync PATCH /v1beta/{dataAgent.name=projects/*/locations/*/dataAgents/*}:updateSync
同步更新单个 DataAgent 的参数。

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
列出与请求中指定的过滤条件匹配的操作。

REST 资源:v1alpha.projects.locations

方法
chat POST /v1alpha/{parent=projects/*/locations/*}:chat
通过生成 Message 对象的数据流来回答数据问题。
get GET /v1alpha/{name=projects/*/locations/*}
获取位置相关信息。
list GET /v1alpha/{name=projects/*}/locations
列出有关此服务所支持位置的信息。
queryData POST /v1alpha/{parent=projects/*/locations/*}:queryData
根据自然语言用户查询查询数据。

REST 资源:v1alpha.projects.locations.conversations

方法
create POST /v1alpha/{parent=projects/*/locations/*}/conversations
创建新对话以保留对话记录。
delete DELETE /v1alpha/{name=projects/*/locations/*/conversations/*}
删除对话。
get GET /v1alpha/{name=projects/*/locations/*/conversations/*}
使用对话 ID 和父级获取单个对话的详细信息。
list GET /v1alpha/{parent=projects/*/locations/*}/conversations
列出给定父级的所有对话。

REST 资源:v1alpha.projects.locations.conversations.messages

方法
list GET /v1alpha/{parent=projects/*/locations/*/conversations/*}/messages
列出给定对话的所有消息。

REST 资源:v1alpha.projects.locations.dataAgents

方法
create POST /v1alpha/{parent=projects/*/locations/*}/dataAgents
在给定的项目和位置中创建新 DataAgent。
createSync POST /v1alpha/{parent=projects/*/locations/*}/dataAgents:createSync
在给定的项目和位置中同步创建新 DataAgent。
delete DELETE /v1alpha/{name=projects/*/locations/*/dataAgents/*}
删除单个 DataAgent。
deleteSync DELETE /v1alpha/{name=projects/*/locations/*/dataAgents/*}:deleteSync
同步删除单个 DataAgent。
get GET /v1alpha/{name=projects/*/locations/*/dataAgents/*}
获取单个 DataAgent 的详细信息。
getIamPolicy POST /v1alpha/{resource=projects/*/locations/*/dataAgents/*}:getIamPolicy
获取 DataAgent 的 IAM 政策
list GET /v1alpha/{parent=projects/*/locations/*}/dataAgents
列出给定项目和位置中的 DataAgent。
listAccessible GET /v1alpha/{parent=projects/*/locations/*}/dataAgents:listAccessible
列出给定项目和位置中调用方可访问的 DataAgent。
patch PATCH /v1alpha/{dataAgent.name=projects/*/locations/*/dataAgents/*}
更新单个 DataAgent 的参数。
setIamPolicy POST /v1alpha/{resource=projects/*/locations/*/dataAgents/*}:setIamPolicy
为 DataAgent 设置 IAM 政策。
updateSync PATCH /v1alpha/{dataAgent.name=projects/*/locations/*/dataAgents/*}:updateSync
同步更新单个 DataAgent 的参数。

REST 资源:v1alpha.projects.locations.operations

方法
cancel POST /v1alpha/{name=projects/*/locations/*/operations/*}:cancel
对长时间运行的操作启动异步取消。
delete DELETE /v1alpha/{name=projects/*/locations/*/operations/*}
删除长时间运行的操作。
get GET /v1alpha/{name=projects/*/locations/*/operations/*}
获取长时间运行的操作的最新状态。
list GET /v1alpha/{name=projects/*/locations/*}/operations
列出与请求中指定的过滤条件匹配的操作。

REST 资源:v1.a2a.projects.locations.agents.v1

方法
getCard GET /v1/a2a/{tenant=projects/*/locations/*/agents/*}/v1/card
GetAgentCard 会返回代理的代理卡片。

REST 资源:v1.a2a.projects.locations.agents.v1.message

方法
send POST /v1/a2a/{tenant=projects/*/locations/*/agents/*}/v1/message:send
向代理发送消息。
stream POST /v1/a2a/{tenant=projects/*/locations/*/agents/*}/v1/message:stream
SendStreamingMessage 是一种流式调用,它会返回任务更新事件流,直到任务处于中断或终止状态。