Pic-quoi : Atelier 1 : Stocker et analyser des images (Java)

1. Présentation

Dans le premier atelier de programmation, vous importerez des images dans un bucket. Cette opération génère un événement de création de fichier qui sera géré par une fonction. La fonction appellera l'API Vision pour analyser des images et enregistrer les résultats dans un datastore.

d650ca5386ea71ad.png

Points abordés

  • Cloud Storage
  • Cloud Functions
  • API Cloud Vision
  • Cloud Firestore

2. Préparation

Configuration de l'environnement au rythme de chacun

  1. Connectez-vous à la console Google Cloud, puis créez un projet ou réutilisez un projet existant. (Si vous ne possédez pas encore de compte Gmail ou Google Workspace, vous devez en créer un.)

b35bf95b8bf3d5d8.png

a99b7ace416376c4.png

bd84a6d3004737c5.png

  • Le nom du projet est le nom à afficher pour les participants au projet. Il s'agit d'une chaîne de caractères non utilisée par les API Google. Vous pouvez le modifier à tout moment.
  • L'ID du projet doit être unique sur l'ensemble des projets Google Cloud et doit être immuable (vous ne pouvez pas le modifier une fois que vous l'avez défini). La console Cloud génère automatiquement une chaîne unique. généralement, vous ne vous souciez pas de ce que c’est. Dans la plupart des ateliers de programmation, vous devrez référencer l'ID du projet (il est généralement identifié comme PROJECT_ID). Si l'ID généré ne vous convient pas, vous pouvez en générer un autre au hasard. Vous pouvez également essayer la vôtre pour voir si elle est disponible. Il ne peut pas être modifié après cette étape et restera actif pendant toute la durée du projet.
  • Pour votre information, il existe une troisième valeur, le numéro de projet, utilisé par certaines API. Pour en savoir plus sur ces trois valeurs, consultez la documentation.
  1. Vous devez ensuite activer la facturation dans la console Cloud pour utiliser les ressources/API Cloud. L'exécution de cet atelier de programmation est très peu coûteuse, voire sans frais. Pour arrêter les ressources afin d'éviter que des frais ne vous soient facturés au-delà de ce tutoriel, vous pouvez supprimer les ressources que vous avez créées ou l'ensemble du projet. Les nouveaux utilisateurs de Google Cloud peuvent participer au programme d'essai gratuit pour bénéficier d'un crédit de 300 $.

Démarrer Cloud Shell

Bien que Google Cloud puisse être utilisé à distance depuis votre ordinateur portable, nous allons nous servir de Google Cloud Shell pour cet atelier de programmation, un environnement de ligne de commande exécuté dans le cloud.

Dans la console Google Cloud, cliquez sur l'icône Cloud Shell dans la barre d'outils supérieure :

55efc1aaa7a4d3ad.png

Le provisionnement et la connexion à l'environnement prennent quelques instants seulement. Une fois l'opération terminée, le résultat devrait ressembler à ceci :

7ffe5cbb04455448.png

Cette machine virtuelle contient tous les outils de développement nécessaires. Elle comprend un répertoire d'accueil persistant de 5 Go et s'exécute sur Google Cloud, ce qui améliore nettement les performances du réseau et l'authentification. Vous pouvez effectuer toutes les tâches de cet atelier de programmation dans un navigateur. Vous n'avez rien à installer.

3. Activer les API

Dans cet atelier, vous allez utiliser Cloud Functions et l'API Vision, mais vous devez d'abord les activer dans la console Cloud ou avec gcloud.

Pour activer l'API Vision dans la console Cloud, recherchez Cloud Vision API dans la barre de recherche:

cf48b1747ba6a6fb.png

Vous arrivez sur la page de l'API Cloud Vision:

ba4af419e6086fbb.png

Cliquez sur le bouton ENABLE.

Vous pouvez également l'activer dans Cloud Shell à l'aide de l'outil de ligne de commande gcloud.

Dans Cloud Shell, exécutez la commande suivante:

gcloud services enable vision.googleapis.com

L'opération doit s'afficher pour se terminer correctement:

Operation "operations/acf.12dba18b-106f-4fd2-942d-fea80ecc5c1c" finished successfully.

Activez également Cloud Functions:

gcloud services enable cloudfunctions.googleapis.com

4. Créer le bucket (console)

Créez un bucket de stockage pour les photos. Vous pouvez le faire depuis la console Google Cloud Platform ( console.cloud.google.com) ou à l'aide de l'outil de ligne de commande gsutil depuis Cloud Shell ou votre environnement de développement local.

Du "hamburger", (Twilio), accédez à la page Storage.

1930e055d138150a.png

Attribuer un nom au bucket

Cliquez sur le bouton CREATE BUCKET.

34147939358517f8.png

Cliquez sur CONTINUE.

Choisir un emplacement

197817f20be07678.png

Créez un bucket multirégional dans la région de votre choix (ici Europe).

Cliquez sur CONTINUE.

Choisir la classe de stockage par défaut

53cd91441c8caf0e.png

Choisissez la classe de stockage Standard pour vos données.

Cliquez sur CONTINUE.

Configurer le contrôle des accès

8c2b3b459d934a51.png

Comme vous allez travailler avec des images accessibles publiquement, vous souhaitez que toutes les images stockées dans ce bucket aient le même contrôle d'accès uniforme.

Choisissez l'option de contrôle d'accès Uniform.

Cliquez sur CONTINUE.

Définir la protection/le chiffrement

d931c24c3e705a68.png

Conservez la valeur par défaut (Google-managed key), car vous n'utiliserez pas vos propres clés de chiffrement.

Cliquez sur CREATE pour finaliser la création du bucket.

Ajouter allUsers en tant que lecteur de l'espace de stockage

Accédez à l'onglet Permissions:

d0ecfdcff730ea51.png

Ajoutez un membre allUsers au bucket, avec le rôle Storage > Storage Object Viewer, comme suit:

e9f25ec1ea0b6cc6.png

Cliquez sur SAVE.

5. Créer le bucket (gsutil)

Vous pouvez également créer des buckets à l'aide de l'outil de ligne de commande gsutil dans Cloud Shell.

Dans Cloud Shell, définissez une variable pour le nom unique du bucket. GOOGLE_CLOUD_PROJECT est déjà défini sur votre ID de projet unique dans Cloud Shell. Vous pouvez l'ajouter au nom du bucket.

Exemple :

export BUCKET_PICTURES=uploaded-pictures-${GOOGLE_CLOUD_PROJECT}

Créez une zone multirégionale standard en Europe:

gsutil mb -l EU gs://${BUCKET_PICTURES}

Assurez-vous que l'accès est uniforme au niveau du bucket:

gsutil uniformbucketlevelaccess set on gs://${BUCKET_PICTURES}

Rendez le bucket public :

gsutil iam ch allUsers:objectViewer gs://${BUCKET_PICTURES}

Si vous accédez à la section Cloud Storage de la console, vous devriez disposer d'un bucket uploaded-pictures public:

a98ed4ba17873e40.png

Vérifiez que vous pouvez importer des photos dans le bucket et qu'elles sont accessibles au public, comme expliqué à l'étape précédente.

6. Tester l'accès public au bucket

Dans le navigateur de stockage, votre bucket apparaît dans la liste, avec la mention "Public". y compris un panneau d'avertissement vous rappelant que n'importe qui a accès au contenu de ce bucket.

89e7a4d2c80a0319.png

Votre bucket est maintenant prêt à recevoir des photos.

Si vous cliquez sur le nom du bucket, ses informations s'affichent.

131387f12d3eb2d3.png

Appuyez sur le bouton Upload files pour tester l'ajout d'une image au bucket. Un pop-up de sélection de fichier vous invite à sélectionner un fichier. Une fois sélectionné, il sera importé dans votre bucket, et vous verrez de nouveau l'accès public attribué automatiquement à ce nouveau fichier.

e87584471a6e9c6d.png

Une petite icône de lien apparaît également le long du libellé d'accès Public. Lorsque vous cliquez dessus, votre navigateur accédera à l'URL publique de cette image, qui se présentera sous la forme suivante:

https://storage.googleapis.com/BUCKET_NAME/PICTURE_FILE.png

BUCKET_NAME étant le nom unique que vous avez choisi pour votre bucket, suivi du nom de fichier de votre image.

Cliquez sur la case à cocher à côté du nom de l'image pour activer le bouton DELETE et supprimer cette première image.

7. Créer la fonction

Au cours de cette étape, vous allez créer une fonction qui réagit aux événements d'importation d'images.

Accédez à la section Cloud Functions de la console Google Cloud. En accédant à cet emplacement, le service Cloud Functions sera automatiquement activé.

9d29e8c026a7a53f.png

Cliquez sur Create function.

Choisissez un nom (par exemple, picture-uploaded) et la région (veillez à rester cohérent avec la région choisie pour le bucket):

4bb222633e6f278.png

Il existe deux types de fonctions:

  • Des fonctions HTTP pouvant être appelées via une URL (une API Web, par exemple)
  • Fonctions d'arrière-plan pouvant être déclenchées par un événement.

Vous souhaitez créer une fonction d'arrière-plan qui se déclenche lorsqu'un nouveau fichier est importé dans notre bucket Cloud Storage:

d9a12fcf58f4813c.png

Vous êtes intéressé par le type d'événement Finalize/Create, qui est l'événement déclenché lorsqu'un fichier est créé ou mis à jour dans le bucket:

b30c8859b07dc4cb.png

Sélectionnez le bucket créé précédemment pour indiquer à Cloud Functions d'être averti lorsqu'un fichier est créé ou mis à jour dans ce bucket:

cb15a1f4c7a1ca5f.png

Cliquez sur Select pour choisir le bucket que vous avez créé précédemment, puis sur Save.

c1933777fac32c6a.png

Avant de cliquer sur "Suivant", vous pouvez développer et modifier les valeurs par défaut (256 Mo de mémoire) sous Paramètres d'exécution, de compilation, de connexion et de sécurité, puis les mettre à jour et les définir sur 1 Go.

83d757e6c38e10.png

Après avoir cliqué sur Next, vous pouvez ajuster l'environnement d'exécution, le code source et le point d'entrée.

Conservez le Inline editor pour cette fonction:

b6646ec646082b32.png

Sélectionnez l'un des environnements d'exécution Java, par exemple Java 11:

f85b8a6f951f47a7.png

Le code source se compose d'un fichier Java et d'un fichier Maven pom.xml qui fournit diverses métadonnées et dépendances.

Conservez l'extrait de code par défaut, qui consigne le nom de fichier de l'image importée :

9b7b9801b42f6ca6.png

Pour l'instant, conservez le nom de la fonction à exécuter dans Example, à des fins de test.

Cliquez sur Deploy pour créer et déployer la fonction. Une fois le déploiement réussi, une coche entourée d'un cercle vert doit s'afficher dans la liste des fonctions:

3732fdf409eefd1a.png

8. Tester la fonction

Au cours de cette étape, vous allez vérifier que la fonction répond aux événements de stockage.

Du "hamburger", (Twilio), revenez à la page Storage.

Cliquez sur le bucket d'images, puis sur Upload files pour importer une image.

21767ec3cb8b18de.png

Revenez à la console Cloud pour accéder à la page Logging > Logs Explorer.

Dans le sélecteur Log Fields, sélectionnez Cloud Function pour afficher les journaux dédiés à vos fonctions. Faites défiler les champs de journal vers le bas. Vous pouvez même sélectionner une fonction spécifique pour obtenir une vue plus détaillée des journaux associés aux fonctions. Sélectionnez la fonction picture-uploaded.

Vous devriez voir les éléments de journal mentionnant la création de la fonction, les heures de début et de fin de la fonction et notre instruction de journalisation réelle:

e8ba7d39c36df36c.png

Notre instruction de journalisation indique: Processing file: pic-a-daily-architecture-events.png, ce qui signifie que l'événement lié à la création et au stockage de cette image a bien été déclenché comme prévu.

9. Préparer la base de données

Vous allez stocker des informations sur l'image fournie par l'API Vision dans la base de données Cloud Firestore, une base de données de documents NoSQL sans serveur, cloud native, entièrement gérée et rapide. Préparez votre base de données en accédant à la section Firestore de Cloud Console:

9e4708d2257de058.png

Deux options sont proposées: Native mode ou Datastore mode. Utilisez le mode natif, qui offre des fonctionnalités supplémentaires telles que le fonctionnement hors connexion et la synchronisation en temps réel.

Cliquez sur SELECT NATIVE MODE.

9449ace8cc84de43.png

Choisissez un emplacement multirégional (ici en Europe, mais idéalement au moins la même région que votre fonction et votre bucket de stockage).

Cliquez sur le bouton CREATE DATABASE.

Une fois la base de données créée, la page suivante doit s'afficher:

56265949a124819e.png

Créez une collection en cliquant sur le bouton + START COLLECTION.

Nom de la collection pictures.

75806ee24c4e13a7.png

Vous n'avez pas besoin de créer de document. Vous allez les ajouter par programmation, car de nouvelles images sont stockées dans Cloud Storage et analysées par l'API Vision.

Cliquez sur Save.

Firestore crée un premier document par défaut dans la collection que vous venez de créer. Vous pouvez supprimer ce document en toute sécurité, car il ne contient aucune information utile:

5c2f1e17ea47f48f.png

Les documents qui seront créés par programmation dans notre collection contiendront quatre champs:

  • name (chaîne): nom de fichier de l'image importée, qui est également la clé du document.
  • labels (tableau de chaînes): étiquettes des éléments reconnus par l'API Vision
  • color (chaîne): code hexadécimal de la couleur dominante (par exemple, #ab12ef)
  • créé (date): horodatage correspondant au moment où les métadonnées de cette image ont été stockées
  • thumbnail (valeur booléenne): champ facultatif qui est présent et a la valeur "true" si une vignette a été générée pour cette image.

Comme nous allons rechercher dans Firestore des images pour lesquelles des vignettes sont disponibles, et trier les dates de création, nous devons créer un index de recherche.

Vous pouvez créer l'index à l'aide de la commande suivante dans Cloud Shell:

gcloud firestore indexes composite create \
  --collection-group=pictures \
  --field-config field-path=thumbnail,order=descending \
  --field-config field-path=created,order=descending

Vous pouvez également le faire depuis la console Cloud. Pour ce faire, cliquez sur Indexes dans la colonne de navigation à gauche, puis créez un index composite comme indiqué ci-dessous:

ecb8b95e3c791272.png

Cliquez sur Create. La création de l'index peut prendre quelques minutes.

10. Mettre à jour la fonction

Revenez à la page Functions pour mettre à jour la fonction afin d'appeler l'API Vision afin d'analyser les images et de stocker les métadonnées dans Firestore.

Du "hamburger", (Twilio), accédez à la section Cloud Functions, cliquez sur le nom de la fonction, sélectionnez l'onglet Source, puis cliquez sur le bouton EDIT.

Commencez par modifier le fichier pom.xml qui répertorie les dépendances de notre fonction Java. Mettez à jour le code pour ajouter la dépendance Maven de l'API Cloud Vision:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>cloudfunctions</groupId>
  <artifactId>gcs-function</artifactId>
  <version>1.0-SNAPSHOT</version>

  <properties>
    <maven.compiler.target>11</maven.compiler.target>
    <maven.compiler.source>11</maven.compiler.source>
  </properties>

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>com.google.cloud</groupId>
        <artifactId>libraries-bom</artifactId>
        <version>26.1.1</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

  <dependencies>
    <dependency>
      <groupId>com.google.cloud.functions</groupId>
      <artifactId>functions-framework-api</artifactId>
      <version>1.0.4</version>
      <type>jar</type>
    </dependency>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>google-cloud-firestore</artifactId>
    </dependency>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>google-cloud-vision</artifactId>
    </dependency>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>google-cloud-storage</artifactId>
    </dependency>
  </dependencies>

  <!-- Required for Java 11 functions in the inline editor -->
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.8.1</version>
        <configuration>
          <excludes>
            <exclude>.google/</exclude>
          </excludes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

Maintenant que les dépendances sont à jour, vous allez travailler sur le code de notre fonction en mettant à jour le fichier Example.java avec notre code personnalisé.

Déplacez la souris sur le fichier Example.java, puis cliquez sur le crayon. Remplacez le nom du package et le nom du fichier par src/main/java/fn/ImageAnalysis.java.

Remplacez le code dans ImageAnalysis.java par le code ci-dessous. Nous y reviendrons à l'étape suivante.

package fn;

import com.google.cloud.functions.*;
import com.google.cloud.vision.v1.*;
import com.google.cloud.vision.v1.Feature.Type;
import com.google.cloud.firestore.*;
import com.google.api.core.ApiFuture;

import java.io.*;
import java.util.*;
import java.util.stream.*;
import java.util.concurrent.*;
import java.util.logging.Logger;

import fn.ImageAnalysis.GCSEvent;

public class ImageAnalysis implements BackgroundFunction<GCSEvent> {
    private static final Logger logger = Logger.getLogger(ImageAnalysis.class.getName());

    @Override
    public void accept(GCSEvent event, Context context) 
            throws IOException, InterruptedException, ExecutionException {
        String fileName = event.name;
        String bucketName = event.bucket;

        logger.info("New picture uploaded " + fileName);

        try (ImageAnnotatorClient vision = ImageAnnotatorClient.create()) {
            List<AnnotateImageRequest> requests = new ArrayList<>();
            
            ImageSource imageSource = ImageSource.newBuilder()
                .setGcsImageUri("gs://" + bucketName + "/" + fileName)
                .build();

            Image image = Image.newBuilder()
                .setSource(imageSource)
                .build();

            Feature featureLabel = Feature.newBuilder()
                .setType(Type.LABEL_DETECTION)
                .build();
            Feature featureImageProps = Feature.newBuilder()
                .setType(Type.IMAGE_PROPERTIES)
                .build();
            Feature featureSafeSearch = Feature.newBuilder()
                .setType(Type.SAFE_SEARCH_DETECTION)
                .build();
                
            AnnotateImageRequest request = AnnotateImageRequest.newBuilder()
                .addFeatures(featureLabel)
                .addFeatures(featureImageProps)
                .addFeatures(featureSafeSearch)
                .setImage(image)
                .build();
            
            requests.add(request);

            logger.info("Calling the Vision API...");
            BatchAnnotateImagesResponse result = vision.batchAnnotateImages(requests);
            List<AnnotateImageResponse> responses = result.getResponsesList();

            if (responses.size() == 0) {
                logger.info("No response received from Vision API.");
                return;
            }

            AnnotateImageResponse response = responses.get(0);
            if (response.hasError()) {
                logger.info("Error: " + response.getError().getMessage());
                return;
            }

            List<String> labels = response.getLabelAnnotationsList().stream()
                .map(annotation -> annotation.getDescription())
                .collect(Collectors.toList());
            logger.info("Annotations found:");
            for (String label: labels) {
                logger.info("- " + label);
            }

            String mainColor = "#FFFFFF";
            ImageProperties imgProps = response.getImagePropertiesAnnotation();
            if (imgProps.hasDominantColors()) {
                DominantColorsAnnotation colorsAnn = imgProps.getDominantColors();
                ColorInfo colorInfo = colorsAnn.getColors(0);

                mainColor = rgbHex(
                    colorInfo.getColor().getRed(), 
                    colorInfo.getColor().getGreen(), 
                    colorInfo.getColor().getBlue());

                logger.info("Color: " + mainColor);
            }

            boolean isSafe = false;
            if (response.hasSafeSearchAnnotation()) {
                SafeSearchAnnotation safeSearch = response.getSafeSearchAnnotation();

                isSafe = Stream.of(
                    safeSearch.getAdult(), safeSearch.getMedical(), safeSearch.getRacy(),
                    safeSearch.getSpoof(), safeSearch.getViolence())
                .allMatch( likelihood -> 
                    likelihood != Likelihood.LIKELY && likelihood != Likelihood.VERY_LIKELY
                );

                logger.info("Safe? " + isSafe);
            }

            // Saving result to Firestore
            if (isSafe) {
                FirestoreOptions firestoreOptions = FirestoreOptions.getDefaultInstance();
                Firestore pictureStore = firestoreOptions.getService();

                DocumentReference doc = pictureStore.collection("pictures").document(fileName);

                Map<String, Object> data = new HashMap<>();
                data.put("labels", labels);
                data.put("color", mainColor);
                data.put("created", new Date());

                ApiFuture<WriteResult> writeResult = doc.set(data, SetOptions.merge());

                logger.info("Picture metadata saved in Firestore at " + writeResult.get().getUpdateTime());
            }
        }
    }

    private static String rgbHex(float red, float green, float blue) {
        return String.format("#%02x%02x%02x", (int)red, (int)green, (int)blue);
    }

    public static class GCSEvent {
        String bucket;
        String name;
    }
}

968749236c3f01da.png

11. Explorer la fonction

Examinons de plus près les différentes parties intéressantes.

Tout d'abord, nous incluons les dépendances spécifiques dans le fichier Maven pom.xml. Les bibliothèques clientes Google Java publient un Bill-of-Materials(BOM) afin d'éliminer les conflits de dépendances. Grâce à cette API, vous n'avez pas à spécifier de version pour chaque bibliothèque cliente Google.

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>com.google.cloud</groupId>
        <artifactId>libraries-bom</artifactId>
        <version>26.1.1</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

Ensuite, nous préparons un client pour l'API Vision:

...
try (ImageAnnotatorClient vision = ImageAnnotatorClient.create()) {
...

Vient maintenant la structure de notre fonction. À partir de l'événement entrant, nous récupérons les champs qui nous intéressent et nous les mappons à la structure GCSEvent que nous définissons:

...
public class ImageAnalysis implements BackgroundFunction<GCSEvent> {
    @Override
    public void accept(GCSEvent event, Context context) 
            throws IOException, InterruptedException,     
    ExecutionException {
...

    public static class GCSEvent {
        String bucket;
        String name;
    }

Notez la signature, mais aussi la façon dont nous récupérons le nom du fichier et du bucket qui ont déclenché la fonction Cloud.

Pour référence, voici à quoi ressemble la charge utile de l'événement:

{
  "bucket":"uploaded-pictures",
  "contentType":"image/png",
  "crc32c":"efhgyA==",
  "etag":"CKqB956MmucCEAE=",
  "generation":"1579795336773802",
  "id":"uploaded-pictures/Screenshot.png/1579795336773802",
  "kind":"storage#object",
  "md5Hash":"PN8Hukfrt6C7IyhZ8d3gfQ==",
  "mediaLink":"https://www.googleapis.com/download/storage/v1/b/uploaded-pictures/o/Screenshot.png?generation=1579795336773802&alt=media",
  "metageneration":"1",
  "name":"Screenshot.png",
  "selfLink":"https://www.googleapis.com/storage/v1/b/uploaded-pictures/o/Screenshot.png",
  "size":"173557",
  "storageClass":"STANDARD",
  "timeCreated":"2020-01-23T16:02:16.773Z",
  "timeStorageClassUpdated":"2020-01-23T16:02:16.773Z",
  "updated":"2020-01-23T16:02:16.773Z"
}

Nous préparons une requête à envoyer via le client Vision:

ImageSource imageSource = ImageSource.newBuilder()
    .setGcsImageUri("gs://" + bucketName + "/" + fileName)
    .build();

Image image = Image.newBuilder()
    .setSource(imageSource)
    .build();

Feature featureLabel = Feature.newBuilder()
    .setType(Type.LABEL_DETECTION)
    .build();
Feature featureImageProps = Feature.newBuilder()
    .setType(Type.IMAGE_PROPERTIES)
    .build();
Feature featureSafeSearch = Feature.newBuilder()
    .setType(Type.SAFE_SEARCH_DETECTION)
    .build();
    
AnnotateImageRequest request = AnnotateImageRequest.newBuilder()
    .addFeatures(featureLabel)
    .addFeatures(featureImageProps)
    .addFeatures(featureSafeSearch)
    .setImage(image)
    .build();

Nous avons besoin de trois fonctionnalités clés de l'API Vision:

  • Détection de thèmes: pour comprendre le contenu de ces images
  • Propriétés de l'image: pour fournir des attributs intéressants de l'image (nous nous intéressons à la couleur dominante de l'image)
  • SafeSearch: permet de savoir si l'image peut être affichée sans risque (elle ne doit pas contenir de contenu réservé aux adultes, médical, pour adultes ou violent)

À ce stade, nous pouvons appeler l'API Vision:

...
logger.info("Calling the Vision API...");
BatchAnnotateImagesResponse result = 
                            vision.batchAnnotateImages(requests);
List<AnnotateImageResponse> responses = result.getResponsesList();
...

Pour référence, voici à quoi ressemble la réponse de l'API Vision:

{
  "faceAnnotations": [],
  "landmarkAnnotations": [],
  "logoAnnotations": [],
  "labelAnnotations": [
    {
      "locations": [],
      "properties": [],
      "mid": "/m/01yrx",
      "locale": "",
      "description": "Cat",
      "score": 0.9959855675697327,
      "confidence": 0,
      "topicality": 0.9959855675697327,
      "boundingPoly": null
    },
    ✄ - - - ✄
  ],
  "textAnnotations": [],
  "localizedObjectAnnotations": [],
  "safeSearchAnnotation": {
    "adult": "VERY_UNLIKELY",
    "spoof": "UNLIKELY",
    "medical": "VERY_UNLIKELY",
    "violence": "VERY_UNLIKELY",
    "racy": "VERY_UNLIKELY",
    "adultConfidence": 0,
    "spoofConfidence": 0,
    "medicalConfidence": 0,
    "violenceConfidence": 0,
    "racyConfidence": 0,
    "nsfwConfidence": 0
  },
  "imagePropertiesAnnotation": {
    "dominantColors": {
      "colors": [
        {
          "color": {
            "red": 203,
            "green": 201,
            "blue": 201,
            "alpha": null
          },
          "score": 0.4175916016101837,
          "pixelFraction": 0.44456374645233154
        },
        ✄ - - - ✄
      ]
    }
  },
  "error": null,
  "cropHintsAnnotation": {
    "cropHints": [
      {
        "boundingPoly": {
          "vertices": [
            { "x": 0, "y": 118 },
            { "x": 1177, "y": 118 },
            { "x": 1177, "y": 783 },
            { "x": 0, "y": 783 }
          ],
          "normalizedVertices": []
        },
        "confidence": 0.41695669293403625,
        "importanceFraction": 1
      }
    ]
  },
  "fullTextAnnotation": null,
  "webDetection": null,
  "productSearchResults": null,
  "context": null
}

Si aucune erreur ne s'affiche, nous pouvons passer à autre chose. C'est pourquoi nous avons ce bloc "if" :

AnnotateImageResponse response = responses.get(0);
if (response.hasError()) {
     logger.info("Error: " + response.getError().getMessage());
     return;
}

Nous allons faire reconnaître les étiquettes des choses, des catégories ou des thèmes sur l'image:

List<String> labels = response.getLabelAnnotationsList().stream()
    .map(annotation -> annotation.getDescription())
    .collect(Collectors.toList());

logger.info("Annotations found:");
for (String label: labels) {
    logger.info("- " + label);
}

Nous souhaitons connaître la couleur dominante de l'image:

String mainColor = "#FFFFFF";
ImageProperties imgProps = response.getImagePropertiesAnnotation();
if (imgProps.hasDominantColors()) {
    DominantColorsAnnotation colorsAnn = 
                               imgProps.getDominantColors();
    ColorInfo colorInfo = colorsAnn.getColors(0);

    mainColor = rgbHex(
        colorInfo.getColor().getRed(), 
        colorInfo.getColor().getGreen(), 
        colorInfo.getColor().getBlue());

    logger.info("Color: " + mainColor);
}

Nous utilisons également une fonction utilitaire pour transformer les valeurs rouge / vert / bleu en un code couleur hexadécimal que nous pouvons utiliser dans les feuilles de style CSS.

Vérifions que l'image peut être affichée sans risque:

boolean isSafe = false;
if (response.hasSafeSearchAnnotation()) {
    SafeSearchAnnotation safeSearch = 
                      response.getSafeSearchAnnotation();

    isSafe = Stream.of(
        safeSearch.getAdult(), safeSearch.getMedical(), safeSearch.getRacy(),
        safeSearch.getSpoof(), safeSearch.getViolence())
    .allMatch( likelihood -> 
        likelihood != Likelihood.LIKELY && likelihood != Likelihood.VERY_LIKELY
    );

    logger.info("Safe? " + isSafe);
}

Nous vérifions les attributs pour adultes, parodies, médecine, violence ou pour adultes afin de déterminer s'ils sont peu probables ou très probables.

Si le résultat de la recherche sécurisée est correct, nous pouvons stocker des métadonnées dans Firestore:

if (isSafe) {
    FirestoreOptions firestoreOptions = FirestoreOptions.getDefaultInstance();
    Firestore pictureStore = firestoreOptions.getService();

    DocumentReference doc = pictureStore.collection("pictures").document(fileName);

    Map<String, Object> data = new HashMap<>();
    data.put("labels", labels);
    data.put("color", mainColor);
    data.put("created", new Date());

    ApiFuture<WriteResult> writeResult = doc.set(data, SetOptions.merge());

    logger.info("Picture metadata saved in Firestore at " + writeResult.get().getUpdateTime());
}

12. Déployer la fonction

Il est temps de déployer la fonction.

604f47aa11fbf8e.png

Appuyez sur le bouton DEPLOY pour déployer la nouvelle version. Vous pouvez voir la progression:

13da63f23e4dbbdd.png

13. Tester à nouveau la fonction

Une fois la fonction déployée, vous publierez une image dans Cloud Storage, puis vérifiez si la fonction est appelée, ce que renvoie l'API Vision et si les métadonnées sont stockées dans Firestore.

Revenez à Cloud Storage et cliquez sur le bucket que nous avons créé au début de l'atelier:

d44c1584122311c7.png

Une fois sur la page d'informations du bucket, cliquez sur le bouton Upload files pour importer une photo.

26bb31d35fb6aa3d.png

Du "hamburger", (Twilio), accédez à l'explorateur Logging > Logs.

Dans le sélecteur Log Fields, sélectionnez Cloud Function pour afficher les journaux dédiés à vos fonctions. Faites défiler les champs de journal vers le bas. Vous pouvez même sélectionner une fonction spécifique pour obtenir une vue plus détaillée des journaux associés aux fonctions. Sélectionnez la fonction picture-uploaded.

b651dca7e25d5b11.png

En effet, dans la liste des journaux, je peux voir que notre fonction a été appelée:

d22a7f24954e4f63.png

Les journaux indiquent le début et la fin de l'exécution de la fonction. Entre les deux, nous pouvons voir les journaux que nous avons placés dans notre fonction avec les instructions console.log(). Voici ce que nous voyons:

  • Les détails de l'événement qui déclenche notre fonction,
  • Les résultats bruts de l'appel de l'API Vision
  • Les étiquettes qui ont été trouvées dans l'image que nous avons importée,
  • Les informations sur les couleurs dominantes,
  • Si l'image peut être affichée en toute sécurité,
  • Et finalement, ces métadonnées sur l'image ont été stockées dans Firestore.

9ff7956a215c15da.png

Encore une fois, pour le « hamburger », (Twilio), accédez à la section Firestore. Dans la sous-section Data (affichée par défaut), vous devriez voir la collection pictures avec un nouveau document ajouté, correspondant à l'image que vous venez d'importer:

a6137ab9687da370.png

14. Nettoyer (facultatif)

Si vous n'avez pas l'intention de suivre les autres ateliers de la série, vous pouvez nettoyer les ressources pour réduire les coûts et utiliser globalement le cloud comme il se doit. Vous pouvez nettoyer les ressources individuellement comme suit.

Supprimez le bucket :

gsutil rb gs://${BUCKET_PICTURES}

Supprimez la fonction:

gcloud functions delete picture-uploaded --region europe-west1 -q

Supprimez la collection Firestore en sélectionnant "Supprimer la collection de la collection" :

410b551c3264f70a.png

Vous pouvez également supprimer l'intégralité du projet:

gcloud projects delete ${GOOGLE_CLOUD_PROJECT} 

15. Félicitations !

Félicitations ! Vous avez réussi à mettre en œuvre le premier service de clés du projet.

Points abordés

  • Cloud Storage
  • Cloud Functions
  • API Cloud Vision
  • Cloud Firestore

Étapes suivantes