# EntityExtractionParams.Builder

public static class **EntityExtractionParams.Builder** extends [Object](https://developer.android.com/reference/java/lang/Object.html)  
Builder class for `https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams`.

### Public Constructor Summary

|---|---|
|   | [Builder](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams.Builder#Builder(java.lang.String))([String](https://developer.android.com/reference/java/lang/String.html) text) Creates a new builder to build `https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams`. |

### Public Method Summary

|---|---|
| [EntityExtractionParams](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams) | [build](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams.Builder#build())() Builds a `https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams` instance. |
| [EntityExtractionParams.Builder](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams.Builder) | [setEntityTypesFilter](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams.Builder#setEntityTypesFilter(java.util.Set<java.lang.Integer>))([Set](https://developer.android.com/reference/java/util/Set.html)\<[Integer](https://developer.android.com/reference/java/lang/Integer.html)\> typesFilter) Defines the subset of type (e.g. |
| [EntityExtractionParams.Builder](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams.Builder) | [setPreferredLocale](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams.Builder#setPreferredLocale(java.util.Locale))([Locale](https://developer.android.com/reference/java/util/Locale.html) preferredLocale) Sets the preferred locale that can be used to disambiguate potential values for identified entities. |
| [EntityExtractionParams.Builder](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams.Builder) | [setReferenceTime](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams.Builder#setReferenceTime(java.lang.Long))([Long](https://developer.android.com/reference/java/lang/Long.html) referenceTime) Sets the reference time based on which relative dates (e.g. |
| [EntityExtractionParams.Builder](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams.Builder) | [setReferenceTimeZone](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams.Builder#setReferenceTimeZone(java.util.TimeZone))([TimeZone](https://developer.android.com/reference/java/util/TimeZone.html) referenceTimeZone) Sets the reference time zone based on which relative dates (e.g. |

### Inherited Method Summary

From class java.lang.Object

|---|---|
| [Object](https://developer.android.com/reference/java/lang/Object.html) | clone() |
| boolean | equals([Object](https://developer.android.com/reference/java/lang/Object.html) arg0) |
| void | finalize() |
| final [Class](https://developer.android.com/reference/java/lang/Class.html)\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| [String](https://developer.android.com/reference/java/lang/String.html) | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

## Public Constructors

#### public **Builder** ([String](https://developer.android.com/reference/java/lang/String.html) text)

Creates a new builder to build `https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams`.

##### Parameters

| text | used for entity extraction. |
|---|---|

## Public Methods

#### public [EntityExtractionParams](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams)
**build** ()

Builds a `https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams`
instance.

#### public [EntityExtractionParams.Builder](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams.Builder) **setEntityTypesFilter** ([Set](https://developer.android.com/reference/java/util/Set.html)\<[Integer](https://developer.android.com/reference/java/lang/Integer.html)\> typesFilter)

Defines the subset of type (e.g. `https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/Entity#TYPE_URL`)
that are relevant to the use case (can be a single element if only one entity type is
relevant). If this is not set, all possible entity types will be returned.

#### public [EntityExtractionParams.Builder](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams.Builder) **setPreferredLocale** ([Locale](https://developer.android.com/reference/java/util/Locale.html) preferredLocale)

Sets the preferred locale that can be used to disambiguate potential values for
identified entities. For example, "01/02/2000" is ambiguous and could refer to either
January 2nd or February 1st, but a locale preference could help pick the right one
(en-US would pick the first, en-UK would pick the second).

The supported locales match the list of supported models. So any of (or a subset
of): `'en-*'` (`'en-US'`, `'en-UK'`,
`'en-CA'`, ...), `'ar-*'`, `'de-*'`,
`'es-*'`, `'fr-*'`, `'it-*'`, `'ja-*'`,
`'ko-*'`, `'nl-*'`, `'pl-*'`, `'pt-*'`,
`'ru-*'`, `'th-*'`, `'tr-*'`, `'zh-*'`

If this is not set, the device's locale will be used instead.

#### public [EntityExtractionParams.Builder](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams.Builder) **setReferenceTime** ([Long](https://developer.android.com/reference/java/lang/Long.html) referenceTime)

Sets the reference time based on which relative dates (e.g. "tomorrow") should be
interpreted, in milliseconds from the epoch of 1970-01-01T00:00:00Z (UTC timezone). If
this is not set, the current time (when entity extraction is invoked) will be used.

#### public [EntityExtractionParams.Builder](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractionParams.Builder) **setReferenceTimeZone** ([TimeZone](https://developer.android.com/reference/java/util/TimeZone.html) referenceTimeZone)

Sets the reference time zone based on which relative dates (e.g. "tomorrow") should
be interpreted. If this is not set, the current time zone (when entity extraction is
invoked) will be used.