ML Kit を使用してスマート リプライを生成する（Android）

ML Kit は、デバイスモデルを使用してメッセージに対する短い返信を生成できます。

スマート リプライを生成するには、会話の中の最新のメッセージのログを ML Kit に渡します。ML Kit で、会話が英語であり、会話に機密性の高い話題が含まれていないと判断された場合、ML Kit で最大 3 つのリプライが生成されます。これをユーザーに提案できます。

	バンドル	バンドル解除
ライブラリ名	com.google.mlkit:smart-reply	com.google.android.gms:play-services-mlkit-smart-reply
実装	モデルはビルド時にアプリに静的にリンクされます。	モデルは Google Play 開発者サービス経由で動的にダウンロードされます。
アプリのサイズへの影響	サイズが約 5.7 MB 増加します。	サイズが約 200 KB 増加します。
初期化時間	モデルはすぐに利用できます。	初めて使用する前にモデルのダウンロードを待つ必要がある場合があります。

試してみる

• サンプルアプリを試して、この API の使用例を確認してください。

始める前に

1. プロジェクト レベルの build.gradle ファイルの buildscript セクションと allprojects セクションの両方に Google の Maven リポジトリを組み込みます。

2. ML Kit Android ライブラリの依存関係をモジュールのアプリレベルの Gradle ファイル（通常は app/build.gradle）に追加します。ニーズに応じて、次のいずれかの依存関係を選択します。

   • モデルをアプリにバンドルするには:

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

   • 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'
   }
   

   Google Play 開発者サービスでモデルを使用する場合は、アプリが Play ストアからインストールされたらモデルをデバイスに自動的にダウンロードするようにアプリを構成できます。アプリの AndroidManifest.xml ファイルに次の宣言を追加します。

   <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>
   

   Google Play 開発者サービスの ModuleInstallClient API を使用して、モデルの可用性を明示的に確認し、ダウンロードをリクエストすることもできます。

   インストール時のモデルのダウンロードを有効にしない、または明示的なダウンロードをリクエストしない場合は、スマート返信生成ツールを初めて実行したときにモデルがダウンロードされます。ダウンロードが完了する前にリクエストしても結果は生成されません。

   1. 会話履歴オブジェクトを作成する

   スマート リプライを生成するには、TextMessage オブジェクトの List を時系列の順で ML Kit に渡します。最も早いタイムスタンプが最初です。

   ユーザーがメッセージを送信するたびに、メッセージとそのタイムスタンプを会話履歴に追加します。

   Kotlin

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

   Java

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

   ユーザーがメッセージを受信するたびに、メッセージ、そのタイムスタンプ、送信者のユーザー ID を会話履歴に追加します。ユーザー ID は、会話内で送信者を一意に識別する任意の文字列にすることができます。ユーザー ID は、ユーザーデータに対応する必要はありません。また、ユーザー ID は、会話とスマート リプライ生成ツールの呼び出しとの間で整合性のとれたものである必要はありません。

   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));

   次に、会話履歴オブジェクトの例を示します。

   タイムスタンプ	userID	isLocalUser	メッセージ
   Thu Feb 21 13:13:39 PST 2019		true	まだ着きませんか？
   Thu Feb 21 13:15:03 PST 2019	FRIEND0	false	遅れて申し訳ありません！

   ML Kit は、会話履歴の最後のメッセージへの返信を提案します。最後のメッセージは、ローカル以外のユーザーからのものでなければなりません。上記の例では、会話の最後のメッセージはローカル以外のユーザー FRIEND0 からのものです。このログを ML Kit に渡すと、FRIENDO のメッセージへの返信として「遅れて申し訳ございません」が提案されます。

   2. メッセージのリプライを取得する

   メッセージにスマート リプライを生成するには、SmartReplyGenerator のインスタンスを取得して、会話履歴を 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
                   // ...
               }
           });

   オペレーションが成功すると、SmartReplySuggestionResult オブジェクトが成功ハンドラに渡されます。このオブジェクトには、ユーザーに提示することができるリプライ候補が 3 つまで含まれます。

   Kotlin

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

   Java

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

   提案されたリプライの関連性にモデルが確信を持てない場合、入力された会話が英語ではない場合、またはモデルで機密性の高い話題が検出された場合、ML Kit によって結果が返されない可能性があります。