Безопасное распознавание текста на изображениях с помощью Cloud Vision с использованием аутентификации Firebase и функций на платформах Apple

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Чтобы вызвать API Google Cloud из вашего приложения, вам нужно создать промежуточный REST API, который обрабатывает авторизацию и защищает секретные значения, такие как ключи API. Затем вам нужно написать код в вашем мобильном приложении для аутентификации и связи с этой промежуточной службой.

Одним из способов создания REST API является использование Firebase Authentication and Functions, что предоставляет вам управляемый бессерверный шлюз к API Google Cloud, который обрабатывает аутентификацию и может вызываться из вашего мобильного приложения с помощью готовых SDK.

В этом руководстве показано, как использовать эту технику для вызова API Cloud Vision из вашего приложения. Этот метод позволит всем аутентифицированным пользователям получать доступ к платным сервисам Cloud Vision через ваш проект Cloud, поэтому подумайте, достаточен ли этот механизм аутентификации для вашего варианта использования, прежде чем продолжить.

Прежде чем начать

Настройте свой проект

Используйте Swift Package Manager для установки и управления зависимостями Firebase.

1. В Xcode откройте проект приложения и перейдите в меню Файл > Добавить пакеты .
2. При появлении соответствующего запроса добавьте репозиторий Firebase Apple platform SDK:

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

3. Выберите библиотеку Firebase ML .
4. Добавьте флаг -ObjC в раздел «Другие флаги компоновщика» настроек сборки вашей цели.
5. По завершении Xcode автоматически начнет разрешать и загружать ваши зависимости в фоновом режиме.

Далее выполните некоторые настройки в приложении:

1. Импортируйте Firebase в свое приложение:

   Быстрый

   import FirebaseMLModelDownloader

   Objective-C

   @import FirebaseMLModelDownloader;

Еще несколько шагов по настройке, и мы готовы к работе:

1. Если вы еще не включили облачные API для своего проекта, сделайте это сейчас:

   1. Откройте страницу API Firebase ML в консоли Firebase .

   2. Если вы еще не обновили свой проект до тарифного плана Blaze с оплатой по мере использования , нажмите «Обновить» , чтобы сделать это. (Вам будет предложено обновиться, только если ваш проект не входит в тарифный план Blaze.)

      Использовать облачные API могут только проекты на тарифном плане Blaze.

   3. Если облачные API еще не включены, нажмите Включить облачные API .
2. Настройте существующие ключи API Firebase, чтобы запретить доступ к API Cloud Vision:
   1. Откройте страницу «Учетные данные» облачной консоли.
   2. Для каждого ключа API в списке откройте представление редактирования и в разделе «Ограничения ключа» добавьте в список все доступные API, за исключением API Cloud Vision.

Развертывание вызываемой функции

Далее разверните Cloud Function, которую вы будете использовать для соединения своего приложения и API Cloud Vision. Репозиторий functions-samples содержит пример, который вы можете использовать.

По умолчанию доступ к API Cloud Vision через эту функцию позволит только аутентифицированным пользователям вашего приложения получить доступ к API Cloud Vision. Вы можете изменить функцию для различных требований.

Для развертывания функции:

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 Auth в свое приложение

Вызываемая функция, развернутая выше, отклонит любой запрос от неаутентифицированных пользователей вашего приложения. Если вы еще этого не сделали, вам нужно будет добавить Firebase Auth в свое приложение.

Добавьте необходимые зависимости в ваше приложение

Используйте Swift Package Manager для установки библиотеки Cloud Functions for 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:

   Быстрый

   lazy var functions = Functions.functions()
   

   Objective-C

   @property(strong, nonatomic) FIRFunctions *functions;
   

2. Создайте запрос. API Cloud Vision поддерживает два типа обнаружения текста: TEXT_DETECTION и DOCUMENT_TEXT_DETECTION . Ознакомьтесь с документацией Cloud Vision OCR, чтобы узнать разницу между двумя вариантами использования.

   Быстрый

   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. Наконец, вызовите функцию:

   Быстрый

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