Guida rapida all'autenticazione con OAuth

Il modo più semplice per autenticarsi all'API Gemini è configurare una chiave API, come descritto nella guida rapida dell'API Gemini. Se hai bisogno di controlli di accesso più rigidi, puoi utilizzare OAuth. Questa guida ti aiuterà a configurare l'autenticazione con OAuth.

Questa guida utilizza un approccio di autenticazione semplificato, appropriato per un ambiente di test. Per un ambiente di produzione, scopri di più su autenticazione e autorizzazione prima di scegliere le credenziali di accesso appropriate per la tua app.

Obiettivi

  • Configura il progetto cloud per OAuth
  • Configurare application-default-credentials
  • Gestire le credenziali nel tuo programma anziché utilizzare gcloud auth

Prerequisiti

Per eseguire questa guida rapida, hai bisogno di:

Configura il progetto cloud

Per completare questa guida rapida, devi prima configurare il tuo progetto Cloud.

1. Abilita l'API

Prima di utilizzare le API Google, devi attivarle in un progetto Google Cloud.

  • Nella console Google Cloud, abilita l'API di linguaggio generativo di Google.

    Attiva l'API

2. Configura la schermata per il consenso OAuth

A questo punto, configura la schermata per il consenso OAuth del progetto e aggiungiti come utente di test. Se hai già completato questo passaggio per il tuo progetto Cloud, vai alla sezione successiva.

  1. Nella console Google Cloud, vai a Menu > API e servizi > Schermata consenso OAuth.

    Vai alla schermata per il consenso OAuth

  2. Seleziona il tipo di utente Esterno per la tua app, quindi fai clic su Crea.

  3. Compila il modulo di registrazione dell'app (puoi lasciare la maggior parte dei campi vuoti) e poi fai clic su Salva e continua.

  4. Per il momento, puoi saltare l'aggiunta di ambiti e fare clic su Salva e continua. In futuro, quando crei un'app da utilizzare al di fuori della tua organizzazione Google Workspace, devi aggiungere e verificare gli ambiti di autorizzazione richiesti dalla tua app.

  5. Aggiungi utenti di test:

    1. In Utenti di test, fai clic su Aggiungi utenti.
    2. Inserisci il tuo indirizzo email e gli altri utenti di test autorizzati, quindi fai clic su Salva e continua.
  6. Rivedi il riepilogo della registrazione dell'app. Per apportare modifiche, fai clic su Modifica. Se la registrazione dell'app è a posto, fai clic su Torna alla dashboard.

3. Autorizzare le credenziali per un'applicazione desktop

Per eseguire l'autenticazione come utente finale e accedere ai dati utente nella tua app, devi creare uno o più ID client OAuth 2.0. L'ID client viene utilizzato per identificare una singola app nei server OAuth di Google. Se l'app viene eseguita su più piattaforme, devi creare un ID client separato per ogni piattaforma.

  1. Nella console Google Cloud, vai a Menu > API e servizi > Credenziali.

    Vai a Credenziali

  2. Fai clic su Crea credenziali > ID client OAuth.

  3. Fai clic su Tipo di applicazione > App desktop.

  4. Nel campo Nome, digita un nome per la credenziale. Questo nome viene visualizzato solo nella console Google Cloud.

  5. Fai clic su Crea. Viene visualizzata la schermata del client OAuth creato, che mostra il nuovo ID client e il nuovo client secret.

  6. Fai clic su OK. La credenziale appena creata viene visualizzata in ID client OAuth 2.0.

  7. Fai clic sul pulsante di download per salvare il file JSON. Verrà salvato come client_secret_<identifier>.json, rinominalo in client_secret.json e spostalo nella tua directory di lavoro.

Configura le credenziali predefinite dell'applicazione

Per convertire il file client_secret.json in credenziali utilizzabili, passa la sua posizione all'argomento --client-id-file del comando gcloud auth application-default login.

gcloud auth application-default login \
    --client-id-file=client_secret.json \
    --scopes='https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/generative-language.retriever'

La configurazione semplificata del progetto in questo tutorial attiva la finestra di dialogo "Google non ha verificato questa app". È normale, scegli "Continua".

Il token risultante viene posizionato in una posizione nota, in modo che possa essere accessibile da gcloud o dalle librerie client.

gcloud auth application-default login 
--no-browser --client-id-file=client_secret.json
--scopes='https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/generative-language.retriever'

Una volta impostate le credenziali predefinite dell'applicazione (ACD), le librerie client nella maggior parte delle lingue richiedono un'assistenza minima o nessuna per trovarle.

Curl

Il modo più rapido per verificare che tutto funzioni è usarlo per accedere all'API REST con curl:

access_token=$(gcloud auth application-default print-access-token)
project_id=<MY PROJECT ID>
curl -X GET https://generativelanguage.googleapis.com/v1/models \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer ${access_token}" \
    -H "x-goog-user-project: ${project_id}" | grep '"name"'

Python

In Python, le librerie client dovrebbero individuarle automaticamente:

pip install google-generativeai

Uno script minimo per testarlo potrebbe essere:

import google.generativeai as genai

print('Available base models:', [m.name for m in genai.list_models()])

Passaggi successivi

Se funziona, puoi provare il retrieval semantico sui tuoi dati di testo.

Gestire le credenziali autonomamente [Python]

In molti casi non avrai a disposizione il comando gcloud per creare il token di accesso dall'ID client (client_secret.json). Google fornisce librerie in molti linguaggi per consentirti di gestire questo processo all'interno della tua app. Questa sezione mostra il processo in Python. Esistono esempi equivalenti di questo tipo di procedura, per altri linguaggi, disponibili nella documentazione dell'API Drive.

1. Installa le librerie necessarie

Installa la libreria client di Google per Python e la libreria client di Gemini.

pip install --upgrade -q google-api-python-client google-auth-httplib2 google-auth-oauthlib
pip install google-generativeai

2. Scrivi il gestore delle credenziali

Per ridurre al minimo il numero di volte in cui devi fare clic sulle schermate di autorizzazione, crea un file denominato load_creds.py nella tua directory di lavoro per memorizzare nella cache un file token.json che può essere riutilizzato in un secondo momento o aggiornato se scade.

Inizia con il seguente codice per convertire il file client_secret.json in un token utilizzabile con genai.configure:

import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow

SCOPES = ['https://www.googleapis.com/auth/generative-language.retriever']

def load_creds():
    """Converts `client_secret.json` to a credential object.

    This function caches the generated tokens to minimize the use of the
    consent screen.
    """
    creds = None
    # The file token.json stores the user's access and refresh tokens, and is
    # created automatically when the authorization flow completes for the first
    # time.
    if os.path.exists('token.json'):
        creds = Credentials.from_authorized_user_file('token.json', SCOPES)
    # If there are no (valid) credentials available, let the user log in.
    if not creds or not creds.valid:
        if creds and creds.expired and creds.refresh_token:
            creds.refresh(Request())
        else:
            flow = InstalledAppFlow.from_client_secrets_file(
                'client_secret.json', SCOPES)
            creds = flow.run_local_server(port=0)
        # Save the credentials for the next run
        with open('token.json', 'w') as token:
            token.write(creds.to_json())
    return creds

3. Scrivi il tuo programma

Ora crea il tuo script.py:

import pprint
import google.generativeai as genai
from load_creds import load_creds

creds = load_creds()

genai.configure(credentials=creds)

print()
print('Available base models:', [m.name for m in genai.list_models()])

4. Esegui il programma

Nella directory di lavoro, esegui il sample:

python script.py

La prima volta che esegui lo script, si apre una finestra del browser e ti viene chiesto di autorizzare l'accesso.

  1. Se non hai ancora eseguito l'accesso al tuo Account Google, ti verrà chiesto di farlo. Se hai eseguito l'accesso a più account, assicurati di selezionare quello impostato come "Account di test" quando configuri il progetto.

  2. Le informazioni di autorizzazione vengono memorizzate nel file system, pertanto la volta successiva che esegui il codice di esempio non ti verrà richiesta l'autorizzazione.

L'autenticazione è stata configurata correttamente.