使用 OAuth 进行身份验证的快速入门

Gemini API 快速入门中所述,对 Gemini API 进行身份验证的最简单方法是配置 API 密钥。如果您需要更严格的访问权限控制,可以改用 OAuth。本指南将帮助您设置 OAuth 身份验证。

本指南使用适用于测试环境的简化身份验证方法。对于生产环境,请先了解身份验证和授权,然后再选择适合您的应用的访问凭据

目标

  • 针对 OAuth 设置您的 Cloud 项目
  • 设置 application-default-credentials
  • 在您的计划中管理凭据,而不是使用 gcloud auth

前提条件

如需运行本快速入门,您需要满足以下条件:

设置 Cloud 项目

如需完成本快速入门,您首先需要设置 Cloud 项目。

1. 启用 API

在使用 Google API 之前,您需要先在 Google Cloud 项目中启用这些 API。

  • 在 Google Cloud 控制台中,启用 Google 生成式语言 API。

    启用 API

2. 配置 OAuth 权限请求页面

接下来,配置项目的 OAuth 同意屏幕,并将您自己添加为测试用户。如果您已经为自己的 Cloud 项目完成此步骤,请跳到下一部分。

  1. 在 Google Cloud 控制台中,依次点击菜单 > API 和服务 > OAuth 同意屏幕

    前往 OAuth 同意屏幕

  2. 为您的应用选择用户类型外部,然后点击创建

  3. 填写应用注册表单(您可以将大多数字段留空),然后点击保存并继续

  4. 目前,您可以跳过添加镜重,直接点击保存并继续。今后,如果您创建的应用要在 Google Workspace 组织之外使用,则必须添加并验证应用所需的授权范围。

  5. 添加测试用户:

    1. 测试用户下,点击添加用户
    2. 输入您的电子邮件地址和任何其他授权测试用户,然后点击保存并继续
  6. 查看应用注册摘要。如需进行更改,请点击修改。如果应用注册未出现任何问题,请点击返回信息中心

3. 为桌面应用授权凭据

如需以最终用户身份进行身份验证并访问应用中的用户数据,您需要创建一个或多个 OAuth 2.0 客户端 ID。客户端 ID 用于向 Google 的 OAuth 服务器标识单个应用。如果您的应用在多个平台上运行,您必须为每个平台分别创建客户端 ID。

  1. 在 Google Cloud 控制台中,依次选择菜单 > API 和服务 > 凭据

    前往“凭据”页面

  2. 点击创建凭据 > OAuth 客户端 ID

  3. 依次点击应用类型 > 桌面应用

  4. 名称字段中,输入凭据的名称。此名称仅在 Google Cloud 控制台中显示。

  5. 点击创建。系统会显示“OAuth 客户端创建”屏幕,其中显示了您的新客户端 ID 和客户端密钥。

  6. 点击确定。新创建的凭据会显示在 OAuth 2.0 客户端 ID 下。

  7. 点击下载按钮以保存 JSON 文件。它将另存为 client_secret_<identifier>.json,重命名为 client_secret.json,并将其移至工作目录。

设置应用默认凭据

如需将 client_secret.json 文件转换为可用的凭据,请将其位置传递给 gcloud auth application-default login 命令的 --client-id-file 参数。

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'

本教程中简化的项目设置会触发“Google 尚未验证此应用”对话框。这是正常现象,请选择“继续”

这会将生成的令牌放置在一个众所周知的位置,以便 gcloud 或客户端库可以访问它。

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'

设置应用默认凭据 (ACD) 后,大多数语言的客户端库无需任何帮助即可找到它们。

Curl

若要测试其是否正常运行,最快的方法是使用它通过 curl 访问 REST API:

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 中,客户端库应会自动找到它们:

pip install google-generativeai

用于测试它的最小脚本可能是:

import google.generativeai as genai

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

后续步骤

如果一切顺利,您就可以尝试对文本数据进行语义检索了。

自行管理凭据 [Python]

在许多情况下,您无法使用 gcloud 命令根据客户端 ID (client_secret.json) 创建访问令牌。Google 提供了多种语言的库,以便您在应用中管理该过程。本部分将以 Python 语言演示该过程。如需查看适用于其他语言的此类过程的等效示例,请参阅 Drive API 文档

1. 安装必要的库

安装 Python 版 Google 客户端库和 Gemini 客户端库。

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

2. 编写 Credential Manager

为了尽可能减少您必须点击授权界面的时间,请在工作目录中创建一个名为 load_creds.py 的文件,以缓存 token.json 文件,以便日后重复使用,或者在该文件过期时进行刷新。

首先,使用以下代码将 client_secret.json 文件转换为可与 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. 编写程序

现在,创建 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. 运行程序

在您的工作目录中,运行该示例:

python script.py

首次运行该脚本时,系统会打开一个浏览器窗口并提示您授予访问权限。

  1. 如果您尚未登录 Google 账号,系统会提示您登录。如果您登录了多个账号,请务必在配置项目时选择您设置为“测试账号”的账号。

  2. 授权信息存储在文件系统中,因此当您下次运行示例代码时,系统不会提示您授权。

您已成功设置身份验证。