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

ML Kit peut générer des réponses courtes aux messages en utilisant 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 dans une conversationnelle. Si ML Kit détermine que la conversation est en anglais, la conversation n'a pas d'objet potentiellement sensible, ML Kit génère jusqu'à trois réponses, que vous pouvez suggérer à l'utilisateur.

<ph type="x-smartling-placeholder">

</ph> Cette API est disponible avec une bibliothèque dégroupée à télécharger avant utilisation ou un intégrée qui augmente la taille de votre application. Voir ce guide pour en savoir plus sur les différences entre les deux options d'installation.

	Groupée	Sans catégorie
Nom de la bibliothèque	com.google.mlkit:smart-reply	com.google.android.gms:play-services-mlkit-smart-reply
Mise en œuvre	Le modèle est associé de manière statique à votre application au moment de la compilation.	Le modèle est téléchargé de manière dynamique via les services Google Play.
Impact sur la taille de l'application	Augmentation de la taille d'environ 5,7 Mo.	Augmentation de la taille d'environ 200 Ko.
Délai d'initialisation	Le modèle est disponible immédiatement.	Vous devrez peut-être attendre que le modèle soit téléchargé avant de l'utiliser pour la première fois.

Remarque :La version sans groupe de la fonctionnalité Réponse suggérée est actuellement disponible en bêta, signifie qu'elle peut faire l'objet de modifications susceptibles d'affecter la compatibilité ascendante et n'est pas soumise aux tout Contrat de niveau de service ou politique d'abandon.

Essayer

• Testez l'application exemple pour : consultez un exemple d'utilisation de cette API.

Avant de commencer

<ph type="x-smartling-placeholder">

</ph> Cette API nécessite le niveau d'API Android 21 ou supérieur. Assurez-vous que le build de votre application utilise une valeur minSdkVersion supérieure ou égale à 21.

1. Dans le fichier build.gradle au niveau du projet, veillez à inclure l'adresse e-mail de Google Dépôt Maven dans les sections buildscript et allprojects.

2. Ajoutez les dépendances des bibliothèques Android ML Kit au fichier fichier Gradle au niveau de l'application, généralement app/build.gradle. Choisissez l'une des options suivantes : les dépendances suivantes en fonction de vos besoins:

   • Pour empaqueter le modèle avec votre application:

   dependencies {
     // ...
     // Use this dependency to bundle the model with your app
     implementation 'com.google.mlkit:smart-reply:17.0.4'
   }
   

   • Pour utiliser le modèle dans les services Google Play:

   dependencies {
     // ...
     // Use this dependency to use the dynamically downloaded model in Google Play Services
     implementation 'com.google.android.gms:play-services-mlkit-smart-reply:16.0.0-beta1'
   }
   

   Si vous choisissez d'utiliser le modèle dans les services Google Play, vous pouvez configurer votre application pour télécharger automatiquement le modèle sur l'appareil une fois l'application installé depuis le Play Store. En ajoutant la déclaration suivante à votre fichier le fichier AndroidManifest.xml de l'application:

   <application ...>
         ...
         <meta-data
             android:name="com.google.mlkit.vision.DEPENDENCIES"
             android:value="smart_reply" >
         <!-- To use multiple models: android:value="smart_reply,model2,model3" -->
   </application>
   

   Vous pouvez aussi vérifier explicitement la disponibilité du modèle et demander un téléchargement via API ModuleInstallClient des services Google Play.

   Si vous n'activez pas le téléchargement du modèle au moment de l'installation ou le modèle est téléchargé la première fois que vous exécutez le générateur de réponses suggérées. Les requêtes que vous effectuez avant la fin du téléchargement ne produisent aucun résultat.

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

   Pour générer des réponses suggérées, vous transmettez à ML Kit un List dans l'ordre chronologique des objets TextMessage, avec le code temporel le plus ancien en premier.

   Chaque fois que l'utilisateur envoie un message, ajoutez le message et son code temporel à la section historique des conversations:

   Kotlin

   conversation.add(TextMessage.createForLocalUser(
           "heading out now", System.currentTimeMillis()))

   Java

   conversation.add(TextMessage.createForLocalUser(
           "heading out now", System.currentTimeMillis()));

   Chaque fois que l'utilisateur reçoit un message, ajoutez le message, son code temporel et l'élément l'ID utilisateur de l'expéditeur dans l'historique de la conversation. L'ID utilisateur peut être n'importe quelle chaîne identifie de manière unique l'expéditeur dans la conversation. L'ID utilisateur n'a pas besoin correspondant à n'importe quelle donnée utilisateur, et l'ID utilisateur n'a pas besoin d'être cohérent entre les conversations ou les appels du générateur de réponses suggérées.

   Kotlin

   conversation.add(TextMessage.createForRemoteUser(
           "Are you coming back soon?", System.currentTimeMillis(), userId))

   Java

   conversation.add(TextMessage.createForRemoteUser(
           "Are you coming back soon?", System.currentTimeMillis(), userId));

   Voici un exemple d'objet d'historique des conversations:

   Horodatage	userID	isLocalUser	Message
   Jeu. 21 févr. 13:13:39 PST 2019		true	Tu es en route ?
   Jeu. 21 févr. 13:15:03 PST 2019	FRIEND0	faux	Nous sommes en retard, désolé !

   ML Kit suggère des réponses au dernier message d'un historique de conversation. Le dernier message doit provenir d'un utilisateur non local. Dans l'exemple ci-dessus, le dernier message de la conversation provient de l'utilisateur non local Friends0. Lorsque vous utilisez ML Kit, ce journal suggère répond au message de Friends : "Je suis en retard, désolé !"

   2. Recevoir des réponses aux messages

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

   Kotlin

   val smartReplyGenerator = SmartReply.getClient()
   smartReply.suggestReplies(conversation)
           .addOnSuccessListener { result ->
               if (result.getStatus() == SmartReplySuggestionResult.STATUS_NOT_SUPPORTED_LANGUAGE) {
                   // The conversation's language isn't supported, so
                   // the result doesn't contain any suggestions.
               } else if (result.getStatus() == SmartReplySuggestionResult.STATUS_SUCCESS) {
                   // Task completed successfully
                   // ...
               }
           }
           .addOnFailureListener {
               // Task failed with an exception
               // ...
           }

   Java

   SmartReplyGenerator smartReply = SmartReply.getClient();
   smartReply.suggestReplies(conversation)
           .addOnSuccessListener(new OnSuccessListener() {
               @Override
               public void onSuccess(SmartReplySuggestionResult result) {
                   if (result.getStatus() == SmartReplySuggestionResult.STATUS_NOT_SUPPORTED_LANGUAGE) {
                       // The conversation's language isn't supported, so
                       // the result doesn't contain any suggestions.
                   } else if (result.getStatus() == SmartReplySuggestionResult.STATUS_SUCCESS) {
                       // Task completed successfully
                       // ...
                   }
               }
           })
           .addOnFailureListener(new OnFailureListener() {
               @Override
               public void onFailure(@NonNull Exception e) {
                   // Task failed with an exception
                   // ...
               }
           });

   Si l'opération aboutit, un objet SmartReplySuggestionResult est transmis à le gestionnaire de réussite. Cet objet contient une liste de trois suggestions de réponses maximum, que vous pouvez présenter à l'utilisateur:

   Kotlin

   for (suggestion in result.suggestions) {
       val replyText = suggestion.text
   }

   Java

   for (SmartReplySuggestion suggestion : result.getSuggestions()) {
       String replyText = suggestion.getText();
   }

   Notez que ML Kit risque de ne pas renvoyer de résultats si le modèle n'est pas sûr de la pertinence des réponses suggérées, la conversation d'entrée n'est pas ou si le modèle détecte des sujets sensibles.