Stay organized with collections
Save and categorize content based on your preferences.
EmbeddingPropertyConfig
class EmbeddingPropertyConfig : AppSearchSchema.PropertyConfig
Configuration for a property of type EmbeddingVector in a Document.
Summary
| Constants |
| static Int |
Content in this property will not be indexed.
|
| static Int |
Embedding vectors in this property will be indexed.
|
| static Int |
Contents in this property will be quantized to 8 bits.
|
| static Int |
Contents in this property will not be quantized.
|
| Public methods |
| Int |
Returns how the property is indexed.
|
| Int |
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 |
getDescription()
Returns a natural language description of this property.
Ex. The description for the "homeAddress" property of a "Person" type could be "the address at which this person lives".
This information is purely to help apps consuming this type the semantic meaning of its properties. This field has no effect in AppSearch - it is just stored with the AppSearchSchema. If the description is not set, then this method will return an empty string.
|
String |
getName()
Returns the name of this property.
|
Int |
hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the
equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
- It is not required that if two objects are unequal according to the
equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
|
String |
toString()
Returns a string representation of the object.
|
|
Constants
INDEXING_TYPE_NONE
static val INDEXING_TYPE_NONE: Int
Content in this property will not be indexed.
Value: 0
INDEXING_TYPE_SIMILARITY
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
QUANTIZATION_TYPE_8_BIT
static val QUANTIZATION_TYPE_8_BIT: Int
Contents in this property will be quantized to 8 bits.
Value: 1
QUANTIZATION_TYPE_NONE
static val QUANTIZATION_TYPE_NONE: Int
Contents in this property will not be quantized.
Value: 0
Public methods
getIndexingType
fun getIndexingType(): Int
Returns how the property is indexed.
| Return |
Int |
Value is one of the following:
|
getQuantizationType
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 one of the following:
|
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2026-02-13 UTC.
[null,null,["Last updated 2026-02-13 UTC."],[],[]]