Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit ae85aae6 authored by Tony Mak's avatar Tony Mak
Browse files

Cleanup TextClassifier APIs 

Major changes:
1. ConversationAction is now in top-level.
2. Removed TypeConfig, and repurposed TextClassifier.EntityConfig for
   general use. It would be better to rename it to be something like
   TypeConfig. But just a bad name is probably not worth to deprecate
   the existing APIs.
3. Hints constants are moved to Request object.
4. Action constants are moved to ConversationAction object.

Test: atest TextClassifierTest.java

BUG: 120841922

Change-Id: Ia466aaf4c5050a9c7e404dcd3b295f5ef7e4ce6f
parent 4a710a85

api/current.txt

+38 −44
Original line number Diff line number Diff line
@@ -52930,15 +52930,15 @@ package android.view.inspector { 














package android.view.textclassifier {



























  public final class ConversationActions implements android.os.Parcelable {













    ctor public ConversationActions(java.util.List<android.view.textclassifier.ConversationActions.ConversationAction>, java.lang.String);













  public final class ConversationAction implements android.os.Parcelable {















    method public int describeContents();













    method public java.util.List<android.view.textclassifier.ConversationActions.ConversationAction> getConversationActions();













    method public java.lang.String getId();













    method public android.app.RemoteAction getAction();













    method public float getConfidenceScore();













    method public android.os.Bundle getExtras();













    method public java.lang.CharSequence getTextReply();













    method public java.lang.String getType();















    method public void writeToParcel(android.os.Parcel, int);













    field public static final android.os.Parcelable.Creator<android.view.textclassifier.ConversationActions> CREATOR;













    field public static final java.lang.String HINT_FOR_IN_APP = "in_app";













    field public static final java.lang.String HINT_FOR_NOTIFICATION = "notification";













    field public static final android.os.Parcelable.Creator<android.view.textclassifier.ConversationAction> CREATOR;















    field public static final java.lang.String TYPE_CALL_PHONE = "call_phone";















    field public static final java.lang.String TYPE_CREATE_REMINDER = "create_reminder";















    field public static final java.lang.String TYPE_OPEN_URL = "open_url";









@@ -52951,24 +52951,22 @@ package android.view.textclassifier {













    field public static final java.lang.String TYPE_VIEW_MAP = "view_map";















  }



























  public static final class ConversationActions.ConversationAction implements android.os.Parcelable {













    method public int describeContents();













    method public android.app.RemoteAction getAction();













    method public float getConfidenceScore();













    method public android.os.Bundle getExtras();













    method public java.lang.CharSequence getTextReply();













    method public java.lang.String getType();













    method public void writeToParcel(android.os.Parcel, int);













    field public static final android.os.Parcelable.Creator<android.view.textclassifier.ConversationActions.ConversationAction> CREATOR;













  public static final class ConversationAction.Builder {













    ctor public ConversationAction.Builder(java.lang.String);













    method public android.view.textclassifier.ConversationAction build();













    method public android.view.textclassifier.ConversationAction.Builder setAction(android.app.RemoteAction);













    method public android.view.textclassifier.ConversationAction.Builder setConfidenceScore(float);













    method public android.view.textclassifier.ConversationAction.Builder setExtras(android.os.Bundle);













    method public android.view.textclassifier.ConversationAction.Builder setTextReply(java.lang.CharSequence);















  }



























  public static final class ConversationActions.ConversationAction.Builder {













    ctor public ConversationActions.ConversationAction.Builder(java.lang.String);













    method public android.view.textclassifier.ConversationActions.ConversationAction build();













    method public android.view.textclassifier.ConversationActions.ConversationAction.Builder setAction(android.app.RemoteAction);













    method public android.view.textclassifier.ConversationActions.ConversationAction.Builder setConfidenceScore(float);













    method public android.view.textclassifier.ConversationActions.ConversationAction.Builder setExtras(android.os.Bundle);













    method public android.view.textclassifier.ConversationActions.ConversationAction.Builder setTextReply(java.lang.CharSequence);













  public final class ConversationActions implements android.os.Parcelable {













    ctor public ConversationActions(java.util.List<android.view.textclassifier.ConversationAction>, java.lang.String);













    method public int describeContents();













    method public java.util.List<android.view.textclassifier.ConversationAction> getConversationActions();













    method public java.lang.String getId();













    method public void writeToParcel(android.os.Parcel, int);













    field public static final android.os.Parcelable.Creator<android.view.textclassifier.ConversationActions> CREATOR;















  }





























  public static final class ConversationActions.Message implements android.os.Parcelable {










@@ -52998,9 +52996,11 @@ package android.view.textclassifier {













    method public java.lang.String getConversationId();















    method public java.util.List<java.lang.String> getHints();















    method public int getMaxSuggestions();













    method public android.view.textclassifier.ConversationActions.TypeConfig getTypeConfig();













    method public android.view.textclassifier.TextClassifier.EntityConfig getTypeConfig();















    method public void writeToParcel(android.os.Parcel, int);















    field public static final android.os.Parcelable.Creator<android.view.textclassifier.ConversationActions.Request> CREATOR;













    field public static final java.lang.String HINT_FOR_IN_APP = "in_app";













    field public static final java.lang.String HINT_FOR_NOTIFICATION = "notification";















  }





























  public static final class ConversationActions.Request.Builder {









@@ -53009,23 +53009,7 @@ package android.view.textclassifier {













    method public android.view.textclassifier.ConversationActions.Request.Builder setConversationId(java.lang.String);















    method public android.view.textclassifier.ConversationActions.Request.Builder setHints(java.util.List<java.lang.String>);















    method public android.view.textclassifier.ConversationActions.Request.Builder setMaxSuggestions(int);













    method public android.view.textclassifier.ConversationActions.Request.Builder setTypeConfig(android.view.textclassifier.ConversationActions.TypeConfig);













  }

























  public static final class ConversationActions.TypeConfig implements android.os.Parcelable {













    method public int describeContents();













    method public java.util.Collection<java.lang.String> resolveTypes(java.util.Collection<java.lang.String>);













    method public boolean shouldIncludeTypesFromTextClassifier();













    method public void writeToParcel(android.os.Parcel, int);













    field public static final android.os.Parcelable.Creator<android.view.textclassifier.ConversationActions.TypeConfig> CREATOR;













  }

























  public static final class ConversationActions.TypeConfig.Builder {













    ctor public ConversationActions.TypeConfig.Builder();













    method public android.view.textclassifier.ConversationActions.TypeConfig build();













    method public android.view.textclassifier.ConversationActions.TypeConfig.Builder includeTypesFromTextClassifier(boolean);













    method public android.view.textclassifier.ConversationActions.TypeConfig.Builder setExcludedTypes(java.util.Collection<java.lang.String>);













    method public android.view.textclassifier.ConversationActions.TypeConfig.Builder setIncludedTypes(java.util.Collection<java.lang.String>);













    method public android.view.textclassifier.ConversationActions.Request.Builder setTypeConfig(android.view.textclassifier.TextClassifier.EntityConfig);















  }





























  public final class SelectionEvent implements android.os.Parcelable {










@@ -53199,16 +53183,26 @@ package android.view.textclassifier {













  }





























  public static final class TextClassifier.EntityConfig implements android.os.Parcelable {













    method public static android.view.textclassifier.TextClassifier.EntityConfig create(java.util.Collection<java.lang.String>, java.util.Collection<java.lang.String>, java.util.Collection<java.lang.String>);













    method public static android.view.textclassifier.TextClassifier.EntityConfig createWithExplicitEntityList(java.util.Collection<java.lang.String>);













    method public static android.view.textclassifier.TextClassifier.EntityConfig createWithHints(java.util.Collection<java.lang.String>);













    method public static deprecated android.view.textclassifier.TextClassifier.EntityConfig create(java.util.Collection<java.lang.String>, java.util.Collection<java.lang.String>, java.util.Collection<java.lang.String>);













    method public static deprecated android.view.textclassifier.TextClassifier.EntityConfig createWithExplicitEntityList(java.util.Collection<java.lang.String>);













    method public static deprecated android.view.textclassifier.TextClassifier.EntityConfig createWithHints(java.util.Collection<java.lang.String>);















    method public int describeContents();















    method public java.util.Collection<java.lang.String> getHints();















    method public java.util.Collection<java.lang.String> resolveEntityListModifications(java.util.Collection<java.lang.String>);













    method public boolean shouldIncludeTypesFromTextClassifier();















    method public void writeToParcel(android.os.Parcel, int);















    field public static final android.os.Parcelable.Creator<android.view.textclassifier.TextClassifier.EntityConfig> CREATOR;















  }



























  public static final class TextClassifier.EntityConfig.Builder {













    ctor public TextClassifier.EntityConfig.Builder();













    method public android.view.textclassifier.TextClassifier.EntityConfig build();













    method public android.view.textclassifier.TextClassifier.EntityConfig.Builder includeTypesFromTextClassifier(boolean);













    method public android.view.textclassifier.TextClassifier.EntityConfig.Builder setExcludedTypes(java.util.Collection<java.lang.String>);













    method public android.view.textclassifier.TextClassifier.EntityConfig.Builder setHints(java.util.Collection<java.lang.String>);













    method public android.view.textclassifier.TextClassifier.EntityConfig.Builder setIncludedTypes(java.util.Collection<java.lang.String>);













  }



























  public final class TextClassifierEvent implements android.os.Parcelable {















    method public int describeContents();















    method public int[] getActionIndices();

























core/java/android/view/textclassifier/ConversationAction.java
0 → 100644



+266
−0




























Original line number
Diff line number
Diff line













/*













 * Copyright (C) 2018 The Android Open Source Project













 *













 * Licensed under the Apache License, Version 2.0 (the "License");













 * you may not use this file except in compliance with the License.













 * You may obtain a copy of the License at













 *













 *      http://www.apache.org/licenses/LICENSE-2.0













 *













 * Unless required by applicable law or agreed to in writing, software













 * distributed under the License is distributed on an "AS IS" BASIS,













 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.













 * See the License for the specific language governing permissions and













 * limitations under the License.













 */













package android.view.textclassifier;



























import static java.lang.annotation.RetentionPolicy.SOURCE;



























import android.annotation.FloatRange;













import android.annotation.NonNull;













import android.annotation.Nullable;













import android.annotation.StringDef;













import android.app.RemoteAction;













import android.os.Bundle;













import android.os.Parcel;













import android.os.Parcelable;



























import com.android.internal.util.Preconditions;



























import java.lang.annotation.Retention;



























/** Represents the action suggested by a {@link TextClassifier} on a given conversation. */













public final class ConversationAction implements Parcelable {



























    /** @hide */













    @Retention(SOURCE)













    @StringDef(













            value = {













                    TYPE_VIEW_CALENDAR,













                    TYPE_VIEW_MAP,













                    TYPE_TRACK_FLIGHT,













                    TYPE_OPEN_URL,













                    TYPE_SEND_SMS,













                    TYPE_CALL_PHONE,













                    TYPE_SEND_EMAIL,













                    TYPE_TEXT_REPLY,













                    TYPE_CREATE_REMINDER,













                    TYPE_SHARE_LOCATION













            },













            prefix = "TYPE_")













    public @interface ActionType {}



























    /**













     * Indicates an action to view a calendar at a specified time.













     */













    public static final String TYPE_VIEW_CALENDAR = "view_calendar";













    /**













     * Indicates an action to view the map at a specified location.













     */













    public static final String TYPE_VIEW_MAP = "view_map";













    /**













     * Indicates an action to track a flight.













     */













    public static final String TYPE_TRACK_FLIGHT = "track_flight";













    /**













     * Indicates an action to open an URL.













     */













    public static final String TYPE_OPEN_URL = "open_url";













    /**













     * Indicates an action to send a SMS.













     */













    public static final String TYPE_SEND_SMS = "send_sms";













    /**













     * Indicates an action to call a phone number.













     */













    public static final String TYPE_CALL_PHONE = "call_phone";













    /**













     * Indicates an action to send an email.













     */













    public static final String TYPE_SEND_EMAIL = "send_email";













    /**













     * Indicates an action to reply with a text message.













     */













    public static final String TYPE_TEXT_REPLY = "text_reply";













    /**













     * Indicates an action to create a reminder.













     */













    public static final String TYPE_CREATE_REMINDER = "create_reminder";













    /**













     * Indicates an action to reply with a location.













     */













    public static final String TYPE_SHARE_LOCATION = "share_location";



























    public static final Creator<ConversationAction> CREATOR =













            new Creator<ConversationAction>() {













                @Override













                public ConversationAction createFromParcel(Parcel in) {













                    return new ConversationAction(in);













                }



























                @Override













                public ConversationAction[] newArray(int size) {













                    return new ConversationAction[size];













                }













            };



























    @NonNull













    @ActionType













    private final String mType;













    @NonNull













    private final CharSequence mTextReply;













    @Nullable













    private final RemoteAction mAction;



























    @FloatRange(from = 0, to = 1)













    private final float mScore;



























    @NonNull













    private final Bundle mExtras;



























    private ConversationAction(













            @NonNull String type,













            @Nullable RemoteAction action,













            @Nullable CharSequence textReply,













            float score,













            @NonNull Bundle extras) {













        mType = Preconditions.checkNotNull(type);













        mAction = action;













        mTextReply = textReply;













        mScore = score;













        mExtras = Preconditions.checkNotNull(extras);













    }



























    private ConversationAction(Parcel in) {













        mType = in.readString();













        mAction = in.readParcelable(null);













        mTextReply = in.readCharSequence();













        mScore = in.readFloat();













        mExtras = in.readBundle();













    }



























    @Override













    public void writeToParcel(Parcel parcel, int flags) {













        parcel.writeString(mType);













        parcel.writeParcelable(mAction, flags);













        parcel.writeCharSequence(mTextReply);













        parcel.writeFloat(mScore);













        parcel.writeBundle(mExtras);













    }



























    @Override













    public int describeContents() {













        return 0;













    }



























    /** Returns the type of this action, for example, {@link #TYPE_VIEW_CALENDAR}. */













    @NonNull













    @ActionType













    public String getType() {













        return mType;













    }



























    /**













     * Returns a RemoteAction object, which contains the icon, label and a PendingIntent, for













     * the specified action type.













     */













    @Nullable













    public RemoteAction getAction() {













        return mAction;













    }



























    /**













     * Returns the confidence score for the specified action. The value ranges from 0 (low













     * confidence) to 1 (high confidence).













     */













    @FloatRange(from = 0, to = 1)













    public float getConfidenceScore() {













        return mScore;













    }



























    /**













     * Returns the text reply that could be sent as a reply to the given conversation.













     * <p>













     * This is only available when the type of the action is {@link #TYPE_TEXT_REPLY}.













     */













    @Nullable













    public CharSequence getTextReply() {













        return mTextReply;













    }



























    /**













     * Returns the extended data related to this conversation action.













     *













     * <p><b>NOTE: </b>Each call to this method returns a new bundle copy so clients should













     * prefer to hold a reference to the returned bundle rather than frequently calling this













     * method.













     */













    @NonNull













    public Bundle getExtras() {













        return mExtras.deepCopy();













    }



























    /** Builder class to construct {@link ConversationAction}. */













    public static final class Builder {













        @Nullable













        @ActionType













        private String mType;













        @Nullable













        private RemoteAction mAction;













        @Nullable













        private CharSequence mTextReply;













        private float mScore;













        @Nullable













        private Bundle mExtras;



























        public Builder(@NonNull @ActionType String actionType) {













            mType = Preconditions.checkNotNull(actionType);













        }



























        /**













         * Sets an action that may be performed on the given conversation.













         */













        @NonNull













        public Builder setAction(@Nullable RemoteAction action) {













            mAction = action;













            return this;













        }



























        /**













         * Sets a text reply that may be performed on the given conversation.













         */













        @NonNull













        public Builder setTextReply(@Nullable CharSequence textReply) {













            mTextReply = textReply;













            return this;













        }



























        /** Sets the confident score. */













        @NonNull













        public Builder setConfidenceScore(@FloatRange(from = 0, to = 1) float score) {













            mScore = score;













            return this;













        }



























        /**













         * Sets the extended data for the conversation action object.













         */













        @NonNull













        public Builder setExtras(@Nullable Bundle extras) {













            mExtras = extras;













            return this;













        }



























        /** Builds the {@link ConversationAction} object. */













        @NonNull













        public ConversationAction build() {













            return new ConversationAction(













                    mType,













                    mAction,













                    mTextReply,













                    mScore,













                    mExtras == null ? Bundle.EMPTY : mExtras.deepCopy());













        }













    }













}
























core/java/android/view/textclassifier/ConversationActions.java



+28
−404


























File changed.
Preview size limit exceeded, changes collapsed.
























core/java/android/view/textclassifier/TextClassificationConstants.java



+9
−9




























Original line number
Diff line number
Diff line








@@ -117,15 +117,15 @@ public final class TextClassificationConstants {













            .add(TextClassifier.TYPE_FLIGHT_NUMBER).toString();















    private static final String CONVERSATION_ACTIONS_TYPES_DEFAULT_VALUES =















            new StringJoiner(ENTITY_LIST_DELIMITER)













                    .add(ConversationActions.TYPE_TEXT_REPLY)













                    .add(ConversationActions.TYPE_CREATE_REMINDER)













                    .add(ConversationActions.TYPE_CALL_PHONE)













                    .add(ConversationActions.TYPE_OPEN_URL)













                    .add(ConversationActions.TYPE_SEND_EMAIL)













                    .add(ConversationActions.TYPE_SEND_SMS)













                    .add(ConversationActions.TYPE_TRACK_FLIGHT)













                    .add(ConversationActions.TYPE_VIEW_CALENDAR)













                    .add(ConversationActions.TYPE_VIEW_MAP)













                    .add(ConversationAction.TYPE_TEXT_REPLY)













                    .add(ConversationAction.TYPE_CREATE_REMINDER)













                    .add(ConversationAction.TYPE_CALL_PHONE)













                    .add(ConversationAction.TYPE_OPEN_URL)













                    .add(ConversationAction.TYPE_SEND_EMAIL)













                    .add(ConversationAction.TYPE_SEND_SMS)













                    .add(ConversationAction.TYPE_TRACK_FLIGHT)













                    .add(ConversationAction.TYPE_VIEW_CALENDAR)













                    .add(ConversationAction.TYPE_VIEW_MAP)















                    .toString();































    private final boolean mSystemTextClassifierEnabled;

































core/java/android/view/textclassifier/TextClassifier.java



+149
−57


























File changed.
Preview size limit exceeded, changes collapsed.