Perspective API 使用入门

1. 准备工作

Perspective API 是一个免费的 API，可帮助您在线举办更好的对话。该 API 使用机器学习 (ML) 来分析一串文本，并预测其对对话的感知影响。

在此 Codelab 中，您将设置 Perspective API。

注意：Perspective API 旨在简化内容审核。而不是完全取代人类决策者的工作。

学习内容

• 一种 AI 驱动型审核方法，可在内容创建时立即举报内容。

您需要满足的条件

• 用于访问 Google Cloud 的 Google 帐号
• 网速不错

2. 开始

首先，您需要一个 Google Cloud 项目来对 API 请求进行身份验证。

1. 在 Google Cloud Console 中，使用现有项目。
2. 如有必要，请按照以下步骤创建新项目：

• 使用您的 Google 帐号登录。
• 打开 Cloud Console。
• 点击 Create Project 或打开 Select a Project 菜单，然后点击对话框中的 New Project。
• 为项目命名，然后点击创建。

此时，项目即会显示在下拉菜单中。

申请 API 访问权限

• 如需申请 API 访问权限，请填写此表单。

您应该会在一小时内收到一封电子邮件，确认您可以在 Google Cloud 中查看和启用该 API。

注意：如果您在 1 个工作日内未收到电子邮件，请重新填写表单或与支持团队联系。

3.启用 API

• 在 Cloud Console 中，转到 Perspective API 概览页面，然后点击启用。

4.生成 API 密钥

1. 在导航菜单中，点击 API 和服务 > 凭据 > 创建凭据 > API 密钥。

注意：如果您使用 JavaScript 等客户端语言发出请求，您的 API 密钥将面向所有访问者公开。我们强烈建议您通过服务器代理请求并应用密钥限制，这样密钥就不会在浏览器中显示，只有您的服务器可以使用该密钥。有关详情，请参阅如何通过服务器代理请求的示例和更多 API 密钥安全建议。

您的 API 密钥在几分钟内应该就能正常工作，但最多可能需要一个小时。在此之前，您可能会收到错误消息。

2. 复制 API 密钥。

5. 请求示例

您可以使用 Google API 客户端库生成 API 客户端库。以下示例展示了如何使用一些最常见的语言设置 API 库。

1. 发出 AnalyzeComment 请求。
2. 运行以下其中一个 API 调用示例，直接从 Perspective API 获取分数。

AnalyzeComment 方法发出一个 API 请求，以分析 requestedAttributes（在此示例中为 TOXICITY 模型）的 comment.text 字段。

3. 将您的 API 密钥粘贴到 API_KEY 字段中。

如果您愿意，可以利用 doNotStore 标志来确保在系统返回分数后自动删除所有提交的评论。

4. 请参阅 API 参考文档，详细了解所有请求和响应字段，以及 requestedAttributes 的可用值。

您也可以使用实验性属性，例如 OBSCENE、ATTACK_ON_COMMENTER 和 SPAM。

Python

此示例请求和响应使用的是 Python 版本的 Google API 客户端库。

1. 安装 Python 客户端库。
2. 运行以下命令：

您应该会看到类似以下输出的内容：

友好的问候语带来了恶意言论。

Node.js

此示例请求和响应使用的是 Node.js 版 Google API 客户端库。

1. 安装 Node.js 客户端库或安装 npm 软件包 googleapis。
2. 运行以下命令：

您应该会看到类似以下输出的内容：

cURL

此示例请求和响应使用了 cURL 命令。此命令应该适用于大多数 MacOS 和 Linux 用户。您可能需要安装 c网址 才能运行此命令。

• 将 YOUR_KEY_HERE 替换为您的 API 密钥。

在此响应中，attributeScores.TOXICITY.summaryScore.value 字段会提供评论的恶意模型得分。该评论的得分为 0.9（满分 1.0 分）。

6. 恭喜

您已成功启动并运行 Perspective API！

了解详情

• Perspective API 网站详细介绍了此 API，包括案例研究。
• Perspective API 开发者网站详细介绍了属性、语言和方法。如需快速上手，方法页面介绍了如何使用 AnalyzeComment 和 SuggestCommentScore 方法。