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

Class DenseVectorIndexOptions

java.lang.Object
co.elastic.clients.elasticsearch._types.mapping.DenseVectorIndexOptions
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class DenseVectorIndexOptions extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

      public static DenseVectorIndexOptions of(Function<DenseVectorIndexOptions.Builder,ObjectBuilder<DenseVectorIndexOptions>> fn)

    • confidenceInterval

      @Nullable public final Float confidenceInterval()
      The confidence interval to use when quantizing the vectors. Can be any value between and including 0.90 and 1.0 or exactly 0. When the value is 0, this indicates that dynamic quantiles should be calculated for optimized quantization. When between 0.90 and 1.0, this value restricts the values used when calculating the quantization thresholds.

      For example, a value of 0.95 will only use the middle 95% of the values when calculating the quantization thresholds (e.g. the highest and lowest 2.5% of values will be ignored).

      Defaults to 1/(dims + 1) for int8 quantized vectors and 0 for int4 for dynamic quantile calculation.

      Only applicable to int8_hnsw, int4_hnsw, int8_flat, and int4_flat index types.

      API name: confidence_interval

    • efConstruction

      @Nullable public final Integer efConstruction()
      The number of candidates to track while assembling the list of nearest neighbors for each new node.

      Only applicable to hnsw, int8_hnsw, bbq_hnsw, and int4_hnsw index types.

      API name: ef_construction

    • m

      @Nullable public final Integer m()
      The number of neighbors each node will be connected to in the HNSW graph.

      Only applicable to hnsw, int8_hnsw, bbq_hnsw, and int4_hnsw index types.

      API name: m

    • type

      public final DenseVectorIndexOptionsType type()
      Required - The type of kNN algorithm to use.

      API name: type

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupDenseVectorIndexOptionsDeserializer

      protected static void setupDenseVectorIndexOptionsDeserializer(ObjectDeserializer<DenseVectorIndexOptions.Builder> op)