Class Lucene99ScalarQuantizedVectorsFormat

java.lang.Object
org.apache.lucene.codecs.hnsw.FlatVectorsFormat
org.apache.lucene.codecs.lucene99.Lucene99ScalarQuantizedVectorsFormat

public class Lucene99ScalarQuantizedVectorsFormat extends FlatVectorsFormat
Format supporting vector quantization, storage, and retrieval
  • Field Details

  • Constructor Details

    • Lucene99ScalarQuantizedVectorsFormat

      public Lucene99ScalarQuantizedVectorsFormat()
      Constructs a format using default graph construction parameters
    • Lucene99ScalarQuantizedVectorsFormat

      public Lucene99ScalarQuantizedVectorsFormat(Float confidenceInterval, int bits, boolean compress)
      Constructs a format using the given graph construction parameters.
      Parameters:
      confidenceInterval - the confidenceInterval for scalar quantizing the vectors, when `null` it is calculated based on the vector dimension. When `0`, the quantiles are dynamically determined by sampling many confidence intervals and determining the most accurate pair.
      bits - the number of bits to use for scalar quantization (must be between 1 and 8, inclusive)
      compress - whether to compress the vectors, if true, the vectors that are quantized with lte 4 bits will be compressed into a single byte. If false, the vectors will be stored as is. This provides a trade-off of memory usage and speed.
  • Method Details