Data Analytics API with Gemini

Data Analytics API with Gemini (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 是串流呼叫,會傳回工作更新事件串流,直到工作處於中斷或終止狀態為止。