Retail diganti namanya menjadi Vertex AI Search untuk retail. Kami sedang dalam proses memperbarui konten untuk mencerminkan branding baru ini.

Halaman ini diterjemahkan oleh Cloud Translation API.

Melakukan autentikasi ke Vertex AI Search untuk retail

Dokumen ini menjelaskan cara melakukan autentikasi ke Vertex AI Search untuk retail secara terprogram. Cara Anda melakukan autentikasi ke Vertex AI Search untuk retail bergantung pada antarmuka yang Anda gunakan untuk mengakses API dan lingkungan tempat kode Anda dijalankan.

Untuk mengetahui informasi selengkapnya tentang autentikasi Google Cloud, lihat ringkasan autentikasi.

Akses API

Vertex AI Search untuk retail mendukung akses terprogram. Anda dapat mengakses API di cara berikut:

Library klien
REST

Library klien

Vertex AI Search untuk library klien retail dukungan bahasa tingkat tinggi untuk autentikasi ke Vertex AI Search untuk retail secara terprogram. Untuk mengautentikasi panggilan ke Google Cloud API, library klien mendukung Kredensial Default Aplikasi (ADC); library akan mencari kredensial di satu set lokasi yang ditentukan dan menggunakan kredensial tersebut untuk mengautentikasi permintaan ke API. Dengan ADC, Anda dapat membuat yang tersedia untuk aplikasi Anda di berbagai lingkungan, seperti lokal pengembangan atau produksi, tanpa perlu mengubah kode aplikasi.

REST

Anda dapat mengotentikasi ke Vertex AI Search for retail API menggunakan kredensial gcloud CLI atau Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya tentang autentikasi permintaan REST, silakan melihat Melakukan autentikasi untuk menggunakan REST. Untuk mengetahui informasi tentang jenis kredensial, silakan melihat kredensial ADC dan gcloud CLI.

Kunci API

Kunci API menyediakan cara untuk mengaitkan panggilan API dengan project, yang digunakan untuk penagihan dan kuota, tanpa menentukan identitas pemanggil. Kunci API hanya dapat digunakan dengan metode API yang mendukung Kunci API.

Vertex AI Search untuk retail mendukung kunci API untuk metode API berikut:

userEvents.collect

Untuk informasi selengkapnya tentang penggunaan kunci API dengan Vertex AI Search untuk retail, lihat Membuat kunci API. Untuk informasi umum tentang penggunaan kunci API, lihat Autentikasi menggunakan kunci API.

Kredensial pengguna dan ADC untuk Vertex AI Search untuk retail

Salah satu cara untuk memberikan kredensial ke ADC adalah menggunakan gcloud CLI untuk memasukkan kredensial pengguna Anda ke dalam file kredensial. File ini ditempatkan di sistem file lokal tempat ADC dapat menemukannya; ADC kemudian menggunakan kredensial pengguna yang disediakan untuk melakukan autentikasi permintaan. Metode ini sering digunakan untuk pengembangan lokal.

Jika Anda menggunakan metode ini, Anda mungkin mengalami kesalahan otentikasi ketika Anda mencoba melakukan autentikasi ke Vertex AI Search untuk retail. Untuk informasi selengkapnya tentang {i>error<i} ini dan bagaimana untuk mengatasinya, lihat Kredensial pengguna tidak berfungsi.

Menyiapkan autentikasi untuk Vertex AI Search untuk retail

Cara Anda menyiapkan autentikasi bergantung pada lingkungan tempat kode Anda berjalan.

Opsi untuk menyiapkan autentikasi berikut adalah yang paling umum digunakan. Untuk selengkapnya pilihan, dan informasi tentang otentikasi, lihat Metode autentikasi.

Sebelum menyelesaikan petunjuk ini, Anda harus menyelesaikan pengaturan dasar untuk Vertex AI Search untuk retail, seperti yang dijelaskan dalam Sebelum memulai.

Untuk lingkungan pengembangan lokal

Anda dapat menyiapkan kredensial untuk lingkungan pengembangan lokal dengan cara berikut:

Kredensial pengguna untuk library klien atau alat pihak ketiga
Kredensial pengguna untuk permintaan REST dari command line

Library klien atau alat pihak ketiga

Siapkan Kredensial Default Aplikasi (ADC) di lingkungan lokal Anda:

Instal Google Cloud CLI, lalu initialize dengan menjalankan perintah berikut:
```
gcloud init
```
Buat kredensial autentikasi lokal untuk Akun Google Anda:
```
gcloud auth application-default login
```
Catatan: Jika gcloud CLI menampilkan peringatan bahwa akun Anda tidak memiliki izin serviceusage.services.use, beberapa perintah gcloud CLI dan library klien mungkin tidak berfungsi. Minta administrator untuk memberi Anda peran IAM Consumer Service Usage (roles/serviceusage.serviceUsageConsumer), lalu jalankan perintah berikut:
```
gcloud auth application-default set-quota-project PROJECT_ID
```
Layar login akan muncul. Setelah login, kredensial Anda akan disimpan di file kredensial lokal yang digunakan oleh ADC.

Untuk mengetahui informasi selengkapnya tentang cara bekerja dengan ADC di lingkungan lokal, silakan melihat Lingkungan pengembangan lokal.

Permintaan REST dari command line

Saat membuat permintaan REST dari command line, Anda dapat menggunakan kredensial gcloud CLI dengan menyertakan gcloud auth print-access-token sebagai bagian dari perintah yang mengirimkan permintaan.

Contoh berikut mencantumkan akun layanan untuk project yang ditentukan. Anda dapat menggunakan pola yang sama untuk setiap permintaan REST.

Sebelum menggunakan salah satu data permintaan, buat penggantian berikut:

PROJECT_ID: project ID Google Cloud Anda.

Untuk mengirim permintaan, luaskan salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Jalankan perintah berikut:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: PROJECT_ID" \
     "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts"

PowerShell (Windows)

Jalankan perintah berikut:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "PROJECT_ID" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts" | Select-Object -Expand Content

Untuk mengetahui informasi selengkapnya tentang autentikasi menggunakan REST dan gRPC, lihat Mengautentikasi untuk menggunakan REST. Untuk mengetahui informasi tentang perbedaan antara kredensial ADC lokal dan kredensial gcloud CLI, lihat kredensial ADC dan gcloud CLI.

Di Google Cloud

Untuk mengautentikasi workload yang berjalan di Google Cloud, Anda menggunakan kredensial akun layanan yang dikaitkan ke resource komputasi tempat kode Anda dijalankan, seperti Instance virtual machine (VM) Compute Engine. Pendekatan ini adalah metode autentikasi yang direkomendasikan untuk kode yang berjalan di resource komputasi Google Cloud.

Untuk sebagian besar layanan, Anda harus memasang akun layanan saat membuat resource yang akan menjalankan kode Anda; Anda tidak dapat menambahkan atau mengganti akun layanan nanti. Compute Engine merupakan pengecualian—Anda dapat memasang akun layanan ke instance VM kapan saja.

Gunakan gcloud CLI untuk membuat akun layanan dan memasangnya ke resource Anda:

Instal Google Cloud CLI, lalu initialize dengan menjalankan perintah berikut:
```
gcloud init
```
Menyiapkan autentikasi:
1. Buat akun layanan:
```
gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
```
  Ganti SERVICE_ACCOUNT_NAME dengan nama untuk akun layanan.
2. Untuk memberikan akses ke project dan resource Anda, berikan peran ke akun layanan:
```
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" --role=ROLE
```
  Ganti kode berikut:
  - SERVICE_ACCOUNT_NAME: nama dari akun layanan.
  - PROJECT_ID: project ID dimana Anda membuat akun layanan
  - ROLE: peran yang akan diberikan
  Catatan: Flag --role memengaruhi resource mana saja yang dapat diakses oleh akun layanan dalam proyek Anda. Anda dapat mencabut peran ini atau memberikan peran tambahan di lain waktu. Dalam lingkungan produksi, jangan berikan peran Owner, Editor, atau Viewer. Sebagai gantinya, berikan peran standar atau peran khusus yang memenuhi kebutuhan Anda.
3. Untuk memberikan peran lain ke akun layanan, jalankan perintah seperti yang Anda lakukan di langkah sebelumnya.
4. Memberi Akun Google Anda peran yang memungkinkan Anda menggunakan peran akun layanan dan tambahkan akun layanan tersebut ke resource lain:
```
gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com --member="user:USER_EMAIL" --role=roles/iam.serviceAccountUser
```
  Ganti kode berikut:
  - SERVICE_ACCOUNT_NAME: nama dari akun layanan.
  - PROJECT_ID: project ID dimana Anda membuat akun layanan
  - USER_EMAIL: alamat email untuk Akun Google Anda
Buat resource yang akan menjalankan kode Anda, lalu instal akun layanan ke resource tersebut. Misalnya, jika Anda menggunakan Compute Engine:
Buat instance Compute Engine. Konfigurasikan instance sebagai berikut:
- Ganti INSTANCE_NAME dengan nama instance pilihan Anda.
- Tetapkan flag --zone ke zona tempat Anda ingin membuat instance.
- Tetapkan flag --service-account ke alamat email untuk akun layanan yang Anda buat.
```
gcloud compute instances create INSTANCE_NAME --zone=ZONE --service-account=SERVICE_ACCOUNT_EMAIL
```

Untuk informasi selengkapnya tentang mengautentikasi ke Google API, lihat Metode autentikasi.

Lokal atau di penyedia cloud lain

Metode yang direkomendasikan untuk menyiapkan autentikasi dari luar Google Cloud adalah menggunakan workload identity federation. Untuk mengetahui informasi selengkapnya, lihat Penyedia lokal atau penyedia cloud lainnya dalam dokumentasi autentikasi.

Kontrol akses Vertex AI Search untuk retail

Setelah melakukan autentikasi ke Vertex AI Search untuk retail, Anda harus diizinkan untuk mengakses akses terperinci ke resource Google Cloud tertentu. Vertex AI Search untuk penggunaan retail Identity and Access Management (IAM) untuk otorisasi.

Untuk informasi selengkapnya tentang peran Vertex AI Search untuk retail, lihat Identity and Access Management (IAM). Untuk mengetahui informasi selengkapnya tentang IAM dan otorisasi, lihat Ringkasan IAM.

Langkah berikutnya

Pelajari metode autentikasi Google Cloud.
Lihat daftar kasus penggunaan autentikasi.