OAuth ile kimlik doğrulama hızlı başlangıç kılavuzu

Gemini API'de kimlik doğrulamanın en kolay yolu, Gemini API hızlı başlangıç kılavuzunda açıklandığı gibi bir API anahtarı yapılandırmaktır. Daha katı erişim denetimlerine ihtiyacınız varsa bunun yerine OAuth'u kullanabilirsiniz. Bu kılavuz, OAuth ile kimlik doğrulamayı ayarlamanıza yardımcı olacaktır.

Bu kılavuzda, test ortamı için uygun olan basitleştirilmiş bir kimlik doğrulama yaklaşımı kullanılmaktadır. Üretim ortamında, uygulamanız için uygun erişim kimlik bilgilerini seçmeden önce kimlik doğrulama ve yetkilendirme hakkında bilgi edinin.

Hedefler

  • Cloud projenizi OAuth için ayarlama
  • application-default-credentials ayarlama
  • gcloud auth yerine programınızda kimlik bilgilerini yönetme

Ön koşullar

Bu hızlı başlangıç kılavuzunu çalıştırmak için gerekenler:

Cloud projenizi ayarlama

Bu hızlı başlangıç kılavuzunu tamamlamak için öncelikle Cloud projenizi ayarlamanız gerekir.

1. API'yi etkinleştirme

Google API'lerini kullanmadan önce bir Google Cloud projesinde etkinleştirmeniz gerekir.

2. OAuth kullanıcı rızası ekranını yapılandırma

Ardından projenin OAuth izin ekranını yapılandırın ve kendinizi test kullanıcısı olarak ekleyin. Cloud projeniz için bu adımı zaten tamamladıysanız sonraki bölüme geçin.

  1. Google Cloud Console'da Menü > > Genel Bakış'a gidin.

    adresine gidin.

  2. Proje yapılandırma formunu doldurun ve Kitle bölümünde kullanıcı türünü Harici olarak ayarlayın.

  3. Formun geri kalanını doldurun, Kullanıcı Verileri Politikası şartlarını kabul edin ve Oluştur'u tıklayın.

  4. Şimdilik kapsam eklemeyi atlayabilir ve Kaydet ve Devam Et'i tıklayabilirsiniz. Gelecekte, Google Workspace kuruluşunuzun dışında kullanılacak bir uygulama oluşturduğunuzda uygulamanızın gerektirdiği yetkilendirme kapsamlarını ekleyip doğrulamanız gerekir.

  5. Test kullanıcıları ekleme:

    1. 'ın bölümüne gidin.
    2. Test kullanıcıları bölümünde Kullanıcı ekle'yi tıklayın.
    3. E-posta adresinizi ve diğer yetkili test kullanıcılarını girip Kaydet'i tıklayın.

3. Masaüstü uygulaması için kimlik bilgilerini yetkilendirme

Son kullanıcı olarak kimlik doğrulamak ve uygulamanızdaki kullanıcı verilerine erişmek için bir veya daha fazla OAuth 2.0 istemci kimliği oluşturmanız gerekir. İstemci kimliği, tek bir uygulamanın Google OAuth sunucularına tanıtılması için kullanılır. Uygulamanız birden fazla platformda çalışıyorsa her platform için ayrı bir istemci kimliği oluşturmanız gerekir.

  1. Google Cloud Console'da Menü > > İstemciler'e gidin.

    Kimlik Bilgileri'ne gidin

  2. Create Client'ı (Müşteri Oluştur) tıklayın.

  3. Uygulama türü > Masaüstü uygulaması'nı tıklayın.

  4. Ad alanına, kimliğin adını yazın. Bu ad yalnızca Google Cloud Console'da gösterilir.

  5. Oluştur'u tıklayın. Yeni istemci kimliğinizi ve istemci gizli anahtarınızı gösteren OAuth istemcisi oluşturuldu ekranı gösterilir.

  6. Tamam'ı tıklayın. Yeni oluşturulan kimlik bilgisi OAuth 2.0 İstemci Kimlikleri altında görünür.

  7. JSON dosyasını kaydetmek için indir düğmesini tıklayın. client_secret_<identifier>.json olarak kaydedilir. Dosyayı client_secret.json olarak yeniden adlandırın ve çalışma dizininize taşıyın.

Uygulama varsayılan kimlik bilgilerini ayarlama

client_secret.json dosyasını kullanılabilir kimlik bilgilerine dönüştürmek için dosya konumunu gcloud auth application-default login komutunun --client-id-file bağımsız değişkenine iletin.

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'

Bu eğitimdeki basitleştirilmiş proje kurulumu, "Google bu uygulamayı doğrulamadı." iletişim kutusunu tetikler. Bu normal bir durumdur. "Devam"ı seçin.

Bu işlem, oluşturulan jetonu gcloud veya istemci kitaplıkları tarafından erişilebilmesi için iyi bilinen bir konuma yerleştirir.

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'

Uygulama varsayılan kimlik bilgilerini (ACD) ayarladıktan sonra, çoğu dildeki istemci kitaplıklarının bunları bulması için çok az yardıma veya hiç yardıma ihtiyacı yoktur.

Kıvrılma

Bu yöntemin çalıştığını test etmenin en hızlı yolu, curl'i kullanarak REST API'ye erişmek için kullanmaktır:

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

Python'da istemci kitaplıkları bunları otomatik olarak bulur:

pip install google-generativeai

Bunu test etmek için kullanabileceğiniz minimum komut dosyası şu şekilde olabilir:

import google.generativeai as genai

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

Sonraki adımlar

Bu işlem çalışıyorsa metin verileriniz üzerinde semantik arama özelliğini denemeye hazırsınız demektir.

Kimlik bilgilerini kendiniz yönetme [Python]

Çoğu durumda, istemci kimliğinden (client_secret.json) erişim jetonu oluşturmak için gcloud komutunu kullanamazsınız. Google, bu süreci uygulamanızda yönetmenize olanak tanıyan birçok dilde kitaplık sağlar. Bu bölümde, süreç Python'da gösterilmektedir. Bu tür prosedürlerin diğer diller için eşdeğer örneklerini Drive API dokümanlarında bulabilirsiniz.

1. Gerekli kitaplıkları yükleme

Python için Google istemci kitaplığını ve Gemini istemci kitaplığını yükleyin.

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

2. Kimlik bilgisi yöneticisini yazma

Yetkilendirme ekranlarında tıklama sayısını en aza indirmek için çalışma dizininizde load_creds.py adlı bir dosya oluşturun. Bu dosya, daha sonra yeniden kullanabileceği veya süresi dolduğunda yenileyebileceği bir token.json dosyasını önbelleğe alır.

client_secret.json dosyasını genai.configure ile kullanılabilen bir jetona dönüştürmek için aşağıdaki kodla başlayın:

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. Programınızı yazma

Ardından script.py'nizi oluşturun:

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. Programınızı çalıştırma

Çalışma dizininizde örneği çalıştırın:

python script.py

Komut dosyasını ilk kez çalıştırdığınızda bir tarayıcı penceresi açılır ve erişim için yetki vermenizi ister.

  1. Google Hesabınızda oturum açmadıysanız oturum açmanız istenir. Birden fazla hesapta oturum açtıysanız projenizi yapılandırırken "Test Hesabı" olarak ayarladığınız hesabı seçtiğinizden emin olun.

  2. Yetkilendirme bilgileri dosya sisteminde depolandığından, örnek kodu bir sonraki sefer çalıştırdığınızda yetkilendirme istemiyle karşılaşmazsınız.

Kimlik doğrulamayı başarıyla ayarladınız.