Migración para Android

Actualiza las importaciones de Gradle

El nuevo SDK solo requiere una dependencia para cada API de ML Kit. No es necesario que especifiques bibliotecas comunes como firebase-ml-vision o firebase-ml-natural-language. ML Kit usa el espacio de nombres com.google.android.gms para las bibliotecas que dependen de los Servicios de Google Play.

APIs de Vision

Los modelos agrupados se entregan como parte de tu aplicación. Se deben descargar los modelos delgados. Algunas APIs están disponibles en forma agrupada y delgada, mientras que otras solo en una forma u otra:

Actualiza las dependencias de las bibliotecas de Android del ML Kit en el archivo Gradle (generalmente app/build.gradle) de tu módulo (nivel de app) según las siguientes tablas:

Modelos agrupados

Modelos delgados

AutoMLVision Edge

APIs de Natural Language

Los modelos agrupados se entregan como parte de tu aplicación. Se deben descargar los modelos delgados:

Actualiza las dependencias de las bibliotecas de Android del ML Kit en el archivo Gradle (generalmente app/build.gradle) de tu módulo (nivel de app) según las siguientes tablas:

Modelos agrupados

Modelos delgados

Actualiza los nombres de las clases

Si tu clase aparece en esta tabla, realiza el cambio indicado:

Para otras clases, sigue estas reglas:

• Quita el prefijo FirebaseVision del nombre de la clase.
• Quita otros prefijos que comiencen con el prefijo Firebase del nombre de la clase.

Además, en los nombres de los paquetes, reemplaza el prefijo com.google.firebase.ml por com.google.mlkit.

Actualiza los nombres de los métodos

Los cambios en el código son mínimos:

• Se cambió la instancia de detector/escáner/etiquetador/traductor. Cada función ahora tiene su propio punto de entrada. Por ejemplo: BarcodeScanning, TextRecognition, ImageLabeling, Translation… Las llamadas al servicio de Firebase getInstance() se reemplazan por llamadas al método getClient() del punto de entrada de la función.
• Se quitó la instancia predeterminada de TextRecognizer, ya que presentamos bibliotecas adicionales para reconocer otras secuencias de comandos, como el chino y el coreano. Para usar las opciones predeterminadas con el modelo de reconocimiento de texto de secuencia de comandos latina, declara una dependencia en com.google.android.gms:play-services-mlkit-text-recognition y usa TextRecognition.getClient(TextRecognizerOptions.DEFAULT_OPTIONS).
• Se quitó la instancia predeterminada de ImageLabeler y ObjectDetector, ya que presentamos compatibilidad con modelos personalizados para estas dos funciones. Por ejemplo, para usar las opciones predeterminadas con el modelo base en ImageLabeling, declara una dependencia en com.google.mlkit:image-labeling y usa ImageLabeling.getClient(ImageLabelerOptions.DEFAULT_OPTIONS) en Java.
• Todos los controladores (detector/escáner/etiquetador/traductor…) se pueden cerrar. Asegúrate de que se llame al método close() cuando ya no se usen esos objetos. Si los usas en un fragmento o AppCompatActivity, una forma sencilla de hacerlo es llamar a LifecycleOwner.getLifecycle() en el fragmento o AppCompatActivity y, luego, llamar a Lifecycle.addObserver.
• Se cambió el nombre de processImage() y detectInImage() en las APIs de Vision a process() para mantener la coherencia.
• Las APIs de Natural Language ahora usan el término “etiqueta de idioma” (según lo define el estándar BCP 47) en lugar de “código de idioma”.
• Se quitaron los métodos getter en las clases xxxOptions.
• Ya no se admite el método getBitmap() en la clase InputImage(que reemplaza a FirebaseVisionImage) como parte de la interfaz pública. Consulta BitmapUtils.java en la muestra de inicio rápido del ML Kit para obtener el mapa de bits convertido de varias entradas.
• Se quitó FirebaseVisionImageMetadata. Ahora puedes pasar metadatos de imágenes, como ancho, alto, rotationDegrees y formato, a los métodos de construcción de InputImages.

Estos son algunos ejemplos de métodos de Kotlin anteriores y nuevos:

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

Estos son algunos ejemplos de métodos de Java anteriores y nuevos:

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

Cambios específicos de la API

Escaneo de códigos de barras

Para la API de Barcode Scanning, ahora hay dos formas en que se pueden entregar los modelos:

• A través de los Servicios de Google Play, también conocidos como “delgados” (recomendado) : Esto reduce el tamaño de la app y el modelo se comparte entre las aplicaciones. Sin embargo, los desarrolladores deberán asegurarse de que el modelo se descargue antes de usarlo por primera vez.
• Con el APK de tu app, también conocido como “agrupado” : Esto aumenta el tamaño de la app, pero significa que el modelo se puede usar de inmediato.

Las dos implementaciones son ligeramente diferentes, y la versión “agrupada” tiene varias mejoras con respecto a la versión “delgada”. Puedes encontrar detalles sobre estas diferencias en los lineamientos de la API de Barcode Scanning.

Detección de rostro

Para la API de Face Detection, hay dos formas en que se pueden entregar los modelos:

• A través de los Servicios de Google Play, también conocidos como “delgados” (recomendado) : Esto reduce el tamaño de la app y el modelo se comparte entre las aplicaciones. Sin embargo, los desarrolladores deberán asegurarse de que el modelo se descargue antes de usarlo por primera vez.
• Con el APK de tu app, también conocido como “agrupado” : Esto aumenta el tamaño de descarga de la app, pero significa que el modelo se puede usar de inmediato.

El comportamiento de las implementaciones es el mismo.

Traducción

• TranslateLanguage ahora usa nombres legibles para sus constantes (p.ej., ENGLISH) en lugar de etiquetas de idioma (EN). También son @StringDef, en lugar de @IntDef, y el valor de la constante es la etiqueta de idioma BCP 47 coincidente.

• Si tu app usa la opción de condición de descarga “dispositivo inactivo”, ten en cuenta que se quitó y ya no se puede usar. Aún puedes usar la opción “dispositivo cargando”. Si deseas un comportamiento más complejo, puedes retrasar la llamada a RemoteModelManager.download detrás de tu propia lógica.

Etiquetado de imágenes de AutoML

Si tu app usa la opción de condición de descarga “dispositivo inactivo”, ten en cuenta que se quitó y ya no se puede usar. Aún puedes usar la opción “dispositivo cargando”.

Si deseas un comportamiento más complejo, puedes retrasar la llamada a RemoteModelManager.download detrás de tu propia lógica.

Detección y seguimiento de objetos

Si tu app usa la detección de objetos con clasificación aproximada, ten en cuenta que el nuevo SDK cambió la forma en que muestra la categoría de clasificación para los objetos detectados.

La categoría de clasificación se muestra como una instancia de DetectedObject.Label en lugar de un número entero. Todas las categorías posibles para el clasificador aproximado se incluyen en la clase PredefinedCategory.

Este es un ejemplo del código de Kotlin anterior y nuevo:

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

Este es un ejemplo del código de Java anterior y nuevo:

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

Se quitó la categoría “desconocido”. Cuando la confianza de la clasificación de un objeto es baja, no mostramos ninguna etiqueta.

Quita las dependencias de Firebase (opcional)

Este paso solo se aplica cuando se cumplen estas condiciones:

• El Kit de AA de Firebase es el único componente de Firebase que usas.
• Solo usas APIs integrado en el dispositivo.
• No usas la entrega de modelos.

Si es así, puedes quitar las dependencias de Firebase después de la migración. Sigue estos pasos:

• Para quitar el archivo de configuración de Firebase, borra el archivo de configuración google-services.json en el directorio del módulo (nivel de app) de tu app.
• Reemplaza el complemento Gradle de los servicios de Google en el archivo Gradle (generalmente app/build.gradle) de tu módulo (nivel de app) por el complemento 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 {
  // …
}

• Reemplaza la ruta de clase del complemento Gradle de los servicios de Google en el archivo Gradle (nivel raíz) de tu proyecto (build.gradle) por la del complemento 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'
  }
}

Borra tu app de Firebase en Firebase console según las instrucciones del sitio de asistencia de Firebase.

Cómo obtener ayuda

Si tienes algún problema, consulta nuestra página de la comunidad, en la que se describen los canales disponibles para comunicarte con nosotros.