Android के लिए माइग्रेट करना

इस गाइड में, Android के लिए ML Kit for Firebase से माइग्रेट करने का तरीका बताया गया है.

Gradle इंपोर्ट अपडेट करना

ML Kit SDK टूल को हर ML Kit API के लिए, सिर्फ़ एक डिपेंडेंसी की ज़रूरत होती है. आपको firebase-ml-vision या firebase-ml-natural-language जैसी सामान्य लाइब्रेरी के बारे में बताने की ज़रूरत नहीं है. ML Kit, Google Play services पर निर्भर लाइब्रेरी के लिए, com.google.android.gms नेमस्पेस का इस्तेमाल करता है.

Vision API

बंडल किए गए मॉडल, आपके ऐप्लिकेशन के हिस्से के तौर पर डिलीवर किए जाते हैं. थिन मॉडल डाउनलोड करना ज़रूरी है. कुछ एपीआई, बंडल और थिन, दोनों फ़ॉर्म में उपलब्ध होते हैं. वहीं, कुछ एपीआई सिर्फ़ एक या दूसरे फ़ॉर्म में उपलब्ध होते हैं:

अपनी मॉड्यूल (ऐप्लिकेशन-लेवल) Gradle फ़ाइल (आम तौर पर app/build.gradle.kts) में, ML Kit की Android लाइब्रेरी के लिए डिपेंडेंसी अपडेट करें. इसके लिए, यहां दी गई टेबल देखें:

बंडल किए गए मॉडल

थिन मॉडल

AutoMLVision Edge

नैचुरल लैंग्वेज एपीआई

बंडल किए गए मॉडल, आपके ऐप्लिकेशन के हिस्से के तौर पर डिलीवर किए जाते हैं. थिन मॉडल डाउनलोड करने होंगे:

अपने मॉड्यूल (ऐप्लिकेशन-लेवल) की Gradle फ़ाइल (आम तौर पर app/build.gradle.kts) में, ML Kit की Android लाइब्रेरी के लिए डिपेंडेंसी अपडेट करें. इसके लिए, यहां दी गई टेबल देखें:

बंडल किए गए मॉडल

थिन मॉडल

क्लास के नाम अपडेट करना

अगर आपकी क्लास इस टेबल में दिखती है, तो बताया गया बदलाव करें:

अन्य क्लास के लिए, इन नियमों का पालन करें:

• क्लास के नाम से 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 अब "भाषा कोड" के बजाय, "भाषा टैग" शब्द का इस्तेमाल करते हैं. इसे बीसीपी 47 स्टैंडर्ड के मुताबिक तय किया गया है.
• xxxOptions क्लास में मौजूद Getter मेथड हटा दिए गए हैं.
• InputImage क्लास में getBitmap() मेथड (FirebaseVisionImage की जगह) अब पब्लिक इंटरफ़ेस के तौर पर काम नहीं करता. अलग-अलग इनपुट से बिटमैप को बदलने के लिए, ML Kit के क्विकस्टार्ट सैंपल में BitmapUtils.java देखें.
• FirebaseVisionImageMetadata को हटा दिया गया है. अब InputImage के कंस्ट्रक्शन मेथड में, इमेज का मेटाडेटा पास किया जा सकता है. जैसे, width, height, rotationDegrees, format.

यहां 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());
  

एपीआई से जुड़े बदलाव

बारकोड स्कैन करना

बारकोड स्कैनिंग एपीआई के लिए, अब मॉडल दो तरीकों से डिलीवर किए जा सकते हैं:

• Google Play Services, यानी "थिन" (सुझाया गया) के ज़रिए - इससे ऐप्लिकेशन का साइज़ कम हो जाता है और मॉडल को ऐप्लिकेशन के बीच शेयर किया जाता है. हालांकि, डेवलपर को यह पक्का करना होगा कि पहली बार इस्तेमाल करने से पहले, मॉडल डाउनलोड किया गया हो.
• अपने ऐप्लिकेशन के APK के साथ, जिसे "बंडल" भी कहा जाता है - इससे ऐप्लिकेशन का साइज़ बढ़ जाता है, लेकिन इसका मतलब है कि मॉडल को तुरंत इस्तेमाल किया जा सकता है.

दोनों को लागू करने का तरीका थोड़ा अलग है. "बंडल" वर्शन में, "थिन" वर्शन के मुकाबले कई सुधार किए गए हैं. इन अंतर के बारे में ज़्यादा जानकारी, बारकोड स्कैनिंग एपीआई के दिशा-निर्देशों में मिल सकती है.

चेहरे की पहचान

चेहरे की पहचान करने वाले एपीआई के लिए, मॉडल दो तरीकों से डिलीवर किए जा सकते हैं:

• Google Play Services, यानी "थिन" (सुझाया गया) के ज़रिए - इससे ऐप्लिकेशन का साइज़ कम हो जाता है और मॉडल को ऐप्लिकेशन के बीच शेयर किया जाता है. हालांकि, डेवलपर को यह पक्का करना होगा कि पहली बार इस्तेमाल करने से पहले, मॉडल डाउनलोड किया गया हो.
• अपने ऐप्लिकेशन के APK के साथ, जिसे "बंडल" भी कहा जाता है - इससे ऐप्लिकेशन डाउनलोड करने का साइज़ बढ़ जाता है. हालांकि, इसका मतलब है कि मॉडल को तुरंत इस्तेमाल किया जा सकता है.

दोनों तरीकों से सेट अप करने पर, एक जैसा ही नतीजा मिलता है.

Translation

• TranslateLanguage अब अपने कॉन्सटैंट के लिए, भाषा टैग (EN) के बजाय, आसानी से पढ़े जा सकने वाले नामों (जैसे, ENGLISH) का इस्तेमाल करता है. ये अब @IntDef के बजाय @StringDef हैं. साथ ही, कॉन्सटैंट की वैल्यू, मैच होने वाला बीसीपी 47 भाषा टैग है.

AutoML Image Labeling (अब सेवा में नहीं है)

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

"अज्ञात" कैटगरी को हटा दिया गया है. जब किसी ऑब्जेक्ट की कैटगरी के बारे में ज़्यादा जानकारी नहीं होती, तो हम कोई लेबल नहीं दिखाते.

Firebase डिपेंडेंसी हटाना

माइग्रेशन के बाद, Firebase की डिपेंडेंसी हटाएं. यह तरीका अपनाएं:

• अपने ऐप्लिकेशन के मॉड्यूल (ऐप्लिकेशन-लेवल) डायरेक्ट्री में मौजूद google-services.json कॉन्फ़िगरेशन फ़ाइल को मिटाकर, Firebase कॉन्फ़िगरेशन फ़ाइल को हटाएं.
• अपने मॉड्यूल (ऐप्लिकेशन-लेवल) की Gradle फ़ाइल (आम तौर पर app/build.gradle.kts) में, Google Services Gradle प्लगिन को 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 {
  // …
}

• अपने प्रोजेक्ट (रूट-लेवल) की Gradle फ़ाइल (build.gradle.kts) में, Google Services Gradle प्लगिन के क्लासपाथ को 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 ऐप्लिकेशन मिटाएं.

मदद लेना

अगर आपको कोई समस्या आती है, तो कृपया हमारा कम्यूनिटी पेज देखें. यहां हमने उन चैनलों के बारे में बताया है जिनके ज़रिए हमसे संपर्क किया जा सकता है.