# AppSearchSchema.EmbeddingPropertyConfig
Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)
Also in[T Extensions 16](https://developer.android.com/sdkExtensions)
# EmbeddingPropertyConfig
*** ** * ** ***
Kotlin\|[Java](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig "View this page in Java")
```
class EmbeddingPropertyConfig : AppSearchSchema.PropertyConfig
```
|---|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) |||
| ↳ | [android.app.appsearch.AppSearchSchema.PropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig) ||
| | ↳ | [android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig#) |
Configuration for a property of type[EmbeddingVector](https://developer.android.com/reference/kotlin/android/app/appsearch/EmbeddingVector)in a Document.
## Summary
| Nested classes ||
|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | [Builder](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig.Builder) Builder for[EmbeddingPropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig#). |
| Constants ||
|----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [INDEXING_TYPE_NONE](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig#INDEXING_TYPE_NONE:kotlin.Int) Content in this property will not be indexed. |
| static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [INDEXING_TYPE_SIMILARITY](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig#INDEXING_TYPE_SIMILARITY:kotlin.Int) Embedding vectors in this property will be indexed. |
| static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [QUANTIZATION_TYPE_8_BIT](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig#QUANTIZATION_TYPE_8_BIT:kotlin.Int) Contents in this property will be quantized to 8 bits. |
| static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [QUANTIZATION_TYPE_NONE](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig#QUANTIZATION_TYPE_NONE:kotlin.Int) Contents in this property will not be quantized. |
| Inherited constants ||
|---|---|
| From class[PropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig) |----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [CARDINALITY_OPTIONAL](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL:kotlin.Int)
Zero or one value \[0,1\].
| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [CARDINALITY_REPEATED](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_REPEATED:kotlin.Int)
Any number of items (including zero) \[0...\*\].
| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [CARDINALITY_REQUIRED](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_REQUIRED:kotlin.Int)
Exactly one value \[1\].
| ||
| Public methods ||
|----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getIndexingType](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig#getIndexingType())`()` Returns how the property is indexed. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getQuantizationType](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig#getQuantizationType())`()` Returns how the embedding contents of this property should be quantized. |
| Inherited functions ||
|---|---|
| From class[PropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig) |------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)`
Indicates whether some other object is "equal to" this one. The`equals`method implements an equivalence relation on non-null object references: - It is*reflexive* : for any non-null reference value`x`,`x.equals(x)`should return`true`. - It is*symmetric* : for any non-null reference values`x`and`y`,`x.equals(y)`should return`true`if and only if`y.equals(x)`returns`true`. - It is*transitive* : for any non-null reference values`x`,`y`, and`z`, if`x.equals(y)`returns`true`and`y.equals(z)`returns`true`, then`x.equals(z)`should return`true`. - It is*consistent* : for any non-null reference values`x`and`y`, multiple invocations of`x.equals(y)`consistently return`true`or consistently return`false`, provided no information used in`equals`comparisons on the objects is modified. - For any non-null reference value`x`,`x.equals(null)`should return`false`. An equivalence relation partitions the elements it operates on into*equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getCardinality](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#getCardinality())`()`
Returns the cardinality of the property (whether it is optional, required or repeated).
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [getDescription](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#getDescription())`()`
Returns a natural language description of this property. Ex. The description for the "homeAddress" property of a "Person" type could be "the address at which this person lives". This information is purely to help apps consuming this type the semantic meaning of its properties. This field has no effect in AppSearch - it is just stored with the AppSearchSchema. If the description is not set, then this method will return an empty string.
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [getName](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#getName())`()`
Returns the name of this property.
| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [hashCode](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#hashCode())`()`
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [toString](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#toString())`()`
Returns a string representation of the object.
| ||
## Constants
### INDEXING_TYPE_NONE
Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)
Also in[T Extensions 16](https://developer.android.com/sdkExtensions)
```
static val INDEXING_TYPE_NONE: Int
```
Content in this property will not be indexed.
Value: 0
### INDEXING_TYPE_SIMILARITY
Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)
Also in[T Extensions 16](https://developer.android.com/sdkExtensions)
```
static val INDEXING_TYPE_SIMILARITY: Int
```
Embedding vectors in this property will be indexed.
The index offers 100% accuracy, but has linear time complexity based on the number of embedding vectors within the index.
Value: 1
### QUANTIZATION_TYPE_8_BIT
Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)
Also in[T Extensions 16](https://developer.android.com/sdkExtensions)
```
static val QUANTIZATION_TYPE_8_BIT: Int
```
Contents in this property will be quantized to 8 bits.
Value: 1
### QUANTIZATION_TYPE_NONE
Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)
Also in[T Extensions 16](https://developer.android.com/sdkExtensions)
```
static val QUANTIZATION_TYPE_NONE: Int
```
Contents in this property will not be quantized.
Value: 0
## Public methods
### getIndexingType
Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)
Also in[T Extensions 16](https://developer.android.com/sdkExtensions)
```
fun getIndexingType(): Int
```
Returns how the property is indexed.
| Return ||
|----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | Value is[android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#INDEXING_TYPE_NONE](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig#INDEXING_TYPE_NONE:kotlin.Int), or[android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#INDEXING_TYPE_SIMILARITY](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig#INDEXING_TYPE_SIMILARITY:kotlin.Int) |
### getQuantizationType
Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)
Also in[T Extensions 17](https://developer.android.com/sdkExtensions)
```
fun getQuantizationType(): Int
```
Returns how the embedding contents of this property should be quantized.
If the property isn't indexed, returns[QUANTIZATION_TYPE_NONE](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig#QUANTIZATION_TYPE_NONE:kotlin.Int).
| Return ||
|----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | Value is[android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#QUANTIZATION_TYPE_NONE](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig#QUANTIZATION_TYPE_NONE:kotlin.Int), or[android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#QUANTIZATION_TYPE_8_BIT](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig#QUANTIZATION_TYPE_8_BIT:kotlin.Int) |