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

借助 PaLM API，您可以利用自己的数据对模型进行调优。由于这些是您的数据和经过调优的模型，因此需要比 API 密钥更严格的访问权限控制。

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

目标

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

前提条件

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

设置 Cloud 项目

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

1. 启用 API

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

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

    启用 API

接下来，配置项目的 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.tuning'

本教程中简化的项目设置会触发“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.tuning'

设置应用默认凭据 (ADC) 后，大多数语言的客户端库无需或只需很少的帮助即可找到它们。

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/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

在 Python 中，客户端库应会自动找到它们：

pip install google-generativeai

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

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()])

预期输出为：

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

Node.js

如需将这些凭据与 Node.js 客户端库搭配使用，请设置 GOOGLE_APPLICATION_CREDENTIALS 环境变量。

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

安装客户端库：

npm install @google-ai/generativelanguage

创建一个最小脚本：

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);
    }
  });

其输出应如下所示：

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

后续步骤

如果一切顺利，您就可以尝试自行调优模型了。不妨试试开始调优。

自行管理凭据 [Python]

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

1. 安装必要的库

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

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

pip install google-generativeai

2. 编写 Credential Manager

在工作目录中，创建一个名为 load_creds.py 的文件。首先，使用以下代码将 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.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

如需尽可能减少您必须点击授权界面次数，请缓存可供日后重复使用的 token.json 文件，或在该文件过期时刷新。

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

4. 运行程序

在工作目录中，运行示例：

python script.py

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

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

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

您已成功设置身份验证。