# TextClassifier.EntityConfig.Builder

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# Builder

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig.Builder "View this page in Java")  

```
class Builder
```

|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                                                     ||
| ↳ | [android.view.textclassifier.TextClassifier.EntityConfig.Builder](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#) |

Builder class to construct the[EntityConfig](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig)object.

## Summary

|                                                                Public constructors                                                                ||
|------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [Builder](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#Builder())`()` <br /> |

|                                                                                                                                                                                                                                                                                                               Public methods                                                                                                                                                                                                                                                                                                               ||
|--------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [TextClassifier.EntityConfig](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig)                  | [build](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#build())`()` Combines all of the options that have been set and returns a new[EntityConfig](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig)object.                                                                                                                                                  |
| [TextClassifier.EntityConfig.Builder](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#) | [includeTypesFromTextClassifier](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#includeTypesFromTextClassifier(kotlin.Boolean))`(`includeTypesFromTextClassifier:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Specifies whether or not to include the types suggested by the text classifier.                                                                          |
| [TextClassifier.EntityConfig.Builder](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#) | [setExcludedTypes](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#setExcludedTypes(kotlin.collections.MutableCollection))`(`excludedTypes:` `[MutableCollection](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!>?`)` Sets a collection of types that are explicitly excluded.   |
| [TextClassifier.EntityConfig.Builder](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#) | [setHints](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#setHints(kotlin.collections.MutableCollection))`(`hints:` `[MutableCollection](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!>?`)` Sets the hints for the TextClassifier to determine what types of entities to find. |
| [TextClassifier.EntityConfig.Builder](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#) | [setIncludedTypes](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#setIncludedTypes(kotlin.collections.MutableCollection))`(`includedTypes:` `[MutableCollection](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!>?`)` Sets a collection of types that are explicitly included.   |

## Public constructors

### Builder

```
Builder()
```

## Public methods

### build

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun build(): TextClassifier.EntityConfig
```

Combines all of the options that have been set and returns a new[EntityConfig](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig)object.

|                                                                               Return                                                                               ||
|---------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [TextClassifier.EntityConfig](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig) | This value cannot be`null`. |

### includeTypesFromTextClassifier

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun includeTypesFromTextClassifier(includeTypesFromTextClassifier: Boolean): TextClassifier.EntityConfig.Builder
```

Specifies whether or not to include the types suggested by the text classifier. By default, it is included.

|                                                                                       Return                                                                                        ||
|--------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [TextClassifier.EntityConfig.Builder](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#) | This value cannot be`null`. |

### setExcludedTypes

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setExcludedTypes(excludedTypes: MutableCollection<String!>?): TextClassifier.EntityConfig.Builder
```

Sets a collection of types that are explicitly excluded.

|                                                                                                                     Parameters                                                                                                                      ||
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `excludedTypes` | [MutableCollection](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!\>?:This value may be`null`. |

|                                                                                       Return                                                                                        ||
|--------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [TextClassifier.EntityConfig.Builder](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#) | This value cannot be`null`. |

### setHints

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setHints(hints: MutableCollection<String!>?): TextClassifier.EntityConfig.Builder
```

Sets the hints for the TextClassifier to determine what types of entities to find. These hints will only be used if[includeTypesFromTextClassifier](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#includeTypesFromTextClassifier(kotlin.Boolean))is set to be true.

|                                                                                                                 Parameters                                                                                                                  ||
|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `hints` | [MutableCollection](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!\>?:This value may be`null`. |

|                                                                                       Return                                                                                        ||
|--------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [TextClassifier.EntityConfig.Builder](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#) | This value cannot be`null`. |

### setIncludedTypes

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setIncludedTypes(includedTypes: MutableCollection<String!>?): TextClassifier.EntityConfig.Builder
```

Sets a collection of types that are explicitly included.

|                                                                                                                     Parameters                                                                                                                      ||
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `includedTypes` | [MutableCollection](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!\>?:This value may be`null`. |

|                                                                                       Return                                                                                        ||
|--------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [TextClassifier.EntityConfig.Builder](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextClassifier.EntityConfig.Builder#) | This value cannot be`null`. |