Autenticazione in Vertex AI Search for Retail

Questo documento descrive come eseguire l'autenticazione a Vertex AI Search per la vendita al dettaglio in modo programmatico. Il modo in cui esegui l'autenticazione in Vertex AI Search for Retail dipende dall'interfaccia utilizzata per accedere all'API e dall'ambiente su 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 for Retail forniscono supporto linguistico di alto livello per l'autenticazione in modo programmatico in Vertex AI Search for Retail. Per autenticare le chiamate alle API Google Cloud, le librerie client supportano le credenziali predefinite dell'applicazione (ADC). Le librerie cercano le credenziali in una serie di località definite e le utilizzano per autenticare le richieste all'API. Con ADC, puoi rendere disponibili le credenziali per la tua applicazione in diversi ambienti, come lo sviluppo o la produzione locale, senza dover modificare il codice dell'applicazione.

REST

Puoi autenticarti nell'API Vertex AI Search for Retail utilizzando le tue credenziali gcloud CLI o utilizzando Credenziali predefinite dell'applicazione. Per maggiori informazioni sull'autenticazione per le richieste REST, consulta 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 ai fini della fatturazione e della quota, senza determinare l'identità del chiamante. Le chiavi API possono essere utilizzate solo con metodi API che supportano le chiavi API.

Vertex AI Search for Retail supporta le chiavi API per i seguenti metodi API:

  • userEvents.collect

Per maggiori 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 Autenticazione tramite chiavi API.

Credenziali utente e ADC per Vertex AI Search for Retail

Un modo per fornire le credenziali ad ADC è utilizzare gcloud CLI per inserire le credenziali utente in un file di credenziali. Questo file viene inserito nel tuo file system locale dove ADC può trovarlo; ADC utilizza quindi 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 for Retail. Per maggiori informazioni su questo errore e su come risolverlo, consulta Credenziali utente non funzionanti.

Configura l'autenticazione per Vertex AI Search for Retail

La modalità di 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 ulteriori opzioni e informazioni sull'autenticazione, consulta la pagina Authentication at Google.

Prima di completare queste istruzioni, devi completare la configurazione di base di Vertex AI Search for Retail, 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:

Librerie client o strumenti di terze parti

Configura Credenziali predefinite dell'applicazione (ADC) nel tuo ambiente locale:

  1. Installa Google Cloud CLI, quindi initialize eseguendo questo comando:

    gcloud init
  2. Crea credenziali di autenticazione locali per il tuo Account Google:

    gcloud auth application-default login

    Viene visualizzata una schermata di accesso. Dopo aver eseguito l'accesso, le credenziali vengono archiviate 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 come parte del comando che invia la richiesta.

L'esempio seguente elenca gli account di servizio per il progetto specificato. Puoi utilizzare lo stesso pattern per qualsiasi richiesta REST.

Prima di utilizzare i dati della richiesta, effettua le seguenti sostituzioni:

  • PROJECT_ID: l'ID del tuo progetto Google Cloud.

Per inviare la richiesta, espandi una delle seguenti opzioni:

 

Per maggiori informazioni sull'autenticazione tramite REST e gRPC, consulta Autenticazione per l'utilizzo di REST. Per informazioni sulla differenza tra le credenziali ADC locali e le credenziali gcloud CLI, consulta Credenziali e credenziali ADC di gcloud CLI.

Su Google Cloud

Per autenticare un carico di lavoro in esecuzione su Google Cloud, devi utilizzare le credenziali dell'account di servizio collegato alla risorsa di computing su cui è in esecuzione il codice. Ad esempio, puoi collegare un account di servizio a un'istanza di macchina virtuale (VM) Compute Engine, a un servizio Cloud Run o a un job Dataflow. Questo approccio è il metodo di autenticazione preferito per il codice in esecuzione su una risorsa di computing Google Cloud.

Per la maggior parte dei servizi, devi collegare l'account di servizio quando crei la risorsa che eseguirà il codice. Non potrai aggiungere o sostituire l'account di servizio in un secondo momento. Compute Engine è un'eccezione: 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 tua risorsa:

  1. Installa Google Cloud CLI, quindi initialize eseguendo questo comando:

    gcloud init
  2. Set up authentication:

    1. Create the service account:

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      Replace SERVICE_ACCOUNT_NAME with a name for the service account.

    2. 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 account
      • PROJECT_ID: the project ID where you created the service account
      • ROLE: the role to grant
    3. To grant another role to the service account, run the command as you did in the previous step.
    4. 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 account
      • PROJECT_ID: the project ID where you created the service account
      • USER_EMAIL: the email address for a Google Account
  3. Crea la risorsa che eseguirà il codice e collega l'account di servizio alla risorsa. Ad esempio, se utilizzi Compute Engine:

    Crea un'istanza Compute Engine. Configura l'istanza come segue:
    • Sostituisci INSTANCE_NAME con il nome istanza che preferisci.
    • 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

Per maggiori informazioni sull'autenticazione nelle API di Google, consulta Autenticazione in Google.

On-premise o su un cloud provider diverso

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 cloud provider nella documentazione sull'autenticazione.

Controllo dell'accesso per Vertex AI Search for Retail

Dopo aver eseguito l'autenticazione a Vertex AI Search for Retail, devi disporre dell'autorizzazione per accedere alle risorse Google Cloud. Vertex AI Search for Retail utilizza Identity and Access Management (IAM) per l'autorizzazione.

Per maggiori informazioni sui ruoli per Vertex AI Search for Retail, consulta Identity and Access Management (IAM). Per ulteriori informazioni su IAM e autorizzazione, consulta la panoramica di IAM.

Passaggi successivi