Android पर Firebase की पुष्टि और फ़ंक्शन का इस्तेमाल करके, इमेज को Cloud Vision की मदद से सुरक्षित तरीके से लेबल करें

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

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

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

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

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

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

    1. Firebase कंसोल में, Firebase ML API वाला पेज खोलें.
    2. अगर आपने अपने प्रोजेक्ट को, इस्तेमाल के हिसाब से पैसे चुकाने वाले Blaze प्लान में अपग्रेड नहीं किया है, तो ऐसा करने के लिए अपग्रेड करें पर क्लिक करें. आपको अपग्रेड करने का मैसेज सिर्फ़ तब दिखेगा, जब आपका प्रोजेक्ट Blaze प्लान पर नहीं होगा.

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

    3. अगर क्लाउड पर आधारित एपीआई पहले से चालू नहीं हैं, तो क्लाउड पर आधारित एपीआई चालू करें पर क्लिक करें.
  3. अपने मौजूदा Firebase API पासकोड को कॉन्फ़िगर करें, ताकि Cloud Vision API को ऐक्सेस न किया जा सके:
    1. Cloud कंसोल का क्रेडेंशियल पेज खोलें.
    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 (क्लाइंट) और gson Android लाइब्रेरी के लिए, Cloud Functions की डिपेंडेंसी जोड़ें:
    implementation("com.google.firebase:firebase-functions:22.1.1")
    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);
    4. Bitmap ऑब्जेक्ट से दिखाई जाने वाली इमेज सीधी होनी चाहिए. इसके लिए, उसे घुमाने की ज़रूरत नहीं होनी चाहिए.

    2. इमेज को लेबल करने के लिए, कॉल किए जा सकने वाले फ़ंक्शन को लागू करना

    किसी इमेज में मौजूद ऑब्जेक्ट को लेबल करने के लिए, कॉल किए जा सकने वाले फ़ंक्शन को लागू करें. इसके लिए, a 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. टाइप को LABEL_DETECTION पर सेट करके, JSON फ़ॉर्मैट में अनुरोध बनाएं:

      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("LABEL_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("LABEL_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 फ़ॉर्मैट में रिस्पॉन्स मिलेगा. labelAnnotations कैटगरी में मौजूद हर ऑब्जेक्ट, इमेज में लेबल की गई किसी चीज़ के बारे में बताता है. हर लेबल के लिए, लेबल की टेक्स्ट के तौर पर जानकारी, उसका Knowledge Graph एंटिटी आईडी (अगर उपलब्ध हो), और मैच का कॉन्फ़िडेंस स्कोर पाया जा सकता है. उदाहरण के लिए:

    Kotlin

    for (label in task.result!!.asJsonArray[0].asJsonObject["labelAnnotations"].asJsonArray) {
        val labelObj = label.asJsonObject
        val text = labelObj["description"]
        val entityId = labelObj["mid"]
        val confidence = labelObj["score"]
    }
    

    Java

    for (JsonElement label : task.getResult().getAsJsonArray().get(0).getAsJsonObject().get("labelAnnotations").getAsJsonArray()) {
        JsonObject labelObj = label.getAsJsonObject();
        String text = labelObj.get("description").getAsString();
        String entityId = labelObj.get("mid").getAsString();
        float score = labelObj.get("score").getAsFloat();
    }