Eseguire l'autenticazione in Vertex AI Agent Builder

Questo documento descrive come autenticarsi in Vertex AI Agent Builder in modo programmatico. Come che esegui l'autenticazione in Vertex AI Agent Builder dipende dall'interfaccia che utilizzi per accedere all'API e l'ambiente in cui viene eseguito il codice.

Per ulteriori informazioni sull'autenticazione di Google Cloud, consulta la panoramica dell'autenticazione.

Accesso API

Vertex AI Agent Builder supporta l'accesso programmatico. Puoi accedere all'API nei seguenti modi:

Librerie client

Le librerie client di Vertex AI Agent Builder forniscono supporto linguistico di alto livello per l'autenticazione in Vertex AI Agent Builder 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 rendere disponibili le credenziali per la tua applicazione in diversi ambienti, ad esempio di sviluppo locale o di produzione, senza dover modificare il codice dell'applicazione.

REST

Puoi autenticarti nell'API Vertex AI Agent Builder utilizzando le credenziali dell'interfaccia a riga di comando gcloud o le credenziali predefinite dell'applicazione. Per ulteriori informazioni sull'autenticazione per le richieste REST, consulta Esegui l'autenticazione per l'utilizzo di REST. Per informazioni sui tipi di credenziali, vedi Credenziali di gcloud CLI 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 Agent Builder supporta le chiavi API per i seguenti metodi API:

  • userEvents.Collect

Per ulteriori informazioni sull'utilizzo delle chiavi API con Vertex AI Agent Builder, consulta Crea una chiave API. Per informazioni generali sull'utilizzo delle chiavi API, consulta Eseguire l'autenticazione utilizzando le chiavi API.

Configurare l'autenticazione per Vertex AI Agent Builder

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 maggiori informazioni opzioni e informazioni sull'autenticazione, vedi Metodi di autenticazione.

Prima di completare queste istruzioni, devi completare la configurazione di base per Vertex AI Agent Builder, 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 le credenziali predefinite dell'applicazione (ADC) nel tuo ambiente locale:

  1. Install the Google Cloud CLI, then initialize it by running the following command: 

    gcloud init

  2. 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 aver eseguito l'accesso, le tue credenziali vengono memorizzate nella delle credenziali locali utilizzato da ADC.

Per ulteriori informazioni sull'utilizzo di ADC in un ambiente locale, vedi 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 schema 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 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 le credenziali di gcloud CLI, vedi Configurazione dell'autenticazione gcloud CLI e ADC.

Su Google Cloud

Per autenticare un carico di lavoro in esecuzione su Google Cloud, utilizza le credenziali del account di servizio collegato alla risorsa di computing su cui è in esecuzione il codice, ad esempio un dell'istanza di macchina virtuale (VM) Compute Engine. Questo approccio è il metodo di autenticazione preferito per il codice in esecuzione su un risorsa di computing di Google Cloud.

Per la maggior parte dei servizi, devi collegare l'account di servizio quando crei risorsa che eseguirà il codice; non puoi aggiungere o sostituire l'account di servizio in un secondo momento. Compute Engine è un'eccezione: consente di collegare un servizio a un'istanza VM in qualsiasi momento.

Utilizza gcloud CLI per creare un account di servizio e collegarlo alla risorsa:

  1. Install the Google Cloud CLI, then initialize it by running the following command: 

    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 a questa l'account di servizio risorsa. Ad esempio, se utilizzi Compute Engine:

    Create a Compute Engine instance. Configure the instance as follows:
    • Sostituisci INSTANCE_NAME con il tuo preferito del nome dell'istanza.
    • Imposta il flag --zone su zona in cui creare per 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 ulteriori informazioni sull'autenticazione nelle API di Google, vedi Metodi di autenticazione.

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, vedi On-premise o un altro cloud provider nella documentazione sull'autenticazione.

Controllo dell'accesso per Vertex AI Agent Builder

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

Per ulteriori informazioni sui ruoli di Vertex AI Agent Builder, consulta Controllo dell'accesso con IAM. Per ulteriori informazioni su IAM e autorizzazione, consulta Panoramica IAM.

Passaggi successivi