Developer dapat menggunakan Conversational Analytics API, yang diakses melalui geminidataanalytics.googleapis.com
, untuk membuat antarmuka chat atau agen data berteknologi kecerdasan buatan (AI) yang menjawab pertanyaan tentang data terstruktur di BigQuery, Looker, dan Looker Studio menggunakan bahasa alami. Dengan Conversational Analytics API, Anda memberikan informasi dan data bisnis ("konteks") kepada agen data Anda, serta akses ke alat seperti SQL, Python, dan library visualisasi. Respons agen ini ditampilkan kepada pengguna dan dapat dicatat oleh aplikasi klien, sehingga menciptakan pengalaman chat data yang lancar dan dapat diaudit.
Pelajari cara dan waktu Gemini untuk Google Cloud menggunakan data Anda.
Mulai menggunakan Conversational Analytics API
Untuk menyiapkan lingkungan dan mulai membuat serta berinteraksi dengan agen data menggunakan Conversational Analytics API, Anda dapat memulai dengan notebook Colaboratory untuk pengalaman yang dipandu atau mengikuti langkah-langkah di Penyiapan dan prasyarat untuk pengalaman yang dilakukan sendiri.
Notebook Colaboratory interaktif
Untuk panduan langkah demi langkah yang interaktif tentang cara menyiapkan lingkungan, membuat agen data, dan melakukan panggilan API, lihat notebook Colaboratory berikut:
- Notebook Colaboratory HTTP Conversational Analytics API
- Notebook Colaboratory Conversational Analytics API SDK
Penyiapan dan prasyarat
Sebelum Anda menggunakan API atau contoh, selesaikan langkah-langkah berikut:
- Mengaktifkan Conversational Analytics API: Menjelaskan prasyarat untuk mengaktifkan Conversational Analytics API.
- Memberikan peran dan izin IAM Conversational Analytics API: Menjelaskan peran IAM bawaan untuk mengelola akses ke agen data.
- Mengautentikasi dan menghubungkan ke sumber data dengan Conversational Analytics API: Memberikan petunjuk untuk mengautentikasi API dan mengonfigurasi koneksi ke data BigQuery, Looker, dan Looker Studio Anda.
Membangun dan berinteraksi dengan agen data
Setelah menyelesaikan langkah-langkah sebelumnya, gunakan Conversational Analytics API untuk membuat dan berinteraksi dengan agen data dengan mengikuti langkah-langkah berikut:
- Membangun agen data menggunakan HTTP: Memberikan contoh lengkap tentang cara membangun dan berinteraksi dengan agen data menggunakan permintaan HTTP langsung dengan Python.
- Membangun agen data menggunakan Python SDK: Memberikan contoh lengkap tentang cara membangun dan berinteraksi dengan agen data menggunakan Python SDK.
- Menulis petunjuk sistem yang efektif: Pelajari cara menyusun konten YAML untuk parameter
system_instruction
guna memandu perilaku agen dan meningkatkan akurasi respons. - Merender respons agen Conversational Analytics API sebagai visualisasi: Memberikan contoh pemrosesan spesifikasi diagram dari respons API dan merendernya sebagai visualisasi menggunakan Python SDK dan library Vega-Altair.
Operasi API utama
API ini menyediakan endpoint inti berikut untuk mengelola agen data dan percakapan:
Operasi | Metode HTTP | Endpoint | Deskripsi |
---|---|---|---|
Buat agen | POST |
/v1alpha/projects/*/locations/*/dataAgents |
Membuat agen data baru. |
Mendapatkan agen | GET |
/v1alpha/projects/*/locations/*/dataAgents/* |
Mengambil detail agen data tertentu. |
Memperbarui agen | PATCH |
/v1alpha/projects/*/locations/*/dataAgents/* |
Mengubah agen data yang ada. |
Mencantumkan agen | GET |
/v1alpha/projects/*/locations/*/dataAgents |
Mencantumkan agen data yang tersedia dalam project. |
Menghapus agen | DELETE |
/v1alpha/projects/*/locations/*/dataAgents/* |
Menghapus agen data. |
Buat percakapan | POST |
/v1alpha/projects/*/locations/*/conversations |
Memulai percakapan baru yang persisten. |
Memulai percakapan dengan menggunakan referensi percakapan | POST |
/v1alpha/projects/*/locations/*:chat |
Melanjutkan percakapan stateful dengan mengirim pesan chat yang mereferensikan percakapan yang ada dan konteks agen terkait. Untuk percakapan bolak-balik, Google Cloud menyimpan dan mengelola histori percakapan. |
Melakukan chat menggunakan referensi agen data | POST |
/v1alpha/projects/*/locations/*:chat |
Mengirim pesan chat stateless yang mereferensikan agen data tersimpan untuk konteks. Untuk percakapan multi-turn, aplikasi Anda harus mengelola dan menyediakan histori percakapan dengan setiap permintaan. |
Memulai percakapan dengan menggunakan konteks inline | POST |
/v1alpha/projects/*/locations/*:chat |
Mengirim pesan chat stateless dengan memberikan semua konteks langsung dalam permintaan, tanpa menggunakan agen data tersimpan. Untuk percakapan multi-turn, aplikasi Anda harus mengelola dan menyediakan histori percakapan dengan setiap permintaan. |
Mendapatkan percakapan | GET |
/v1alpha/projects/*/locations/*/conversations/* |
Mengambil detail percakapan tertentu. |
Membuat daftar percakapan | GET |
/v1alpha/projects/*/locations/*/conversations |
Mencantumkan percakapan dalam project tertentu. |
Mencantumkan pesan dalam percakapan | GET |
/v1alpha/projects/*/locations/*/conversations/*/messages |
Mencantumkan pesan dalam percakapan tertentu. |
Referensi tambahan
- Dokumentasi referensi Conversational Analytics API: Memberikan deskripsi mendetail tentang metode, endpoint, dan definisi jenis untuk struktur permintaan dan respons.