使用 Apple 平台上的 Firebase 驗證和函式，透過 Cloud Vision 安全地辨識圖片中的文字

如要從應用程式呼叫 Google Cloud API，您必須建立中介 REST API，以便處理授權並保護 API 金鑰等機密值。接著，您需要在行動應用程式中編寫程式碼，以便驗證並與這項中介服務通訊。

您可以使用 Firebase 驗證和功能，透過受管理的無伺服器閘道建立這個 REST API，以便存取 Google Cloud API，處理驗證作業，並透過預先建構的 SDK 從行動應用程式呼叫。

本指南將說明如何使用這項技術，從應用程式呼叫 Cloud Vision API。這項方法可讓所有已驗證的使用者透過您的 Cloud 專案存取 Cloud Vision 收費服務，因此請先考量這項驗證機制是否足以滿足您的用途，再繼續操作。

事前準備

設定專案

如果您尚未在應用程式中加入 Firebase，請按照入門指南中的步驟操作。

使用 Swift Package Manager 安裝及管理 Firebase 依附元件。

  1. 在 Xcode 中保持開啟應用程式專案，然後依序點選「File」>「Add Packages」。
  2. 系統提示時，請新增 Firebase Apple 平台 SDK 存放區：
    3.   https://github.com/firebase/firebase-ios-sdk.git
  3. 選擇 Firebase ML 程式庫。
  4. 將 -ObjC 標記新增至目標的建構設定「Other Linker Flags」部分。
  5. 完成後，Xcode 就會自動開始在背景中解析並下載依附元件。

接下來，請執行一些應用程式內設定：

  1. 在應用程式中匯入 Firebase：
    SwiftObjective-C
    import FirebaseMLModelDownloader
     
    @import FirebaseMLModelDownloader;

再完成幾個設定步驟，就可以開始使用了：

  1. 如果您尚未為專案啟用雲端 API，請立即啟用：

    1. 開啟 Firebase 控制台的 Firebase ML API 頁面。

    2. 如果您尚未將專案升級至 Blaze 定價方案，請按一下「Upgrade」進行升級 (只有在專案未採用 Blaze 方案時，系統才會提示您升級)。

      只有 Blaze 級別專案可以使用雲端 API。

    3. 如果尚未啟用雲端 API，請按一下「啟用雲端 API」。
  2. 設定現有的 Firebase API 金鑰，禁止存取 Cloud Vision API：
    1. 開啟 Cloud 控制台的「憑證」頁面。
    2. 針對清單中的每個 API 金鑰，請開啟編輯檢視畫面，然後在「金鑰限制」專區中，將所有可用的 API 除了 Cloud Vision API 以外的 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. 在 vision-annotate-image 目錄中初始化 Firebase 專案。系統顯示提示時，請在清單中選取所需專案。
    firebase init
  5. 部署函式：
    firebase deploy --only functions:annotateImage

將 Firebase Auth 新增至應用程式

上方部署的可呼叫函式會拒絕應用程式中未經驗證的使用者提出的任何要求。如果您尚未這麼做，請在應用程式中新增 Firebase Auth。

為應用程式新增必要的依附元件

使用 Swift Package Manager 安裝 Cloud Functions for Firebase 程式庫。

您現在可以開始辨識圖片中的文字。

1. 準備輸入圖片

如要呼叫 Cloud Vision，圖片必須以 base64 編碼字串格式輸入。如何處理 UIImage：
SwiftObjective-C
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. 叫用可呼叫函式以辨識文字

如要辨識圖片中的地標，請呼叫可呼叫函式，並傳遞 JSON Cloud Vision 要求。

  1. 首先，請初始化 Cloud Functions 的例項：

    SwiftObjective-C
    lazy var functions = Functions.functions()

    @property(strong, nonatomic) FIRFunctions *functions;

  2. 建立要求。Cloud Vision API 支援兩種文字偵測類型：TEXT_DETECTION 和 DOCUMENT_TEXT_DETECTION。如要瞭解這兩種用途的差異，請參閱 Cloud Vision OCR 說明文件。

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

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

  3. 最後，請叫用函式：

    SwiftObjective-C
    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]
    }
    // ...
  }
}

    [[_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. 從已辨識的文字區塊中擷取文字

如果文字辨識作業成功，任務結果會傳回 BatchAnnotateImagesResponse 的 JSON 回應。文字註解位於 fullTextAnnotation 物件中。

您可以在 text 欄位中取得辨識結果文字的字串。例如：

SwiftObjective-C
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，您可以取得在該區域中辨識到的文字，以及該區域的邊界座標。例如：

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