ML Kit 可以使用裝置上的模型來產生訊息的簡短回覆。
如要產生智慧回覆,您必須向 ML Kit 傳送對話中近期訊息的記錄。如果 ML Kit 判斷對話是以英文輸入,且對話不含潛在敏感主題,則 ML Kit 會產生最多三個回覆,您可以向使用者提供建議。
組合 | 未分類 | |
---|---|---|
程式庫名稱 | 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 服務中使用模型,可以設定讓應用程式在從 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 不需要對應至任何使用者資料,而且智慧回覆產生器的對話或叫用使用者 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 (太平洋標準時間) FRIEND0 false 抱歉,我遲到了! ML Kit 建議回覆對話記錄中的最後一則訊息。最後一則訊息應來自非本機使用者。在上述範例中,對話中的最後一個訊息是來自非本機使用者 FRIEND0。使用 Pass ML Kit 這項記錄時,它會建議回覆 FRIENDO 的訊息:「Running late, 抱歉!」
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 可能不會傳回結果。