एंड्रॉइड पर फायरबेस प्रमाणीकरण और कार्यों का उपयोग करके क्लाउड विजन के साथ सुरक्षित रूप से लैंडमार्क को पहचानें

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

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

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

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

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

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

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

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

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

कॉल करने योग्य फ़ंक्शन को परिनियोजित करें

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

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

समारोह को तैनात करने के लिए:

  1. फंक्शन-सैंपल रेपो को क्लोन या डाउनलोड करें और vision-annotate-image डायरेक्टरी में बदलें:
    git clone https://github.com/firebase/functions-samples
    cd vision-annotate-image
    
  2. निर्भरता स्थापित करें:
    cd functions
    npm install
    cd ..
    
  3. अगर आपके पास फायरबेस सीएलआई नहीं है, तो इसे इंस्टॉल करें।
  4. vision-annotate-image डायरेक्टरी में फायरबेस प्रोजेक्ट को इनिशियलाइज़ करें। संकेत मिलने पर, सूची में अपना प्रोजेक्ट चुनें।
    firebase init
  5. फ़ंक्शन परिनियोजित करें:
    firebase deploy --only functions:annotateImage

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

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

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

  • अपने मॉड्यूल (ऐप-लेवल) ग्रैडल फ़ाइल (आमतौर पर ऐप/बिल्ड.ग्रेड) में फायरबेस फ़ंक्शंस और जीसन एंड्रॉइड लाइब्रेरी के लिए निर्भरताएं जोड़ें:
    implementation 'com.google.firebase:firebase-functions:20.1.0'
    implementation 'com.google.code.gson:gson:2.8.6'
    
  • 1. इनपुट छवि तैयार करें

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

      Java

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

      Kotlin+KTX

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

      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

      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

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

      Kotlin+KTX

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

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

      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)
    4. Bitmap ऑब्जेक्ट द्वारा दर्शाया गया चित्र सीधा होना चाहिए, बिना किसी अतिरिक्त घुमाव की आवश्यकता के।

    2. स्थलों को पहचानने के लिए कॉल करने योग्य फ़ंक्शन को आमंत्रित करें

    किसी छवि में लैंडमार्क को पहचानने के लिए, JSON क्लाउड विज़न अनुरोध पास करते हुए, कॉल करने योग्य फ़ंक्शन को लागू करें।

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

      Java

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

      Kotlin+KTX

      private lateinit var functions: FirebaseFunctions
      // ...
      functions = Firebase.functions
      
    2. फ़ंक्शन को लागू करने के लिए एक विधि परिभाषित करें:

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

      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))
                  }
      }
      
    3. LANDMARK_DETECTION प्रकार के साथ JSON अनुरोध बनाएं:

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

      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("LANDMARK_DETECTION"))
      val features = JsonArray()
      features.add(feature)
      request.add("features", features)
      
    4. अंत में, फ़ंक्शन का आह्वान करें:

      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
                          // ...
                      }
                  }
              });
      

      Kotlin+KTX

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

    3. मान्यता प्राप्त स्थलों के बारे में जानकारी प्राप्त करें

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

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

    Kotlin+KTX

    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"]
        }
    }