التعرّف على النص في "الصور" بشكل آمن من خلال Cloud Vision باستخدام مصادقة Firebase والوظائف على أنظمة Apple الأساسية

لاستدعاء Cloud APIs من تطبيقك، عليك إنشاء واجهة برمجة تطبيقات REST وسيطة تتعامل مع التفويض وتحمي القيم السرية، مثل مفاتيح واجهة برمجة التطبيقات. بعد ذلك، عليك كتابة رمز في تطبيقك للأجهزة الجوّالة للمصادقة على هذه الخدمة الوسيطة والتواصل معها.

إحدى طرق إنشاء واجهة برمجة التطبيقات REST هذه هي استخدام "مصادقة Firebase" و"وظائف Firebase"، ما يمنحك بوابة مُدارة وبدون خادم إلى Google Cloud APIs تتعامل مع المصادقة ويمكن استدعاؤها من تطبيقك للأجهزة الجوّالة باستخدام حِزم SDK المعدّة مسبقًا.

يوضّح هذا الدليل كيفية استخدام هذا الأسلوب لاستدعاء Cloud Vision API من تطبيقك. ستسمح هذه الطريقة لجميع المستخدمين الذين تمّت مصادقتهم بالوصول إلى الخدمات المدفوعة في Cloud Vision من خلال مشروعك على السحابة الإلكترونية، لذا عليك تحديد ما إذا كانت آلية المصادقة هذه كافية لحالة الاستخدام قبل المتابعة.

قبل البدء

ضبط مشروعك

استخدِم Swift Package Manager لتثبيت التبعيات في Firebase وإدارتها.

1. في Xcode، افتح مشروع تطبيقك وانتقِل إلى ملف > إضافة حِزم.
2. عندما يُطلب منك ذلك، أضِف مستودع حزمة Firebase SDK لمنصّات Apple:

  https://github.com/firebase/firebase-ios-sdk.git

3. اختَر مكتبة Firebase ML.
4. أضِف العلامة -ObjC إلى قسم علامات الرابط الأخرى في إعدادات الإصدار للهدف.
5. بعد الانتهاء، سيبدأ Xcode تلقائيًا في حلّ التبعيات وتنزيلها في الخلفية.

بعد ذلك، نفِّذ بعض خطوات الإعداد داخل التطبيق:

1. في تطبيقك، استورِد Firebase:

   Swift

   import FirebaseMLModelDownloader

   Objective-C

   @import FirebaseMLModelDownloader;

تتبقى بعض خطوات الإعداد الإضافية، وسيصبح التطبيق جاهزًا للاستخدام:

1. إذا لم يسبق لك تفعيل واجهات برمجة التطبيقات المستندة إلى السحابة الإلكترونية لمشروعك، يمكنك إجراء ذلك الآن:

   1. افتح صفحة Firebase ML APIs في Firebase console.

   2. إذا لم يسبق لك ترقية مشروعك إلى خطة Blaze المَرِنة، انقر على ترقية لإجراء ذلك. (لن يُطلب منك الترقية إلا إذا لم يكن مشروعك ضمن خطة Blaze المَرِنة).

      لا يمكن استخدام واجهات برمجة التطبيقات المستندة إلى السحابة الإلكترونية إلا في المشاريع التي تستخدم خطة Blaze المَرِنة.

   3. إذا لم يسبق لك تفعيل واجهات برمجة التطبيقات المستندة إلى السحابة الإلكترونية، انقر على تفعيل واجهات برمجة التطبيقات المستندة إلى السحابة الإلكترونية.
2. اضبط مفاتيح Firebase API الحالية لرفض الوصول إلى Cloud Vision API:
   1. افتح صفحة بيانات الاعتماد في Cloud Console.
   2. لكل مفتاح واجهة برمجة تطبيقات في القائمة، افتح طريقة العرض الخاصة بالتعديل، وفي قسم "قيود المفتاح" ، أضِف جميع واجهات برمجة التطبيقات المتاحة باستثناء Cloud Vision API إلى القائمة.

نشر الدالة القابلة للاستدعاء

بعد ذلك، انشر دالة Cloud Function التي ستستخدمها لربط تطبيقك بـ Cloud Vision API. يحتوي مستودع functions-samples على مثال يمكنك استخدامه.

تلقائيًا، لن يسمح الوصول إلى Cloud Vision API من خلال هذه الدالة إلا للمستخدمين الذين تمّت مصادقتهم في تطبيقك بالوصول إلى Cloud Vision API. يمكنك تعديل الدالة لتلبية متطلبات مختلفة.

لنشر الدالة:

1. استنسِخ مستودع functions-samples أو نزِّله وانتقِل إلى الدليل 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. ابدأ مشروع Firebase في الدليل vision-annotate-image. عندما يُطلب منك ذلك، اختَر مشروعك في القائمة.

   firebase init

5. انشر الدالة:

   firebase deploy --only functions:annotateImage

إضافة "مصادقة Firebase" إلى تطبيقك

سترّفض الدالة القابلة للاستدعاء التي تمّ نشرها أعلاه أي طلب من مستخدمين لم يتمّت مصادقتهم في تطبيقك. إذا لم يسبق لك إجراء ذلك، عليك إضافة "مصادقة Firebase" إلى تطبيقك.

إضافة التبعيات اللازمة إلى تطبيقك

استخدِم Swift Package Manager لتثبيت مكتبة وظائف Firebase السحابية.

أنت الآن جاهز لبدء التعرّف على النص في الصور.

1. إعداد الصورة المُدخَلة

guard let imageData = uiImage.jpegData(compressionQuality: 1.0) else { return }
let base64encodedImage = imageData.base64EncodedString()

NSData *imageData = UIImageJPEGRepresentation(uiImage, 1.0f);
NSString *base64encodedImage =
  [imageData base64EncodedStringWithOptions:NSDataBase64Encoding76CharacterLineLength];

2. استدعاء الدالة القابلة للاستدعاء للتعرّف على النص

1. أولاً، ابدأ مثيلاً من Cloud Functions:

   Swift

   lazy var functions = Functions.functions()
   

   Objective-C

   @property(strong, nonatomic) FIRFunctions *functions;
   

2. أنشِئ الطلب. تتيح Cloud Vision API نوعَين من ميزة التعرّف على النص: TEXT_DETECTION وDOCUMENT_TEXT_DETECTION. راجِع مستندات Cloud Vision OCR للاطّلاع على الفرق بين حالتَي الاستخدام.

   Swift

   let requestData = [
     "image": ["content": base64encodedImage],
     "features": ["type": "TEXT_DETECTION"],
     "imageContext": ["languageHints": ["en"]]
   ]
   

   Objective-C

   NSDictionary *requestData = @{
     @"image": @{@"content": base64encodedImage},
     @"features": @{@"type": @"TEXT_DETECTION"},
     @"imageContext": @{@"languageHints": @[@"en"]}
   };
   

3. أخيرًا، استدعِ الدالة:

   Swift

   do {
     let result = try await functions.httpsCallable("annotateImage").call(requestData)
     print(result)
   } catch {
     if let error = error as NSError? {
       if error.domain == FunctionsErrorDomain {
         let code = FunctionsErrorCode(rawValue: error.code)
         let message = error.localizedDescription
         let details = error.userInfo[FunctionsErrorDetailsKey]
       }
       // ...
     }
   }
   

   Objective-C

   [[_functions HTTPSCallableWithName:@"annotateImage"]
                             callWithObject:requestData
                                 completion:^(FIRHTTPSCallableResult * _Nullable result, NSError * _Nullable error) {
           if (error) {
             if ([error.domain isEqualToString:@"com.firebase.functions"]) {
               FIRFunctionsErrorCode code = error.code;
               NSString *message = error.localizedDescription;
               NSObject *details = error.userInfo[@"details"];
             }
             // ...
           }
           // Function completed succesfully
           // Get information about labeled objects
   
         }];
   

3. استخراج النص من كتل النص الذي تم التعرّف عليه

إذا نجحت عملية التعرّف على النص، سيتم عرض استجابة JSON من BatchAnnotateImagesResponse في نتيجة المهمة. يمكن العثور على تعليقات توضيحية للنص في العنصر fullTextAnnotation.

يمكنك الحصول على النص الذي تم التعرّف عليه كسلسلة في الحقل text. على سبيل المثال:

let annotation = result.flatMap { $0.data as? [String: Any] }
    .flatMap { $0["fullTextAnnotation"] }
    .flatMap { $0 as? [String: Any] }
guard let annotation = annotation else { return }

if let text = annotation["text"] as? String {
  print("Complete annotation: \(text)")
}

NSDictionary *annotation = result.data[@"fullTextAnnotation"];
if (!annotation) { return; }
NSLog(@"\nComplete annotation:");
NSLog(@"\n%@", annotation[@"text"]);

يمكنك أيضًا الحصول على معلومات خاصة بمناطق الصورة. لكل block وparagraph وword وsymbol، يمكنك الحصول على النص الذي تم التعرّف عليه في المنطقة والإحداثيات المحيطة بالمنطقة. على سبيل المثال:

guard let pages = annotation["pages"] as? [[String: Any]] else { return }
for page in pages {
  var pageText = ""
  guard let blocks = page["blocks"] as? [[String: Any]] else { continue }
  for block in blocks {
    var blockText = ""
    guard let paragraphs = block["paragraphs"] as? [[String: Any]] else { continue }
    for paragraph in paragraphs {
      var paragraphText = ""
      guard let words = paragraph["words"] as? [[String: Any]] else { continue }
      for word in words {
        var wordText = ""
        guard let symbols = word["symbols"] as? [[String: Any]] else { continue }
        for symbol in symbols {
          let text = symbol["text"] as? String ?? ""
          let confidence = symbol["confidence"] as? Float ?? 0.0
          wordText += text
          print("Symbol text: \(text) (confidence: \(confidence)%n")
        }
        let confidence = word["confidence"] as? Float ?? 0.0
        print("Word text: \(wordText) (confidence: \(confidence)%n%n")
        let boundingBox = word["boundingBox"] as? [Float] ?? [0.0, 0.0, 0.0, 0.0]
        print("Word bounding box: \(boundingBox.description)%n")
        paragraphText += wordText
      }
      print("%nParagraph: %n\(paragraphText)%n")
      let boundingBox = paragraph["boundingBox"] as? [Float] ?? [0.0, 0.0, 0.0, 0.0]
      print("Paragraph bounding box: \(boundingBox)%n")
      let confidence = paragraph["confidence"] as? Float ?? 0.0
      print("Paragraph Confidence: \(confidence)%n")
      blockText += paragraphText
    }
    pageText += blockText
  }
}

for (NSDictionary *page in annotation[@"pages"]) {
  NSMutableString *pageText = [NSMutableString new];
  for (NSDictionary *block in page[@"blocks"]) {
    NSMutableString *blockText = [NSMutableString new];
    for (NSDictionary *paragraph in block[@"paragraphs"]) {
      NSMutableString *paragraphText = [NSMutableString new];
      for (NSDictionary *word in paragraph[@"words"]) {
        NSMutableString *wordText = [NSMutableString new];
        for (NSDictionary *symbol in word[@"symbols"]) {
          NSString *text = symbol[@"text"];
          [wordText appendString:text];
          NSLog(@"Symbol text: %@ (confidence: %@\n", text, symbol[@"confidence"]);
        }
        NSLog(@"Word text: %@ (confidence: %@\n\n", wordText, word[@"confidence"]);
        NSLog(@"Word bounding box: %@\n", word[@"boundingBox"]);
        [paragraphText appendString:wordText];
      }
      NSLog(@"\nParagraph: \n%@\n", paragraphText);
      NSLog(@"Paragraph bounding box: %@\n", paragraph[@"boundingBox"]);
      NSLog(@"Paragraph Confidence: %@\n", paragraph[@"confidence"]);
      [blockText appendString:paragraphText];
    }
    [pageText appendString:blockText];
  }
}