Android पर Firebase पुष्टि करने और फ़ंक्शन की सुविधा का इस्तेमाल करके, Cloud Vision की मदद से लैंडमार्क की पहचान सुरक्षित तरीके से करने के लिए

किसी इमेज में Firebase ML के लिए recognizing well-known landmarks Firebase ML Vision SDK टूल अब काम नहीं करता (पुराने दस्तावेज़ यहां देखें). इस पेज पर बताया गया है कि इस्तेमाल नहीं किए जा रहे SDK टूल के विकल्प के तौर पर, Firebase Auth और Firebase Functions का इस्तेमाल करके, Cloud Vision API को कैसे कॉल किया जा सकता है. इससे, सिर्फ़ पुष्टि किए गए उपयोगकर्ताओं को API को ऐक्सेस करने की अनुमति मिलती है.

अपने ऐप्लिकेशन से Google Cloud API को कॉल करने के लिए, आपको एक इंटरमीडियरी REST API बनाना होगा. यह अनुमति को मैनेज करता है और एपीआई कुंजियों जैसी गोपनीय वैल्यू को सुरक्षित रखता है. इसके बाद, आपको अपने मोबाइल ऐप्लिकेशन में कोड लिखना होगा, ताकि इस इंटरमीडियरी सेवा की पुष्टि की जा सके और उससे संपर्क किया जा सके.

Firebase Authentication और Functions का इस्तेमाल करके, इस REST API को बनाने का एक तरीका है. इससे आपको Google Cloud API के लिए, मैनेज किया जाने वाला और सर्वर-लेस गेटवे मिलता है. यह गेटवे, पुष्टि की प्रोसेस को मैनेज करता है. साथ ही, इसे पहले से बने SDK टूल की मदद से, अपने मोबाइल ऐप्लिकेशन से कॉल किया जा सकता है.

इस गाइड में, अपने ऐप्लिकेशन से Cloud Vision API को कॉल करने के लिए, इस तकनीक का इस्तेमाल करने का तरीका बताया गया है. इस तरीके से, पुष्टि किए गए सभी उपयोगकर्ता आपके Cloud प्रोजेक्ट के ज़रिए, Cloud Vision की बिलिंग वाली सेवाओं को ऐक्सेस कर पाएंगे. इसलिए, आगे बढ़ने से पहले यह देख लें कि पुष्टि करने का यह तरीका, आपके इस्तेमाल के उदाहरण के लिए सही है या नहीं.

Cloud Vision API का इस्तेमाल करने के लिए, Google Cloud Platform के लाइसेंस के कानूनी समझौते और सेवा से जुड़ी खास शर्तों का पालन करना ज़रूरी है. साथ ही, इसके हिसाब से ही शुल्क लिया जाता है. बिलिंग की जानकारी के लिए, शुल्क पेज देखें.

शुरू करने से पहले

अपना प्रोजेक्ट कॉन्फ़िगर करना

1. अगर आपने पहले से ऐसा नहीं किया है, तो अपने Android प्रोजेक्ट में Firebase जोड़ें.

2. अगर आपने अब तक अपने प्रोजेक्ट के लिए, क्लाउड पर काम करने वाले एपीआई चालू नहीं किए हैं, तो अभी ऐसा करें:

   1. Firebase कंसोल का Firebase ML एपीआई पेज खोलें.

   2. अगर आपने अब तक अपने प्रोजेक्ट को Blaze की कीमत वाले प्लान पर अपग्रेड नहीं किया है, तो ऐसा करने के लिए अपग्रेड करें पर क्लिक करें. (आपको अपग्रेड करने के लिए तब ही कहा जाएगा, जब आपका प्रोजेक्ट Blaze प्लान पर नहीं होगा.)

      सिर्फ़ Blaze-लेवल के प्रोजेक्ट, क्लाउड-आधारित एपीआई का इस्तेमाल कर सकते हैं.

   3. अगर क्लाउड-आधारित एपीआई पहले से चालू नहीं हैं, तो क्लाउड-आधारित एपीआई चालू करें पर क्लिक करें.
3. Cloud Vision API का ऐक्सेस न देने के लिए, अपनी मौजूदा Firebase एपीआई कुंजियों को कॉन्फ़िगर करें:
   1. Cloud Console का क्रेडेंशियल पेज खोलें.
   2. सूची में मौजूद हर एपीआई पासकोड के लिए, बदलाव करने वाला व्यू खोलें. इसके बाद, पासकोड पर लगी पाबंदियों वाले सेक्शन में, Cloud Vision API के अलावा सभी उपलब्ध एपीआई को सूची में जोड़ें.

कॉल किए जा सकने वाले फ़ंक्शन को डिप्लॉय करना

इसके बाद, वह Cloud फ़ंक्शन डिप्लॉय करें जिसका इस्तेमाल करके, अपने ऐप्लिकेशन और Cloud Vision API को जोड़ा जा सकेगा. functions-samples रिपॉज़िटरी में एक उदाहरण है, जिसका इस्तेमाल किया जा सकता है.

डिफ़ॉल्ट रूप से, इस फ़ंक्शन की मदद से Cloud Vision API को ऐक्सेस करने पर, आपके ऐप्लिकेशन के सिर्फ़ वे उपयोगकर्ता ही Cloud Vision API को ऐक्सेस कर पाएंगे जिन्होंने पुष्टि कराई है. अलग-अलग ज़रूरतों के लिए, फ़ंक्शन में बदलाव किया जा सकता है.

फ़ंक्शन को डिप्लॉय करने के लिए:

1. functions-samples repo को क्लोन या डाउनलोड करें और Node-1st-gen/vision-annotate-image डायरेक्ट्री पर जाएं:

   git clone https://github.com/firebase/functions-samples
   cd Node-1st-gen/vision-annotate-image
   

2. डिपेंडेंसी इंस्टॉल करें:

   cd functions
   npm install
   cd ..

3. अगर आपके पास Firebase CLI नहीं है, तो इसे इंस्टॉल करें.
4. vision-annotate-image डायरेक्ट्री में Firebase प्रोजेक्ट शुरू करें. जब कहा जाए, तब सूची में अपना प्रोजेक्ट चुनें.

   firebase init

5. फ़ंक्शन को डिप्लॉय करें:

   firebase deploy --only functions:annotateImage

अपने ऐप्लिकेशन में Firebase Auth जोड़ना

ऊपर डिप्लॉय किया गया कॉल करने लायक फ़ंक्शन, आपके ऐप्लिकेशन के ऐसे उपयोगकर्ताओं के किसी भी अनुरोध को अस्वीकार कर देगा जिनकी पुष्टि नहीं हुई है. अगर आपने ऐसा पहले नहीं किया है, तो आपको अपने ऐप्लिकेशन में Firebase Auth जोड़ना होगा.

अपने ऐप्लिकेशन में ज़रूरी डिपेंडेंसी जोड़ना

मॉड्यूल (ऐप्लिकेशन-लेवल) की Gradle फ़ाइल (आम तौर पर <project>/<app-module>/build.gradle.kts या <project>/<app-module>/build.gradle) में, Firebase के लिए Cloud Functions (क्लाइंट) और gson Android लाइब्रेरी के लिए डिपेंडेंसी जोड़ें:

implementation("com.google.firebase:firebase-functions:21.1.0")
implementation("com.google.code.gson:gson:2.8.6")

1. इनपुट इमेज तैयार करना

Cloud Vision को कॉल करने के लिए, इमेज को base64 कोड में बदला जाना चाहिए. सेव की गई फ़ाइल के यूआरआई से इमेज को प्रोसेस करने के लिए:

1. इमेज को Bitmap ऑब्जेक्ट के तौर पर पाएं:

   Kotlin

   var bitmap: Bitmap = MediaStore.Images.Media.getBitmap(contentResolver, uri)

   Java

   Bitmap bitmap = MediaStore.Images.Media.getBitmap(getContentResolver(), uri);

2. इसके अलावा, बैंडविड्थ बचाने के लिए, इमेज को छोटा भी किया जा सकता है. Cloud Vision के लिए इमेज के सुझाए गए साइज़ देखें.

   Kotlin

   private fun scaleBitmapDown(bitmap: Bitmap, maxDimension: Int): Bitmap {
       val originalWidth = bitmap.width
       val originalHeight = bitmap.height
       var resizedWidth = maxDimension
       var resizedHeight = maxDimension
       if (originalHeight > originalWidth) {
           resizedHeight = maxDimension
           resizedWidth =
               (resizedHeight * originalWidth.toFloat() / originalHeight.toFloat()).toInt()
       } else if (originalWidth > originalHeight) {
           resizedWidth = maxDimension
           resizedHeight =
               (resizedWidth * originalHeight.toFloat() / originalWidth.toFloat()).toInt()
       } else if (originalHeight == originalWidth) {
           resizedHeight = maxDimension
           resizedWidth = maxDimension
       }
       return Bitmap.createScaledBitmap(bitmap, resizedWidth, resizedHeight, false)
   }

   Java

   private Bitmap scaleBitmapDown(Bitmap bitmap, int maxDimension) {
       int originalWidth = bitmap.getWidth();
       int originalHeight = bitmap.getHeight();
       int resizedWidth = maxDimension;
       int resizedHeight = maxDimension;
   
       if (originalHeight > originalWidth) {
           resizedHeight = maxDimension;
           resizedWidth = (int) (resizedHeight * (float) originalWidth / (float) originalHeight);
       } else if (originalWidth > originalHeight) {
           resizedWidth = maxDimension;
           resizedHeight = (int) (resizedWidth * (float) originalHeight / (float) originalWidth);
       } else if (originalHeight == originalWidth) {
           resizedHeight = maxDimension;
           resizedWidth = maxDimension;
       }
       return Bitmap.createScaledBitmap(bitmap, resizedWidth, resizedHeight, false);
   }

   Kotlin

   // Scale down bitmap size
   bitmap = scaleBitmapDown(bitmap, 640)

   Java

   // Scale down bitmap size
   bitmap = scaleBitmapDown(bitmap, 640);

3. बिटमैप ऑब्जेक्ट को base64 कोड में बदली गई स्ट्रिंग में बदलना:

   Kotlin

   // Convert bitmap to base64 encoded string
   val byteArrayOutputStream = ByteArrayOutputStream()
   bitmap.compress(Bitmap.CompressFormat.JPEG, 100, byteArrayOutputStream)
   val imageBytes: ByteArray = byteArrayOutputStream.toByteArray()
   val base64encoded = Base64.encodeToString(imageBytes, Base64.NO_WRAP)

   Java

   // Convert bitmap to base64 encoded string
   ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
   bitmap.compress(Bitmap.CompressFormat.JPEG, 100, byteArrayOutputStream);
   byte[] imageBytes = byteArrayOutputStream.toByteArray();
   String base64encoded = Base64.encodeToString(imageBytes, Base64.NO_WRAP);

Bitmap ऑब्जेक्ट से दिखाई गई इमेज, सीधी होनी चाहिए. इसे किसी और दिशा में घुमाने की ज़रूरत नहीं है.

2. लैंडमार्क की पहचान करने के लिए, कॉल किए जा सकने वाले फ़ंक्शन को लागू करना

किसी इमेज में लैंडमार्क की पहचान करने के लिए, कॉल किए जा सकने वाले फ़ंक्शन को JSON Cloud Vision का अनुरोध पास करके, चालू करें.

1. सबसे पहले, Cloud Functions का इंस्टेंस शुरू करें:

   Kotlin

   private lateinit var functions: FirebaseFunctions
   // ...
   functions = Firebase.functions
   

   Java

   private FirebaseFunctions mFunctions;
   // ...
   mFunctions = FirebaseFunctions.getInstance();
   

2. फ़ंक्शन को लागू करने का तरीका तय करें:

   Kotlin

   private fun annotateImage(requestJson: String): Task<JsonElement> {
       return functions
           .getHttpsCallable("annotateImage")
           .call(requestJson)
           .continueWith { task ->
               // This continuation runs on either success or failure, but if the task
               // has failed then result will throw an Exception which will be
               // propagated down.
               val result = task.result?.data
               JsonParser.parseString(Gson().toJson(result))
           }
   }
   

   Java

   private Task<JsonElement> annotateImage(String requestJson) {
       return mFunctions
               .getHttpsCallable("annotateImage")
               .call(requestJson)
               .continueWith(new Continuation<HttpsCallableResult, JsonElement>() {
                   @Override
                   public JsonElement then(@NonNull Task<HttpsCallableResult> task) {
                       // This continuation runs on either success or failure, but if the task
                       // has failed then getResult() will throw an Exception which will be
                       // propagated down.
                       return JsonParser.parseString(new Gson().toJson(task.getResult().getData()));
                   }
               });
   }
   

3. टाइप के साथ JSON अनुरोध बनाएं LANDMARK_DETECTION:

   Kotlin

   // Create json request to cloud vision
   val request = JsonObject()
   // Add image to request
   val image = JsonObject()
   image.add("content", JsonPrimitive(base64encoded))
   request.add("image", image)
   // Add features to the request
   val feature = JsonObject()
   feature.add("maxResults", JsonPrimitive(5))
   feature.add("type", JsonPrimitive("LANDMARK_DETECTION"))
   val features = JsonArray()
   features.add(feature)
   request.add("features", features)
   

   Java

   // Create json request to cloud vision
   JsonObject request = new JsonObject();
   // Add image to request
   JsonObject image = new JsonObject();
   image.add("content", new JsonPrimitive(base64encoded));
   request.add("image", image);
   //Add features to the request
   JsonObject feature = new JsonObject();
   feature.add("maxResults", new JsonPrimitive(5));
   feature.add("type", new JsonPrimitive("LANDMARK_DETECTION"));
   JsonArray features = new JsonArray();
   features.add(feature);
   request.add("features", features);
   

4. आखिर में, फ़ंक्शन को लागू करें:

   Kotlin

   annotateImage(request.toString())
       .addOnCompleteListener { task ->
           if (!task.isSuccessful) {
               // Task failed with an exception
               // ...
           } else {
               // Task completed successfully
               // ...
           }
       }
   

   Java

   annotateImage(request.toString())
           .addOnCompleteListener(new OnCompleteListener<JsonElement>() {
               @Override
               public void onComplete(@NonNull Task<JsonElement> task) {
                   if (!task.isSuccessful()) {
                       // Task failed with an exception
                       // ...
                   } else {
                       // Task completed successfully
                       // ...
                   }
               }
           });
   

3. पहचाने गए लैंडमार्क के बारे में जानकारी पाना

अगर लैंडमार्क की पहचान करने की प्रोसेस पूरी हो जाती है, तो टास्क के नतीजे में BatchAnnotateImagesResponse का JSON रिस्पॉन्स दिखेगा. landmarkAnnotations कलेक्शन में मौजूद हर ऑब्जेक्ट, इमेज में पहचाने गए किसी लैंडमार्क को दिखाता है. हर लैंडमार्क के लिए, इनपुट इमेज में उसके बाउंडिंग कोऑर्डिनेट, लैंडमार्क का नाम, उसका अक्षांश और देशांतर, उसका नॉलेज ग्राफ़ इकाई आईडी (अगर उपलब्ध हो), और मैच के कॉन्फ़िडेंस स्कोर की जानकारी मिल सकती है. उदाहरण के लिए:

Kotlin

for (label in task.result!!.asJsonArray[0].asJsonObject["landmarkAnnotations"].asJsonArray) {
    val labelObj = label.asJsonObject
    val landmarkName = labelObj["description"]
    val entityId = labelObj["mid"]
    val score = labelObj["score"]
    val bounds = labelObj["boundingPoly"]
    // Multiple locations are possible, e.g., the location of the depicted
    // landmark and the location the picture was taken.
    for (loc in labelObj["locations"].asJsonArray) {
        val latitude = loc.asJsonObject["latLng"].asJsonObject["latitude"]
        val longitude = loc.asJsonObject["latLng"].asJsonObject["longitude"]
    }
}

Java

for (JsonElement label : task.getResult().getAsJsonArray().get(0).getAsJsonObject().get("landmarkAnnotations").getAsJsonArray()) {
    JsonObject labelObj = label.getAsJsonObject();
    String landmarkName = labelObj.get("description").getAsString();
    String entityId = labelObj.get("mid").getAsString();
    float score = labelObj.get("score").getAsFloat();
    JsonObject bounds = labelObj.get("boundingPoly").getAsJsonObject();
    // Multiple locations are possible, e.g., the location of the depicted
    // landmark and the location the picture was taken.
    for (JsonElement loc : labelObj.get("locations").getAsJsonArray()) {
        JsonObject latLng = loc.getAsJsonObject().get("latLng").getAsJsonObject();
        double latitude = latLng.get("latitude").getAsDouble();
        double longitude = latLng.get("longitude").getAsDouble();
    }
}