Package co.elastic.clients.elasticsearch._types.mapping

Enum Class DenseVectorIndexOptionsType

java.lang.Object

java.lang.Enum<DenseVectorIndexOptionsType>

co.elastic.clients.elasticsearch._types.mapping.DenseVectorIndexOptionsType

All Implemented Interfaces:

JsonEnum, JsonpSerializable, Serializable, Comparable<DenseVectorIndexOptionsType>, Constable

@JsonpDeserializable
public enum DenseVectorIndexOptionsType
extends Enum<DenseVectorIndexOptionsType>
implements JsonEnum

See Also:

• API specification

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface co.elastic.clients.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BbqFlat	This utilizes a brute-force search algorithm in addition to automatically quantizing to binary vectors.
BbqHnsw	This utilizes the HNSW algorithm in addition to automatic binary quantization for scalable approximate kNN search with element_type of float.
Flat	This utilizes a brute-force search algorithm for exact kNN search.
Hnsw	This utilizes the HNSW algorithm for scalable approximate kNN search.
Int4Flat	This utilizes a brute-force search algorithm in addition to automatically half-byte scalar quantization.
Int4Hnsw	This utilizes the HNSW algorithm in addition to automatically scalar quantization for scalable approximate kNN search with element_type of float.
Int8Flat	This utilizes a brute-force search algorithm in addition to automatically scalar quantization.
Int8Hnsw	The default index type for float vectors.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonEnum.Deserializer<DenseVectorIndexOptionsType>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
String	jsonValue()
static DenseVectorIndexOptionsType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DenseVectorIndexOptionsType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.JsonEnum

aliases, serialize

Enum Constant Details

BbqFlat

public static final DenseVectorIndexOptionsType BbqFlat

This utilizes a brute-force search algorithm in addition to automatically quantizing to binary vectors. Only supports element_type of float.

BbqHnsw

public static final DenseVectorIndexOptionsType BbqHnsw

This utilizes the HNSW algorithm in addition to automatic binary quantization for scalable approximate kNN search with element_type of float.

This can reduce the memory footprint by nearly 32x at the cost of some accuracy.

Flat

public static final DenseVectorIndexOptionsType Flat

This utilizes a brute-force search algorithm for exact kNN search. This supports all element_type values.

Hnsw

public static final DenseVectorIndexOptionsType Hnsw

This utilizes the HNSW algorithm for scalable approximate kNN search. This supports all element_type values.

Int4Flat

public static final DenseVectorIndexOptionsType Int4Flat

This utilizes a brute-force search algorithm in addition to automatically half-byte scalar quantization. Only supports element_type of float.

Int4Hnsw

public static final DenseVectorIndexOptionsType Int4Hnsw

This utilizes the HNSW algorithm in addition to automatically scalar quantization for scalable approximate kNN search with element_type of float.

This can reduce the memory footprint by 8x at the cost of some accuracy.

Int8Flat

public static final DenseVectorIndexOptionsType Int8Flat

This utilizes a brute-force search algorithm in addition to automatically scalar quantization. Only supports element_type of float.

Int8Hnsw

public static final DenseVectorIndexOptionsType Int8Hnsw

The default index type for float vectors. This utilizes the HNSW algorithm in addition to automatically scalar quantization for scalable approximate kNN search with element_type of float.

This can reduce the memory footprint by 4x at the cost of some accuracy.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<DenseVectorIndexOptionsType> _DESERIALIZER

Method Details

values

public static DenseVectorIndexOptionsType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DenseVectorIndexOptionsType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

jsonValue

public String jsonValue()

Specified by:

jsonValue in interface JsonEnum