Migração para o Android

Atualizar importações do Gradle

O novo SDK exige apenas uma dependência para cada API do ML Kit. Não é necessário especificar bibliotecas comuns, como firebase-ml-vision ou firebase-ml-natural-language. O ML Kit usa o namespace com.google.android.gms para bibliotecas que dependem do Google Play Services.

APIs Vision

Os modelos agrupados são entregues como parte do seu aplicativo. É preciso fazer o download dos modelos leves. Algumas APIs estão disponíveis nas formas agrupada e fina, outras apenas em uma ou outra:

Atualize as dependências das bibliotecas do Android do Kit de ML no arquivo Gradle do módulo (nível do app), geralmente app/build.gradle, de acordo com as tabelas a seguir:

Modelos agrupados

Modelos finos

AutoMLVision Edge

APIs de linguagem natural

Os modelos agrupados são entregues como parte do seu aplicativo. Os modelos compactos precisam ser baixados:

Atualize as dependências das bibliotecas do Android do Kit de ML no arquivo Gradle do módulo (nível do app), geralmente app/build.gradle, de acordo com as tabelas a seguir:

Modelos agrupados

Modelos finos

Atualizar nomes de classes

Se a sua classe aparecer nesta tabela, faça a mudança indicada:

Para outras classes, siga estas regras:

• Remova o prefixo FirebaseVision do nome da classe.
• Remova outros prefixos que começam com Firebase do nome da classe.

Além disso, nos nomes dos pacotes, substitua o prefixo com.google.firebase.ml por com.google.mlkit.

Atualizar nomes de métodos

Há mudanças mínimas no código:

• A instanciação de detector/scanner/rotulador/tradutor… foi alterada. Agora cada recurso tem um ponto de entrada próprio. Por exemplo: BarcodeScanning, TextRecognition, ImageLabeling, Translation… As chamadas para o serviço do Firebase getInstance() são substituídas por chamadas para o método getClient() do ponto de entrada do recurso.
• A instanciação padrão do TextRecognizer foi removida porque introduzimos outras bibliotecas para reconhecer outros scripts, como chinês e coreano. Para usar as opções padrão com o modelo de reconhecimento de texto em script latino, declare uma dependência de com.google.android.gms:play-services-mlkit-text-recognition e use TextRecognition.getClient(TextRecognizerOptions.DEFAULT_OPTIONS).
• A instanciação padrão para ImageLabeler e ObjectDetector foi removida, já que introduzimos o suporte a modelos personalizados para esses dois recursos. Por exemplo, para usar as opções padrão com o modelo de base em ImageLabeling, declare uma dependência em com.google.mlkit:image-labeling e use ImageLabeling.getClient(ImageLabelerOptions.DEFAULT_OPTIONS) em Java.
• Todos os handles (detector/scanner/rotulador/tradutor etc.) podem ser fechados. Verifique se o método close() é chamado quando esses objetos não serão mais usados. Se você estiver usando em um Fragment ou AppCompatActivity, uma maneira fácil de fazer isso é chamar LifecycleOwner.getLifecycle() no Fragment ou AppCompatActivity e, em seguida, chamar Lifecycle.addObserver.
• processImage() e detectInImage() nas APIs Vision foram renomeados como process() para consistência.
• As APIs Natural Language agora usam o termo "tag de idioma" (conforme definido pelo padrão BCP 47) em vez de "código de idioma".
• Os métodos getter nas classes xxxOptions foram removidos.
• O método getBitmap() na classe InputImage(substituindo FirebaseVisionImage) não é mais compatível como parte da interface pública. Consulte BitmapUtils.java na amostra de início rápido do Kit de ML para converter bitmaps de várias entradas.
• O FirebaseVisionImageMetadata foi removido. Basta transmitir metadados de imagem, como largura, altura, rotationDegrees e formato, para os métodos de construção do InputImages.

Confira alguns exemplos de métodos Kotlin antigos e novos:

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

Confira alguns exemplos de métodos Java antigos e novos:

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

Mudanças específicas da API

Leitura de código de barras

Para a API Barcode Scanning, agora há duas maneiras de entregar os modelos:

• Pelo Google Play Services, também conhecido como "fino" (recomendado): isso reduz o tamanho do app, e o modelo é compartilhado entre aplicativos. No entanto, os desenvolvedores precisam garantir que o modelo seja baixado antes de ser usado pela primeira vez.
• Com o APK do app, também conhecido como "agrupado": isso aumenta o tamanho do app, mas significa que o modelo pode ser usado imediatamente.

As duas implementações são um pouco diferentes, e a versão "agrupada" tem várias melhorias em relação à versão "fina". Confira mais detalhes sobre essas diferenças nas diretrizes da API Barcode Scanning.

Detecção facial

Para a API Face Detection, há duas maneiras de entregar os modelos:

• Pelo Google Play Services, também conhecido como "fino" (recomendado): isso reduz o tamanho do app, e o modelo é compartilhado entre aplicativos. No entanto, os desenvolvedores precisam garantir que o modelo seja baixado antes de ser usado pela primeira vez.
• Com o APK do seu app, também conhecido como "em pacote": isso aumenta o tamanho do download do app, mas significa que o modelo pode ser usado imediatamente.

O comportamento das implementações é o mesmo.

Tradução

• Agora, o TranslateLanguage usa nomes legíveis para as constantes (por exemplo, ENGLISH) em vez de tags de idioma (EN). Elas também são @StringDef, em vez de @IntDef, e o valor da constante é a tag de idioma BCP 47 correspondente.

• Se o app usar a opção de condição de download "dispositivo inativo", saiba que ela foi removida e não pode mais ser usada. Você ainda pode usar a opção "Carregamento do dispositivo". Se quiser um comportamento mais complexo, atrase a chamada de RemoteModelManager.download com sua própria lógica.

Rotulagem de imagens do AutoML

Se o app usar a opção de condição de download "dispositivo inativo", saiba que ela foi removida e não pode mais ser usada. Você ainda pode usar a opção "carregamento do dispositivo".

Se você quiser um comportamento mais complexo, atrase a chamada de RemoteModelManager.download por trás da sua própria lógica.

Detecção e rastreamento de objetos

Se o app usa detecção de objetos com classificação aproximada, saiba que o novo SDK mudou a forma como ele retorna a categoria de classificação para objetos detectados.

A categoria de classificação é retornada como uma instância de DetectedObject.Label em vez de um número inteiro. Todas as categorias possíveis para o classificador aproximado estão incluídas na classe PredefinedCategory.

Confira um exemplo do código Kotlin antigo e novo:

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

Confira um exemplo do código Java antigo e novo:

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

A categoria "desconhecido" foi removida. Quando a confiança da classificação de um objeto é baixa, não retornamos nenhum rótulo.

Remover dependências do Firebase (opcional)

Esta etapa só se aplica quando estas condições são atendidas:

• O Kit de ML do Firebase é o único componente do Firebase que você usa.
• Você usa apenas APIs no dispositivo.
• Você não usa a exibição de modelos.

Se for esse o caso, você poderá remover as dependências do Firebase após a migração. Siga estas etapas:

• Remova o arquivo de configuração do Firebase excluindo o arquivo google-services.json no diretório de módulos (nível do app) do seu app.
• Substitua o plug-in Google Services para Gradle no arquivo Gradle do módulo (nível do app), geralmente app/build.gradle, pelo 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 {
  // …
}

• Substitua o classpath do plug-in do Gradle para os Serviços do Google no arquivo Gradle do projeto (nível raiz) (build.gradle) pelo do 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'
  }
}

Exclua seu app do Firebase no console de acordo com as instruções no site de suporte do Firebase.

Como receber ajuda

Se você tiver algum problema, consulte nossa página da comunidade, onde descrevemos os canais disponíveis para entrar em contato com nossa equipe.