Générer des réponses suggérées avec ML Kit sur iOS

Vous pouvez utiliser ML Kit pour générer des réponses aux messages à l'aide d'un modèle sur l'appareil.

Pour générer des réponses suggérées, vous transmettez à ML Kit un journal des messages récents d'une conversation. Si ML Kit détermine que la conversation est en anglais et qu'elle ne porte pas sur un sujet potentiellement sensible, il génère jusqu'à trois réponses que vous pouvez suggérer à votre utilisateur.

Avant de commencer

1. Si vous n'avez pas encore ajouté Firebase à votre application, suivez la procédure décrite dans le guide de démarrage.
2. Incluez les bibliothèques ML Kit dans votre Podfile :

   pod 'Firebase/MLCommon', '6.25.0'
   pod 'Firebase/MLNLSmartReply', '6.25.0'
   

   Après avoir installé ou mis à jour les pods de votre projet, veillez à ouvrir votre projet Xcode à l'aide de son .xcworkspace.
3. Dans votre application, importez Firebase:

   Swift

   import Firebase

   Objective-C

   @import Firebase;

1. Créer un objet d'historique des conversations

Pour générer des réponses intelligentes, vous transmettez à ML Kit un tableau d'objets TextMessage ordonné chronologiquement, en commençant par le code temporel le plus ancien. Chaque fois que l'utilisateur envoie ou reçoit un message, ajoutez le message, son code temporel et l'ID utilisateur de l'expéditeur du message à l'historique de la conversation.

L'ID utilisateur peut être n'importe quelle chaîne qui identifie de manière unique l'expéditeur dans la conversation. L'ID utilisateur n'a pas besoin de correspondre à des données utilisateur, et il n'a pas besoin d'être cohérent entre les conversations ou les invocations du générateur de réponses intelligentes.

Si le message a été envoyé par l'utilisateur auquel vous souhaitez suggérer des réponses, définissez isLocalUser sur "true".

var conversation: [TextMessage] = []

// Then, for each message sent and received:
let message = TextMessage(
    text: "How are you?",
    timestamp: Date().timeIntervalSince1970,
    userID: "userId",
    isLocalUser: false)
conversation.append(message)

NSMutableArray *conversation = [NSMutableArray array];

// Then, for each message sent and received:
FIRTextMessage *message = [[FIRTextMessage alloc]
        initWithText:@"How are you?"
        timestamp:[NSDate date].timeIntervalSince1970
        userID:userId
        isLocalUser:NO];
[conversation addObject:message];

Un objet "historique des conversations" se présente comme suit:

Notez que le message le plus récent de l'exemple ci-dessus provient d'un utilisateur non local. Cette information est importante, car ML Kit suggère des réponses destinées à être envoyées par l'utilisateur de votre application: l'utilisateur local. Assurez-vous de transmettre à ML Kit un journal de conversation qui se termine par un message auquel votre utilisateur peut souhaiter répondre.

2. Obtenir des réponses aux messages

Pour générer des réponses suggérées à un message, obtenez une instance de SmartReply et transmettez l'historique de la conversation à sa méthode suggestReplies(for:completion:):

let naturalLanguage = NaturalLanguage.naturalLanguage()
naturalLanguage.smartReply().suggestReplies(for: conversation) { result, error in
    guard error == nil, let result = result else {
        return
    }
    if (result.status == .notSupportedLanguage) {
        // The conversation's language isn't supported, so the
        // the result doesn't contain any suggestions.
    } else if (result.status == .success) {
        // Successfully suggested smart replies.
        // ...
    }
}

FIRNaturalLanguage *naturalLanguage = [FIRNaturalLanguage naturalLanguage];
FIRSmartReply *smartReply = [naturalLanguage smartReply];
[smartReply suggestRepliesForMessages:inputText
                           completion:^(FIRSmartReplySuggestionResult * _Nullable result,
                                        NSError * _Nullable error) {
  if (error || !result) {
    return;
  }
  if (result.status == FIRSmartReplyResultStatusNotSupportedLanguage) {
      // The conversation's language isn't supported, so the
      // the result doesn't contain any suggestions.
  } else if (result.status == FIRSmartReplyResultStatusSuccess) {
      // Successfully suggested smart replies.
      // ...
  }
}];
]

Si l'opération aboutit, un objet SmartReplySuggestionResult est transmis au gestionnaire de finalisation. Cet objet contient une liste de trois réponses suggérées que vous pouvez présenter à votre utilisateur:

for suggestion in result.suggestions {
  print("Suggested reply: \(suggestion.text)")
}

for (FIRSmartReplySuggestion *suggestion in result.suggestions) {
  NSLog(@"Suggested reply: %@", suggestion.text);
}

Notez que ML Kit peut ne pas renvoyer de résultats si le modèle n'est pas sûr de la pertinence des réponses suggérées, si la conversation d'entrée n'est pas en anglais ou si le modèle détecte un sujet sensible.