更新 Gradle 匯入項目
新的 SDK 只需要每個 ML Kit API 一個依附元件。您不需要指定 firebase-ml-vision 或 firebase-ml-natural-language 等常用程式庫。ML Kit 會為依賴 Google Play 服務的程式庫使用 com.google.android.gms 命名空間。
Vision API
組合模型會隨應用程式一併提供。必須下載精簡模型。有些 API 可提供捆綁和精簡兩種形式，有些則只提供一種形式：
| API | 組合 | 細 |
|---|---|---|
| 文字辨識 | x (Beta 版) | x |
| 臉部偵測 | x | x |
| 條碼掃描 | x | x |
| 圖片標籤 | x | x |
| 偵測及追蹤物件 | 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.3.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.7 |
| 圖片標籤 | 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.9 |
| 物件偵測 | 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.2 |
精簡模型
| API | 舊有構件 | 新構件 |
|---|---|---|
| 條碼掃描 | com.google.firebase:firebase-ml-vision:24.0.1 | com.google.android.gms:play-services-mlkit-barcode-scanning:18.3.1 |
| 臉部偵測 | 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.1 |
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.3 |
| 下載 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.3
com.google.mlkit:linkfirebase:17.0.0 |
Natural Language API
組合模型會隨應用程式一併提供。必須下載精簡模型：
| API | 組合 | 細 |
|---|---|---|
| 語言 ID | x | x |
| 智慧回覆 | x | x (Beta 版) |
根據下表，在模組 (應用程式層級) 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.6 |
| 智慧回覆 | 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.4 |
精簡模型
| 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 的預設例項化。舉例來說，如要在 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 類別中的 getter 方法。
- 我們不再支援 InputImage 類別中的 getBitmap() 方法(取代
FirebaseVisionImage)，這項方法不再是公開介面的一部分。請參閱 ML Kit 快速入門範例中的BitmapUtils.java，瞭解如何從各種輸入內容轉換點陣圖。 - FirebaseVisionImageMetadata 已遭移除，您只需將圖片中繼資料 (例如寬度、高度、旋轉度數、格式) 傳遞至 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 專屬變更
條碼掃描
對於條碼掃描 API，目前有兩種方式可提供模型：
- 透過 Google Play 服務 (又稱「精簡」) (建議)：這可縮減應用程式大小，且模型會在應用程式之間共用。不過，開發人員必須先下載模型，才能首次使用。
- 使用應用程式 APK (又稱「已封裝」)：雖然會增加應用程式大小，但模型可立即使用。
這兩種實作方式略有不同，其中「已整合」版本相較於「精簡」版本，有許多改善之處。如要進一步瞭解這些差異，請參閱 Barcode Scanning API 規範。
臉部偵測
對於 Face Detection API，您可以透過兩種方式提交模型：
- 透過 Google Play 服務 (又稱「精簡」) (建議)：這可縮減應用程式大小，且模型會在應用程式之間共用。不過，開發人員必須先下載模型，才能首次使用。
- 使用應用程式 APK (又稱「已封裝」)：這會增加應用程式的下載大小，但表示模型可立即使用。
實作項目的行為相同。
翻譯
TranslateLanguage現在會為常數使用可讀名稱 (例如ENGLISH)，而非語言標記 (EN)。現在也改為使用 @StringDef 而非 @IntDef，常數的值則是相符的 BCP 47 語言標記。如果您的應用程式使用「裝置閒置」下載條件選項，請注意，這個選項已遭移除，無法再使用。你仍可使用「裝置充電」選項。如果您想要更複雜的行為，可以延遲在您自己的邏輯後方呼叫
RemoteModelManager.download。
AutoML 圖像標註
如果您的應用程式使用「裝置閒置」下載條件選項，請注意，這個選項已遭移除，無法再使用。你仍可使用「裝置充電」選項。
如果您想要更複雜的行為，可以延遲呼叫您自己的邏輯後的 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 套件。
- 您只使用裝置端 API。
- 您未使用模型供應功能。
在這種情況下，您可以在遷移後移除 Firebase 依附元件。請按照下列步驟操作：
- 在應用程式的模組 (應用程式層級) 目錄中刪除 google-services.json 設定檔，即可移除 Firebase 設定檔。
- 在模組 (應用程式層級) Gradle 檔案 (通常是 app/build.gradle) 中，將 Google 服務 Gradle 外掛程式替換為嚴格版本比對工具外掛程式：
之前
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 外掛程式 classpath 取代為 Strict Version Matcher 外掛程式的 classpath：
之前
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 支援網站上的操作說明，在 Firebase 控制台中刪除 Firebase 應用程式。
取得協助
如有任何問題，請參閱社群頁面，瞭解可用來與我們聯絡的管道。