Comienza a usar la API de Perspective

Comienza a usar la API de Perspective

Acerca de este codelab

Última actualización: mar 10, 2022

Escrito por Jigsaw

1. Antes de comenzar

La API de Perspective es una API gratuita que te ayuda a mejorar las conversaciones en línea. La API utiliza el aprendizaje automático (AA) para analizar una string de texto y predecir el impacto percibido que podría tener en una conversación.

En este codelab, configuraste la API de Perspective.

Nota: La API de Perspective está diseñada para que la moderación de contenido sea más fácil. No está pensado para reemplazar por completo el trabajo de los responsables de tomar decisiones humanas.

Qué aprenderás

• Un enfoque de moderación basado en IA que marca el contenido en el momento en que se crea.

Requisitos

• Una Cuenta de Google para acceder a Google Cloud
• Velocidad de Internet aceptable

2. Comienza ahora

Para comenzar, necesitas un proyecto de Google Cloud para autenticar las solicitudes a la API.

1. En Google Cloud Console, usa un proyecto existente.
2. Si es necesario, sigue estos pasos para crear un proyecto nuevo:

• Accede con tu Cuenta de Google.
• Abre Cloud Console.
• Haz clic en Crear proyecto o abre el menú Seleccionar un proyecto y haz clic en Proyecto nuevo en el diálogo.
• Ingresa un nombre para tu proyecto y, luego, haz clic en Crear.

El proyecto ahora aparece en el menú desplegable.

Solicita acceso a la API

• Para solicitar acceso a la API, complete este formulario.

En el plazo de una hora, debería recibir un correo electrónico que confirma que puede ver y habilitar la API en Google Cloud.

Nota: Si no recibes un correo electrónico en el transcurso de un día hábil, vuelve a completar el formulario o comunícate con el equipo de asistencia al cliente.

3. Habilita la API

• En Cloud Console, navegue a la página Descripción general de la API de Perspective y haga clic en Habilitar.

4. Cómo generar la clave de API

1. En el menú de navegación, haz clic en API & Services > Credenciales > Crear credenciales > Clave de API.

Nota: Si realizas solicitudes desde un lenguaje del cliente, como JavaScript, tu clave de API estará expuesta a todos los visitantes. Te recomendamos que aprobes la solicitud mediante un servidor y que apliques restricciones de clave para que la clave quede oculta en los navegadores y solo el servidor pueda usarla. Para obtener más información, consulta un ejemplo de cómo transmitir la solicitud mediante un servidor y más recomendaciones sobre la seguridad de la clave de API.

Tu clave de API debería funcionar en pocos minutos, pero puede tardar hasta una hora. Hasta entonces, es posible que recibas un mensaje de error.

2. Copie la clave de API.

5. Solicitudes de muestra

Puedes generar bibliotecas cliente de la API con las bibliotecas cliente de la API de Google. En estos ejemplos, se muestra cómo configurar tu biblioteca de API con algunos de los lenguajes más comunes.

1. Realiza una solicitud AnalyzeComment.
2. Ejecuta una de estas llamadas a la API de muestra para obtener puntuaciones directamente desde la API de Perspective.

El método AnalyzeComment emite una solicitud a la API para analizar el campo comment.text de requestedAttributes, en este caso, el modelo TOXICITY.

3. Pega la clave de API en el campo API_KEY.

Si lo prefieres, puedes aprovechar la marca doNotStore para asegurarte de que todos los comentarios enviados se borren automáticamente después de mostrar las puntuaciones.

4. Lee la documentación de referencia de la API para obtener detalles sobre todos los campos de solicitud y respuesta, así como los valores disponibles para requestedAttributes.

Hay atributos experimentales, como OBSCENE, ATTACK_ON_SUFFIX y SPAM que también puedes usar.

Python

En esta solicitud y respuesta de muestra, se usa la versión de Python de las bibliotecas cliente de la API de Google.

1. Instala la biblioteca cliente de Python.
2. Ejecute los siguientes comandos:

Debería ver un resultado similar al siguiente:

Tu amistoso saludo recibió una puntuación baja de toxicidad.

Node.js

Este ejemplo de solicitud y respuesta utiliza la versión Node.js de las bibliotecas cliente de la API de Google.

1. Instala la biblioteca cliente de Node.js o el paquete npm googleapis.
2. Ejecute los siguientes comandos:

Debería ver un resultado similar al siguiente:

cURL

En esta solicitud y respuesta de muestra, se usa el comando cURL. Este comando debería funcionar para la mayoría de los usuarios de macOS y Linux. Es posible que debas instalar cURL para ejecutar este comando.

• Reemplaza YOUR_KEY_HERE por la clave de API.

En esta respuesta, el campo attributeScores.TOXICITY.summaryScore.value proporciona la puntuación del modelo de toxicidad para el comentario. La puntuación del comentario fue 0.9 de 1.0.

6. Felicitaciones

Tienes la API de Perspective en funcionamiento.

Más información

• El sitio web de la API de Perspective contiene más información sobre la API, incluidos los casos de éxito.
• El sitio web para desarrolladores de API de Perspective contiene más información sobre los atributos, los idiomas y los métodos. Si deseas comenzar rápidamente, en la página Métodos, se describe cómo usar los métodos AnalyzeComment y SuggestCommentScore.