Penyiapan dan pembersihan

Panduan ini memberikan semua langkah-langkah penyiapan yang diperlukan untuk memulai CX Agent Studio. Panduan ini juga memberikan saran langkah-langkah pembersihan setelah mencoba atau menguji agen Anda.

Tentang the Google Cloud Console

Google Cloud Console (kunjungi dokumentasi, buka konsol) adalah UI web yang digunakan untuk menyediakan, mengonfigurasi, mengelola, dan memantau sistem yang menggunakan Google Cloud produk. Anda dapat menggunakan Google Cloud Console untuk menyiapkan dan mengelola resource CX Agent Studio.

Membuat project

Untuk menggunakan layanan yang disediakan oleh Google Cloud, Anda harus membuat project. Sebuah project akan mengorganisasikan semua resource Google Cloud Anda. Sebuah project terdiri dari sekumpulan kolaborator, API yang diaktifkan (dan resource lainnya), alat pemantauan, informasi penagihan, serta kontrol akses dan autentikasi. Anda dapat membuat satu project, atau membuat beberapa project dan menggunakannya untuk mengorganisasikan resource Google Cloud dalam hierarki resource. Saat membuat sebuah project, catat project ID dari project tersebut. ID ini dibutuhkan untuk membuat panggilan API. Untuk mengetahui informasi selengkapnya tentang project, baca dokumentasi Resource Manager.

Di Google Cloud konsol, pada halaman pemilih project, pilih atau buat Google Cloud project.

Peran yang diperlukan untuk memilih atau membuat project

  • Memilih project: Memilih project tidak memerlukan peran IAM tertentu Anda dapat memilih project mana pun yang telah diberi peran.
  • Membuat project: Untuk membuat project, Anda memerlukan peran Pembuat Project (roles/resourcemanager.projectCreator), yang berisi izin resourcemanager.projects.create. Pelajari cara memberikan peran.

Buka pemilih project

Aktifkan penagihan

Akun penagihan digunakan untuk menentukan yang membayar serangkaian resource, dan dapat ditautkan ke satu atau beberapa project. Penggunaan project ditagihkan ke akun penagihan tertaut. Dalam sebagian besar kasus, Anda mengonfigurasi penagihan saat membuat project. Untuk mengetahui informasi selengkapnya, baca dokumentasi Penagihan.

Pastikan penagihan diaktifkan untuk Google Cloud project Anda.

Mengaktifkan API

Anda harus mengaktifkan Gemini Enterprise for Customer Experience API untuk project Anda. Untuk informasi selengkapnya mengenai cara mengaktifkan API, baca dokumentasi Service Usage.

Aktifkan Gemini Enterprise for Customer Experience API.

Peran yang diperlukan untuk mengaktifkan API

Untuk mengaktifkan API, Anda memerlukan peran IAM Service Usage Admin (roles/serviceusage.serviceUsageAdmin), yang berisi izin serviceusage.services.enable. Pelajari cara memberikan peran.

Mengaktifkan API

Mengaktifkan log audit

Aktifkan log audit Akses Data untuk Gemini Enterprise for Customer Experience API di project Anda. Selain Versi, log audit membantu Anda melacak perubahan waktu desain di aplikasi agen CX Agent Studio yang terkait dengan project.

Instal dan lakukan inisialisasi pada Google Cloud CLI

Jika berencana menggunakan Gemini Enterprise for Customer Experience API, Anda perlu menginstal dan melakukan inisialisasi Google Cloud CLI. gcloud CLI merupakan serangkaian alat yang dapat Anda gunakan untuk mengelola resource dan aplikasi yang dihosting di Google Cloud.

Link berikut berisi petunjuk:

Instal Google Cloud CLI. Setelah penginstalan, lakukan inisialisasi Google Cloud CLI dengan menjalankan perintah berikut:

gcloud init

Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus terlebih dahulu login ke gcloud CLI dengan identitas gabungan Anda.

Siapkan kontrol akses dan autentikasi

Jika berencana menggunakan Gemini Enterprise for Customer Experience API, Anda perlu menyiapkan autentikasi. Setiap aplikasi klien menggunakan API harus diautentikasi dan diberi akses ke resources yang diminta. Bagian ini menjelaskan konsep autentikasi penting dan memberikan langkah-langkah untuk menyiapkannya. Untuk mengetahui informasi selengkapnya, lihat Google Cloud ringkasan autentikasi.

Autentikasi dengan akun pengguna

Akun pengguna adalah opsi autentikasi terbaik ketika mempelajari Gemini Enterprise for Customer Experience API dan untuk pengembangan lokal. Anda dapat memanfaatkan akun pengguna Anda untuk mengautentikasi eksekusi command line REST atau panggilan library klien.

Autentikasi akun pengguna command line REST

Untuk mengautentikasi panggilan command line REST, gunakan gcloud CLI. Perintah gcloud auth login membuat Anda login ke gcloud menggunakan akun pengguna Anda, yang harus dilakukan sebelum memanggil API. Perintah gcloud auth print-access-token digunakan diseluruh contoh command line REST pada dokumentasi ini untuk mengautentikasi panggilan REST.

Untuk membuat kredensial pengguna bagi lingkungan lokal Anda:

gcloud auth login

Autentikasi akun pengguna library klien

Untuk mengautentikasi panggilan library klien, Anda dapat menggunakan gcloud CLI. Perintah gcloud auth application-default login membuat Anda login ke gcloud untuk kredensial default aplikasi, menggunakan akun pengguna Anda yang harus dilakukan sebelum memanggil API. Perintah gcloud auth application-default set-quota-project harus digunakan untuk set project Anda untuk penagihan dan kuota yang terkait dengan panggilan API. Biasanya, project ini sama dengan project yang digunakan agen Anda, dan Anda memberikan ID project untuk project yang dibuat pada langkah-langkah di atas.

Variabel lingkungan GOOGLE_APPLICATION_CREDENTIALS tidak boleh ditetapkan, agar kredensial default aplikasi Anda dapat digunakan oleh library klien.

Untuk membuat kredensial default aplikasi untuk lingkungan lokal Anda:

gcloud auth application-default login
gcloud auth application-default set-quota-project PROJECT_ID

Autentikasi dengan akun layanan

Akun layanan memberikan kredensial untuk aplikasi, bukan untuk pengguna akhir. Akun layanan dimiliki oleh project, dan Anda dapat membuat banyak akun layanan untuk sebuah project. Untuk informasi selengkapnya, lihat:

Kontrol akses dengan peran

Saat principal (akun pengguna, akun layanan, dan sebagainya) memanggil API, Google Cloud mewajibkan principal memiliki izin yang sesuai. Anda dapat memberikan izin dengan memberikan peran ke akun utama. Untuk informasi selengkapnya, lihat ringkasan peran.

Jika Anda telah membuat project dengan menggunakan akun pengguna Anda, akun pengguna Anda memiliki Peran dasar pemilik untuk project tersebut. Peran ini memberikan akses untuk memanggil API apa pun untuk project. Namun, jika project dibuat dengan akun yang berbeda, Anda mungkin perlu memberi peran ke akun pengguna Anda sebelum Anda dapat memanggil API.

Menginstal library klien CX Agent Studio Agents

Untuk petunjuk download dan penginstalan library, lihat Library klien.

Pembersihan

Setelah menyiapkan dan mencoba atau menguji CX Agent Studio, sebaiknya Anda menghapus resources yang Anda buat:

  • Sebaiknya Anda menonaktifkan project .
  • Jika Anda memanggil gcloud auth login, tindakan ini akan menyimpan kredensial di direktori pengguna pada komputer Anda. Anda dapat menghapus kredensial ini dengan memanggil:
    gcloud auth revoke
  • Jika Anda memanggil gcloud auth application-default login, tindakan ini akan menyimpan kredensial di direktori pengguna pada komputer Anda. Anda dapat menghapus kredensial ini dengan memanggil:
    gcloud auth application-default revoke