Безопасно маркируйте изображения с помощью 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, поэтому подумайте, достаточен ли этот механизм аутентификации для вашего варианта использования, прежде чем продолжить.

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

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

Если вы еще не добавили Firebase в свое приложение, сделайте это, следуя инструкциям в руководстве по началу работы .

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

  1. В Xcode откройте проект приложения и перейдите в меню Файл > Добавить пакеты .
  2. При появлении соответствующего запроса добавьте репозиторий Firebase Apple platform SDK:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. Выберите библиотеку Firebase ML .
  5. Добавьте флаг -ObjC в раздел «Другие флаги компоновщика» настроек сборки вашей цели.
  6. По завершении 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. Подготовьте входное изображение.

Для вызова Cloud Vision изображение должно быть отформатировано как строка в кодировке base64. Для обработки UIImage :

Быстрый

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. Вызовите вызываемую функцию для маркировки изображения.

Чтобы пометить объекты на изображении, вызовите вызываемую функцию, передав запрос JSON Cloud Vision .

  1. Сначала инициализируйте экземпляр Cloud Functions:

    Быстрый

    lazy var functions = Functions.functions()
    

    Objective-C

    @property(strong, nonatomic) FIRFunctions *functions;
    
  2. Создайте запрос с типом LABEL_DETECTION :

    Быстрый

    let requestData = [
      "image": ["content": base64encodedImage],
      "features": ["maxResults": 5, "type": "LABEL_DETECTION"]
    ]
    

    Objective-C

    NSDictionary *requestData = @{
      @"image": @{@"content": base64encodedImage},
      @"features": @{@"maxResults": @5, @"type": @"LABEL_DETECTION"}
    };
    
  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 . Каждый объект в массиве labelAnnotations представляет собой что-то, что было помечено на изображении. Для каждой метки можно получить текстовое описание метки, ее идентификатор сущности Knowledge Graph (если доступен) и оценку достоверности совпадения. Например:

Быстрый

if let labelArray = (result?.data as? [String: Any])?["labelAnnotations"] as? [[String:Any]] {
  for labelObj in labelArray {
    let text = labelObj["description"]
    let entityId = labelObj["mid"]
    let confidence = labelObj["score"]
  }
}

Objective-C

NSArray *labelArray = result.data[@"labelAnnotations"];
for (NSDictionary *labelObj in labelArray) {
  NSString *text = labelObj[@"description"];
  NSString *entityId = labelObj[@"mid"];
  NSNumber *confidence = labelObj[@"score"];
}