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

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 API. Następnie musisz napisać kod w swojej aplikacji mobilnej, aby uwierzytelnić się i komunikować z tą usługą pośredniczącą.

Jednym ze sposobów utworzenia tego interfejsu API REST jest użycie uwierzytelniania i funkcji Firebase, które zapewniają zarządzaną, bezserwerową bramę do interfejsów Google Cloud API, które obsługują uwierzytelnianie i które można wywoływać z aplikacji mobilnej za pomocą gotowych pakietów SDK.

W tym przewodniku pokazano, 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 rozliczanych usług Cloud Vision za pośrednictwem projektu Cloud, więc przed kontynuowaniem zastanów się, czy ten mechanizm uwierzytelniania jest wystarczający w Twoim przypadku użycia.

Zanim zaczniesz

Skonfiguruj swój projekt

  1. Jeśli nie masz już dodane Firebase do aplikacji, należy to zrobić, wykonując czynności opisane w podręcznej instrukcji .
  2. Obejmują Firebase w Podfile: Po zainstalowaniu lub aktualizacji Pods Twojego projektu, należy otworzyć swój projekt Xcode używając jego .xcworkspace .
  3. W swojej aplikacji zaimportuj Firebase:

    Szybki

    import Firebase

    Cel C

    @import Firebase;
  4. Jeśli nie masz jeszcze włączonych interfejsów API opartych na chmurze w swoim projekcie, zrób to teraz:

    1. Otwórz stronę Firebase ML API konsoli Firebase.
    2. Jeśli nie masz już uaktualniony projekt do planu cenowego Blaze, kliknij przycisk Zmień, aby to zrobić. (Zostaniesz poproszony o uaktualnienie tylko wtedy, gdy Twój projekt nie jest objęty planem Blaze).

      Tylko projekty na poziomie Blaze mogą korzystać z interfejsów API opartych na chmurze.

    3. Jeśli API w chmurze nie są już włączone, kliknij przycisk Włącz API chmurowej.
  5. Skonfiguruj swoje istniejące klucze Firebase API, aby zablokować dostęp do Cloud Vision API:
    1. Otwórz Poświadczenia stronę konsoli chmurze.
    2. Dla każdego klucza API na liście, otwórz widok edycji, aw sekcji głównych ograniczeń, dodać wszystkie dostępne API wyjątkiem API Chmura wizja listy.

Wdróż funkcję wywoływalną

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

Domyślnie dostęp do Cloud Vision API za pomocą tej funkcji umożliwi dostęp do Cloud Vision API tylko uwierzytelnionym użytkownikom Twojej aplikacji. Możesz modyfikować funkcję do różnych wymagań.

Aby wdrożyć funkcję:

  1. Klon lub pobrać funkcje-samples repo i zmiana vision-annotate-image katalogu:
    git clone https://github.com/firebase/functions-samples
    cd vision-annotate-image
    
  2. Zainstalować zależności:
    cd functions
    npm install
    cd ..
    
  3. Jeśli nie masz Firebase CLI, zainstalować go .
  4. Zainicjować projekt Firebase w vision-annotate-image katalogu. Po wyświetleniu monitu wybierz swój projekt z listy.
    firebase init
  5. Wdrożyć funkcję:
    firebase deploy --only functions:annotateImage

Dodaj uwierzytelnianie Firebase do swojej aplikacji

Wdrożona powyżej funkcja wywoływalna odrzuci wszelkie żądania od nieuwierzytelnionych użytkowników Twojej aplikacji. Jeśli nie zostało to jeszcze zrobione, trzeba będzie dodać Firebase Auth do swojej aplikacji.

Dodaj niezbędne zależności do swojej aplikacji

  1. Dodaj zależności dla Firebase funkcji bibliotecznych do swojej Podfile:
    pod 'Firebase/Functions'
  2. Zainstalować zależności:
    pod install

Teraz możesz zacząć rozpoznawać tekst na obrazach.

1. Przygotuj obraz wejściowy

Aby można było wywołać Cloud Vision, obraz musi być sformatowany jako ciąg znaków zakodowany w base64. Przetworzyć UIImage :

Szybki

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

Cel C

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

2. Wywołaj funkcję wywoływaną, aby rozpoznać tekst

Aby rozpoznać punkty orientacyjne w obrazie, wywołać wpłacone funkcji przechodzącą żądanie JSON Chmura Vision .

  1. Najpierw zainicjuj instancję Cloud Functions:

    Szybki

    lazy var functions = Functions.functions()
    

    Cel C

    @property(strong, nonatomic) FIRFunctions *functions;
    
  2. Utwórz zgłoszenie. Vision Cloud API obsługuje dwa typy wykrywania tekstem: TEXT_DETECTION i DOCUMENT_TEXT_DETECTION . Zobacz Chmura Vision OCR Dokumenty do różnicy między tymi dwoma przypadkami użycia.

    Szybki

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

    Cel C

    NSDictionary *requestData = @{
      @"image": @{@"content": base64encodedImage},
      @"features": @{@"type": @"TEXT_DETECTION"},
      @"imageContext": @{@"languageHints": @[@"en"]}
    };
    
  3. Na koniec wywołaj funkcję:

    Szybki

    functions.httpsCallable("annotateImage").call(requestData) { (result, error) in
      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]
        }
        // ...
      }
      // Function completed succesfully
    }
    

    Cel C

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

3. Wyodrębnij tekst z bloków rozpoznanego tekstu

Jeśli operacja się powiedzie rozpoznawania tekstu, odpowiedź JSON BatchAnnotateImagesResponse zostaną zwrócone w wyniku zadania jest. Adnotacje tekstowe mogą być znalezione w fullTextAnnotation obiektu.

Można uzyskać rozpoznany tekst jako ciąg w text polu. Na przykład:

Szybki

guard let annotation = (result?.data as? [String: Any])?["fullTextAnnotation"] as? [String: Any] else { return }
print("%nComplete annotation:")
let text = annotation["text"] as? String ?? ""
print("%n\(text)")

Cel C

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

Możesz także uzyskać informacje specyficzne dla regionów obrazu. Dla każdego block , paragraph , word i symbol , można uzyskać tekst rozpoznany w regionie oraz obwiedni współrzędne regionu. Na przykład:

Szybki

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
}

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