在 Android 上使用 ML Kit 產生智慧回覆

ML Kit 可以使用裝置上的模型來產生訊息的簡短回覆。

如要產生智慧回覆,請將 ML Kit 近期訊息記錄傳送至 對話。如果 ML Kit 判斷對話是以英文表示對話, 就沒有敏感主題的 ML Kit 最多產生 3 則回覆,您可當做建議使用者參考。

組合未分類
程式庫名稱com.google.mlkit:smart-replycom.google.android.gms:play-services-mlkit-smart-reply
導入模型會在建構期間以靜態方式連結至應用程式。模型會透過 Google Play 服務動態下載。
應用程式大小影響大小增加約 5.7 MB。大小增加約 200 KB。
初始化時間模型可立即使用。可能要等到模型下載完畢再開始使用。

立即試用

事前準備

  1. 在專案層級的 build.gradle 檔案中,請務必加入 Google 的 buildscriptallprojects 區段內的 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 服務中使用模型,可以 讓應用程式自動下載至裝置, 安裝將以下宣告加到 應用程式的 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 按照時間排序的ListTextMessage 物件,並採用最早的時間戳記。

    每當使用者傳送訊息時,請將訊息和時間戳記新增至 對話記錄:

    Kotlin

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

    Java

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

    每當使用者收到訊息時,請新增訊息、訊息時間戳記和 並將傳送者的使用者 ID 加入對話記錄中。使用者 ID 可以是任何 可明確識別會話群組中的寄件者。User-ID 不需要 對應至任何使用者資料,而且 User-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 (太平洋標準時間) true 你正在路上嗎?
    2019 年 2 月 21 日星期四 13:15:03 (太平洋標準時間) 朋友 false 抱歉,我遲到了!

    ML Kit 建議回覆對話記錄中的最後一則訊息。最後一則訊息 應為非本機使用者。在上述範例中,對話中的最後一則訊息 來自非當地使用者 FRIEND0。使用 Pass 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 物件傳遞至 成功處理常式這個物件包含最多三個建議的回覆清單 可用來向使用者顯示:

    Kotlin

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

    Java

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

    請注意,如果模型對模型缺乏信心,ML Kit 可能不會傳回結果 建議回覆的關聯性,但輸入對話不在 指定語言,或模型偵測到敏感主題。