Kurzanleitung zur Authentifizierung mit OAuth

Mit der PaLM API können Sie Modelle auf Grundlage Ihrer eigenen Daten abstimmen. Da es sich um Ihre Daten und Ihre abgestimmten Modelle handelt, sind dafür strengere Zugriffssteuerungen erforderlich als API-Schlüssel.

In dieser Kurzanleitung 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 die Anwendung geeigneten Anmeldedaten auswählen.

Zielsetzungen

  • Cloud-Projekt für OAuth einrichten
  • Standardanmeldedaten für Anwendungen einrichten
  • Anmeldedaten in deinem Programm verwalten, anstatt gcloud auth zu verwenden

Voraussetzungen

Zum Ausführen dieser Kurzanleitung benötigen Sie:

Cloud-Projekt einrichten

Um diese Kurzanleitung ausführen zu können, 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

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

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

    Zum OAuth-Zustimmungsbildschirm

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

  3. Füllen Sie das App-Registrierungsformular aus (in den meisten Feldern können Sie leer lassen) und klicken Sie dann auf Speichern und fortfahren.

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

  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. Prüfen Sie die Zusammenfassung der App-Registrierung. Wenn Sie Änderungen vornehmen möchten, klicken Sie auf Bearbeiten. Wenn die Anwendungsregistrierung 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 App auf mehreren Plattformen ausgeführt wird, müssen Sie für jede Plattform eine separate Client-ID erstellen.

  1. Rufen Sie in der Google Cloud Console Menü > APIs und Dienste > Anmeldedaten auf.

    Zu den 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 mit Ihrer neuen Client-ID und Ihrem neuen Clientschlüssel angezeigt.

  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, in client_secret.json umbenannt und in Ihr Arbeitsverzeichnis verschoben.

Standardanmeldedaten für Anwendungen einrichten

Um die Datei client_secret.json in nutzbare Anmeldedaten zu konvertieren, übergeben Sie ihren Speicherort mit dem Argument --client-id-file des Befehls 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.tuning'

Durch die vereinfachte Projekteinrichtung in dieser Anleitung wird das Dialogfeld Google hat diese Anwendung nicht verifiziert. angezeigt. Das ist normal. Wählen Sie Weiter aus.

Dadurch wird das resultierende Token an einem bekannten Speicherort gespeichert, 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.tuning'

Nachdem Sie die Standardanmeldedaten für Anwendungen (Application Default Credentials, ACD) festgelegt haben, benötigen die Clientbibliotheken in den meisten Sprachen nur minimale oder gar keine Hilfe, um sie zu finden.

Curl

Am schnellsten können Sie überprüfen, ob dies funktioniert, indem Sie mithilfe von curl auf die restliche API zugreifen:

access_token=$(gcloud auth application-default print-access-token)
project_id=<MY PROJECT ID>

curl -X GET https://generativelanguage.googleapis.com/v1beta3/models \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer ${access_token}" \
    -H "x-goog-user-project: ${project_id}" | grep '"name"'
"name": "models/chat-bison-001",
"name": "models/text-bison-001",
"name": "models/embedding-gecko-001",

Python

In Python sollten sie von den Clientbibliotheken automatisch gefunden werden:

pip install google-generativeai

Ein minimales Skript zum Testen könnte wie folgt aussehen:

import google.generativeai as genai

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

Folgende Ausgabe wird erwartet:

Available base models: ['models/chat-bison-001', 'models/text-bison-001', 'models/embedding-gecko-001']
My tuned models: []

Node.js

Wenn Sie diese Anmeldedaten mit der Node.js-Clientbibliothek verwenden möchten, legen Sie die Umgebungsvariable GOOGLE_APPLICATION_CREDENTIALS fest.

export GOOGLE_APPLICATION_CREDENTIALS='<PATH_TO>/application_default_credentials.json'

Installieren Sie die Clientbibliothek:

npm install @google-ai/generativelanguage

Erstellen Sie ein minimales Skript:

const { ModelServiceClient } =
  require("@google-ai/generativelanguage").v1beta3;

const MODEL_NAME = "models/text-bison-001";

const client = new ModelServiceClient({});

client
  .listModels({})
  .then((result) => {
    result = result[0]
    for (let i = 0; i < result.length; i++) {
      console.log(result[i].name);
    }
  });

Die Ausgabe sollte so aussehen:

models/chat-bison-001
models/text-bison-001
models/embedding-gecko-001

Nächste Schritte

Wenn das funktioniert, können Sie versuchen, ein Modell selbst abzustimmen. Weitere Informationen finden Sie unter Erste Schritte bei der Abstimmung.

Anmeldedaten selbst verwalten [Python]

In vielen Fällen steht der Befehl gcloud zum Erstellen des Zugriffstokens aus der Client-ID (client_secret.json) nicht zur Verfügung. Google bietet Bibliotheken in vielen Sprachen, mit denen Sie diesen Prozess in Ihrer Anwendung verwalten können. In diesem Abschnitt wird der Prozess in Python beschrieben. Entsprechende Beispiele für andere Programmiersprachen finden Sie in der Dokumentation zur Drive API.

1. Erforderliche Bibliotheken installieren

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

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

pip install google-generativeai

2. Anmeldedaten-Manager schreiben

Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen load_creds.py. Beginnen Sie mit dem folgenden Code, um das 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.tuning']

def load_creds():
    """Converts `oauth-client-id.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(
                'oauth-client-id.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

Damit Sie sich seltener durch die Autorisierungsbildschirme klicken müssen, wenn eine token.json-Datei im Cache gespeichert wird, die später wiederverwendet werden kann, oder aktualisieren, wenn sie abgelaufen ist.

3. Programm schreiben

Erstellen Sie jetzt Ihre 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_tuned_models()])
print('My tuned models:', [m.name for m in genai.list_tuned_models()])

4. Programm ausführen

Führen Sie das Beispiel in Ihrem Arbeitsverzeichnis aus:

python script.py

Wenn Sie das Skript 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 dazu aufgefordert. Wenn Sie in mehreren Konten angemeldet sind, wählen Sie beim Konfigurieren Ihres Projekts unbedingt das Konto aus, das Sie als "Testkonto" festgelegt haben.

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

Sie haben die Authentifizierung erfolgreich eingerichtet.