AppSearchSchema.EmbeddingPropertyConfig.Builder

Artifact: androidx.appsearch:appsearch

View Source

Added in 1.1.0-alpha06

---

Kotlin |Java

public final class AppSearchSchema.EmbeddingPropertyConfig.Builder

---

Builder for EmbeddingPropertyConfig.

Summary

Public constructors
Builder(@NonNull String propertyName) Creates a new EmbeddingPropertyConfig.Builder.

Public methods
@NonNull AppSearchSchema.EmbeddingPropertyConfig	build() Constructs a new EmbeddingPropertyConfig from the contents of this builder.
@NonNull AppSearchSchema.EmbeddingPropertyConfig.Builder	setCardinality(int cardinality) Sets the cardinality of the property (whether it is optional, required or repeated).
@NonNull AppSearchSchema.EmbeddingPropertyConfig.Builder	@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SET_DESCRIPTION) setDescription(@NonNull String description) Sets a natural language description of this property.
@NonNull AppSearchSchema.EmbeddingPropertyConfig.Builder	setIndexingType(int indexingType) Configures how a property should be indexed so that it can be retrieved by queries.

Public constructors

Builder

Added in 1.1.0-alpha06

public Builder(@NonNull String propertyName)

Creates a new EmbeddingPropertyConfig.Builder.

Public methods

build

Added in 1.1.0-alpha06

public @NonNull AppSearchSchema.EmbeddingPropertyConfig build()

Constructs a new EmbeddingPropertyConfig from the contents of this builder.

setCardinality

Added in 1.1.0-alpha06

public @NonNull AppSearchSchema.EmbeddingPropertyConfig.Builder setCardinality(int cardinality)

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)
public @NonNull AppSearchSchema.EmbeddingPropertyConfig.Builder setDescription(@NonNull String description)

Sets a natural language description of this property.

For more details about the description field, see getDescription.

setIndexingType

Added in 1.1.0-alpha06

public @NonNull AppSearchSchema.EmbeddingPropertyConfig.Builder setIndexingType(int indexingType)

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.