TextClassification.Request.Builder

class TextClassification.Request.Builder


A builder for building TextClassification requests.

Summary

Public constructors

Builder(
    text: CharSequence,
    startIndex: @IntRange(from = 0) Int,
    endIndex: @IntRange(from = 0) Int
)

Public functions

TextClassification.Request

Builds and returns the request object.

TextClassification.Request.Builder
TextClassification.Request.Builder
setExtras(extras: Bundle?)

Sets the extended, vendor specific data.

TextClassification.Request.Builder
setReferenceTime(referenceTime: Long?)

Public constructors

Builder

Builder(
    text: CharSequence,
    startIndex: @IntRange(from = 0) Int,
    endIndex: @IntRange(from = 0) Int
)
Parameters
text: CharSequence

text providing context for the text to classify (which is specified by the sub sequence starting at startIndex and ending at endIndex)

startIndex: @IntRange(from = 0) Int

start index of the text to classify

endIndex: @IntRange(from = 0) Int

end index of the text to classify

Public functions

build

fun build(): TextClassification.Request

Builds and returns the request object.

setDefaultLocales

fun setDefaultLocales(defaultLocales: LocaleListCompat?): TextClassification.Request.Builder
Parameters
defaultLocales: LocaleListCompat?

ordered list of locale preferences that may be used to disambiguate the provided text. If no locale preferences exist, set this to null or an empty locale list.

Returns
TextClassification.Request.Builder

this builder

setExtras

fun setExtras(extras: Bundle?): TextClassification.Request.Builder

Sets the extended, vendor specific data.

Returns
TextClassification.Request.Builder

this builder

setReferenceTime

fun setReferenceTime(referenceTime: Long?): TextClassification.Request.Builder
Parameters
referenceTime: Long?

reference time based on which relative dates (e.g. "tomorrow") should be interpreted. This should usually be the time when the text was originally composed and should be milliseconds from the epoch of 1970-01-01T00:00:00Z(UTC timezone). For example, if there is a message saying "see you 10 days later", and the message was composed yesterday, text classifier will then realize it is indeed means 9 days later from now and classify the text accordingly. If no reference time is set, now is used.

Returns
TextClassification.Request.Builder

this builder