L'Ancrage dans la recherche Google est désormais disponible. En savoir plus

Cette page a été traduite par l'API Cloud Translation.

Guide de démarrage rapide de l'authentification avec OAuth

Le moyen le plus simple d'authentifier une application auprès de l'API Gemini consiste à configurer une clé API, comme décrit dans le guide de démarrage rapide de l'API Gemini. Si vous avez besoin de contrôles d'accès plus stricts, vous pouvez utiliser OAuth à la place. Ce guide vous aidera à configurer l'authentification avec OAuth.

Ce guide utilise une approche d'authentification simplifiée adaptée à un environnement de test. Pour un environnement de production, découvrez l'authentification et l'autorisation avant de choisir les identifiants d'accès appropriés pour votre application.

Objectifs

Configurer votre projet cloud pour OAuth
Configurer application-default-credentials
Gérez les identifiants dans votre programme au lieu d'utiliser gcloud auth

Prérequis

Pour exécuter ce guide de démarrage rapide, vous avez besoin des éléments suivants :

Configurer votre projet cloud

Pour suivre ce guide de démarrage rapide, vous devez d'abord configurer votre projet Cloud.

1. Activer l'API

Avant d'utiliser les API Google, vous devez les activer dans un projet Google Cloud.

Dans la console Google Cloud, activez l'API Google Generative Language.

Activer l'API

2. Configurer l'écran d'autorisation OAuth

Configurez ensuite l'écran de consentement OAuth du projet, puis ajoutez-vous en tant qu'utilisateur test. Si vous avez déjà effectué cette étape pour votre projet Cloud, passez à la section suivante.

Dans la console Google Cloud, accédez à Menu > API et services > Écran de consentement OAuth.

Accéder à l'écran de consentement OAuth
Sélectionnez le type d'utilisateur Externe pour votre application, puis cliquez sur Créer.
Remplissez le formulaire d'enregistrement de l'application (vous pouvez laisser la plupart des champs vides), puis cliquez sur Enregistrer et continuer.
Pour l'instant, vous pouvez ignorer l'ajout de champs d'application et cliquer sur Enregistrer et continuer. À l'avenir, lorsque vous créerez une application à utiliser en dehors de votre organisation Google Workspace, vous devrez ajouter et valider les champs d'application d'autorisation requis par votre application.
Ajoutez des utilisateurs tests :
1. Sous Utilisateurs de test, cliquez sur Ajouter des utilisateurs.
2. Saisissez votre adresse e-mail et tout autre utilisateur de test autorisé, puis cliquez sur Save and Continue (Enregistrer et continuer).
Consultez le résumé de l'enregistrement de votre application. Pour y apporter des modifications, cliquez sur Modifier. Si l'enregistrement de l'application semble correct, cliquez sur Revenir au tableau de bord.

3. Autoriser des identifiants pour une application de bureau

Pour vous authentifier en tant qu'utilisateur final et accéder aux données utilisateur dans votre application, vous devez créer un ou plusieurs ID client OAuth 2.0. Un ID client sert à identifier une application unique auprès des serveurs OAuth de Google. Si votre application s'exécute sur plusieurs plates-formes, vous devez créer un ID client distinct pour chacune d'elles.

Dans la console Google Cloud, accédez à Menu > API et services > Identifiants.

Accéder à la page "Identifiants"
Cliquez sur Créer des identifiants > ID client OAuth.
Cliquez sur Type d'application > Application de bureau.
Dans le champ Nom, saisissez un nom pour l'identifiant. Ce nom n'apparaît que dans la console Google Cloud.
Cliquez sur Créer. L'écran "Client OAuth créé" s'affiche, avec votre nouvel ID client et votre nouveau code secret.
Cliquez sur OK. Les nouveaux identifiants s'affichent sous ID client OAuth 2.0.
Cliquez sur le bouton de téléchargement pour enregistrer le fichier JSON. Il sera enregistré sous le nom client_secret_<identifier>.json. Renommez-le client_secret.json et déplacez-le dans votre répertoire de travail.

Configurer les identifiants par défaut de l'application

Pour convertir le fichier client_secret.json en identifiants utilisables, transmettez son emplacement à l'argument --client-id-file de la commande 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 configuration simplifiée du projet dans ce tutoriel déclenche une boîte de dialogue Google n'a pas validé cette application. Cela est normal. Choisissez "Continuer".

Le jeton obtenu est placé dans un emplacement bien connu afin qu'il puisse être accessible par gcloud ou les bibliothèques clientes.

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'

Une fois les identifiants par défaut de l'application (ACD) définis, les bibliothèques clientes dans la plupart des langues n'ont besoin que d'une aide minimale pour les trouver.

Curl

Le moyen le plus rapide de vérifier que cela fonctionne consiste à l'utiliser pour accéder à l'API REST à l'aide de 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

En Python, les bibliothèques clientes devraient les trouver automatiquement :

pip install google-generativeai

Voici un script minimal pour le tester:

import google.generativeai as genai

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

Étapes suivantes

Si tout fonctionne, vous pouvez essayer la récupération sémantique sur vos données textuelles.

Gérer vous-même les identifiants [Python]

Dans de nombreux cas, la commande gcloud n'est pas disponible pour créer le jeton d'accès à partir de l'ID client (client_secret.json). Google fournit des bibliothèques dans de nombreux langages pour vous permettre de gérer ce processus dans votre application. Cette section présente le processus en Python. Des exemples équivalents de ce type de procédure, pour d'autres langues, sont disponibles dans la documentation de l'API Drive.

1. Installer les bibliothèques nécessaires

Installez la bibliothèque cliente Google pour Python et la bibliothèque cliente Gemini.

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

2. Écrire le Gestionnaire d'identifiants

Pour réduire le nombre de fois où vous devez cliquer sur les écrans d'autorisation, créez un fichier appelé load_creds.py dans votre répertoire de travail pour mettre en cache un fichier token.json qu'il pourra réutiliser ultérieurement ou actualiser s'il expire.

Commencez par le code suivant pour convertir le fichier client_secret.json en jeton utilisable avec 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. Écrire votre programme

Créez maintenant votre 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. Exécuter votre programme

Dans votre répertoire de travail, exécutez l'exemple :

python script.py

La première fois que vous exécutez le script, une fenêtre de navigateur s'ouvre et vous invite à autoriser l'accès.

Si vous n'êtes pas déjà connecté à votre compte Google, vous êtes invité à le faire. Si vous êtes connecté à plusieurs comptes, assurez-vous de sélectionner le compte que vous avez défini comme "Compte de test" lors de la configuration de votre projet.

Remarque :La configuration de projet simplifiée dans ce tutoriel déclenche une boîte de dialogue Google n'a pas validé cette application. Cela est normal. Choisissez Continuer.
Les informations d'autorisation sont stockées dans le système de fichiers. Par conséquent, la prochaine fois que vous exécuterez l'exemple de code, vous ne serez pas invité à autoriser l'opération.

Vous avez bien configuré l'authentification.