Builder

Kotlin |Java

class Builder

kotlin.Any
↳	android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig.Builder

Builder for EmbeddingPropertyConfig.

Summary

Public constructors
`Builder(propertyName: String)` Creates a new `EmbeddingPropertyConfig.Builder`.

Public methods
AppSearchSchema.EmbeddingPropertyConfig	`build()` Constructs a new `EmbeddingPropertyConfig` from the contents of this builder.
AppSearchSchema.EmbeddingPropertyConfig.Builder	`setCardinality(cardinality: Int)` Sets the cardinality of the property (whether it is optional, required or repeated).
AppSearchSchema.EmbeddingPropertyConfig.Builder	`setIndexingType(indexingType: Int)` Configures how a property should be indexed so that it can be retrieved by queries.
AppSearchSchema.EmbeddingPropertyConfig.Builder	`setQuantizationType(quantizationType: Int)` Configures whether the vector contents of this property should be quantized.

Public constructors

Builder

Added in T Extensions 16

Builder(propertyName: String)

Creates a new EmbeddingPropertyConfig.Builder.

Parameters
`propertyName`	String: This value cannot be `null`.

Public methods

build

Added in T Extensions 16

fun build(): AppSearchSchema.EmbeddingPropertyConfig

Constructs a new EmbeddingPropertyConfig from the contents of this builder.

Return
`AppSearchSchema.EmbeddingPropertyConfig`	This value cannot be `null`.

setCardinality

Added in T Extensions 16

fun setCardinality(cardinality: Int): AppSearchSchema.EmbeddingPropertyConfig.Builder

Sets the cardinality of the property (whether it is optional, required or repeated).

If this method is not called, the default cardinality is android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL.

Parameters
`cardinality`	Int: Value is `android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_REPEATED`, `android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL`, or `android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_REQUIRED`

Return
`AppSearchSchema.EmbeddingPropertyConfig.Builder`	This value cannot be `null`.

setIndexingType

Added in T Extensions 16

fun setIndexingType(indexingType: Int): AppSearchSchema.EmbeddingPropertyConfig.Builder

Configures how a property should be indexed so that it can be retrieved by queries.

If this method is not called, the default indexing type is android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#INDEXING_TYPE_NONE, so that it will not be indexed and cannot be matched by queries.

Parameters
`indexingType`	Int: Value is `android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#INDEXING_TYPE_NONE`, or `android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#INDEXING_TYPE_SIMILARITY`

Return
`AppSearchSchema.EmbeddingPropertyConfig.Builder`	This value cannot be `null`.

setQuantizationType

Added in API level Baklava

fun setQuantizationType(quantizationType: Int): AppSearchSchema.EmbeddingPropertyConfig.Builder

Configures whether the vector contents of this property should be quantized.

Quantization can reduce the size of the embedding search index, potentially leading to faster embedding search due to lower I/O bandwidth. Quantization is usually very reliable and in most cases will have a negligible impact on recall. Using quantization is strongly recommended.

If this method is not called, the default quantization type is android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#QUANTIZATION_TYPE_NONE.

Parameters
`quantizationType`	Int: Value is `android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#QUANTIZATION_TYPE_NONE`, or `android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#QUANTIZATION_TYPE_8_BIT`

Return
`AppSearchSchema.EmbeddingPropertyConfig.Builder`	This value cannot be `null`.