快速入门:设置 Natural Language API

本指南介绍了开始使用 Natural Language 所需的所有设置步骤。

Google Cloud Console 简介

Google Cloud Console 是一个网页界面,用于预配、配置、管理和监控使用 Google Cloud 产品的系统。您可以使用 Google Cloud Console 设置和管理 Natural Language 资源。

创建项目

如需使用 Google Cloud 提供的服务,您必须创建一个项目

项目用于组织您的所有 Google Cloud 资源。 项目由以下部分组成:

  • 一组协作者
  • 已启用的 API(以及其他资源)
  • 监控工具
  • 结算信息
  • 身份验证和访问权限控制

您可以创建一个项目,也可以创建多个项目,并使用这些项目按资源层次结构组织 Google Cloud 资源。如需详细了解项目,请参阅 Resource Manager 文档

在 Google Cloud Console 的项目选择器页面上,选择或创建一个 Google Cloud 项目。

转到“项目选择器”

启用结算功能

结算帐号用于定义一组给定资源的付款方,并且可以关联到一个或多个项目。项目的资源使用费将记在关联的结算帐号名下。在大多数情况下,您应在创建项目时配置结算信息。如需了解详情,请参阅结算文档

确保您的 Cloud 项目已启用结算功能。 了解如何确认您的项目是否已启用结算功能

启用 API

您必须为项目启用 Cloud Natural Language API。 如需详细了解如何启用 API,请参阅服务使用工具文档

启用 Cloud Natural Language API。

启用 API

设置身份验证

任何使用 API 的客户端应用都必须经过身份验证,并且拥有所请求资源的访问权限。本部分介绍重要的身份验证概念及其设置步骤。如需了解详情,请参阅 Google Cloud 身份验证概览

服务帐号简介

身份验证有多种可选方式,但建议您使用服务帐号执行身份验证和访问权限控制。服务帐号为应用而非最终用户提供凭据。服务帐号由项目拥有,您可以为一个项目创建多个服务帐号。如需了解详情,请参阅服务帐号

角色简介

访问 Cloud Natural Language API 不需要角色。通过身份验证的用户或应用无论具有什么权限,都可以调用该 API。

服务帐号密钥简介

服务帐号与一个或多个公钥/私钥对相关联。创建新密钥对时,您需要下载私钥。私钥用于在调用 API 时生成凭据。您需要负责确保私钥和其他管理操作(如密钥轮替)的安全性。

创建服务帐号并下载私钥文件

创建服务帐号:

  1. 在 Cloud Console 中,转到创建服务帐号页面。

    转到“创建服务帐号”
  2. 选择一个项目。
  3. 服务帐号名称字段中,输入一个名称。 Cloud Console 会根据此名称填充服务帐号 ID 字段。

    服务帐号说明字段中,输入说明。例如,Service account for quickstart

  4. 点击完成以完成服务帐号的创建过程。

    不要关闭浏览器窗口。您将在下一步骤中用到它。

创建服务帐号密钥:

  1. 在 Cloud Console 中,点击您创建的服务帐号的电子邮件地址。
  2. 点击密钥
  3. 依次点击添加密钥创建新密钥
  4. 点击创建。JSON 密钥文件将下载到您的计算机上。
  5. 点击关闭

在您的环境中使用服务帐号密钥文件

通过设置环境变量 GOOGLE_APPLICATION_CREDENTIALS 向应用代码提供身份验证凭据。 此变量仅适用于当前的 Shell 会话,因此,如果您打开新的会话,请重新设置该变量。

Linux 或 macOS

export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

KEY_PATH 替换为包含您的服务帐号密钥的 JSON 文件的路径。

例如:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Windows

对于 PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

KEY_PATH 替换为包含您的服务帐号密钥的 JSON 文件的路径。

例如:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

对于命令提示符:

set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

KEY_PATH 替换为包含您的服务帐号密钥的 JSON 文件的路径。

安装并初始化 Cloud SDK

如果您计划使用 Natural Language API,则需要安装并初始化 Cloud SDK。Cloud SDK 是一组工具,可用于管理 Google Cloud 上托管的资源和应用。其中包括 gcloud 命令行工具。以下链接提供了相关说明:

安装并初始化 Cloud SDK

测试 SDK 和身份验证

如果您在前面的步骤中设置了身份验证,则可以使用 gcloud 工具测试您的身份验证环境。 执行以下命令,确认没有错误发生并且返回了凭据:

gcloud auth application-default print-access-token

所有 Natural Language 命令行 REST 示例都会使用该命令对 API 调用进行身份验证。

安装 Natural Language API 客户端库

您可以通过以下三种方式调用 Natural Language API:

客户端库支持多种主流语言。如需了解如何安装客户端库,请参阅 Cloud Natural Language 客户端库