للاتّصال بواجهة برمجة تطبيقات Google Cloud من تطبيقك، عليك إنشاء واجهة برمجة تطبيقات برمجة تطبيقات REST API وسيطة تتعامل مع التفويض وتحمي القيم السرية، مثل مفاتيح واجهة برمجة التطبيقات. بعد ذلك، عليك كتابة رمز في تطبيقك المتوافق مع الأجهزة الجوّالة لمصادقة هذه الخدمة الوسيطة والتواصل معها.
إحدى طرق إنشاء واجهة برمجة التطبيقات REST API هذه هي استخدام Firebase Authentication وFunctions، ما يمنحك بوابة مُدارة بدون خادم للوصول إلى واجهات برمجة تطبيقات Google Cloud التي تعالج المصادقة ويمكن طلبها من تطبيقك المتوافق مع الأجهزة الجوّالة باستخدام حِزم تطوير البرامج (SDK) المُنشأة مسبقًا.
يوضّح هذا الدليل كيفية استخدام هذه التقنية لاستدعاء واجهة برمجة التطبيقات Cloud Vision API من تطبيقك. ستسمح هذه الطريقة لجميع المستخدمين الذين تمّت مصادقة هويتهم بالوصول إلى خدمات Cloud Vision المدفوعة من خلال مشروعك على Cloud، لذلك ننصحك بالتفكير في ما إذا كانت آلية المصادقة هذه كافية لحالة الاستخدام التي تتعامل معها قبل المتابعة.
قبل البدء
ضبط إعدادات مشروعك
- أضِف Firebase إلى مشروع Android، في حال لم يسبق لك إجراء ذلك.
-
إذا لم يسبق لك تفعيل واجهات برمجة التطبيقات المستندة إلى السحابة الإلكترونية لمشروعك، عليك إجراء ذلك الآن:
- افتح Firebase ML صفحة واجهات برمجة التطبيقات في وحدة تحكّم Firebase.
-
إذا لم تكن قد أجريت ترقية لمشروعك إلى خطة أسعار Blaze، انقر على ترقية لإجراء ذلك. (لن يُطلب منك إجراء الترقية إلا إذا كان مشروعك غير مُدرَج في خطة Blaze).
يمكن للمشاريع على مستوى Blaze فقط استخدام واجهات برمجة التطبيقات المستندة إلى Cloud.
- إذا لم تكن واجهات برمجة التطبيقات المستندة إلى السحابة الإلكترونية مفعّلة، انقر على تفعيل واجهات برمجة التطبيقات المستندة إلى السحابة الإلكترونية.
- اضبط مفاتيح واجهة برمجة تطبيقات Firebase الحالية لحظر الوصول إلى واجهة برمجة تطبيقات
Cloud Vision:
- افتح صفحة بيانات الاعتماد في Cloud Console.
- لكل مفتاح واجهة برمجة تطبيقات في القائمة، افتح طريقة عرض التعديل، وفي قسم "قيود المفتاح"، أضِف جميع واجهات برمجة التطبيقات المتاحة باستثناء واجهة برمجة التطبيقات Cloud Vision إلى القائمة.
نشر الدالة القابلة للاتّصال
بعد ذلك، يمكنك نشر Cloud Function التي ستستخدمها لربط تطبيقك بواجهة برمجة التطبيقات لخدمة معالجة الصور في يحتوي مستودع functions-samples
على مثال
يمكنك استخدامه.
سيؤدي الوصول إلى واجهة برمجة التطبيقات Cloud Vision API من خلال هذه الوظيفة تلقائيًا إلى منح المستخدمين الذين تمّت مصادقة هويتهم في تطبيقك إذن الوصول إلى واجهة برمجة التطبيقات Cloud Vision API فقط. يمكنك تعديل الدالة لتلبية متطلبات مختلفة.
لنشر الدالة:
- يمكنك استنساخ مستودع functions-samples أو تنزيله
وانتقل إلى الدليل
Node-1st-gen/vision-annotate-image
:git clone https://github.com/firebase/functions-samples
cd Node-1st-gen/vision-annotate-image
- ثبِّت التبعيّات:
cd functions
npm install
cd ..
- إذا لم يكن لديك Firebase CLI، ثبِّته.
- ابدأ مشروعًا على Firebase في الدليل
vision-annotate-image
. اختَر مشروعك من القائمة عندما يُطلب منك ذلك.firebase init
- نشر الدالة:
firebase deploy --only functions:annotateImage
إضافة Firebase Auth إلى تطبيقك
سترفض الوظيفة القابلة للاستدعاء التي تم نشرها أعلاه أي طلب من مستخدمي تطبيقك الذين لم يتم مصادقة هويتهم. إذا لم يسبق لك إجراء ذلك، عليك إضافة Firebase Auth إلى تطبيقك.
إضافة العناصر التابعة اللازمة إلى تطبيقك
<project>/<app-module>/build.gradle.kts
أو
<project>/<app-module>/build.gradle
):
implementation("com.google.firebase:firebase-functions:21.1.0") implementation("com.google.code.gson:gson:2.8.6")
أنت الآن جاهز لبدء التعرّف على النص في الصور.
1. تجهيز صورة الإدخال
للاتصال بخدمة Cloud Vision، يجب تنسيق الصورة كسلسلة بترميز base64. لمعالجة صورة من عنوان URI لملف محفوظ:- الحصول على الصورة كعنصر
Bitmap
:Kotlin
var bitmap: Bitmap = MediaStore.Images.Media.getBitmap(contentResolver, uri)
Java
Bitmap bitmap = MediaStore.Images.Media.getBitmap(getContentResolver(), uri);
- يمكنك تصغير حجم الصورة لتوفير مساحة في النطاق الترددي، إذا أردت. اطّلِع على
أحجام الصور المقترَحة في 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);
- حوِّل عنصر الصورة النقطية إلى سلسلة بترميز 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
upright، بدون الحاجة إلى إجراء أيّ دوران إضافي.
2- استدعاء الدالة القابلة للاستدعاء للتعرّف على النص
للتعرّف على نص في صورة، يمكنك استدعاء الدالة القابلة للاستدعاء مع تمرير طلب JSON في Cloud Vision.
أولاً، عليك إعداد مثيل لخدمة Cloud Functions:
Kotlin
private lateinit var functions: FirebaseFunctions // ... functions = Firebase.functions
Java
private FirebaseFunctions mFunctions; // ... mFunctions = FirebaseFunctions.getInstance();
حدِّد طريقة لاستدعاء الدالة:
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())); } }); }
أنشئ طلب JSON. تتيح Cloud Vision API نوعَين من ميزة "اكتشاف النص":
TEXT_DETECTION
وDOCUMENT_TEXT_DETECTION
. اطّلِع على مستندات ميزة التعرّف على النص من الصور في Cloud Vision لمعرفة الفرق بين حالتَي الاستخدام.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("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
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);
أخيرًا، استدِع الدالة:
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- استخراج النص من مجموعات النصوص التي تم التعرّف عليها
إذا نجحت عملية التعرّف على النص، سيتم عرض استجابة JSON من نوع BatchAnnotateImagesResponse في نتيجة المهمة. يمكن العثور على التعليقات التوضيحية النصية في عنصرfullTextAnnotation
.
يمكنك الحصول على النص الذي تم التعرّف عليه كسلسلة في حقل text
. على سبيل المثال:
Kotlin
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
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);
}
}