Migrer pour Android

Mettre à jour les importations Gradle

Le nouveau SDK ne nécessite qu'une seule dépendance pour chaque API ML Kit. Vous n'avez pas besoin de spécifier les bibliothèques courantes telles que firebase-ml-vision ou firebase-ml-natural-language. ML Kit utilise l'espace de noms com.google.android.gms pour les bibliothèques qui dépendent des services Google Play.

API Vision

Les modèles groupés sont fournis avec votre application. Les modèles fins doivent être téléchargés. Certaines API sont disponibles à la fois sous forme groupée et sous forme fine, tandis que d'autres ne le sont que sous une seule forme :

Mettez à jour les dépendances des bibliothèques Android ML Kit dans le fichier Gradle de votre module (au niveau de l'application, généralement app/build.gradle) en fonction des tableaux suivants :

Modèles groupés

Modèles fins

AutoMLVision Edge

API Natural Language

Les modèles groupés sont fournis avec votre application. Les modèles fins doivent être téléchargés :

Mettez à jour les dépendances des bibliothèques Android ML Kit dans le fichier Gradle de votre module (au niveau de l'application, généralement app/build.gradle) en fonction des tableaux suivants :

Modèles groupés

Modèles fins

Mettre à jour les noms de classes

Si votre cours apparaît dans ce tableau, apportez la modification indiquée :

Pour les autres cours, suivez ces règles :

• Supprimez le préfixe FirebaseVision du nom de la classe.
• Supprimez les autres préfixes commençant par Firebase du nom de la classe.

De plus, dans les noms de packages, remplacez le préfixe com.google.firebase.ml par com.google.mlkit.

Mettre à jour les noms de méthodes

Les modifications de code sont minimes :

• L'instanciation du détecteur/scanner/outil d'étiquetage/traducteur… a été modifiée. Chaque fonctionnalité dispose désormais de son propre point d'entrée. Par exemple : BarcodeScanning, TextRecognition, ImageLabeling, Translation…. Les appels au service Firebase getInstance() sont remplacés par des appels à la méthode getClient() du point d'entrée de la fonctionnalité.
• L'instanciation par défaut de TextRecognizer a été supprimée, car nous avons introduit des bibliothèques supplémentaires pour reconnaître d'autres scripts comme le chinois et le coréen. Pour utiliser les options par défaut avec le modèle de reconnaissance de texte en alphabet latin, veuillez déclarer une dépendance sur com.google.android.gms:play-services-mlkit-text-recognition et utiliser TextRecognition.getClient(TextRecognizerOptions.DEFAULT_OPTIONS).
• L'instanciation par défaut pour ImageLabeler et ObjectDetector a été supprimée, car nous avons introduit la prise en charge des modèles personnalisés pour ces deux fonctionnalités. Par exemple, pour utiliser les options par défaut avec le modèle de base dans ImageLabeling, veuillez déclarer une dépendance sur com.google.mlkit:image-labeling et utiliser ImageLabeling.getClient(ImageLabelerOptions.DEFAULT_OPTIONS) en Java.
• Tous les handles (détecteur/scanner/outil d'étiquetage/traducteur, etc.) peuvent être fermés. Assurez-vous que la méthode close() est appelée lorsque ces objets ne seront plus utilisés. Si vous les utilisez dans un Fragment ou une AppCompatActivity, une façon simple de le faire est d'appeler LifecycleOwner.getLifecycle() sur le Fragment ou l'AppCompatActivity, puis d'appeler Lifecycle.addObserver.
• processImage() et detectInImage() dans les API Vision ont été renommés process() pour plus de cohérence.
• Les API Natural Language utilisent désormais le terme "tag de langue" (tel que défini par la norme BCP 47) au lieu de "code de langue".
• Les méthodes Getter des classes xxxOptions ont été supprimées.
• La méthode getBitmap() de la classe InputImage(qui remplace FirebaseVisionImage) n'est plus compatible avec l'interface publique. Veuillez consulter BitmapUtils.java dans l'exemple de démarrage rapide de ML Kit pour obtenir un bitmap converti à partir de différentes entrées.
• FirebaseVisionImageMetadata a été supprimé. Vous pouvez simplement transmettre les métadonnées de l'image, telles que la largeur, la hauteur, rotationDegrees et le format, aux méthodes de construction d'InputImages.

Voici quelques exemples d'anciennes et de nouvelles méthodes Kotlin :

// Construct image labeler with base model and default options.
val imageLabeler = FirebaseVision.getInstance().onDeviceImageLabeler

// Construct object detector with base model and default options.
val objectDetector = FirebaseVision.getInstance().onDeviceObjectDetector

// Construct face detector with given options
val faceDetector = FirebaseVision.getInstance().getVisionFaceDetector(options)

// Construct image labeler with local AutoML model
val localModel =
    FirebaseAutoMLLocalModel.Builder()
      .setAssetFilePath("automl/manifest.json")
      .build()
val autoMLImageLabeler =
    FirebaseVision.getInstance()
      .getOnDeviceAutoMLImageLabeler(
          FirebaseVisionOnDeviceAutoMLImageLabelerOptions.Builder(localModel)
            .setConfidenceThreshold(0.3F)
            .build()
    )

// Construct image labeler with base model and default options.
val imageLabeler = ImageLabeling.getClient(ImageLabelerOptions.DEFAULT_OPTIONS)
// Optional: add life cycle observer
lifecycle.addObserver(imageLabeler)

// Construct object detector with base model and default options.
val objectDetector = ObjectDetection.getClient(ObjectDetectorOptions.DEFAULT_OPTIONS)

// Construct face detector with given options
val faceDetector = FaceDetection.getClient(options)

// Construct image labeler with local AutoML model
val localModel =
  LocalModel.Builder()
    .setAssetManifestFilePath("automl/manifest.json")
    .build()
val autoMLImageLabeler =
  ImageLabeling.getClient(
    CustomImageLabelerOptions.Builder(localModel)
    .setConfidenceThreshold(0.3F).build())
  

Voici quelques exemples d'anciennes et de nouvelles méthodes Java :

// Construct image labeler with base model and default options.
FirebaseVisionImageLabeler imagelLabeler =
     FirebaseVision.getInstance().getOnDeviceImageLabeler();

// Construct object detector with base model and default options.
FirebaseVisionObjectDetector objectDetector =
     FirebaseVision.getInstance().getOnDeviceObjectDetector();

// Construct face detector with given options
FirebaseVisionFaceDetector faceDetector =
     FirebaseVision.getInstance().getVisionFaceDetector(options);

// Construct image labeler with local AutoML model
FirebaseAutoMLLocalModel localModel =
    new FirebaseAutoMLLocalModel.Builder()
      .setAssetFilePath("automl/manifest.json")
      .build();
FirebaseVisionImageLabeler autoMLImageLabeler =
    FirebaseVision.getInstance()
      .getOnDeviceAutoMLImageLabeler(
          FirebaseVisionOnDeviceAutoMLImageLabelerOptions.Builder(localModel)
            .setConfidenceThreshold(0.3F)
            .build());

// Construct image labeler with base model and default options.
ImageLabeler imageLabeler = ImageLabeling.getClient(ImageLabelerOptions.DEFAULT_OPTIONS);
// Optional: add life cycle observer
getLifecycle().addObserver(imageLabeler);

// Construct object detector with base model and default options.
ObjectDetector objectDetector = ObjectDetection.getClient(ObjectDetectorOptions.DEFAULT_OPTIONS);

// Construct face detector with given options
FaceDetector faceDetector = FaceDetection.getClient(options);

// Construct image labeler with local AutoML model
LocalModel localModel =
  new LocalModel.Builder()
    .setAssetManifestFilePath("automl/manifest.json")
    .build();
ImageLabeler autoMLImageLabeler =
  ImageLabeling.getClient(
    new CustomImageLabelerOptions.Builder(localModel)
    .setConfidenceThreshold(0.3F).build());
  

Modifications spécifiques à l'API

Lecture de codes-barres

Pour l'API Barcode Scanning, les modèles peuvent désormais être fournis de deux manières :

• Via les services Google Play, également appelés "minces" (recommandé) : cela réduit la taille de l'application et le modèle est partagé entre les applications. Toutefois, les développeurs devront s'assurer que le modèle est téléchargé avant de l'utiliser pour la première fois.
• Avec l'APK de votre application, également appelé "groupé" : la taille de l'application augmente, mais le modèle est immédiatement utilisable.

Les deux implémentations sont légèrement différentes, la version "groupée" présentant un certain nombre d'améliorations par rapport à la version "mince". Pour en savoir plus sur ces différences, consultez les consignes concernant l'API Barcode Scanning.

Détection de visages

Pour l'API Face Detection, les modèles peuvent être fournis de deux manières :

• Via les services Google Play, également appelés "minces" (recommandé) : cela réduit la taille de l'application et le modèle est partagé entre les applications. Toutefois, les développeurs devront s'assurer que le modèle est téléchargé avant de l'utiliser pour la première fois.
• Avec l'APK de votre application, également appelé "groupé" : la taille de téléchargement de l'application augmente, mais le modèle est immédiatement utilisable.

Le comportement des implémentations est identique.

Translation

• TranslateLanguage utilise désormais des noms lisibles pour ses constantes (par exemple, ENGLISH) au lieu de balises de langue (EN). Elles sont également désormais @StringDef, au lieu de @IntDef, et la valeur de la constante est la balise de langue BCP 47 correspondante.

• Si votre application utilise l'option de condition de téléchargement "Appareil inactif", sachez qu'elle a été supprimée et ne peut plus être utilisée. Vous pouvez toujours utiliser l'option "Recharge de l'appareil". Si vous souhaitez un comportement plus complexe, vous pouvez retarder l'appel de RemoteModelManager.download derrière votre propre logique.

AutoML Image Labeling

Si votre application utilise l'option de condition de téléchargement "Appareil inactif", sachez que cette option a été supprimée et ne peut plus être utilisée. Vous pouvez toujours utiliser l'option "Recharge de l'appareil".

Si vous souhaitez un comportement plus complexe, vous pouvez retarder l'appel de RemoteModelManager.download derrière votre propre logique.

Détection et suivi des objets

Si votre application utilise la détection d'objets avec une classification approximative, sachez que le nouveau SDK a modifié la façon dont il renvoie la catégorie de classification pour les objets détectés.

La catégorie de classification est renvoyée sous la forme d'une instance de DetectedObject.Label au lieu d'un nombre entier. Toutes les catégories possibles pour le classificateur grossier sont incluses dans la classe PredefinedCategory.

Voici un exemple de l'ancien et du nouveau code Kotlin :

if (object.classificationCategory == FirebaseVisionObject.CATEGORY_FOOD) {
    ...
}

if (!object.labels.isEmpty() && object.labels[0].text == PredefinedCategory.FOOD) {
    ...
}
// or
if (!object.labels.isEmpty() && object.labels[0].index == PredefinedCategory.FOOD_INDEX) {
    ...
}

Voici un exemple de l'ancien et du nouveau code Java :

if (object.getClassificationCategory() == FirebaseVisionObject.CATEGORY_FOOD) {
    ...
}

if (!object.getLabels().isEmpty()
    && object.getLabels().get(0).getText().equals(PredefinedCategory.FOOD)) {
    ...
}
// or
if (!object.getLabels().isEmpty()
    && object.getLabels().get(0).getIndex() == PredefinedCategory.FOOD_INDEX) {
    ...
}

La catégorie "Inconnu" a été supprimée. Lorsque la confiance dans la classification d'un objet est faible, nous ne renvoyons aucune étiquette.

Supprimer les dépendances Firebase (facultatif)

Cette étape ne s'applique que lorsque les conditions suivantes sont remplies :

• Firebase ML Kit est le seul composant Firebase que vous utilisez.
• Vous n'utilisez que des API sur l'appareil.
• Vous n'utilisez pas le service de modèle.

Si tel est le cas, vous pouvez supprimer les dépendances Firebase après la migration. Procédez comme suit :

• Supprimez le fichier de configuration Firebase en supprimant le fichier de configuration google-services.json dans le répertoire du module (au niveau de l'application) de votre application.
• Remplacez le plug-in Gradle des services Google dans le fichier Gradle de votre module (au niveau de l'application), généralement app/build.gradle, par le plug-in Strict Version Matcher :

apply plugin: 'com.android.application'
apply plugin: 'com.google.gms.google-services'  // Google Services plugin

android {
  // …
}

apply plugin: 'com.android.application'
apply plugin: 'com.google.android.gms.strict-version-matcher-plugin'

android {
  // …
}

• Remplacez le chemin de classe du plug-in Gradle des services Google dans le fichier Gradle (build.gradle) au niveau du projet (racine) par celui du plug-in Strict Version Matcher :

buildscript {
  dependencies {
    // ...

    classpath 'com.google.gms:google-services:4.3.3'  // Google Services plugin
  }
}

buildscript {
  dependencies {
    // ...

    classpath 'com.google.android.gms:strict-version-matcher-plugin:1.2.1'
  }
}

Supprimez votre application Firebase dans la console Firebase en suivant les instructions sur le site d'assistance Firebase.

Obtenir de l'aide

Si vous rencontrez des problèmes, veuillez consulter notre page de la communauté, qui présente les canaux disponibles pour nous contacter.