การย้ายข้อมูลสำหรับ Android

คู่มือนี้อธิบายวิธีย้ายข้อมูลออกจาก ML Kit สำหรับ Firebase สำหรับ Android

อัปเดตการนำเข้า Gradle

ML Kit SDK ต้องการทรัพยากร Dependency เพียงรายการเดียวสำหรับ ML Kit API แต่ละรายการ คุณไม่จำเป็นต้องระบุไลบรารีที่ใช้กันทั่วไป เช่น firebase-ml-vision หรือ firebase-ml-natural-language ML Kit ใช้เนมสเปซ com.google.android.gms สำหรับไลบรารีที่ขึ้นอยู่กับบริการ Google Play

Vision API

ระบบจะนำส่งโมเดลที่รวมไว้เป็นส่วนหนึ่งของแอปพลิเคชัน ต้องดาวน์โหลดโมเดลแบบ Thin API บางรายการมีให้บริการทั้งในรูปแบบที่รวมมาให้และแบบ Thin ส่วน API อื่นๆ จะมีให้บริการในรูปแบบใดรูปแบบหนึ่งเท่านั้น ดังนี้

APIรวมกลุ่มบาง
การจดจำข้อความx (เบต้า)x
การตรวจจับใบหน้าxx
การสแกนบาร์โค้ดxx
การติดป้ายกำกับรูปภาพxx
การตรวจจับออบเจ็กต์และการติดตามx-

อัปเดตทรัพยากร Dependency สำหรับไลบรารี ML Kit สำหรับ Android ในไฟล์ Gradle ของโมดูล (ระดับแอป) (โดยปกติคือ app/build.gradle.kts) ตามตารางต่อไปนี้

โมเดลที่รวมมาให้

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.2

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

หากต้องการโฮสต์และดาวน์โหลดโมเดลที่กำหนดเอง ให้ย้ายโมเดลไปยัง Cloud Storage และเพิ่มตรรกะการดาวน์โหลดในแอปเพื่อโหลดโมเดลโดยใช้ LocalModel ดูรายละเอียดได้ที่ คำแนะนำในการย้ายข้อมูลจาก Firebase ML ไปยัง Cloud Storage

Natural Language API

ระบบจะนำส่งโมเดลที่รวมไว้เป็นส่วนหนึ่งของแอปพลิเคชัน ต้องดาวน์โหลดโมเดลแบบ Thin:

APIรวมกลุ่มบาง
รหัสภาษาxx
ฟีเจอร์ช่วยตอบxx (เบต้า)

อัปเดตทรัพยากร Dependency สำหรับไลบรารี ML Kit สำหรับ Android ในไฟล์ Gradle ของโมดูล (ระดับแอป) (โดยปกติคือ app/build.gradle.kts) ตามตารางต่อไปนี้

โมเดลที่รวมมาให้

APIอาร์ติแฟกต์เก่าอาร์ติแฟกต์ใหม่
รหัสภาษา 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อาร์ติแฟกต์เก่าอาร์ติแฟกต์ใหม่
รหัสภาษา 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.LocalModel

ต้องดาวน์โหลดด้วยตนเอง โมเดลระยะไกลที่โฮสต์ใน Firebase เลิกใช้งานแล้ว ดูรายละเอียดได้ที่ คำแนะนำในการย้ายข้อมูลจาก Firebase ML ไปยัง Cloud Storage
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 ให้ประกาศทรัพยากร Dependency ใน com.google.mlkit:image-labeling และใช้ ImageLabeling.getClient(ImageLabelerOptions.DEFAULT_OPTIONS) ใน Java
  • แฮนเดิลทั้งหมด (เครื่องมือตรวจจับ/เครื่องสแกน/เครื่องมือติดป้ายกำกับ/เครื่องมือแปลภาษา...) ปิดได้ ตรวจสอบว่ามีการเรียกใช้เมธอด close() เมื่อไม่มีการใช้ออบเจ็กต์เหล่านั้นอีกต่อไป หากคุณใช้ใน Fragment หรือ AppCompatActivity วิธีหนึ่งที่ทำได้คือเรียกใช้ LifecycleOwner.getLifecycle() ใน Fragment หรือ AppCompatActivity แล้วเรียกใช้ Lifecycle.addObserver
  • processImage() และ detectInImage() ใน Vision API ได้เปลี่ยนชื่อเป็น process() เพื่อความสอดคล้องกัน
  • ตอนนี้ Natural Language API ใช้คำว่า "แท็กภาษา" (ตามที่กำหนดโดยมาตรฐาน BCP 47) แทน "รหัสภาษา"
  • นำเมธอด Getter ในคลาส xxxOptions ออกแล้ว
  • ระบบไม่รองรับเมธอด getBitmap() ในคลาส InputImage (แทนที่ FirebaseVisionImage) อีกต่อไปในฐานะส่วนหนึ่งของอินเทอร์เฟซสาธารณะ โปรดดู BitmapUtils.java ในตัวอย่างการเริ่มต้นใช้งาน ML Kit เพื่อรับบิตแมปที่แปลงจากอินพุตต่างๆ
  • เราได้นำ FirebaseVisionImageMetadata ออกแล้ว คุณสามารถส่งข้อมูลเมตาของรูปภาพ เช่น width, height, rotationDegrees, format ไปยังเมธอดการสร้างของ InputImage ได้

ตัวอย่างเมธอด 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 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())
  

ตัวอย่างเมธอด 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 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());
  

การเปลี่ยนแปลงเฉพาะ API

การสแกนบาร์โค้ด

สำหรับ Barcode Scanning API ตอนนี้มี 2 วิธีในการส่งโมเดล ดังนี้

  • ผ่านบริการ Google Play หรือที่เรียกว่า "Thin" (แนะนำ) - วิธีนี้จะลดขนาดแอปและแอปพลิเคชันต่างๆ จะใช้โมเดลร่วมกัน อย่างไรก็ตาม นักพัฒนาแอปจะต้องตรวจสอบว่าได้ดาวน์โหลดโมเดลแล้วก่อนที่จะใช้เป็นครั้งแรก
  • รวมไว้กับ APK ของแอปหรือที่เรียกว่า "รวมแพ็กเกจ" - วิธีนี้จะเพิ่มขนาดแอป แต่หมายความว่าโมเดลจะใช้งานได้ทันที

การติดตั้งใช้งานทั้ง 2 แบบแตกต่างกันเล็กน้อย โดยเวอร์ชัน "รวมกลุ่ม" มีการปรับปรุงหลายอย่างเหนือกว่าเวอร์ชัน "บาง" ดูรายละเอียดเกี่ยวกับความแตกต่างเหล่านี้ได้ในหลักเกณฑ์ของ Barcode Scanning API

การตรวจจับใบหน้า

สำหรับ Face Detection API โมเดลจะแสดงได้ 2 วิธีดังนี้

  • ผ่านบริการ Google Play หรือที่เรียกว่า "Thin" (แนะนำ) - วิธีนี้จะลดขนาดแอปและแอปพลิเคชันต่างๆ จะใช้โมเดลร่วมกัน อย่างไรก็ตาม นักพัฒนาแอปจะต้องตรวจสอบว่าได้ดาวน์โหลดโมเดลแล้วก่อนที่จะใช้เป็นครั้งแรก
  • รวมไว้กับ APK ของแอปหรือที่เรียกว่า "รวมแพ็กเกจ" - วิธีนี้จะเพิ่มขนาดการดาวน์โหลดแอป แต่หมายความว่าโมเดลจะใช้งานได้ทันที

ลักษณะการทำงานของการติดตั้งใช้งานจะเหมือนกัน

คำแปล

  • ตอนนี้ TranslateLanguage ใช้ชื่อที่อ่านได้สำหรับค่าคงที่ (เช่น ENGLISH) แทนแท็กภาษา (EN) และตอนนี้ยังเป็น @StringDef แทน @IntDef ด้วย โดยค่าคงที่จะเป็นแท็กภาษา BCP 47 ที่ตรงกัน

การติดป้ายกำกับรูปภาพ AutoML (เลิกใช้งานแล้ว)

เราเลิกใช้งานการดาวน์โหลดโมเดลที่กำหนดเองสำหรับการติดป้ายกำกับรูปภาพโดยใช้ AutoML แล้ว และจะปิดให้บริการในวันที่ 15 มิถุนายน 2027 คุณควรใช้ Cloud Storage เพื่อโฮสต์โมเดลและเพิ่มตรรกะการดาวน์โหลดลงในแอปเพื่อดาวน์โหลดโมเดลแทน โปรดดูรายละเอียดที่คำแนะนำในการย้ายข้อมูลจาก Firebase ML ไปยัง Cloud Storage

การตรวจจับออบเจ็กต์และการติดตาม

หากแอปใช้การตรวจจับออบเจ็กต์ที่มีการแยกประเภทแบบคร่าวๆ โปรดทราบว่า 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) {
    ...
}

เราได้นำหมวดหมู่ "ไม่ระบุ" ออกแล้ว เมื่อความเชื่อมั่นในการจัดประเภทของวัตถุต่ำ เราจะไม่แสดงป้ายกำกับใดๆ

นำทรัพยากร Dependency ของ Firebase ออก

นำทรัพยากร Dependency ของ Firebase ออกหลังจากการย้ายข้อมูล โปรดทำตามขั้นตอนต่อไปนี้

  • นำไฟล์การกำหนดค่า Firebase ออกโดยลบไฟล์การกำหนดค่า google-services.json ในไดเรกทอรีโมดูล (ระดับแอป) ของแอป
  • แทนที่ปลั๊กอิน Gradle ของบริการของ Google ในไฟล์ Gradle ของโมดูล (ระดับแอป) (โดยปกติคือ app/build.gradle.kts) ด้วยปลั๊กอิน 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 {
  // …
}
  • แทนที่ classpath ของปลั๊กอิน Gradle ของบริการของ Google ในไฟล์ Gradle (ระดับรูท) ของโปรเจ็กต์ (build.gradle.kts) ด้วย classpath ของปลั๊กอิน 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")
  }
}

ลบแอป Firebase ในคอนโซล Firebase ตามวิธีการในเว็บไซต์สนับสนุนของ Firebase

ขอความช่วยเหลือ

หากพบปัญหา โปรดไปที่หน้าชุมชนซึ่งเราได้ระบุช่องทางที่พร้อมให้บริการสำหรับการติดต่อเรา