Kurzanleitung zur Authentifizierung mit OAuth

Die einfachste Möglichkeit, sich bei der Gemini API zu authentifizieren, ist die Konfiguration eines API-Schlüssels. Eine entsprechende Anleitung finden Sie in der Kurzanleitung für die Gemini API. Wenn Sie eine strengere Zugriffssteuerung benötigen, können Sie stattdessen OAuth verwenden. In diesem Leitfaden erfährst du, wie du die Authentifizierung mit OAuth einrichtest.

In diesem Leitfaden wird ein vereinfachter Authentifizierungsansatz verwendet, der für eine Testumgebung geeignet ist. Für eine Produktionsumgebung sollten Sie sich über die Authentifizierung und Autorisierung informieren, bevor Sie die für Ihre Anwendung geeigneten Anmeldedaten auswählen.

Zielsetzungen

  • Cloud-Projekt für OAuth einrichten
  • „application-default-credentials“ einrichten
  • Anmeldedaten in Ihrem Programm verwalten, anstatt gcloud auth zu verwenden

Vorbereitung

Für diese Kurzanleitung benötigen Sie Folgendes:

Cloud-Projekt einrichten

Für diese Kurzanleitung müssen Sie zuerst Ihr Cloud-Projekt einrichten.

1. API aktivieren

Bevor Sie Google APIs verwenden können, müssen Sie sie in einem Google Cloud-Projekt aktivieren.

  • Aktivieren Sie in der Google Cloud Console die Google Generative Language API.

    API aktivieren

2. OAuth-Zustimmungsbildschirm konfigurieren

Konfigurieren Sie als Nächstes den OAuth-Zustimmungsbildschirm des Projekts und fügen Sie sich als Testnutzer hinzu. Wenn Sie diesen Schritt für Ihr Cloud-Projekt bereits ausgeführt haben, fahren Sie mit dem nächsten Abschnitt fort.

  1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü > APIs und Dienste > OAuth-Zustimmungsbildschirm.

    Zum OAuth-Zustimmungsbildschirm

  2. Wählen Sie den Nutzertyp Extern für Ihre Anwendung aus und klicken Sie auf Erstellen.

  3. Füllen Sie das Formular zur Anwendungsregistrierung aus (die meisten Felder können leer bleiben) und klicken Sie dann auf Speichern und fortfahren.

  4. Sie können das Hinzufügen von Bereichen vorerst überspringen und auf Speichern und fortfahren klicken. Wenn Sie in Zukunft eine App für die Verwendung außerhalb Ihrer Google Workspace-Organisation erstellen, müssen Sie die erforderlichen Autorisierungsbereiche hinzufügen und bestätigen.

  5. Testnutzer hinzufügen:

    1. Klicken Sie unter Testnutzer auf Nutzer hinzufügen.
    2. Geben Sie Ihre E-Mail-Adresse und alle anderen autorisierten Testnutzer ein und klicken Sie dann auf Speichern und fortfahren.
  6. Sehen Sie sich die Zusammenfassung der App-Registrierung an. Wenn Sie Änderungen vornehmen möchten, klicken Sie auf Bearbeiten. Wenn die App-Registrierung in Ordnung ist, klicken Sie auf Zurück zum Dashboard.

3. Anmeldedaten für eine Desktopanwendung autorisieren

Für die Authentifizierung als Endnutzer und für den Zugriff auf Nutzerdaten in Ihrer Anwendung müssen Sie mindestens eine OAuth 2.0-Client-ID erstellen. Eine Client-ID wird zur Identifizierung einer einzelnen Anwendung bei Googles OAuth-Servern verwendet. Wenn Ihre Anwendung auf mehreren Plattformen ausgeführt wird, müssen Sie für jede Plattform eine separate Client-ID erstellen.

  1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü > APIs und Dienste > Anmeldedaten.

    Zu „Anmeldedaten“

  2. Klicken Sie auf Anmeldedaten erstellen > OAuth-Client-ID.

  3. Klicken Sie auf Anwendungstyp > Desktop-App.

  4. Geben Sie im Feld Name einen Namen für die Anmeldedaten ein. Dieser Name wird nur in der Google Cloud Console angezeigt.

  5. Klicken Sie auf Erstellen. Der Bildschirm „OAuth-Client erstellt“ wird angezeigt. Darauf sind Ihre neue Client-ID und Ihr Clientschlüssel zu sehen.

  6. Klicken Sie auf OK. Die neu erstellten Anmeldedaten werden unter OAuth 2.0-Client-IDs angezeigt.

  7. Klicken Sie auf die Schaltfläche „Herunterladen“, um die JSON-Datei zu speichern. Sie wird als client_secret_<identifier>.json gespeichert. Benennen Sie sie in client_secret.json um und verschieben Sie sie in Ihr Arbeitsverzeichnis.

Standardanmeldedaten für Anwendungen einrichten

Wenn Sie die client_secret.json-Datei in verwendbare Anmeldedaten konvertieren möchten, geben Sie den Speicherort als --client-id-file-Argument des gcloud auth application-default login-Befehls an.

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'

Die vereinfachte Projekteinrichtung in dieser Anleitung löst das Dialogfeld Diese App wurde von Google nicht überprüft aus. Das ist normal. Wählen Sie Weiter aus.

Dadurch wird das resultierende Token an einem bekannten Speicherort abgelegt, sodass gcloud oder die Clientbibliotheken darauf zugreifen können.

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'

Nachdem Sie die Standardanmeldedaten für Anwendungen festgelegt haben, können die Clientbibliotheken in den meisten Sprachen diese mit minimaler oder gar keiner Hilfe finden.

Curl

Am schnellsten lässt sich das mit curl testen:

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 sollten sie von den Clientbibliotheken automatisch gefunden werden:

pip install google-generativeai

Hier ist ein minimales Skript zum Testen:

import google.generativeai as genai

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

Nächste Schritte

Wenn das funktioniert, können Sie jetzt das semantische Abrufen von Textdaten ausprobieren.

Anmeldedaten selbst verwalten [Python]

In vielen Fällen steht Ihnen der Befehl gcloud nicht zur Verfügung, um das Zugriffstoken über die Client-ID (client_secret.json) zu erstellen. Google stellt Bibliotheken in vielen Sprachen zur Verfügung, damit Sie diesen Prozess in Ihrer Anwendung verwalten können. In diesem Abschnitt wird der Prozess in Python beschrieben. Entsprechende Beispiele für diese Art von Verfahren für andere Sprachen finden Sie in der Drive API-Dokumentation.

1. Erforderliche Bibliotheken installieren

Installieren Sie die Google-Clientbibliothek für Python und die Gemini-Clientbibliothek.

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

2. Anmeldedaten-Manager schreiben

Damit Sie nicht so oft durch die Autorisierungsbildschirme klicken müssen, erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei namens load_creds.py, um eine token.json-Datei im Cache zu speichern, die später wiederverwendet oder aktualisiert werden kann, wenn sie abläuft.

Beginnen Sie mit dem folgenden Code, um die Datei client_secret.json in ein Token zu konvertieren, das mit genai.configure verwendet werden kann:

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. Programm schreiben

Erstellen Sie jetzt Ihr 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. Programm ausführen

Führen Sie das Beispiel in Ihrem Arbeitsverzeichnis aus:

python script.py

Wenn Sie das Script zum ersten Mal ausführen, wird ein Browserfenster geöffnet und Sie werden aufgefordert, den Zugriff zu autorisieren.

  1. Wenn Sie noch nicht in Ihrem Google-Konto angemeldet sind, werden Sie aufgefordert, sich anzumelden. Wenn Sie in mehreren Konten angemeldet sind, wählen Sie unbedingt das Konto aus, das Sie beim Konfigurieren des Projekts als „Testkonto“ festgelegt haben.

  2. Da Autorisierungsinformationen im Dateisystem gespeichert sind, werden Sie bei der nächsten Ausführung des Beispielcodes nicht zur Autorisierung aufgefordert.

Sie haben die Authentifizierung erfolgreich eingerichtet.