# EntityExtractorOptions

public class **EntityExtractorOptions** extends [Object](https://developer.android.com/reference/java/lang/Object.html)  
Options for extracting entities from a piece of text.

### Nested Class Summary

|---|---|---|---|
| class | [EntityExtractorOptions.Builder](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions.Builder) || Builder for `https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions` instances. |
| @interface | [EntityExtractorOptions.ModelIdentifier](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions.ModelIdentifier) || The list of models supported by entity extraction (e.g. |

### Constant Summary

|---|---|---|
| [String](https://developer.android.com/reference/java/lang/String.html) | [ARABIC](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#ARABIC) | Arabic. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [CHINESE](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#CHINESE) | Chinese. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [DUTCH](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#DUTCH) | Dutch. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [ENGLISH](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#ENGLISH) | English. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [FRENCH](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#FRENCH) | French. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [GERMAN](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#GERMAN) | German. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [ITALIAN](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#ITALIAN) | Italian. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [JAPANESE](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#JAPANESE) | Japanese. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [KOREAN](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#KOREAN) | Korean. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [POLISH](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#POLISH) | Polish. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [PORTUGUESE](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#PORTUGUESE) | Portuguese. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [RUSSIAN](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#RUSSIAN) | Russian. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [SPANISH](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#SPANISH) | Spanish. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [THAI](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#THAI) | Thai. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [TURKISH](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#TURKISH) | Turkish. |

### Public Method Summary

|---|---|
| boolean | [equals](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#equals(java.lang.Object))([Object](https://developer.android.com/reference/java/lang/Object.html) o) Indicates whether some other object is "equal to" this one. |
| static [String](https://developer.android.com/reference/java/lang/String.html) | [fromLanguageTag](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#fromLanguageTag(java.lang.String))([String](https://developer.android.com/reference/java/lang/String.html) languageTag) Returns a model identifier (e.g. |
| static [List](https://developer.android.com/reference/java/util/List.html)\<[String](https://developer.android.com/reference/java/lang/String.html)\> | [getAllModelIdentifiers](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#getAllModelIdentifiers())() Returns the list of all model identifiers (e.g. |
| int | [hashCode](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#hashCode())() Returns a hash code value for the object. |
| static [String](https://developer.android.com/reference/java/lang/String.html) | [toLanguageTag](https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#toLanguageTag(java.lang.String))([String](https://developer.android.com/reference/java/lang/String.html) modelIdentifier) Returns the [BCP 47 language tag](https://tools.ietf.org/rfc/bcp/bcp47.txt) of the language covered by the model associated with this `modelIdentifier` (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() |

## Constants

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**ARABIC**

Arabic.
Constant Value: "arabic"

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**CHINESE**

Chinese.
Constant Value: "chinese"

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**DUTCH**

Dutch.
Constant Value: "dutch"

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**ENGLISH**

English.
Constant Value: "english"

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**FRENCH**

French.
Constant Value: "french"

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**GERMAN**

German.
Constant Value: "german"

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**ITALIAN**

Italian.
Constant Value: "italian"

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**JAPANESE**

Japanese.
Constant Value: "japanese"

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**KOREAN**

Korean.
Constant Value: "korean"

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**POLISH**

Polish.
Constant Value: "polish"

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**PORTUGUESE**

Portuguese.
Constant Value: "portuguese"

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**RUSSIAN**

Russian.
Constant Value: "russian"

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**SPANISH**

Spanish.
Constant Value: "spanish"

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**THAI**

Thai.
Constant Value: "thai"

#### public static final [String](https://developer.android.com/reference/java/lang/String.html)
**TURKISH**

Turkish.
Constant Value: "turkish"

## Public Methods

#### public boolean **equals** ([Object](https://developer.android.com/reference/java/lang/Object.html) o)

Indicates whether some other object is "equal to" this one.

#### public static [String](https://developer.android.com/reference/java/lang/String.html) **fromLanguageTag** ([String](https://developer.android.com/reference/java/lang/String.html) languageTag)

Returns a model identifier (e.g. `https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#ARABIC`) that identifies an entity extraction model that is suitable for
extracting entities from text in the specified language, or `null` if the
language tag is invalid or not supported by the Entity Extraction API.

##### Parameters

| languageTag | a [BCP 47 language tag](https://tools.ietf.org/rfc/bcp/bcp47.txt) that identifies a particular language |
|---|---|

#### public static [List](https://developer.android.com/reference/java/util/List.html)\<[String](https://developer.android.com/reference/java/lang/String.html)\>
**getAllModelIdentifiers** ()

Returns the list of all model identifiers (e.g. `https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#ARABIC`) supported by EntityExtraction.

#### public int **hashCode** ()

Returns a hash code value for the object.

#### public static [String](https://developer.android.com/reference/java/lang/String.html) **toLanguageTag** ([String](https://developer.android.com/reference/java/lang/String.html) modelIdentifier)

Returns the [BCP 47 language tag](https://tools.ietf.org/rfc/bcp/bcp47.txt) of
the language covered by the model associated with this `modelIdentifier`
(e.g. `https://developers.google.com/android/reference/com/google/mlkit/nl/entityextraction/EntityExtractorOptions#ARABIC`).