Migration für Android

Gradle-Importe aktualisieren

Für das neue SDK ist nur eine Abhängigkeit für jede ML Kit API erforderlich. Sie müssen keine gängigen Bibliotheken wie firebase-ml-vision oder firebase-ml-natural-language angeben. ML Kit verwendet den Namespace com.google.android.gms für Bibliotheken, die von Google Play-Diensten abhängen.

Vision APIs

Gebündelte Modelle werden als Teil Ihrer Anwendung bereitgestellt. Thin-Modelle müssen heruntergeladen werden. Einige APIs sind sowohl in der gebündelten als auch in der Thin-Form verfügbar, andere nur in einer der beiden Formen:

Aktualisieren Sie die Abhängigkeiten für die ML Kit Android-Bibliotheken in der Gradle-Datei Ihres Moduls (auf App-Ebene, in der Regel app/build.gradle) gemäß den folgenden Tabellen:

Gebündelte Modelle

Schlanke Modelle

AutoMLVision Edge

Natural Language APIs

Gebündelte Modelle werden als Teil Ihrer Anwendung bereitgestellt. Thin-Modelle müssen heruntergeladen werden:

Aktualisieren Sie die Abhängigkeiten für die ML Kit Android-Bibliotheken in der Gradle-Datei Ihres Moduls (auf App-Ebene, in der Regel app/build.gradle) gemäß den folgenden Tabellen:

Gebündelte Modelle

Schlanke Modelle

Klassennamen aktualisieren

Wenn Ihre Klasse in dieser Tabelle aufgeführt ist, nehmen Sie die angegebene Änderung vor:

Für andere Klassen gelten folgende Regeln:

• Entfernen Sie das Präfix FirebaseVision aus dem Klassennamen.
• Entfernen Sie andere Präfixe, die mit dem Präfix Firebase beginnen, aus dem Klassennamen.

Ersetzen Sie außerdem in Paketnamen das Präfix com.google.firebase.ml durch com.google.mlkit.

Methodennamen aktualisieren

Es sind nur geringfügige Codeänderungen erforderlich:

• Die Instanziierung von Detektor, Scanner, Labeler und Übersetzer wurde geändert. Jedes Feature hat jetzt einen eigenen Einstiegspunkt. Beispiele: BarcodeScanning, TextRecognition, ImageLabeling, Translation… Aufrufe des Firebase-Dienstes getInstance() werden durch Aufrufe der getClient()-Methode des Feature-Einstiegspunkts ersetzt.
• Die Standardinstanziierung für TextRecognizer wurde entfernt, da wir zusätzliche Bibliotheken für die Erkennung anderer Schriftsysteme wie Chinesisch und Koreanisch eingeführt haben. Wenn Sie Standardoptionen mit dem Modell für die Texterkennung im lateinischen Schriftsystem verwenden möchten, deklarieren Sie eine Abhängigkeit von com.google.android.gms:play-services-mlkit-text-recognition und verwenden Sie TextRecognition.getClient(TextRecognizerOptions.DEFAULT_OPTIONS).
• Die Standardinstanziierung für ImageLabeler und ObjectDetector wurde entfernt, da wir die Unterstützung für benutzerdefinierte Modelle für diese beiden Funktionen eingeführt haben. Wenn Sie beispielsweise Standardoptionen mit dem Basismodell in ImageLabeling verwenden möchten, deklarieren Sie eine Abhängigkeit von com.google.mlkit:image-labeling und verwenden Sie ImageLabeling.getClient(ImageLabelerOptions.DEFAULT_OPTIONS) in Java.
• Alle Handles (Detektor, Scanner, Labeler, Übersetzer usw.) können geschlossen werden. Achten Sie darauf, dass die Methode close() aufgerufen wird, wenn diese Objekte nicht mehr verwendet werden. Wenn Sie sie in einem Fragment oder einer AppCompatActivity verwenden, können Sie dazu einfach LifecycleOwner.getLifecycle() für das Fragment oder die AppCompatActivity aufrufen und dann Lifecycle.addObserver.
• processImage() und detectInImage() in den Vision APIs wurden aus Gründen der Einheitlichkeit in process() umbenannt.
• In den Natural Language APIs wird jetzt der Begriff „Sprachtag“ (gemäß BCP 47-Standard) anstelle von „Sprachcode“ verwendet.
• Getter-Methoden in xxxOptions-Klassen wurden entfernt.
• Die Methode „getBitmap()“ in der Klasse „InputImage“ (als Ersatz für FirebaseVisionImage) wird nicht mehr als Teil der öffentlichen Schnittstelle unterstützt. Unter BitmapUtils.java im ML Kit-Schnellstartbeispiel finden Sie Informationen zum Konvertieren von Bitmaps aus verschiedenen Eingaben.
• FirebaseVisionImageMetadata wurde entfernt. Sie können einfach Bildmetadaten wie Breite, Höhe, rotationDegrees und Format an die Konstruktionsmethoden von InputImages übergeben.

Hier sind einige Beispiele für alte und neue Kotlin-Methoden:

// 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())
  

Hier einige Beispiele für alte und neue Java-Methoden:

// 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());
  

API-spezifische Änderungen

Barcodes scannen

Für die Barcode Scanning API gibt es jetzt zwei Möglichkeiten, die Modelle bereitzustellen:

• Über die Google Play-Dienste, auch „Thin“ genannt (empfohlen): Dadurch wird die App-Größe reduziert und das Modell wird von mehreren Anwendungen gemeinsam genutzt. Entwickler müssen jedoch dafür sorgen, dass das Modell heruntergeladen wird, bevor es zum ersten Mal verwendet wird.
• Mit dem APK Ihrer App, also „gebündelt“: Dadurch wird die App-Größe erhöht, das Modell ist aber sofort nutzbar.

Die beiden Implementierungen unterscheiden sich geringfügig. Die „gebündelte“ Version bietet einige Verbesserungen gegenüber der „schlanken“ Version. Details zu diesen Unterschieden finden Sie in den Richtlinien zur Barcode Scanning API.

Gesichtserkennung

Für die Face Detection API gibt es zwei Möglichkeiten, die Modelle bereitzustellen:

• Über die Google Play-Dienste, auch „Thin“ genannt (empfohlen): Dadurch wird die App-Größe reduziert und das Modell wird von mehreren Anwendungen gemeinsam genutzt. Entwickler müssen jedoch dafür sorgen, dass das Modell heruntergeladen wird, bevor es zum ersten Mal verwendet wird.
• Mit dem APK Ihrer App, d. h. „gebündelt“: Dadurch wird die Downloadgröße der App erhöht, das Modell ist aber sofort einsatzbereit.

Das Verhalten der Implementierungen ist identisch.

Translation

• TranslateLanguage verwendet jetzt lesbare Namen für seine Konstanten (z.B. ENGLISH) anstelle von Sprach-Tags (EN). Sie sind jetzt auch @StringDef anstelle von @IntDef und der Wert der Konstante ist das entsprechende BCP 47-Sprach-Tag.

• Wenn Ihre App die Downloadbedingung „Gerät im Leerlauf“ verwendet, beachten Sie bitte, dass diese Option entfernt wurde und nicht mehr verwendet werden kann. Sie können die Option „Gerät aufladen“ weiterhin verwenden. Wenn Sie ein komplexeres Verhalten wünschen, können Sie den Aufruf von RemoteModelManager.download hinter Ihrer eigenen Logik verzögern.

AutoML-Bildlabeling

Wenn Ihre App die Downloadbedingung „Gerät im Leerlauf“ verwendet, beachten Sie, dass diese Option entfernt wurde und nicht mehr verwendet werden kann. Sie können weiterhin die Option „Gerät aufladen“ verwenden.

Wenn Sie ein komplexeres Verhalten wünschen, können Sie den Aufruf von RemoteModelManager.download hinter Ihrer eigenen Logik verzögern.

Objekterkennung und -tracking

Wenn Ihre App die Objekterkennung mit grober Klassifizierung verwendet, beachten Sie, dass sich die Art und Weise geändert hat, wie das neue SDK die Klassifizierungskategorie für erkannte Objekte zurückgibt.

Die Klassifizierungskategorie wird als Instanz von DetectedObject.Label anstelle einer Ganzzahl zurückgegeben. Alle möglichen Kategorien für den groben Klassifikator sind in der Klasse PredefinedCategory enthalten.

Hier ein Beispiel für den alten und neuen Kotlin-Code:

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) {
    ...
}

Hier ist ein Beispiel für den alten und neuen Java-Code:

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) {
    ...
}

Die Kategorie „Unbekannt“ wurde entfernt. Wenn die Konfidenz der Klassifizierung eines Objekts niedrig ist, geben wir einfach kein Label zurück.

Firebase-Abhängigkeiten entfernen (optional)

Dieser Schritt gilt nur, wenn die folgenden Bedingungen erfüllt sind:

• Firebase ML Kit ist die einzige Firebase-Komponente, die Sie verwenden.
• Sie verwenden nur On-Device-APIs.
• Sie verwenden keine Modellbereitstellung.

In diesem Fall können Sie die Firebase-Abhängigkeiten nach der Migration entfernen. Gehen Sie so vor:

• Entfernen Sie die Firebase-Konfigurationsdatei, indem Sie die Konfigurationsdatei „google-services.json“ im Modulverzeichnis (auf App-Ebene) Ihrer App löschen.
• Ersetzen Sie das Google-Dienste-Gradle-Plug-in in der Gradle-Datei Ihres Moduls (auf App-Ebene, in der Regel „app/build.gradle“) durch das Strict Version Matcher-Plug-in:

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 {
  // …
}

• Ersetzen Sie den Google Services Gradle-Plug-in-Klassenpfad in der Gradle-Datei Ihres Projekts (auf Stammebene) (build.gradle) durch den des Strict Version Matcher-Plug-ins:

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'
  }
}

Löschen Sie Ihre Firebase-App in der Firebase Console gemäß der Anleitung auf der Firebase-Supportwebsite.

Hilfe erhalten

Sollten Probleme auftreten, findest du auf unserer Community-Seite Informationen dazu, wie du uns kontaktieren kannst.