एंड्रॉइड पर फायरबेस ऑथ और फ़ंक्शंस का उपयोग करके क्लाउड विज़न के साथ छवियों को सुरक्षित रूप से लेबल करें

अपने ऐप से Google क्लाउड API को कॉल करने के लिए, आपको एक मध्यवर्ती REST API बनाना होगा जो प्राधिकरण को संभालता है और API कुंजियों जैसे गुप्त मानों की सुरक्षा करता है। फिर आपको इस मध्यवर्ती सेवा को प्रमाणित करने और उससे संचार करने के लिए अपने मोबाइल ऐप में कोड लिखना होगा।

इस REST API को बनाने का एक तरीका फायरबेस प्रमाणीकरण और फ़ंक्शंस का उपयोग करना है, जो आपको Google क्लाउड एपीआई के लिए एक प्रबंधित, सर्वर रहित गेटवे देता है जो प्रमाणीकरण को संभालता है और पूर्व-निर्मित एसडीके के साथ आपके मोबाइल ऐप से कॉल किया जा सकता है।

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

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

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

  1. यदि आपने पहले से नहीं किया है, तो अपने एंड्रॉइड प्रोजेक्ट में फायरबेस जोड़ें
  2. यदि आपने पहले से ही अपने प्रोजेक्ट के लिए क्लाउड-आधारित एपीआई सक्षम नहीं किया है, तो अभी करें:

    1. फायरबेस कंसोल का फायरबेस एमएल एपीआई पेज खोलें।
    2. यदि आपने पहले से ही अपने प्रोजेक्ट को ब्लेज़ मूल्य निर्धारण योजना में अपग्रेड नहीं किया है, तो ऐसा करने के लिए अपग्रेड पर क्लिक करें। (आपको केवल तभी अपग्रेड करने के लिए प्रेरित किया जाएगा यदि आपका प्रोजेक्ट ब्लेज़ योजना पर नहीं है।)

      केवल ब्लेज़-स्तरीय प्रोजेक्ट ही क्लाउड-आधारित एपीआई का उपयोग कर सकते हैं।

    3. यदि क्लाउड-आधारित एपीआई पहले से सक्षम नहीं हैं, तो क्लाउड-आधारित एपीआई सक्षम करें पर क्लिक करें।
  3. क्लाउड विज़न एपीआई तक पहुंच की अनुमति न देने के लिए अपनी मौजूदा फायरबेस एपीआई कुंजियों को कॉन्फ़िगर करें:
    1. क्लाउड कंसोल का क्रेडेंशियल पृष्ठ खोलें।
    2. सूची में प्रत्येक एपीआई कुंजी के लिए, संपादन दृश्य खोलें, और कुंजी प्रतिबंध अनुभाग में, क्लाउड विज़न एपीआई को छोड़कर सभी उपलब्ध एपीआई को सूची में जोड़ें।

कॉल करने योग्य फ़ंक्शन को तैनात करें

इसके बाद, क्लाउड फ़ंक्शन को तैनात करें जिसका उपयोग आप अपने ऐप और क्लाउड विज़न एपीआई को जोड़ने के लिए करेंगे। functions-samples भंडार में एक उदाहरण होता है जिसका आप उपयोग कर सकते हैं।

डिफ़ॉल्ट रूप से, इस फ़ंक्शन के माध्यम से क्लाउड विज़न एपीआई तक पहुंचने से आपके ऐप के केवल प्रमाणित उपयोगकर्ता ही क्लाउड विज़न एपीआई तक पहुंच पाएंगे। आप विभिन्न आवश्यकताओं के लिए फ़ंक्शन को संशोधित कर सकते हैं।

फ़ंक्शन को तैनात करने के लिए:

  1. फ़ंक्शंस-सैंपल्स रेपो को क्लोन करें या डाउनलोड करें और 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. यदि आपके पास फायरबेस सीएलआई नहीं है, तो इसे इंस्टॉल करें
  4. vision-annotate-image निर्देशिका में एक फायरबेस प्रोजेक्ट प्रारंभ करें। संकेत मिलने पर, सूची में अपना प्रोजेक्ट चुनें।
    firebase init
  5. फ़ंक्शन परिनियोजित करें:
    firebase deploy --only functions:annotateImage

अपने ऐप में फायरबेस ऑथ जोड़ें

ऊपर तैनात कॉल करने योग्य फ़ंक्शन आपके ऐप के गैर-प्रमाणीकृत उपयोगकर्ताओं के किसी भी अनुरोध को अस्वीकार कर देगा। यदि आपने पहले से ऐसा नहीं किया है, तो आपको अपने ऐप में फायरबेस ऑथ को जोड़ना होगा।

अपने ऐप में आवश्यक निर्भरताएँ जोड़ें

  • अपने मॉड्यूल (ऐप-स्तर) ग्रैडल फ़ाइल (आमतौर पर <project>/<app-module>/build.gradle.kts या <project>/<app-module>/build.gradle में फायरबेस (क्लाइंट) और gson एंड्रॉइड लाइब्रेरी के लिए क्लाउड फ़ंक्शंस की निर्भरताएं जोड़ें <project>/<app-module>/build.gradle ):
    implementation("com.google.firebase:firebase-functions:20.4.0")
    implementation("com.google.code.gson:gson:2.8.6")
  • अब आप छवियों को लेबल करने के लिए तैयार हैं।

    1. इनपुट छवि तैयार करें

    क्लाउड विज़न को कॉल करने के लिए, छवि को बेस64-एन्कोडेड स्ट्रिंग के रूप में स्वरूपित किया जाना चाहिए। किसी सहेजी गई फ़ाइल URI से किसी छवि को संसाधित करने के लिए:
    1. छवि को Bitmap ऑब्जेक्ट के रूप में प्राप्त करें:

      Kotlin+KTX

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

      Java

      Bitmap bitmap = MediaStore.Images.Media.getBitmap(getContentResolver(), uri);
    2. वैकल्पिक रूप से, बैंडविड्थ बचाने के लिए छवि को छोटा करें। क्लाउड विज़न अनुशंसित छवि आकार देखें।

      Kotlin+KTX

      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+KTX

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

      Java

      // Scale down bitmap size
      bitmap = scaleBitmapDown(bitmap, 640);
    3. बिटमैप ऑब्जेक्ट को बेस64 एन्कोडेड स्ट्रिंग में बदलें:

      Kotlin+KTX

      // 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. छवि को लेबल करने के लिए कॉल करने योग्य फ़ंक्शन को प्रारंभ करें

    किसी छवि में ऑब्जेक्ट को लेबल करने के लिए, JSON क्लाउड विज़न अनुरोध पास करने वाले कॉल करने योग्य फ़ंक्शन को प्रारंभ करें।

    1. सबसे पहले, क्लाउड फ़ंक्शंस का एक उदाहरण प्रारंभ करें:

      Kotlin+KTX

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

      Java

      private FirebaseFunctions mFunctions;
      // ...
      mFunctions = FirebaseFunctions.getInstance();
      
    2. फ़ंक्शन को लागू करने की एक विधि परिभाषित करें:

      Kotlin+KTX

      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+KTX

      // 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+KTX

      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 सरणी में प्रत्येक ऑब्जेक्ट किसी ऐसी चीज़ का प्रतिनिधित्व करता है जिसे छवि में लेबल किया गया था। प्रत्येक लेबल के लिए, आप लेबल का टेक्स्ट विवरण, उसकी नॉलेज ग्राफ इकाई आईडी (यदि उपलब्ध हो), और मैच का कॉन्फिडेंस स्कोर प्राप्त कर सकते हैं। उदाहरण के लिए:

    Kotlin+KTX

    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();
    }