Android への移行

Gradle インポートを更新する

新しい SDK では、ML Kit API ごとに依存関係が 1 つだけ必要です。firebase-ml-vision や firebase-ml-natural-language などの共通ライブラリを指定する必要はありません。ML Kit は、Google Play 開発者サービスに依存するライブラリに com.google.android.gms 名前空間を使用します。

Vision API

バンドルされたモデルは、アプリケーションの一部として提供されます。シンモデルをダウンロードする必要があります。API には、バンドル形式とシン形式の両方で使用できるものと、一方の形式のみで使用できるものがあります。

APIバンドル細い
テキスト認識x（ベータ版）x
顔検出xx
バーコード スキャンxx
画像ラベル付けxx
オブジェクトの検出とトラッキングx-

次の表に従って、モジュール（アプリレベル）の Gradle ファイル（通常は app/build.gradle）内の ML Kit Android ライブラリの依存関係を更新します。

バンドルされたモデル

API古いアーティファクト新しいアーティファクト
バーコード スキャン com.google.firebase:firebase-ml-vision:24.0.1
com.google.firebase:firebase-ml-vision-barcode-model:16.0.1		 com.google.mlkit:barcode-scanning:17.2.0
顔の輪郭 com.google.firebase:firebase-ml-vision:24.0.1
com.google.firebase:firebase-ml-vision-face-model:19.0.0		 com.google.mlkit:face-detection:16.1.6
画像ラベル付け com.google.firebase:firebase-ml-vision:24.0.1
com.google.firebase:firebase-ml-vision-image-label-model:19.0.0		 com.google.mlkit:image-labeling:17.0.8
オブジェクト検出 com.google.firebase:firebase-ml-vision:24.0.1
com.google.firebase:firebase-ml-vision-object-detection-model:19.0.3		 com.google.mlkit:object-detection:17.0.1

シンモデル

API古いアーティファクト新しいアーティファクト
バーコード スキャン com.google.firebase:firebase-ml-vision:24.0.1 com.google.android.gms:play-services-mlkit-barcode-scanning:18.3.0
顔検出 com.google.firebase:firebase-ml-vision:24.0.1 com.google.android.gms:play-services-mlkit-face-detection:17.1.0
テキスト認識 com.google.firebase:firebase-ml-vision:24.0.1 com.google.android.gms:play-services-mlkit-text-recognition:19.0.0

AutoMLVision Edge

API古いアーティファクト新しいアーティファクト
ダウンロードなしの AutoML com.google.firebase:firebase-ml-vision:24.0.1
com.google.firebase:firebase-ml-vision-automl:18.0.3		 com.google.mlkit:image-labeling-custom:17.0.2
AutoML とダウンロード com.google.firebase:firebase-ml-vision:24.0.1
com.google.firebase:firebase-ml-vision-automl:18.0.3		 com.google.mlkit:image-labeling-custom:17.0.2
com.google.mlkit:linkfirebase:17.0.0

Natural Language API

バンドルされたモデルは、アプリケーションの一部として提供されます。シンモデルは、次の方法でダウンロードする必要があります。

APIバンドル細い
言語 IDxx
スマート リプライxx（ベータ版）

次の表に従って、モジュール（アプリレベル）の Gradle ファイル（通常は app/build.gradle）内の ML Kit Android ライブラリの依存関係を更新します。

バンドルされたモデル

API古いアーティファクト新しいアーティファクト
言語 ID com.google.firebase:firebase-ml-natural-language:22.0.0
com.google.firebase:firebase-ml-natural-language-language-id-model:20.0.7		 com.google.mlkit:language-id:17.0.5
スマート リプライ com.google.firebase:firebase-ml-natural-language:22.0.0
com.google.firebase:firebase-ml-natural-language-smart-reply-model:20.0.7		 com.google.mlkit:smart-reply:17.0.3

シンモデル

API古いアーティファクト新しいアーティファクト
言語 ID com.google.firebase:firebase-ml-natural-language:22.0.0
com.google.firebase:firebase-ml-natural-language-language-id-model:20.0.7		 com.google.android.gms:play-services-mlkit-language-id:17.0.0
スマート リプライ com.google.firebase:firebase-ml-natural-language:22.0.0
com.google.firebase:firebase-ml-natural-language-smart-reply-model:20.0.7		 com.google.android.gms:play-services-mlkit-smart-reply:16.0.0-beta1

クラス名を更新する

クラスがこの表に表示された場合は、次のように変更します。

以前のクラス新しいクラス
com.google.firebase.ml.common.FirebaseMLException com.google.mlkit.common.MlKitException
com.google.firebase.ml.vision.common.FirebaseVisionImage com.google.mlkit.vision.common.InputImage
com.google.firebase.ml.vision.barcode.FirebaseVisionBarcodeDetector com.google.mlkit.vision.barcode.BarcodeScanner
com.google.firebase.ml.vision.labeler.FirebaseVisionImageLabel com.google.mlkit.vision.label.ImageLabeler
com.google.firebase.ml.vision.barcode.FirebaseVisionBarcodeDetector com.google.mlkit.vision.barcode.BarcodeScanner
com.google.firebase.ml.vision.automl.FirebaseAutoMLLocalModel com.google.mlkit.common.model.LocalModel
com.google.firebase.ml.vision.automl.FirebaseAutoMLRemoteModel com.google.mlkit.common.model.CustomRemoteModel
com.google.firebase.ml.vision.label.FirebaseVisionOnDeviceImageLabelerOptions com.google.mlkit.vision.label.defaults.ImageLabelerOptions
com.google.firebase.ml.vision.label.FirebaseVisionImageLabel com.google.mlkit.vision.label.ImageLabel
com.google.firebase.ml.vision.label.FirebaseVisionOnDeviceAutoMLImageLabelerOptions com.google.mlkit.vision.label.custom.CustomImageLabelerOptions
com.google.firebase.ml.vision.objects.FirebaseVisionObjectDetectorOptions com.google.mlkit.vision.objects.defaults.ObjectDetectorOptions

他のクラスについては、次のルールに従ってください。

  • クラス名から FirebaseVision 接頭辞を削除します。
  • クラス名から Firebase 接頭辞で始まる他の接頭辞を削除します。

また、パッケージ名内の com.google.firebase.ml 接頭辞を com.google.mlkit に置き換えます。

メソッド名を更新する

コードの変更が最小限で済みます。

  • 検出/スキャナ/ラベラー/トランスレータ... のインスタンス化が変更されました。各機能に独自のエントリ ポイントが追加されました。BarcodeScanning、TextRecognition、ImageLabeling、Translation など。Firebase サービス getInstance() の呼び出しは、機能のエントリ ポイントの getClient() メソッドの呼び出しに置き換えられます。
  • 中国語や韓国語などの他のスクリプトを認識するための追加ライブラリを導入したため、TextRecognizer のデフォルトのインスタンス化が削除されました。ラテン文字テキスト認識モデルでデフォルトのオプションを使用するには、com.google.android.gms:play-services-mlkit-text-recognition への依存関係を宣言し、TextRecognition.getClient(TextRecognizerOptions.DEFAULT_OPTIONS) を使用してください。
  • ImageLabeler と ObjectDetector のデフォルトのインスタンス化は削除されました。これは、これら 2 つの機能に対するカスタムモデルのサポートを導入したためです。たとえば、ImageLabeling のベースモデルでデフォルトのオプションを使用するには、com.google.mlkit:image-labeling への依存関係を宣言し、Java で ImageLabeling.getClient(ImageLabelerOptions.DEFAULT_OPTIONS) を使用してください。
  • すべてのハンドル（検出ツール/スキャナ/ラベラー/翻訳ツールなど）は閉じることができます。それらのオブジェクトが不要になったときに close() メソッドが呼び出されるようにします。Fragment または AppCompatActivity で使用されている場合は、Fragment または AppCompatActivity で LifecycleOwner.getLifecycle() を呼び出してから、Lifecycle.addObserver を呼び出す方法が簡単です。
  • 一貫性を保つために、Vision API の processImage() と detectInImage() の名前が process() に変更されました 。
  • Natural Language API では、「言語コード」ではなく「言語タグ」（BCP 47 標準で定義されている）という用語が使用されるようになりました。
  • xxxOptions クラスのゲッター メソッドが削除されました。
  • InputImage クラスの getBitmap() メソッド（FirebaseVisionImage に代わるもの）は、公開インターフェースの一部としてサポートされなくなりました。さまざまな入力からビットマップを変換する方法については、ML Kit クイックスタート サンプルの BitmapUtils.java をご覧ください。
  • JetpackImageMetadata は削除されました。width、height、rotationDegrees、format などの画像メタデータを InputImages の構築メソッドに渡すだけです。

新旧の 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())

以下に、新旧の 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());

API 固有の変更

バーコード スキャン

Barcode Scanning API の場合、モデルを配信する方法は 2 つあります。

  • Google Play 開発者サービス（別名「薄型」（推奨））を通じて - アプリのサイズを小さくし、アプリ間でモデルを共有します。ただし、モデルを初めて使用する場合は、その前にモデルがダウンロードされていることを確認する必要があります。
  • アプリの APK を「バンドル」とも呼ばれると、アプリのサイズが大きくなりますが、モデルがすぐに使用可能になります。

2 つの実装は若干異なり、「バンドル」バージョンでは「シン」バージョンと比べて多くの点で改善されています。これらの違いについて詳しくは、Barcode Scanning API のガイドラインをご覧ください。

顔検出

Face Detection API では、次の 2 つの方法でモデルを提供できます。

  • Google Play 開発者サービス（別名「薄型」（推奨））を通じて - アプリのサイズを小さくし、アプリ間でモデルを共有します。ただし、モデルを初めて使用する場合は、その前にモデルがダウンロードされていることを確認する必要があります。
  • アプリの APK（別名「バンドル」）を使用する場合 - アプリのダウンロード サイズは大きくなりますが、モデルがすぐに使用可能になります。

実装の動作は同じです。

翻訳

  • TranslateLanguage は、定数に言語タグ（EN）ではなく読みやすい名前を使用するようになりました（例: ENGLISH）。また、それらも @IntDef ではなく @StringDef になり、定数の値は対応する BCP 47 言語タグになります。

  • ダウンロード条件に [デバイスがアイドル状態である] というオプションをアプリで使用している場合、このオプションは削除され、使用できなくなりましたのでご注意ください。「デバイスの充電」オプションは引き続き使用できます。より複雑な動作が必要な場合は、独自のロジックの背後で RemoteModelManager.download の呼び出しを遅らせることができます。

AutoML Image Labeling

「デバイスがアイドル状態である」ダウンロード条件オプションをアプリで使用している場合、このオプションは削除され、使用できなくなりました。「デバイスの充電」オプションは引き続き使用できます。

より複雑な動作が必要な場合は、独自のロジックの背後で RemoteModelManager.download の呼び出しを遅らせることができます。

オブジェクトの検出とトラッキング

アプリがあいまい分類でオブジェクト検出を使用している場合、新しい SDK では検出されたオブジェクトの分類カテゴリを返す方法が変更されています。

分類カテゴリは、整数ではなく DetectedObject.Label のインスタンスとして返されます。粗分類器に使用できるカテゴリはすべて PredefinedCategory クラスに含まれています。

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

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

「不明」カテゴリは削除されました。オブジェクトの分類の信頼度が低い場合、ラベルは返されません。

Firebase の依存関係を削除する（省略可）

このステップは、次の条件が満たされている場合にのみ適用されます。

  • 使用する Firebase コンポーネントは Firebase ML Kit のみです。
  • オンデバイス API のみを使用する。
  • モデルのサービングは使用しません。

その場合は、移行後に Firebase の依存関係を削除できます。以下の手順に沿って登録してください。

  • アプリのモジュール（アプリレベル）ディレクトリにある google-services.json 構成ファイルを削除して、Firebase 構成ファイルを削除します。
  • モジュール（アプリレベル）の Gradle ファイル（通常は app/build.gradle）内の Google サービスの Gradle プラグインを 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 {
  // …
}
  • プロジェクト（ルートレベル）の Gradle ファイル（build.gradle）の Google サービス Gradle プラグインのクラスパスを、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'
  }
}

Firebase サポートサイトのinstructionsに沿って、Firebase コンソールで Firebase アプリを削除します。

ヘルプ

問題が発生した場合は、コミュニティ ページをご確認ください。お問い合わせに使用できるチャンネルの概要が掲載されています。