TextLanguage
class TextLanguage : Parcelable
| kotlin.Any | |
| ↳ | android.view.textclassifier.TextLanguage |
Represents the result of language detection of a piece of text.
This contains a list of locales, each paired with a confidence score, sorted in decreasing order of those scores. E.g., for a given input text, the model may return [<"en", 0.85>, <"fr", 0.15>]. This sample result means the model reports that it is 85% likely that the entire text is in English and 15% likely that the entire text is in French, etc. It does not mean that 85% of the input is in English and 15% is in French.
Summary
| Nested classes | |
|---|---|
| Builder used to build TextLanguage objects. | |
| A request object for detecting the language of a piece of text. | |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int | |
| Float | getConfidenceScore(locale: ULocale)Returns the confidence score for the specified language locale. |
| Bundle | Returns a bundle containing non-structured extra information about this result. |
| String? | getId()Returns the id, if one exists, for this object. |
| ULocale | Returns the language locale at the specified index. |
| Int | Returns the number of possible locales for the processed text. |
| String | toString() |
| Unit | writeToParcel(dest: Parcel, flags: Int) |
| Properties | |
|---|---|
| static Parcelable.Creator<TextLanguage!> | |
Public methods
describeContents
fun describeContents(): Int
| Return | |
|---|---|
Int | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR |
getConfidenceScore
fun getConfidenceScore(locale: ULocale): Float
Returns the confidence score for the specified language locale. The value ranges from 0 (low confidence) to 1 (high confidence). 0 indicates that the locale was not found for the processed text.
| Parameters | |
|---|---|
locale | ULocale: This value cannot be null. |
| Return | |
|---|---|
Float | Value is between 0.0 and 1.0 inclusive |
getExtras
fun getExtras(): Bundle
Returns a bundle containing non-structured extra information about this result. What is returned in the extras is specific to the TextClassifier implementation.
NOTE: Do not modify this bundle.
| Return | |
|---|---|
Bundle | This value cannot be null. |
getId
fun getId(): String?
Returns the id, if one exists, for this object.
| Return | |
|---|---|
String? | This value may be null. |
getLocale
fun getLocale(index: Int): ULocale
Returns the language locale at the specified index. Locales are ordered from high confidence to low confidence.
See getLocaleHypothesisCount() for the number of locales available.
| Return | |
|---|---|
ULocale | This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.IndexOutOfBoundsException | if the specified index is out of range. |
getLocaleHypothesisCount
fun getLocaleHypothesisCount(): Int
Returns the number of possible locales for the processed text.
| Return | |
|---|---|
Int | Value is 0 or greater |
toString
fun toString(): String
| Return | |
|---|---|
String | a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
| Parameters | |
|---|---|
dest | Parcel: The Parcel in which the object should be written. This value cannot be null. |
flags | Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |