Начните работу с перспективным API

Начните работу с перспективным API

О практической работе

Последнее обновление: мар. 10, 2022

Авторы: Jigsaw

1. Прежде чем вы начнете

Perspective API — это бесплатный API, который поможет вам лучше проводить онлайн-беседы. API использует машинное обучение (ML) для анализа строки текста и прогнозирования предполагаемого влияния, которое она может оказать на разговор.

В этой лаборатории кода вы настраиваете Perspective API.

Примечание. Perspective API предназначен для упрощения модерации контента. Он не предназначен для того, чтобы полностью заменить работу людей, принимающих решения.

Что вы узнаете

• Подход к модерации на основе искусственного интеллекта, который помечает контент в момент его создания.

Что вам понадобится

• Аккаунт Google для доступа к Google Cloud
• Достойная скорость интернета

2. Начать

Для начала вам нужен проект Google Cloud для аутентификации ваших запросов API.

1. В Google Cloud Console используйте существующий проект.
2. При необходимости выполните следующие действия, чтобы создать новый проект:

• Войдите в свой аккаунт Google.
• Откройте облачную консоль.
• Нажмите «Создать проект» или откройте меню « Выбор проекта», а затем нажмите «Новый проект» в диалоговом окне.
• Назовите свой проект и нажмите «Создать ».

Теперь проект появится в раскрывающемся меню.

Запросить доступ к API

• Чтобы запросить доступ к API, заполните эту форму .

В течение часа вы должны получить электронное письмо, подтверждающее, что вы можете просматривать и включать API в Google Cloud.

Примечание. Если вы не получили электронное письмо в течение одного рабочего дня, заполните форму еще раз или обратитесь в службу поддержки .

3. Включить API

• В Cloud Console перейдите на страницу обзора API Perspective и нажмите « Включить ».

4. Сгенерировать API-ключ

1. В меню навигации щелкните API и службы > Учетные данные > Создать учетные данные > Ключ API .

Примечание . Если вы отправляете запросы на клиентском языке, таком как JavaScript, ваш ключ API доступен всем посетителям. Настоятельно рекомендуется проксировать запрос через сервер и применять ограничения ключа , чтобы ключ был скрыт от браузеров и только ваш сервер мог использовать этот ключ. Для получения дополнительной информации см. пример того, как проксировать запрос через сервер, и другие рекомендации по безопасности ключа API .

Ваш ключ API должен работать через несколько минут, но это может занять до часа. До тех пор вы можете получить сообщение об ошибке.

2. Скопируйте ключ API.

5. Примеры запросов

Вы можете создавать клиентские библиотеки API с помощью клиентских библиотек Google API. В этих примерах показано, как настроить библиотеку API для некоторых наиболее распространенных языков.

1. Сделайте запрос AnalyzeComment .
2. Запустите один из этих примеров вызовов API, чтобы получить оценки непосредственно из Perspective API.

Метод AnalyzeComment запрос API для анализа поля comment.text для requestedAttributes атрибутов, в данном случае модели TOXICITY .

3. Вставьте свой ключ API в поле API_KEY .

При желании вы можете использовать флаг doNotStore , чтобы гарантировать автоматическое удаление всех отправленных комментариев после возврата оценок.

4. Прочтите справочную документацию по API, чтобы узнать подробности обо всех полях запроса и ответа, а также о доступных значениях для requestedAttributes .

Вы также можете использовать экспериментальные атрибуты , такие как OBSCENE , ATTACK_ON_COMMENTER и SPAM .

питон

В этом образце запроса и ответа используется версия клиентских библиотек Google API для Python.

1. Установите клиентскую библиотеку Python .
2. Запустите эти команды:

Вы должны увидеть что-то вроде этого вывода:

Ваше дружеское приветствие получило низкую оценку токсичности.

Node.js

В этом образце запроса и ответа используется версия Node.js клиентских библиотек Google API.

1. Установите клиентскую библиотеку Node.js или установите пакет npm googleapis .
2. Запустите эти команды:

Вы должны увидеть что-то вроде этого вывода:

CURL

В этом примере запроса и ответа используется команда cURL . Эта команда должна работать для большинства пользователей MacOS и Linux. Возможно, вам потребуется установить cURL для запуска этой команды.

• Замените YOUR_KEY_HERE своим ключом API.

В этом ответе поле attributeScores.TOXICITY.summaryScore.value дает оценку модели токсичности для комментария. Комментарий получил оценку 0,9 из 1,0.

6. Поздравления

Вы запустили Perspective API!

Учить больше

• Веб- сайт Perspective API содержит дополнительную информацию об API, включая тематические исследования.
• Веб -сайт разработчиков Perspective API содержит дополнительную информацию об атрибутах, языках и методах. Если вы хотите быстро приступить к работе, на странице « Методы » описано, как использовать методы AnalyzeComment и SuggestCommentScore .