Document.EmbeddingProperty
@Documented
@Retention(value = RetentionPolicy.CLASS)
@Target(value = [ElementType.FIELD, ElementType.METHOD])
public annotation Document.EmbeddingProperty
Configures an EmbeddingVector field of a class as a property known to AppSearch.
Summary
Public methods |
|
|---|---|
abstract int |
Configures how a property should be indexed so that it can be retrieved by queries. |
abstract String |
name()The name of this property. |
abstract int |
Configures whether the embedding vectors in this property should be quantized. |
abstract boolean |
required()Configures whether this property must be specified for the document to be valid. |
Public methods
indexingType
public abstract int indexingType()
Configures how a property should be indexed so that it can be retrieved by queries.
If not specified, defaults to INDEXING_TYPE_NONE (the field will not be indexed and cannot be queried).
name
public abstract String name()
The name of this property. This string is used to query against this property.
If not specified, the name of the field in the code will be used instead.
quantizationType
@ExperimentalAppSearchApi
public abstract int quantizationType()
Configures whether the embedding vectors in this property should be quantized.
If not specified, defaults to QUANTIZATION_TYPE_NONE (contents in this property will not be quantized.).
required
public abstract boolean required()
Configures whether this property must be specified for the document to be valid.
This attribute does not apply to properties of a repeated type (e.g. a list).
Please make sure you understand the consequences of required fields on schema migration before setting this attribute to true.