Bezpieczne rozpoznawanie tekstu w obrazach dzięki Cloud Vision przy użyciu uwierzytelniania i funkcji Firebase na platformach Apple

Aby wywołać interfejs Google Cloud API z aplikacji, musisz utworzyć pośredni interfejs API REST, który obsługuje autoryzację i chroni tajne wartości, takie jak klucze interfejsu API. Następnie musisz napisać kod w aplikacji mobilnej, aby uwierzytelnić się w tej usłudze pośredniczącej i komunikować się z nią.

Jednym ze sposobów utworzenia tego API (typu) REST jest użycie Uwierzytelniania Firebase i Funkcji, co zapewnia zarządzaną, bezserwerową bramę do interfejsów Cloud APIs, która obsługuje uwierzytelnianie i może być wywoływana z aplikacji mobilnej za pomocą gotowych pakietów SDK.

Z tego przewodnika dowiesz się, jak używać tej techniki do wywoływania interfejsu Cloud Vision API z aplikacji. Ta metoda umożliwi wszystkim uwierzytelnionym użytkownikom dostęp do płatnych usług Cloud Vision za pośrednictwem Twojego projektu w chmurze, więc zanim przejdziesz dalej, zastanów się, czy ten mechanizm uwierzytelniania jest wystarczający w Twoim przypadku.

Uwaga: korzystanie z interfejsów Cloud Vision API podlega umowie licencyjnej Google Cloud Platform i szczegółowym warunkom korzystania z usługi i jest odpowiednio rozliczane. Informacje rozliczeniowe znajdziesz na stronie Cennik.

Szukasz funkcji rozpoznawania tekstu na urządzeniu? Wypróbuj samodzielną bibliotekę ML Kit.

Zanim zaczniesz

Skonfiguruj projekt

Jeśli nie masz jeszcze Firebase w aplikacji, dodaj tę platformę, wykonując czynności opisane w przewodniku dla początkujących.

Do instalowania zależności Firebase i zarządzania nimi używaj menedżera pakietów Swift.

Zapoznaj się z przewodnikiem instalacji, aby dowiedzieć się, jak dodać pakiety SDK Firebase do projektu Apple.

1. W Xcode, gdy projekt aplikacji jest otwarty, kliknij File > Add Packages (Plik > Dodaj pakiety).
2. Gdy pojawi się prośba, dodaj repozytorium pakietu SDK Firebase na platformy Apple:

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

Uwaga: nowe projekty powinny używać domyślnej (najnowszej) wersji pakietu SDK, ale w razie potrzeby możesz wybrać starszą wersję.
3. Wybierz bibliotekę Firebase ML.
4. Dodaj flagę -ObjC do sekcji Other Linker Flags (Inne flagi łączące) w ustawieniach kompilacji celu.
5. Gdy skończysz, Xcode zacznie automatycznie przetwarzać i pobierać zależności w tle.

Następnie wykonaj kilka czynności konfiguracyjnych w aplikacji:

1. W aplikacji zaimportuj Firebase:

   Swift

   import FirebaseMLModelDownloader

   Objective-C

   @import FirebaseMLModelDownloader;

Zostało jeszcze kilka kroków konfiguracji:

1. Jeśli w projekcie nie masz jeszcze włączonych interfejsów API działających w chmurze, włącz je teraz:

   1. Otwórz stronę Firebase ML interfejsów API w konsoli Firebase.

   2. Jeśli nie masz jeszcze projektu w abonamencie Blaze z płatnością według wykorzystania, kliknij Przejdź na wyższą wersję. (Prośba o przejście na wyższą wersję pojawi się tylko wtedy, gdy projekt nie jest w abonamencie Blaze).

      Tylko projekty w abonamencie Blaze mogą korzystać z interfejsów API działających w chmurze.

   3. Jeśli interfejsy API działające w chmurze nie są jeszcze włączone, kliknij Włącz interfejsy API działające w chmurze.
2. Skonfiguruj istniejące klucze interfejsu API Firebase, aby uniemożliwić dostęp do interfejsu Cloud Vision API:
   1. Otwórz stronę Dane logowania w konsoli Cloud.
   2. W przypadku każdego klucza interfejsu API na liście otwórz widok edycji i w sekcji Ograniczenia kluczy dodaj do listy wszystkie dostępne interfejsy API oprócz Cloud Vision API.

Wdrażanie funkcji możliwej do wywołania

Następnie wdróż funkcję w Cloud Functions, której użyjesz do połączenia aplikacji z interfejsem Cloud Vision API. Repozytorium functions-samples zawiera przykład, którego możesz użyć.

Domyślnie dostęp do interfejsu Cloud Vision API za pomocą tej funkcji będą mieli tylko uwierzytelnieni użytkownicy Twojej aplikacji. Możesz zmodyfikować funkcję, aby spełniała inne wymagania.

Aby wdrożyć funkcję:

1. Skopiuj lub pobierz repozytorium functions-samples i przejdź do katalogu Node-1st-gen/vision-annotate-image:

   git clone https://github.com/firebase/functions-samples
   cd Node-1st-gen/vision-annotate-image
   

2. Zainstaluj zależności:

   cd functions
   npm install
   cd ..

3. Jeśli nie masz wiersza poleceń Firebase, zainstaluj go.
4. Zainicjuj projekt Firebase w katalogu vision-annotate-image. Gdy pojawi się prośba, wybierz projekt z listy.

   firebase init

5. Wdróż funkcję:

   firebase deploy --only functions:annotateImage

Dodawanie uwierzytelniania Firebase do aplikacji

Wdrożona powyżej funkcja wywoływalna odrzuci każde żądanie od nieuwierzytelnionych użytkowników aplikacji. Jeśli jeszcze nie masz Firebase Auth w aplikacji, dodaj tę funkcję.

Dodawanie niezbędnych zależności do aplikacji

Użyj menedżera pakietów Swift, aby zainstalować bibliotekę Cloud Functions dla Firebase.

Możesz już zacząć rozpoznawać tekst na obrazach.

1. Przygotowywanie obrazu wejściowego

Aby wywołać Cloud Vision, obraz musi być sformatowany jako ciąg tekstowy z kodowaniem Base64. Aby przetworzyć UIImage:

Swift

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

Objective-C

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

2. Wywoływanie funkcji callable w celu rozpoznania tekstu

Aby rozpoznać obiekty na obrazie, wywołaj funkcję, przekazując żądanie Cloud Vision w formacie JSON.

1. Najpierw zainicjuj instancję Cloud Functions:

   Swift

   lazy var functions = Functions.functions()
   

   Objective-C

   @property(strong, nonatomic) FIRFunctions *functions;
   

2. Utwórz żądanie. Interfejs Cloud Vision API obsługuje 2 typy wykrywania tekstu: TEXT_DETECTION i DOCUMENT_TEXT_DETECTION. Różnice między tymi 2 przypadkami użycia znajdziesz w dokumentacji 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. Na koniec wywołaj funkcję:

   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. Wyodrębnianie tekstu z bloków rozpoznanego tekstu

Jeśli operacja rozpoznawania tekstu się powiedzie, w wyniku zadania zostanie zwrócona odpowiedź JSON BatchAnnotateImagesResponse. Adnotacje tekstowe znajdziesz w obiekcie fullTextAnnotation.

Rozpoznany tekst możesz uzyskać jako ciąg znaków w polu text. Przykład:

Swift

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

Objective-C

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

Możesz też uzyskać informacje o konkretnych obszarach obrazu. W przypadku każdego elementu block, paragraph, word i symbol możesz uzyskać tekst rozpoznany w regionie i współrzędne ograniczające region. Przykład:

Swift

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

Objective-C

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