AppSearchSchema.EmbeddingPropertyConfig


public static final class AppSearchSchema.EmbeddingPropertyConfig
extends AppSearchSchema.PropertyConfig

java.lang.Object
   ↳ android.app.appsearch.AppSearchSchema.PropertyConfig
     ↳ android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig


Configuration for a property of type EmbeddingVector in a Document.

Summary

Constants

int INDEXING_TYPE_NONE

Content in this property will not be indexed.

int INDEXING_TYPE_SIMILARITY

Embedding vectors in this property will be indexed.

int QUANTIZATION_TYPE_8_BIT

Contents in this property will be quantized to 8 bits.

int QUANTIZATION_TYPE_NONE

Contents in this property will not be quantized.

Inherited constants

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 methods

boolean equals(Object other)

Indicates whether some other object is "equal to" this one.

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()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

INDEXING_TYPE_NONE

Added in T Extensions 16
public static final int INDEXING_TYPE_NONE

Content in this property will not be indexed.

Constant Value: 0 (0x00000000)

INDEXING_TYPE_SIMILARITY

Added in T Extensions 16
public static final int INDEXING_TYPE_SIMILARITY

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.

Constant Value: 1 (0x00000001)

QUANTIZATION_TYPE_8_BIT

Added in T Extensions 16
public static final int QUANTIZATION_TYPE_8_BIT

Contents in this property will be quantized to 8 bits.

Constant Value: 1 (0x00000001)

QUANTIZATION_TYPE_NONE

Added in T Extensions 16
public static final int QUANTIZATION_TYPE_NONE

Contents in this property will not be quantized.

Constant Value: 0 (0x00000000)

Public methods

getIndexingType

Added in T Extensions 16
public int getIndexingType ()

Returns how the property is indexed.

Returns
int Value is INDEXING_TYPE_NONE, or INDEXING_TYPE_SIMILARITY

getQuantizationType

public int getQuantizationType ()

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

If the property isn't indexed, returns QUANTIZATION_TYPE_NONE.