ML Kit では、オンデバイス モデルを使用してメッセージに対する短い返信を生成できます。
スマート リプライを生成するには、会話内の最近のメッセージのログを 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 の使用例を確認します。
始める前に
プロジェクト レベルの
build.gradle
ファイルで、buildscript
セクションとallprojects
セクションの両方に Google の Maven リポジトリを含めます。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.3' }
- 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 開発者サービスでモデルを使用する場合は、アプリが Google 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 メッセージ 2019 年 2 月 21 日(木)13:13:39(PST) true 今向かっていますか? 2019 年 2 月 21 日(木)13:15:03(PST) FRIEND0 false 遅れてごめんなさい! ML Kit は、会話履歴の最後のメッセージに対する返信を提案します。最後のメッセージはローカル以外のユーザーからのものである必要があります。上記の例では、会話の最後のメッセージはローカル以外のユーザー FRIEND0 からのものです。このログ Pass ML Kit を使用すると、FRIENDO のメッセージ「Running late, dollar!」に対する返信が提案されます。
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 が結果を返さないことがあります。