Primeiros passos com a API Perspective

Primeiros passos com a API Perspective

Sobre este codelab

Último mar. 10, 2022 atualizado

Escrito por Jigsaw

1. Antes de começar

A API Perspective é sem custo financeiro e ajuda você a hospedar conversas melhores on-line. A API usa o aprendizado de máquina para analisar uma string de texto e prever o impacto percebido em uma conversa.

Neste codelab, você vai configurar a API Perspective.

Observação: a API Perspective tem como objetivo facilitar a moderação de conteúdo. O objetivo não é substituir o trabalho de tomadores de decisões.

O que você vai aprender

• Uma abordagem de moderação com tecnologia de IA que sinaliza conteúdo assim que ele é criado.

Pré-requisitos

• Uma Conta do Google para acessar o Google Cloud
• Velocidade média da Internet

2. Introdução

Para começar, você precisa de um projeto do Google Cloud para autenticar suas solicitações de API.

1. No Console do Google Cloud, use um projeto atual.
2. Se necessário, siga estas etapas para criar um novo projeto:

• Faça login com sua Conta do Google.
• Abra o Console do Cloud.
• Clique em Criar projeto ou abra o menu Selecionar um projeto e clique em Novo projeto na caixa de diálogo.
• Dê um nome ao projeto e clique em Criar.

Agora o projeto aparecerá no menu suspenso.

Solicitar acesso à API

• Para solicitar acesso à API, preencha este formulário.

Em até uma hora, você receberá um e-mail confirmando que pode ver e ativar a API no Google Cloud.

Observação:se você não receber um e-mail em um dia útil, preencha o formulário novamente ou entre em contato com a equipe de suporte.

3. Ativar a API

• No Console do Cloud, acesse a página Visão geral da API Perspective e clique em Ativar.

4. Gerar a chave de API

1. No menu de navegação, clique em APIs & Services > Credentials > Criar credenciais > Chave de API.

Observação: se você fizer solicitações de uma linguagem do lado do cliente, como JavaScript, sua chave de API será exposta a todos os visitantes. É altamente recomendável que você faça o proxy da solicitação por um servidor e aplique restrições para ocultar a chave dos navegadores e permitir que apenas seu servidor use essa chave. Para mais informações, veja um exemplo de como fazer o proxy da solicitação por um servidor e mais recomendações de segurança de chave de API.

Sua chave de API funcionará em alguns minutos, mas pode levar até uma hora. Enquanto isso, você pode receber uma mensagem de erro.

2. Copie a chave de API.

5. Exemplos de solicitações

Você pode gerar bibliotecas de cliente da API com as da API do Google. Estes exemplos mostram como configurar a biblioteca de APIs com algumas das linguagens mais comuns.

1. Faça uma solicitação de AnalyzeComment.
2. Execute uma destas chamadas de API de exemplo para receber pontuações diretamente da API Perspective.

O método AnalyzeComment emite uma solicitação de API para analisar o campo comment.text para a requestedAttributes. Neste caso, o modelo TOXICITY.

3. Cole sua chave de API no campo API_KEY.

Se preferir, use a sinalização doNotStore para garantir que todos os comentários enviados sejam excluídos automaticamente depois que as pontuações forem retornadas.

4. Leia a documentação de referência da API para ver detalhes sobre todos os campos de solicitação e resposta, bem como os valores disponíveis para requestedAttributes.

Você também pode usar atributos experimentais, como OBSCENE, ATTACK_ON_RELATIVE e SPAM.

Python

Este exemplo e solicitação de resposta usa a versão Python das bibliotecas de cliente da API do Google.

1. Instale a biblioteca de cliente Python.
2. Execute estes comandos:

Você verá algo como esta saída:

Sua saudação amigável recebeu uma baixa pontuação de toxicidade.

Node.js

Este exemplo de solicitação e resposta usa a versão Node.js das bibliotecas de cliente das APIs do Google.

1. Instale a biblioteca de cliente Node.js ou o pacote npm googleapis.
2. Execute estes comandos:

Você verá algo como esta saída:

cURL

Este exemplo de solicitação e resposta usa o comando cURL. Esse comando funciona para a maioria dos usuários do MacOS e Linux. Talvez seja necessário instalar o cURL para executar este comando.

• Substitua YOUR_KEY_HERE pela sua chave de API.

Nesta resposta, o campo attributeScores.TOXICITY.summaryScore.value atribui a pontuação do modelo de toxicidade para o comentário. O comentário recebeu uma pontuação de 0,9 de 1,0.

6. Parabéns

Você ativou a API Perspective.

Saiba mais

• O site da API Perspective contém mais informações sobre a API, incluindo estudos de caso.
• O site para desenvolvedores da API Perspective contém mais informações sobre atributos, idiomas e métodos. Se você quiser começar rapidamente, a página Métodos descreve como usar os métodos AnalyzeComment e SuggestCommentScore.