Premiers pas avec l'API Perspective

Premiers pas avec l'API Perspective

À propos de cet atelier de programmation

Dernière mise à jour : mars 10, 2022

Rédigé par Jigsaw

1. Avant de commencer

L'API Perspective est une API offerte qui vous aide à organiser de meilleures conversations en ligne. L'API utilise le machine learning pour analyser une chaîne de texte et prédire l'impact perçu qu'elle pourrait avoir sur une conversation.

Dans cet atelier de programmation, vous allez configurer l'API Perspective.

Remarque:L'API Perspective vise à faciliter la modération de contenu. Il ne vise pas à remplacer entièrement le travail des décideurs humains.

Points abordés

• Une approche de modération basée sur l'IA qui signale le contenu créé.

Ce dont vous avez besoin

• Un compte Google pour accéder à Google Cloud
• Débit Internet correct

2. Premiers pas

Pour commencer, vous avez besoin d'un projet Google Cloud pour authentifier vos requêtes API.

1. Dans Google Cloud Console, utilisez un projet existant.
2. Si nécessaire, procédez comme suit pour créer un projet:

• Connectez-vous avec votre compte Google.
• Ouvrez Cloud Console.
• Cliquez sur Create Project (Créer un projet) ou ouvrez le menu Select a Project (Sélectionner un projet), puis cliquez sur New Project (Nouveau projet) dans la boîte de dialogue.
• Attribuez un nom à votre projet, puis cliquez sur Create (Créer).

Le projet apparaît désormais dans le menu déroulant.

Demander l'accès à l'API

• Pour demander l'accès à l'API, remplissez ce formulaire.

Dans un délai d'une heure, vous devriez recevoir un e-mail confirmant que vous pouvez afficher et activer l'API dans Google Cloud.

Remarque : Si vous ne recevez pas d'e-mail dans un délai d'un jour ouvré, remplissez à nouveau le formulaire ou contactez l'équipe d'assistance.

3. Activer l'API

• Dans Cloud Console, accédez à la page Présentation de l'API Perspective, puis cliquez sur Activer.

4. Générer la clé API

1. Dans le menu de navigation, cliquez sur API et services ; services > Identifiants > Créer des identifiants > Clé API.

Remarque: Si vous envoyez des requêtes à partir d'un langage côté client, tel que JavaScript, votre clé API est exposée à tous les visiteurs. Nous vous recommandons vivement de transmettre la demande via un serveur et d'appliquer des restrictions de clé afin que la clé ne soit pas visible par les navigateurs et que seul votre serveur puisse l'utiliser. Pour en savoir plus, consultez un exemple de proxy pour la requête via un serveur et d'autres recommandations de sécurité concernant les clés API.

Votre clé API devrait fonctionner en quelques minutes, mais cela peut prendre jusqu'à une heure. En attendant, il est possible que vous receviez un message d'erreur.

2. Copiez la clé API.

5. Exemples de requêtes

Vous pouvez générer des bibliothèques clientes d'API avec les bibliothèques clientes des API Google. Ces exemples vous montrent comment configurer votre bibliothèque d'API dans certains des langages les plus courants.

1. Envoyez une requête AnalyzeComment.
2. Exécutez l'un de ces exemples d'appels d'API pour obtenir des scores directement à partir de Perspective.

La méthode AnalyzeComment émet une requête API pour analyser le champ comment.text pour requestedAttributes, dans ce cas le modèle TOXICITY.

3. Collez votre clé API dans le champ API_KEY.

Si vous préférez, vous pouvez utiliser l'indicateur doNotStore pour vous assurer que tous les commentaires envoyés sont automatiquement supprimés après le renvoi des scores.

4. Consultez la documentation de référence de l'API pour en savoir plus sur tous les champs de requête et de réponse. Vous trouverez également des informations sur les valeurs disponibles pour requestedAttributes.

Vous pouvez également utiliser d'autres attributs de test tels que OBSCENE, ATTACK_ON_苯 et SPAM.

Python

Cet exemple de requête et de réponse utilise la version Python des bibliothèques clientes des API Google.

1. Installez la bibliothèque cliente Python.
2. Exécutez les commandes suivantes :

Le résultat doit ressembler à ceci:

Votre message d'accueil a reçu un score de toxicité faible.

Node.js

Cet exemple de requête et de réponse utilise la version Node.js des bibliothèques clientes des API Google.

1. Installez la bibliothèque cliente pour Node.js ou le package npm googleapis.
2. Exécutez les commandes suivantes :

Le résultat doit ressembler à ceci:

cURL

Cet exemple de requête et de réponse utilise la commande cURL. Cette commande devrait fonctionner pour la plupart des utilisateurs macOS et Linux. Vous devrez peut-être installer cURL pour exécuter cette commande.

• Remplacez YOUR_KEY_HERE par votre clé API.

Dans cette réponse, le champ attributeScores.TOXICITY.summaryScore.value attribue le score du modèle de toxicité au commentaire. Le commentaire a reçu une note de 0,9 sur 1,0.

6. Félicitations

L'API Perspective est opérationnelle.

Learn more

• Vous trouverez plus d'informations sur l'API, y compris des études de cas, sur le site Web de l'API Perspective.
• Le site Web destiné aux développeurs de l'API Perspective contient plus d'informations sur les attributs, les langues et les méthodes. Si vous souhaitez commencer rapidement, consultez la page Méthodes pour savoir comment utiliser les méthodes AnalyzeComment et SuggestCommentScore.