開發人員可透過 geminidataanalytics.googleapis.com 存取 Conversational Analytics API,建構人工智慧 (AI) 技術輔助的聊天介面或資料代理。這項 API 會使用自然語言回答有關 BigQuery、Looker 和數據分析中結構化資料的問題,並透過新的 QueryData 方法,支援查詢 AlloyDB、GoogleSQL for Spanner、Cloud SQL 和 PostgreSQL 適用的 Cloud SQL 資料。透過 Conversational Analytics API,您可以為資料代理提供業務資訊和資料 (脈絡),以及 SQL、Python 和視覺化程式庫等工具的存取權。這些服務專員回覆會顯示給使用者,且可由用戶端應用程式記錄,打造流暢且可稽核的資料即時通訊體驗。
瞭解 Gemini for Google Cloud 如何使用您的資料。
開始使用 Conversational Analytics API
如要開始使用 Conversational Analytics API,請參閱下列說明文件,瞭解可用的整合方式和核心概念:
- 架構和重要概念:瞭解資料代理程式如何處理要求、代理程式建立者和使用者的工作流程、對話模式,以及必要的 Identity and Access Management (IAM) 角色。
- 資料代理程式的整合模式:比較架構方法,找出最適合應用程式的連線方式。
- 狀態管理:瞭解有狀態和無狀態的對話模式、API 管理對話記錄的方式,以及 ADK 工作階段狀態範圍。
如要開始建構資料代理程式,請完成設定和必要條件說明文件中的步驟。如需逐步導覽、範例應用程式、SDK 和其他開發工具,請參閱對話式 Analytics API 教學課程、操作示範和工具。
設定和必要條件
使用 API 或範例之前,請先完成下列步驟:
- 啟用 Conversational Analytics API:說明啟用 Conversational Analytics API 的先決條件。
- 使用 IAM 控管 Conversational Analytics API 的存取權:說明如何使用 Identity and Access Management 分享及管理資料代理程式的存取權。
使用 Conversational Analytics API 驗證及連線至資料來源:提供 API 驗證操作說明,以及如何設定與 BigQuery、Lakehouse、Looker、Data Studio 和 Cloud Databases 資料 (AlloyDB、GoogleSQL for Spanner、Cloud SQL 和 PostgreSQL 適用的 Cloud SQL) 的連線。
客戶自行管理的加密金鑰 (CMEK):說明如何在 Cloud Key Management Service 中使用自己的加密金鑰,保護使用 Looker 資料來源的資料代理程式和對話。
建構及使用資料代理
完成上述步驟後,請按照下列步驟,使用 Conversational Analytics API 建構資料代理程式並與之互動:
- 使用 HTTP 建構資料代理程式:提供完整範例,說明如何使用 Python 的直接 HTTP 要求,建構及與資料代理程式互動。
- 使用 Python SDK 建構資料代理程式:提供完整範例,說明如何使用 Python SDK 建構資料代理程式並與之互動。
- 使用撰寫的脈絡引導代理行為:瞭解如何提供撰寫的脈絡來引導代理行為,並提升回覆準確度。您也可以查看BigQuery 資料來源和 Looker 資料來源的撰寫脈絡範例。
- 將 Conversational Analytics API 代理程式的回應顯示為資料圖表:提供範例,說明如何使用 Python SDK 和 Vega-Altair 程式庫,處理 API 回應中的圖表規格,並將其顯示為資料圖表。
最佳做法
請參閱下列指南,瞭解使用對話式數據分析 API 的最佳做法:
- 管理代理程式的 BigQuery 費用:瞭解如何設定專案層級、使用者層級和查詢層級的支出上限,監控及管理 Conversational Analytics API 代理程式的 BigQuery 費用。
- 提出有效問題:瞭解如何為代理程式設計有效問題,充分運用 Conversational Analytics API。
- 資料保留與刪除:瞭解對話式 Analytics API 資料代理程式和對話的資料保留與刪除方式。
- 配額與限制:瞭解 Conversational Analytics API 的配額與限制。
- 排解對話式數據分析 API 錯誤:排解常見的對話式數據分析 API 錯誤。
- 已知限制:詳細說明 Conversational Analytics API 的已知限制,包括查詢、資料、視覺化和問題的限制。
- 為 Looker 資料來源算繪代理程式回覆:瞭解使用 Looker 資料來源時,在使用者介面中算繪 Conversational Analytics API 回覆的最佳做法。
API 參考資料和用戶端程式庫
- Gemini Data Analytics REST 參考資料:詳細說明 API 版本、方法、端點和型別定義。
- SDK 和開發工具:列出語言專屬的用戶端程式庫。
主要 API 作業
這個 API 提供下列核心端點,用於管理資料代理程式和對話:
| 作業 | HTTP 方法 | 端點 | 說明 |
|---|---|---|---|
| 建立虛擬服務專員 | POST |
/v1beta/projects/*/locations/*/dataAgents |
建立新的資料代理。 |
| 以同步方式建立代理程式 | POST |
/v1beta/projects/*/locations/*/dataAgents:createSync |
以同步方式建立新的資料代理。 |
| 取得代理程式 | GET |
/v1beta/projects/*/locations/*/dataAgents/* |
擷取特定資料代理程式的詳細資料。 |
| 取得 Identity and Access Management 政策 | POST |
/v1beta/projects/*/locations/*/dataAgents/*:getIamPolicy |
取得指派給特定資料代理程式的每個使用者身分與存取權管理權限。具有資料代理程式擁有者角色的使用者可以呼叫這個端點,在透過 setIAMpolicy 端點與其他使用者共用資料代理程式之前,先查看資料代理程式的身分與存取權管理政策。 |
| 設定身分與存取權管理政策 | POST |
/v1beta/projects/*/locations/*/dataAgents/*:setIamPolicy |
為特定資料代理程式設定身分與存取權管理政策。擁有資料代理程式擁有者角色的使用者應呼叫這個端點,與其他使用者共用資料代理程式,這會有效更新這些使用者的身分與存取權管理權限。 |
| 更新代理程式 | PATCH |
/v1beta/projects/*/locations/*/dataAgents/* |
修改現有資料代理程式。 |
| 同步更新代理程式 | PATCH |
/v1beta/projects/*/locations/*/dataAgents/*:updateSync |
以同步方式修改現有資料代理程式。 |
| 列出代理程式 | GET |
/v1beta/projects/*/locations/*/dataAgents |
列出專案中的可用資料代理程式。 |
| 列出可存取的代理程式 | GET |
/v1beta/projects/*/locations/*/dataAgents:listaccessible |
列出專案中可存取的資料代理程式。如果呼叫這項 API 的使用者對資料代理程式具有 get 權限,系統就會視為可存取該代理程式。您可以使用 creator_filter 欄位,管理這個方法傳回的代理:
|
| 刪除代理程式 | DELETE |
/v1beta/projects/*/locations/*/dataAgents/* |
移除資料代理程式。 |
| 同步刪除代理程式 | DELETE |
/v1beta/projects/*/locations/*/dataAgents/*:deleteSync |
同步移除資料代理程式。 |
| 建立對話 | POST |
/v1beta/projects/*/locations/*/conversations |
發起新的持續性對話。 |
| 使用對話參考資料聊天 | POST |
/v1beta/projects/*/locations/*:chat |
傳送參照現有對話及其相關聯代理脈絡的即時通訊訊息,繼續進行有狀態的對話。對於多輪對話, Google Cloud 會儲存及管理對話記錄。 |
| 使用資料代理參照進行即時通訊 | POST |
/v1beta/projects/*/locations/*:chat |
傳送無狀態的即時通訊訊息,並參照已儲存的資料代理程式來提供脈絡。如果是多輪對話,應用程式必須管理對話記錄,並在每次要求中提供對話記錄。 |
| 使用內嵌脈絡對話 | POST |
/v1beta/projects/*/locations/*:chat |
直接在要求中提供所有脈絡資訊,不使用已儲存的資料代理,傳送無狀態的即時通訊訊息。如果是多輪對話,應用程式必須管理並在每次要求中提供對話記錄。 |
| 取得對話 | GET |
/v1beta/projects/*/locations/*/conversations/* |
擷取特定對話的詳細資料。 |
| 列出對話 | GET |
/v1beta/projects/*/locations/*/conversations |
列出特定專案中的對話。 |
| 列出對話中的訊息 | GET |
/v1beta/projects/*/locations/*/conversations/*/messages |
列出特定對話中的訊息。 |
| 刪除對話 | DELETE |
/v1beta/projects/*/locations/*/conversations/* |
刪除特定對話。如要呼叫這個端點,您必須具備 主題管理員 Identity and Access Management 角色,或至少具備 cloudaicompanion.topics.delete Identity and Access Management 權限。
|
| 查詢資料 | POST |
/v1beta/projects/*/locations/*/conversations:queryData |
使用自然語言查詢 AlloyDB、GoogleSQL for Spanner、Cloud SQL 和 PostgreSQL 適用的 Cloud SQL 資料庫中的資料。 |
提供意見
請使用下列連結回報錯誤或要求功能。