Questo documento descrive come autenticarsi in Vertex AI Search per il retail in modo programmatico. Il modo in cui eseguire l'autenticazione in Vertex AI Search for Retail dipende dall'interfaccia che utilizzi per accedere all'API e dall'ambiente in cui viene eseguito il codice.
Per ulteriori informazioni sull'autenticazione di Google Cloud, consulta la panoramica dell'autenticazione.
Accesso API
Vertex AI Search for Retail supporta l'accesso programmatico. Puoi accedere all'API nei seguenti modi:
Librerie client
Le librerie client di Vertex AI Search per il retail forniscono il supporto di linguaggi di alto livello per l'autenticazione in Vertex AI Search per il retail in modo programmatico. Per autenticare le chiamate alle API Google Cloud, le librerie client supportano le credenziali predefinite dell'applicazione (ADC). Le librerie cercano le credenziali in un insieme di posizioni definite e le utilizzano per autenticare le richieste all'API. Con ADC, puoi mettere a disposizione della tua applicazione le credenziali in una serie di ambienti, come lo sviluppo locale o la produzione, senza dover modificare il codice dell'applicazione.
REST
Puoi autenticarti nell'API Vertex AI Search for Retail utilizzando le credenziali dell'interfaccia a riga della gcloud CLI o le credenziali predefinite dell'applicazione. Per ulteriori informazioni sull'autenticazione per le richieste REST, consulta Eseguire l'autenticazione per l'utilizzo di REST. Per informazioni sui tipi di credenziali, consulta Credenziali dell'interfaccia a riga di comando gcloud e credenziali ADC.
Chiavi API
Le chiavi API consentono di associare una chiamata API a un progetto, che viene utilizzato a fini di fatturazione e di quota, senza determinare l'identità dell'utente che effettua la chiamata. Le chiavi API possono essere utilizzate solo con i metodi API che supportano le chiavi API.
Vertex AI Search per il retail supporta le chiavi API per i seguenti metodi API:
userEvents.collect
Per ulteriori informazioni sull'utilizzo delle chiavi API con Vertex AI Search for Retail, consulta Creare una chiave API. Per informazioni generali sull'utilizzo delle chiavi API, consulta Eseguire l'autenticazione utilizzando le chiavi API.
Credenziali utente e ADC per Vertex AI Search per il retail
Un modo per fornire le credenziali all'ADC è utilizzare la gcloud CLI per inserire le tue credenziali utente in un file delle credenziali. Questo file viene inserito nel file system locale dove può trovarlo ADC, che utilizza poi le credenziali utente fornite per autenticare le richieste. Questo metodo viene spesso utilizzato per lo sviluppo locale.
Se utilizzi questo metodo, potresti riscontrare un errore di autenticazione quando provi a eseguire l'autenticazione in Vertex AI Search per il retail. Per ulteriori informazioni su questo errore e su come risolverlo, consulta Credenziali utente non funzionanti.
Configurare l'autenticazione per Vertex AI Search for Retail
La configurazione dell'autenticazione dipende dall'ambiente in cui viene eseguito il codice.
Le seguenti opzioni per la configurazione dell'autenticazione sono le più utilizzate. Per altre opzioni e informazioni sull'autenticazione, consulta Metodi di autenticazione.
Prima di completare queste istruzioni, devi completare la configurazione di base di Vertex AI Search per la vendita al dettaglio, come descritto in Prima di iniziare.
Per un ambiente di sviluppo locale
Puoi configurare le credenziali per un ambiente di sviluppo locale nei seguenti modi:
- Credenziali utente per librerie client o strumenti di terze parti
- Credenziali utente per le richieste REST dalla riga di comando
Librerie client o strumenti di terze parti
Configura le credenziali predefinite dell'applicazione (ADC) nel tuo ambiente locale:
-
Install the Google Cloud CLI, then initialize it by running the following command:
gcloud init
-
If you're using a local shell, then create local authentication credentials for your user account:
gcloud auth application-default login
You don't need to do this if you're using Cloud Shell.
Viene visualizzata una schermata di accesso. Dopo l'accesso, le credenziali vengono memorizzate nel file delle credenziali locali utilizzato da ADC.
Per ulteriori informazioni sull'utilizzo di ADC in un ambiente locale, consulta Ambiente di sviluppo locale.
Richieste REST dalla riga di comando
Quando effettui una richiesta REST dalla riga di comando,
puoi utilizzare le tue credenziali gcloud CLI includendo
gcloud auth print-access-token
nel comando che invia la richiesta.
L'esempio seguente elenca gli account di servizio per il progetto specificato. Puoi utilizzare lo stesso schema per qualsiasi richiesta REST.
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: l'ID del tuo progetto Google Cloud.
Per inviare la richiesta, espandi una di queste opzioni:
Per ulteriori informazioni sull'autenticazione tramite REST e gRPC, consulta Eseguire l'autenticazione per l'utilizzo di REST. Per informazioni sulla differenza tra le credenziali ADC locali e quelle dell'interfaccia a riga della gcloud CLI, consulta la sezione Configurazione dell'autenticazione dell'interfaccia a riga di comando gcloud e configurazione dell'ADC.
Su Google Cloud
Per autenticare un carico di lavoro in esecuzione su Google Cloud, utilizza le credenziali dell'account di servizio associato alla risorsa di calcolo in cui viene eseguito il codice, ad esempio un' istanza di macchina virtuale (VM) Compute Engine. Questo approccio è il metodo di autenticazione preferito per il codice in esecuzione su una risorsa di calcolo Google Cloud.
Per la maggior parte dei servizi, devi collegare l'account di servizio quando crei la risorsa che eseguirà il codice. Non puoi aggiungere o sostituire l'account di servizio in un secondo momento. Compute Engine è un'eccezione: ti consente di collegare un account di servizio a un'istanza VM in qualsiasi momento.
Utilizza gcloud CLI per creare un account di servizio e collegarlo alla risorsa:
-
Install the Google Cloud CLI, then initialize it by running the following command:
gcloud init
-
Set up authentication:
-
Create the service account:
gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
Replace
SERVICE_ACCOUNT_NAME
with a name for the service account. -
To provide access to your project and your resources, grant a role to the service account:
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" --role=ROLE
Replace the following:
SERVICE_ACCOUNT_NAME
: the name of the service accountPROJECT_ID
: the project ID where you created the service accountROLE
: the role to grant
- To grant another role to the service account, run the command as you did in the previous step.
-
Grant the required role to the principal that will attach the service account to other resources.
gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com --member="user:USER_EMAIL" --role=roles/iam.serviceAccountUser
Replace the following:
SERVICE_ACCOUNT_NAME
: the name of the service accountPROJECT_ID
: the project ID where you created the service accountUSER_EMAIL
: the email address for a Google Account
-
-
Crea la risorsa che eseguirà il codice e collega l'account di servizio a questa risorsa. Ad esempio, se utilizzi Compute Engine:
Create a Compute Engine instance. Configure the instance as follows:-
Sostituisci
INSTANCE_NAME
con il nome dell'istanza preferito. -
Imposta il flag
--zone
sulla zona in cui vuoi creare l'istanza. -
Imposta il flag
--service-account
sull'indirizzo email dell'account di servizio che hai creato.
gcloud compute instances create INSTANCE_NAME --zone=ZONE --service-account=SERVICE_ACCOUNT_EMAIL
-
Sostituisci
Per ulteriori informazioni sull'autenticazione alle API Google, consulta Metodi di autenticazione.
On-premise o su un altro provider cloud
Il metodo preferito per configurare l'autenticazione dall'esterno di Google Cloud è utilizzare la federazione delle identità per i carichi di lavoro. Per ulteriori informazioni, consulta On-premise o un altro fornitore cloud nella documentazione sull'autenticazione.
Controllo dell'accesso per Vertex AI Search per il retail
Dopo aver eseguito l'autenticazione in Vertex AI Search for Retail, devi disporre dell'autorizzazione per accedere alle risorse Google Cloud. Vertex AI Search per il retail utilizza Identity and Access Management (IAM) per l'autorizzazione.
Per ulteriori informazioni sui ruoli di Vertex AI Search per la vendita al dettaglio, consulta Identity and Access Management (IAM). Per ulteriori informazioni su IAM e sull'autorizzazione, consulta la panoramica di IAM.
Passaggi successivi
- Scopri di più sui metodi di autenticazione di Google Cloud.
- Consulta un elenco di casi d'uso dell'autenticazione.