AppSearchSchema.EmbeddingPropertyConfig.Builder


class AppSearchSchema.EmbeddingPropertyConfig.Builder


Builder for EmbeddingPropertyConfig.

Summary

Public constructors

Builder(propertyName: String)

Creates a new EmbeddingPropertyConfig.Builder.

Public functions

AppSearchSchema.EmbeddingPropertyConfig

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
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SET_DESCRIPTION)
setDescription(description: String)

Sets a natural language description of this property.

AppSearchSchema.EmbeddingPropertyConfig.Builder
setIndexingType(indexingType: Int)

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

Public constructors

Builder

Added in 1.1.0-alpha06
Builder(propertyName: String)

Creates a new EmbeddingPropertyConfig.Builder.

Public functions

build

Added in 1.1.0-alpha06
fun build(): AppSearchSchema.EmbeddingPropertyConfig

Constructs a new EmbeddingPropertyConfig from the contents of this builder.

setCardinality

Added in 1.1.0-alpha06
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 CARDINALITY_OPTIONAL.

setDescription

Added in 1.1.0-alpha06
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SET_DESCRIPTION)
fun setDescription(description: String): AppSearchSchema.EmbeddingPropertyConfig.Builder

Sets a natural language description of this property.

For more details about the description field, see getDescription.

setIndexingType

Added in 1.1.0-alpha06
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 INDEXING_TYPE_NONE, so that it will not be indexed and cannot be matched by queries.