Traduire du texte avec ML Kit sur iOS

Vous pouvez utiliser ML Kit pour traduire du texte d'une langue à une autre. ML Kit prend actuellement en charge la traduction 59 langues.

Avant de commencer

  1. Si vous n'avez pas encore ajouté Firebase à votre application, suivez les les étapes décrites dans le guide de démarrage.
  2. Incluez les bibliothèques ML Kit dans votre Podfile: 
    pod 'Firebase/MLNLTranslate', '6.25.0'
    Après avoir installé ou mis à jour les pods de votre projet, ouvrez votre Xcode projet à l'aide de son .xcworkspace.
  3. Dans votre application, importez Firebase :

    Swift

    import Firebase

    Objective-C

    @import Firebase;

Traduire une chaîne de texte

Pour traduire une chaîne entre deux langues :

  1. Créer un objet Translator en le configurant avec la source et la cible langues:

    Swift

    // Create an English-German translator:
let options = TranslatorOptions(sourceLanguage: .en, targetLanguage: .de)
let englishGermanTranslator = NaturalLanguage.naturalLanguage().translator(options: options)

    Objective-C

    // Create an English-German translator:
FIRTranslatorOptions *options =
    [[FIRTranslatorOptions alloc] initWithSourceLanguage:FIRTranslateLanguageEN
                                          targetLanguage:FIRTranslateLanguageDE];
FIRTranslator *englishGermanTranslator =
    [[FIRNaturalLanguage naturalLanguage] translatorWithOptions:options];

    Si vous ne connaissez pas la langue du texte d'entrée, vous pouvez utiliser la fonction l'API d'identification. (Mais assurez-vous de ne conservez pas trop de modèles de langage à la fois sur l'appareil.)

  2. Assurez-vous que le modèle de traduction requis a été téléchargé sur l'appareil. N'appelez translate(_:completion:) que lorsque vous savez que le modèle est disponible.

    Swift

    let conditions = ModelDownloadConditions(
    allowsCellularAccess: false,
    allowsBackgroundDownloading: true
)
englishGermanTranslator.downloadModelIfNeeded(with: conditions) { error in
    guard error == nil else { return }

    // Model downloaded successfully. Okay to start translating.
}

    Objective-C

    FIRModelDownloadConditions *conditions =
    [[FIRModelDownloadConditions alloc] initWithAllowsCellularAccess:NO
                                         allowsBackgroundDownloading:YES];
[englishGermanTranslator downloadModelIfNeededWithConditions:conditions
                                                  completion:^(NSError *_Nullable error) {
  if (error != nil) {
    return;
  }
  // Model downloaded successfully. Okay to start translating.
}];

    Les modèles de langage font environ 30 Mo. Ne les téléchargez donc pas inutilement et ne les téléchargez que via le Wi-Fi, sauf si l'utilisateur a spécifié le contraire. Toi supprimer les modèles inutiles. Consultez Gérer explicitement les modèles de traduction.

  3. Après avoir vérifié que le modèle a été téléchargé, transmettez une chaîne de texte la langue source vers translate(_:completion:):

    Swift

    englishGermanTranslator.translate(text) { translatedText, error in
    guard error == nil, let translatedText = translatedText else { return }

    // Translation succeeded.
}

    Objective-C

    [englishGermanTranslator translateText:text
                            completion:^(NSString *_Nullable translatedText,
                                         NSError *_Nullable error) {
  if (error != nil || translatedText == nil) {
    return;
  }

  // Translation succeeded.
}];

    ML Kit traduit le texte dans la langue cible que vous avez configurée et transmet le texte traduit au gestionnaire de fin.

Gérer explicitement les modèles de traduction

Lorsque vous utilisez l'API Translation comme décrit ci-dessus, ML Kit s'exécute automatiquement télécharge des modèles de traduction spécifiques à la langue sur l'appareil si nécessaire. Toi vous pouvez également gérer explicitement les modèles de traduction que vous souhaitez à l'aide de l'API de gestion des modèles de traduction de ML Kit. Il peut s'agir utile si vous souhaitez télécharger des modèles à l'avance ou supprimer des modèles inutiles de l'appareil.

Pour récupérer les modèles de traduction stockés sur l'appareil:

Swift

let localModels = ModelManager.modelManager().downloadedTranslateModels

Objective-C

NSSet<FIRTranslateRemoteModel *> *localModels =
    [FIRModelManager modelManager].downloadedTranslateModels;

Pour supprimer un modèle, procédez comme suit :

Swift

// Delete the German model if it's on the device.
let deModel = TranslateRemoteModel.translateRemoteModel(language: .de)
ModelManager.modelManager().deleteDownloadedModel(deModel) { error in
    guard error == nil else { return }
    // Model deleted.
}

Objective-C

// Delete the German model if it's on the device.
FIRTranslateRemoteModel *deModel =
    [FIRTranslateRemoteModel translateRemoteModelWithLanguage:FIRTranslateLanguageDE];
[[FIRModelManager modelManager] deleteDownloadedModel:deModel
                                           completion:^(NSError * _Nullable error) {
                                               if (error != nil) {
                                                   return;
                                               }
                                               // Model deleted.
                                           }];

Pour télécharger un modèle :

Swift

// Download the French model.
let frModel = TranslateRemoteModel.translateRemoteModel(language: .fr)

// Keep a reference to the download progress so you can check that the model
// is available before you use it.
progress = ModelManager.modelManager().download(
    frModel,
    conditions: ModelDownloadConditions(
        allowsCellularAccess: false,
        allowsBackgroundDownloading: true
    )
)

Pour connaître l'état du téléchargement auprès de NotificationCenter, inscrivez-vous observateurs pour firebaseMLModelDownloadDidSucceed et firebaseMLModelDownloadDidFail Veillez à utiliser une référence faible à self dans le bloc "Observer", car les téléchargements peuvent prendre un certain temps et que le fichier d'origine peut être libéré une fois le téléchargement terminé. Exemple :

NotificationCenter.default.addObserver(
    forName: .firebaseMLModelDownloadDidSucceed,
    object: nil,
    queue: nil
) { [weak self] notification in
    guard let strongSelf = self,
        let userInfo = notification.userInfo,
        let model = userInfo[ModelDownloadUserInfoKey.remoteModel.rawValue]
            as? TranslateRemoteModel,
        model == frModel
        else { return }
    // The model was downloaded and is available on the device
}

NotificationCenter.default.addObserver(
    forName: .firebaseMLModelDownloadDidFail,
    object: nil,
    queue: nil
) { [weak self] notification in
    guard let strongSelf = self,
        let userInfo = notification.userInfo,
        let model = userInfo[ModelDownloadUserInfoKey.remoteModel.rawValue]
            as? TranslateRemoteModel
        else { return }
    let error = userInfo[ModelDownloadUserInfoKey.error.rawValue]
    // ...
}

Objective-C

// Download the French model.
FIRModelDownloadConditions *conditions =
    [[FIRModelDownloadConditions alloc] initWithAllowsCellularAccess:NO
                                         allowsBackgroundDownloading:YES];
FIRTranslateRemoteModel *frModel =
    [FIRTranslateRemoteModel translateRemoteModelWithLanguage:FIRTranslateLanguageFR];

// Keep a reference to the download progress so you can check that the model
// is available before you use it.
self.downloadProgress = [[FIRModelManager modelManager] downloadModel:frModel
                                                           conditions:conditions];

Si vous souhaitez obtenir l'état du téléchargement avec NSNotificationCenter, enregistrez des observateurs pour FIRModelDownloadDidSucceedNotification et FIRModelDownloadDidFailNotification. Veillez à utiliser une référence faible pour self dans le bloc d'observation, étant donné que les téléchargements peuvent prendre un certain temps, et que l'objet d'origine peut être libéré une fois le téléchargement terminé.

__block MyViewController *weakSelf = self;

[NSNotificationCenter.defaultCenter
 addObserverForName:FIRModelDownloadDidSucceedNotification
 object:nil
 queue:nil
 usingBlock:^(NSNotification * _Nonnull note) {
     if (weakSelf == nil | note.userInfo == nil) {
         return;
     }

     FIRTranslateRemoteModel *model = note.userInfo[FIRModelDownloadUserInfoKeyRemoteModel];
     if ([model isKindOfClass:[FIRTranslateRemoteModel class]]
         && model == frModel) {
         // The model was downloaded and is available on the device
     }
 }];

[NSNotificationCenter.defaultCenter
 addObserverForName:FIRModelDownloadDidFailNotification
 object:nil
 queue:nil
 usingBlock:^(NSNotification * _Nonnull note) {
     if (weakSelf == nil | note.userInfo == nil) {
         return;
     }

     NSError *error = note.userInfo[FIRModelDownloadUserInfoKeyError];
 }];