Firebase is back at Google I/O on May 10! Register now

זיהוי טקסט בתמונות בצורה מאובטחת עם Cloud Vision באמצעות Firebase Auth ופונקציות ב-Android

קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

כדי להתקשר ל-Google Cloud API מהאפליקציה שלך, עליך ליצור REST API ביניים שמטפל בהרשאה ומגן על ערכים סודיים כגון מפתחות API. לאחר מכן עליך לכתוב קוד באפליקציה לנייד שלך כדי לאמת ולתקשר עם שירות הביניים הזה.

אחת הדרכים ליצור REST API זה היא באמצעות Firebase Authentication and Functions, המעניק לך שער מנוהל ללא שרת אל ממשקי Google Cloud API שמטפל באימות וניתן להתקשר אליו מהאפליקציה לנייד שלך עם ערכות SDK מובנות מראש.

מדריך זה מדגים כיצד להשתמש בטכניקה זו כדי לקרוא ל-Cloud Vision API מהאפליקציה שלך. שיטה זו תאפשר לכל המשתמשים המאומתים לגשת לשירותי החיוב של Cloud Vision דרך פרויקט הענן שלך, אז שקול אם מנגנון אימות זה מספיק למקרה השימוש שלך לפני שתמשיך.

לפני שאתה מתחיל

הגדר את הפרויקט שלך

  1. אם עדיין לא עשית זאת, הוסף את Firebase לפרויקט Android שלך .

  2. אם עדיין לא הפעלת ממשקי API מבוססי ענן עבור הפרויקט שלך, עשה זאת כעת:

    1. פתח את הדף Firebase ML APIs של מסוף Firebase.

    2. אם עדיין לא שדרגת את הפרויקט שלך לתוכנית התמחור של Blaze, לחץ על שדרג כדי לעשות זאת. (תתבקש לשדרג רק אם הפרויקט שלך אינו בתוכנית Blaze.)

      רק פרויקטים ברמת Blaze יכולים להשתמש בממשקי API מבוססי ענן.

    3. אם ממשקי API מבוססי ענן עדיין לא מופעלים, לחץ על הפעל ממשקי API מבוססי ענן .
  3. הגדר את מפתחות ה-API הקיימים של Firebase כדי לא לאפשר גישה ל-Cloud Vision API:
    1. פתח את דף האישורים של מסוף הענן.
    2. עבור כל מפתח API ברשימה, פתח את תצוגת העריכה ובקטע מגבלות מפתח, הוסף לרשימה את כל ממשקי ה-API הזמינים מלבד Cloud Vision API.

פרוס את הפונקציה הניתנת להתקשרות

לאחר מכן, פרוס את פונקציית הענן שבה תשתמש כדי לגשר בין האפליקציה שלך לבין Cloud Vision API. מאגר functions-samples מכיל דוגמה שתוכל להשתמש בה.

כברירת מחדל, גישה ל-Cloud Vision API באמצעות פונקציה זו תאפשר רק למשתמשים מאומתים של האפליקציה שלך גישה ל-Cloud Vision API. אתה יכול לשנות את הפונקציה לדרישות שונות.

כדי לפרוס את הפונקציה:

  1. שכפל או הורד את המאגר של functions-samples ושנה לספריית vision-annotate-image :
    git clone https://github.com/firebase/functions-samples
cd vision-annotate-image
  2. תלות בהתקנה:
    cd functions
npm install
cd ..
  3. אם אין לך את Firebase CLI, התקן אותו .
  4. אתחול פרויקט Firebase בספריית vision-annotate-image . כאשר תתבקש, בחר את הפרויקט שלך ברשימה. 
    firebase init
  5. פרוס את הפונקציה: 
    firebase deploy --only functions:annotateImage

הוסף Firebase Auth לאפליקציה שלך

הפונקציה הניתנת להתקשרות שנפרסה למעלה תדחה כל בקשה ממשתמשים לא מאומתים של האפליקציה שלך. אם עדיין לא עשית זאת, תצטרך להוסיף Firebase Auth לאפליקציה שלך.

הוסף תלות נחוצה לאפליקציה שלך

  • הוסף את התלות של פונקציות Firebase ו-gson Android לקובץ Gradle של המודול (ברמת האפליקציה) (בדרך כלל app/build.gradle): 
    implementation 'com.google.firebase:firebase-functions:20.2.2'
implementation 'com.google.code.gson:gson:2.8.6'

    • עכשיו אתה מוכן להתחיל לזהות טקסט בתמונות.

    1. הכן את תמונת הקלט

    כדי לקרוא ל-Cloud Vision, התמונה חייבת להיות בפורמט כמחרוזת מקודדת base64. כדי לעבד תמונה מ-URI של קובץ שמור:
    1. קבל את התמונה כאובייקט Bitmap :

      Kotlin+KTX

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

      Java

      Bitmap bitmap = MediaStore.Images.Media.getBitmap(getContentResolver(), uri);
    2. לחלופין, הקטנת התמונה כדי לחסוך ברוחב הפס. ראה את גדלי התמונות המומלצים של Cloud Vision.

      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. המר את אובייקט מפת הסיביות למחרוזת מקודדת base64:

      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 Cloud Vision .

    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. צור את בקשת ה-JSON. ממשק ה-API של Cloud Vision תומך בשני סוגי זיהוי טקסט: TEXT_DETECTION ו- DOCUMENT_TEXT_DETECTION . עיין ב- Cloud Vision OCR Docs עבור ההבדל בין שני מקרי השימוש.

      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("type", JsonPrimitive("TEXT_DETECTION"))
// Alternatively, for DOCUMENT_TEXT_DETECTION:
// feature.add("type", JsonPrimitive("DOCUMENT_TEXT_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("type", new JsonPrimitive("TEXT_DETECTION"));
// Alternatively, for DOCUMENT_TEXT_DETECTION:
//feature.add("type", new JsonPrimitive("DOCUMENT_TEXT_DETECTION"));
JsonArray features = new JsonArray();
features.add(feature);
request.add("features", features);

      לחלופין, ספק רמזי שפה כדי לסייע בזיהוי שפה (ראה שפות נתמכות ):

      Kotlin+KTX

      val imageContext = JsonObject()
val languageHints = JsonArray()
languageHints.add("en")
imageContext.add("languageHints", languageHints)
request.add("imageContext", imageContext)

      Java

      JsonObject imageContext = new JsonObject();
JsonArray languageHints = new JsonArray();
languageHints.add("en");
imageContext.add("languageHints", languageHints);
request.add("imageContext", imageContext);

    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. חלץ טקסט מגושים של טקסט מוכר

    אם פעולת זיהוי הטקסט תצליח, תגובת JSON של BatchAnnotateImagesResponse תוחזר בתוצאת המשימה. ניתן למצוא את הערות הטקסט באובייקט fullTextAnnotation .

    אתה יכול לקבל את הטקסט המוכר כמחרוזת בשדה text . לדוגמה:

    Kotlin+KTX

    val annotation = task.result!!.asJsonArray[0].asJsonObject["fullTextAnnotation"].asJsonObject
System.out.format("%nComplete annotation:")
System.out.format("%n%s", annotation["text"].asString)

    Java

    JsonObject annotation = task.getResult().getAsJsonArray().get(0).getAsJsonObject().get("fullTextAnnotation").getAsJsonObject();
System.out.format("%nComplete annotation:%n");
System.out.format("%s%n", annotation.get("text").getAsString());

    אתה יכול גם לקבל מידע ספציפי לאזורים בתמונה. עבור כל block , paragraph , word symbol , ניתן לזהות את הטקסט באזור ואת הקואורדינטות התוחמות של האזור. לדוגמה:

    Kotlin+KTX

    for (page in annotation["pages"].asJsonArray) {
    var pageText = ""
    for (block in page.asJsonObject["blocks"].asJsonArray) {
        var blockText = ""
        for (para in block.asJsonObject["paragraphs"].asJsonArray) {
            var paraText = ""
            for (word in para.asJsonObject["words"].asJsonArray) {
                var wordText = ""
                for (symbol in word.asJsonObject["symbols"].asJsonArray) {
                    wordText += symbol.asJsonObject["text"].asString
                    System.out.format("Symbol text: %s (confidence: %f)%n",
                        symbol.asJsonObject["text"].asString, symbol.asJsonObject["confidence"].asFloat)
                }
                System.out.format("Word text: %s (confidence: %f)%n%n", wordText,
                    word.asJsonObject["confidence"].asFloat)
                System.out.format("Word bounding box: %s%n", word.asJsonObject["boundingBox"])
                paraText = String.format("%s%s ", paraText, wordText)
            }
            System.out.format("%nParagraph: %n%s%n", paraText)
            System.out.format("Paragraph bounding box: %s%n", para.asJsonObject["boundingBox"])
            System.out.format("Paragraph Confidence: %f%n", para.asJsonObject["confidence"].asFloat)
            blockText += paraText
        }
        pageText += blockText
    }
}

    Java

    for (JsonElement page : annotation.get("pages").getAsJsonArray()) {
    StringBuilder pageText = new StringBuilder();
    for (JsonElement block : page.getAsJsonObject().get("blocks").getAsJsonArray()) {
        StringBuilder blockText = new StringBuilder();
        for (JsonElement para : block.getAsJsonObject().get("paragraphs").getAsJsonArray()) {
            StringBuilder paraText = new StringBuilder();
            for (JsonElement word : para.getAsJsonObject().get("words").getAsJsonArray()) {
                StringBuilder wordText = new StringBuilder();
                for (JsonElement symbol : word.getAsJsonObject().get("symbols").getAsJsonArray()) {
                    wordText.append(symbol.getAsJsonObject().get("text").getAsString());
                    System.out.format("Symbol text: %s (confidence: %f)%n", symbol.getAsJsonObject().get("text").getAsString(), symbol.getAsJsonObject().get("confidence").getAsFloat());
                }
                System.out.format("Word text: %s (confidence: %f)%n%n", wordText.toString(), word.getAsJsonObject().get("confidence").getAsFloat());
                System.out.format("Word bounding box: %s%n", word.getAsJsonObject().get("boundingBox"));
                paraText.append(wordText.toString()).append(" ");
            }
            System.out.format("%nParagraph:%n%s%n", paraText);
            System.out.format("Paragraph bounding box: %s%n", para.getAsJsonObject().get("boundingBox"));
            System.out.format("Paragraph Confidence: %f%n", para.getAsJsonObject().get("confidence").getAsFloat());
            blockText.append(paraText);
        }
        pageText.append(blockText);
    }
}