EmbeddingPropertyConfig

Kotlin |Java

class EmbeddingPropertyConfig : AppSearchSchema.PropertyConfig

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

Configuration for a property of type EmbeddingVector in a Document.

Summary

Nested classes
	`Builder` Builder for `EmbeddingPropertyConfig`.

Constants
static Int	`INDEXING_TYPE_NONE` Content in this property will not be indexed.
static Int	`INDEXING_TYPE_SIMILARITY` Embedding vectors in this property will be indexed.
static Int	`QUANTIZATION_TYPE_8_BIT` Contents in this property will be quantized to 8 bits.
static Int	`QUANTIZATION_TYPE_NONE` Contents in this property will not be quantized.

Inherited constants

From class PropertyConfig

Int

CARDINALITY_OPTIONAL

Zero or one value [0,1].

Int

CARDINALITY_REPEATED

Any number of items (including zero) [0...*].

Int

CARDINALITY_REQUIRED

Exactly one value [1].

Public methods
Int	`getIndexingType()` Returns how the property is indexed.
Int	`getQuantizationType()` Returns how the embedding contents of this property should be quantized.

Inherited functions

From class PropertyConfig

`Boolean`	`equals(other: Any?)` 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`	`getCardinality()` Returns the cardinality of the property (whether it is optional, required or repeated).
`String`	`getName()` Returns the name of this property.
`Int`	`hashCode()`
`String`	`toString()` Returns a string representation of the object.

static val INDEXING_TYPE_NONE: Int

Content in this property will not be indexed.

Value: 0

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

static val QUANTIZATION_TYPE_8_BIT: Int

Contents in this property will be quantized to 8 bits.

Value: 1

static val QUANTIZATION_TYPE_NONE: Int

Contents in this property will not be quantized.

Value: 0

fun getIndexingType(): Int

Returns how the property is indexed.

Return
`Int`	Value is `android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#INDEXING_TYPE_NONE`, or `android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#INDEXING_TYPE_SIMILARITY`

fun getQuantizationType(): Int

Returns how the embedding contents of this property should be quantized.

If the property isn't indexed, returns QUANTIZATION_TYPE_NONE.

Return
`Int`	Value is `android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#QUANTIZATION_TYPE_NONE`, or `android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#QUANTIZATION_TYPE_8_BIT`