TextClassification
class TextClassification
kotlin.Any | |
↳ | androidx.textclassifier.TextClassification |
Information for generating a widget to handle classified text.
A TextClassification object contains icons, labels, and intents that may be used to build a widget that can be used to act on classified text.
e.g. building a menu that allows the user how to act on a piece of text:
<code>// Called preferably outside the UiThread. TextClassification classification = textClassifier.classifyText(allText, 10, 25); // Called on the UiThread. for (RemoteActionCompat action : classification.getActions()) { MenuItem item = menu.add(action.getTitle()); item.setContentDescription(action.getContentDescription()); item.setOnMenuItemClickListener(v -> action.getActionIntent().send()); if (action.shouldShowIcon()) { item.setIcon(action.getIcon().loadDrawable(context)); } } </code>
Summary
Nested classes | |
---|---|
Builder for building |
|
A request object for generating TextClassification. |
Public methods | |
---|---|
static TextClassification |
createFromBundle(@NonNull bundle: Bundle) Extracts a classification from a bundle that was added using |
MutableList<RemoteActionCompat!> |
Returns a list of actions that may be performed on the text. |
Float |
getConfidenceScore(entity: String!) Returns the confidence score for the specified entity. |
String |
getEntityType(index: Int) Returns the entity type at the specified index. |
Int |
Returns the number of entity types found in the classified text. |
Bundle |
Returns the extended, vendor specific data. |
String? |
getId() Returns the id for this object. |
CharSequence? |
getText() Gets the classified text. |
Bundle |
toBundle() Adds this classification to a Bundle that can be read back with the same parameters to |
String |
toString() |
Public methods
createFromBundle
@NonNull static fun createFromBundle(@NonNull bundle: Bundle): TextClassification
Extracts a classification from a bundle that was added using toBundle()
.
Exceptions | |
---|---|
IllegalArgumentException |
getActions
@NonNull fun getActions(): MutableList<RemoteActionCompat!>
Returns a list of actions that may be performed on the text. The list is ordered based on the likelihood that a user will use the action, with the most likely action appearing first.
getConfidenceScore
@FloatRange(0.0, 1.0) fun getConfidenceScore(entity: String!): Float
Returns the confidence score for the specified entity. The value ranges from 0 (low confidence) to 1 (high confidence). 0 indicates that the entity was not found for the classified text.
getEntityType
@NonNull fun getEntityType(index: Int): String
Returns the entity type at the specified index. Entities are ordered from high confidence to low confidence.
Exceptions | |
---|---|
IndexOutOfBoundsException |
if the specified index is out of range. |
See Also
getEntityTypeCount
@IntRange(0) fun getEntityTypeCount(): Int
Returns the number of entity types found in the classified text.
getExtras
@NonNull fun getExtras(): Bundle
Returns the extended, vendor specific data.
NOTE: 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. Avoid updating the content of this bundle. On pre-O devices, the values in the Bundle are not deep copied.
toBundle
@NonNull fun toBundle(): Bundle
Adds this classification to a Bundle that can be read back with the same parameters to createFromBundle(Bundle)
.
toString
fun toString(): String