このページは Cloud Translation API によって翻訳されました。

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 の使用例をご覧ください。

始める前に

この API には Android API レベル 19 以降が必要です。アプリのビルドファイルで minSdkVersion 値 19 以上が使用されていることを確認します。

プロジェクトレベルの 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.2'
}

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. 会話履歴オブジェクトを作成する

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

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

Kotlin

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

Java

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

ユーザーがメッセージを受信するたびに、メッセージ、タイムスタンプ、送信者のユーザー 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));

会話履歴オブジェクトは、次の例のようになります。

タイムスタンプ	ユーザー ID	isLocalUser	メッセージ
2019 年 2 月 21 日（木）13:13:39（PST）		true	もうすぐ着く？
2019 年 2 月 21 日（木）13:15:03	フレンド 0	false	遅れます。ごめんなさい！

ML Kit は、会話履歴内の最後のメッセージに対する返信を提案します。最後のメッセージは、ローカルユーザー以外からのものである必要があります。上記の例では、会話の最後のメッセージはローカル以外のユーザー FRIEND0 からのものです。このパスを ML Kit を使用すると、FRIENDO さんのメッセージ「Running late, just!

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 が結果を返さないことがあります。

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

試してみる

始める前に

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

Kotlin

Java

Kotlin

Java

2. メッセージに返信する

Kotlin

Java

Kotlin

Java

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