יצירת תשובות מהירות באמצעות ML Kit ב-Android

‫ML Kit יכול ליצור תשובות קצרות להודעות באמצעות מודל במכשיר.

כדי ליצור תשובות מהירות, מעבירים ל-ML Kit יומן של ההודעות האחרונות בשיחה. אם ערכת ML Kit קובעת שהשיחה היא באנגלית, ושהשיחה לא כוללת נושא שעלול להיות רגיש, ערכת ML Kit יוצרת עד שלוש תשובות שאפשר להציע למשתמש.

בחבילהלא מקובצים
שם הספרייהcom.google.mlkit:smart-replycom.google.android.gms:play-services-mlkit-smart-reply
הטמעההמודל מקושר באופן סטטי לאפליקציה בזמן ה-build.המודל יורד באופן דינמי דרך Google Play Services.
ההשפעה של גודל האפליקציההגודל גדל בכ-5.7MB.הגודל גדל בכ-200KB.
זמן האתחולהמודל זמין באופן מיידי.יכול להיות שתצטרכו לחכות עד שהמודל יסיים לרדת לפני השימוש הראשון.

רוצה לנסות?

לפני שמתחילים

  1. בקובץ build.gradle ברמת הפרויקט, צריך לכלול את מאגר ה-Maven של Google בקטעים buildscript ו-allprojects.

  2. מוסיפים את התלויות של ספריות Android של ML Kit לקובץ 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 Services:
    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 Services, אתם יכולים להגדיר את האפליקציה כך שהמודל יורד אוטומטית למכשיר אחרי שהאפליקציה מותקנת מחנות 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>

    אתם יכולים גם לבדוק באופן מפורש את זמינות המודל ולבקש להוריד אותו דרך ModuleInstallClient API של Google Play Services.

    אם לא תפעילו את הורדת המודל בזמן ההתקנה או תבקשו הורדה מפורשת, המודל יורד בפעם הראשונה שתפעילו את מחולל התשובות המהירות. בקשות שתשלחו לפני שההורדה תסתיים לא יניבו תוצאות.

    1. יצירת אובייקט של היסטוריית שיחות

    כדי ליצור תשובות מהירות, מעבירים ל-ML Kit רשימה (List) של אובייקטים מסוג TextMessage בסדר כרונולוגי, כשהחותמת הזמן המוקדמת ביותר מופיעה ראשונה.

    בכל פעם שהמשתמש שולח הודעה, מוסיפים את ההודעה ואת חותמת הזמן שלה להיסטוריית השיחות:

    Kotlin

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

    Java

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

    בכל פעם שהמשתמש מקבל הודעה, מוסיפים את ההודעה, את חותמת הזמן שלה ואת מזהה המשתמש של השולח להיסטוריית השיחות. מזהה המשתמש יכול להיות כל מחרוזת שמזהה באופן ייחודי את השולח בשיחה. מזהה המשתמש לא צריך להתאים לנתוני משתמש כלשהם, והוא לא צריך להיות עקבי בין שיחות או הפעלות של מחולל התשובות המהירות.

    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 are you on your way?
    Thu Feb 21 13:15:03 PST 2019 FRIEND0 false אאחר, סליחה!

    ‫ML Kit מציע תשובות להודעה האחרונה בהיסטוריית השיחה. ההודעה האחרונה צריכה להיות ממשתמש לא מקומי. בדוגמה שלמעלה, ההודעה האחרונה בשיחה היא מהמשתמש הלא מקומי FRIEND0. כשמעבירים את היומן הזה ל-ML Kit, הוא מציע תשובות להודעה של FRIENDO: "אני מאחר, סליחה!"

    2. קבלת תשובות להודעות

    כדי ליצור תשובות מהירות להודעה, מקבלים מופע של SmartReplyGenerator ומעבירים את היסטוריית השיחות ל-method‏ 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 מועבר ל-success handler. האובייקט הזה מכיל רשימה של עד שלוש הצעות לתשובות, שאפשר להציג למשתמש:

    Kotlin

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

    Java

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

    שימו לב: יכול להיות ש-ML Kit לא יחזיר תוצאות אם המודל לא בטוח ברלוונטיות של ההצעות לתשובות, אם השיחה שהוזנה היא לא באנגלית או אם המודל מזהה נושא רגיש.