Bermigrasi untuk Android

Panduan ini menjelaskan cara bermigrasi dari ML Kit for Firebase untuk Android.

Memperbarui impor Gradle

SDK ML Kit hanya memerlukan satu dependensi untuk setiap ML Kit API. Anda tidak perlu menentukan library umum seperti firebase-ml-vision atau firebase-ml-natural-language. ML Kit menggunakan namespace com.google.android.gms untuk library yang bergantung pada layanan Google Play.

Vision API

Model yang dipaketkan dikirimkan sebagai bagian dari aplikasi Anda. Model tipis harus didownload. Beberapa API tersedia dalam bentuk paket dan bentuk ringan, sementara yang lain hanya tersedia dalam salah satu bentuk:

Perbarui dependensi untuk library Android ML Kit di file Gradle modul (level aplikasi) (biasanya app/build.gradle.kts) sesuai dengan tabel berikut:

Model paket

Model tipis

AutoMLVision Edge

Natural Language API

Model yang dipaketkan dikirimkan sebagai bagian dari aplikasi Anda. Model tipis harus didownload:

Perbarui dependensi untuk library Android ML Kit di file Gradle modul (level aplikasi) (biasanya app/build.gradle.kts) sesuai dengan tabel berikut:

Model paket

Model tipis

Memperbarui nama class

Jika class Anda muncul dalam tabel ini, lakukan perubahan yang ditunjukkan:

Untuk class lainnya, ikuti aturan berikut:

• Hapus awalan FirebaseVision dari nama class.
• Hapus awalan lain yang diawali dengan awalan Firebase dari nama class.

Selain itu, dalam nama paket, ganti awalan com.google.firebase.ml dengan com.google.mlkit.

Memperbarui nama metode

Perubahan kode minimal:

• Pembuatan instance detektor/pemindai/pemberi label/penerjemah... telah diubah. Setiap fitur kini memiliki titik entri sendiri. Misalnya: BarcodeScanning, TextRecognition, ImageLabeling, Translation... Panggilan ke layanan Firebase getInstance() diganti dengan panggilan ke metode getClient() titik entri fitur.
• Pembuatan instance default untuk TextRecognizer telah dihapus, karena kami memperkenalkan library tambahan untuk mengenali skrip lain seperti bahasa China dan Korea. Untuk menggunakan opsi default dengan model pengenalan teks skrip Latin, deklarasikan dependensi pada com.google.android.gms:play-services-mlkit-text-recognition dan gunakan TextRecognition.getClient(TextRecognizerOptions.DEFAULT_OPTIONS).
• Pembuatan instance default untuk ImageLabeler dan ObjectDetector telah dihapus, karena kami memperkenalkan dukungan model kustom untuk kedua fitur ini. Misalnya, untuk menggunakan opsi default dengan model dasar di ImageLabeling, deklarasikan dependensi pada com.google.mlkit:image-labeling dan gunakan ImageLabeling.getClient(ImageLabelerOptions.DEFAULT_OPTIONS) di Java.
• Semua handle (detektor/pemindai/pelabel/penerjemah...) dapat ditutup. Pastikan metode close() dipanggil saat objek tersebut tidak akan digunakan lagi. Jika Anda menggunakannya dalam Fragment atau AppCompatActivity, salah satu cara untuk melakukannya adalah dengan memanggil LifecycleOwner.getLifecycle() pada Fragment atau AppCompatActivity, lalu memanggil Lifecycle.addObserver.
• processImage() dan detectInImage() di Vision API telah diganti namanya menjadi process() agar konsisten.
• Natural Language API kini menggunakan istilah "tag bahasa" (sebagaimana didefinisikan oleh standar BCP 47), bukan "kode bahasa".
• Metode pengambil di class xxxOptions telah dihapus.
• Metode getBitmap() di class InputImage (menggantikan FirebaseVisionImage) tidak lagi didukung sebagai bagian dari antarmuka publik. Lihat BitmapUtils.java di contoh panduan memulai ML Kit untuk mendapatkan bitmap yang dikonversi dari berbagai input.
• FirebaseVisionImageMetadata telah dihapus, Anda cukup meneruskan metadata gambar seperti width, height, rotationDegrees, format ke dalam metode konstruksi InputImage.

Berikut beberapa contoh metode Kotlin lama dan baru:

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

Berikut beberapa contoh metode Java lama dan baru:

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

Perubahan khusus API

Pemindaian Kode Batang

Untuk Barcode Scanning API, kini ada dua cara pengiriman model:

• Melalui Layanan Google Play alias "thin" (direkomendasikan) - cara ini mengurangi ukuran aplikasi dan model dibagikan di antara aplikasi. Namun, developer harus memastikan bahwa model telah didownload sebelum menggunakannya untuk pertama kali.
• Dengan APK aplikasi Anda, alias "dipaketkan" - cara ini akan meningkatkan ukuran aplikasi, tetapi model akan langsung dapat digunakan.

Kedua implementasi tersebut sedikit berbeda, dengan versi "dipaketkan" memiliki sejumlah peningkatan dibandingkan versi "ringkas". Detail tentang perbedaan ini dapat ditemukan di panduan Barcode Scanning API.

Deteksi Wajah

Untuk Face Detection API, ada dua cara model dapat dikirimkan:

• Melalui Layanan Google Play alias "thin" (direkomendasikan) - cara ini mengurangi ukuran aplikasi dan model dibagikan di antara aplikasi. Namun, developer harus memastikan bahwa model telah didownload sebelum menggunakannya untuk pertama kali.
• Dengan APK aplikasi Anda, alias "dipaketkan" - hal ini meningkatkan ukuran download aplikasi, tetapi berarti model dapat langsung digunakan.

Perilaku implementasinya sama.

Translation

• TranslateLanguage kini menggunakan nama yang dapat dibaca untuk konstantanya (misalnya, ENGLISH), bukan tag bahasa (EN). Konstanta tersebut kini juga berupa @StringDef, bukan @IntDef, dan nilai konstantanya adalah tag bahasa BCP 47 yang cocok.

Pelabelan Gambar AutoML (tidak digunakan lagi)

Mendownload model kustom untuk pelabelan gambar menggunakan AutoML tidak digunakan lagi dan akan dihentikan pada 15 Juni 2027. Anda harus menggunakan Cloud Storage untuk menghosting model dan menambahkan logika download ke aplikasi untuk mendownload model. Untuk mengetahui detailnya, lihat panduan migrasi Firebase ML ke Cloud Storage.

Deteksi dan Pelacakan Objek

Jika aplikasi Anda menggunakan deteksi objek dengan klasifikasi kasar, perlu diketahui bahwa SDK baru telah mengubah cara menampilkan kategori klasifikasi untuk objek yang terdeteksi.

Kategori klasifikasi ditampilkan sebagai instance DetectedObject.Label, bukan bilangan bulat. Semua kemungkinan kategori untuk pengklasifikasi kasar disertakan dalam class PredefinedCategory.

Berikut adalah contoh kode Kotlin lama dan baru:

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

Berikut adalah contoh kode Java lama dan baru:

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

Kategori "tidak diketahui" telah dihapus. Jika keyakinan klasifikasi objek rendah, kami tidak akan menampilkan label apa pun.

Menghapus dependensi Firebase

Hapus dependensi Firebase setelah migrasi. Ikuti langkah-langkah berikut:

• Hapus file konfigurasi Firebase dengan menghapus file konfigurasi google-services.json di direktori modul (level aplikasi) aplikasi Anda.
• Ganti plugin Gradle Layanan Google di file Gradle modul (level aplikasi) Anda (biasanya app/build.gradle.kts) dengan plugin Strict Version Matcher:

plugins {
  id("com.android.application")
  id("com.google.gms.google-services")
}

android {
  // …
}

plugins {
  id("com.android.application")
  id("com.google.android.gms.strict-version-matcher-plugin")
}

android {
  // …
}

• Ganti classpath plugin Gradle Layanan Google di file Gradle (level root) project Anda (build.gradle.kts) dengan classpath untuk plugin Strict Version Matcher:

buildscript {
  dependencies {
    // ...

    classpath("com.google.gms:google-services:4.3.3")
  }
}

buildscript {
  dependencies {
    // ...
    classpath("com.google.android.gms:strict-version-matcher-plugin:1.2.1")
  }
}

Hapus aplikasi Firebase Anda di Firebase console sesuai dengan petunjuk di situs dukungan Firebase.

Mendapatkan Bantuan

Jika Anda mengalami masalah, lihat halaman Komunitas kami, tempat kami menguraikan saluran yang tersedia untuk menghubungi kami.