Class Lucene99HnswScalarQuantizedVectorsFormat
java.lang.Object
org.apache.lucene.codecs.KnnVectorsFormat
org.apache.lucene.codecs.lucene99.Lucene99HnswScalarQuantizedVectorsFormat
- All Implemented Interfaces:
NamedSPILoader.NamedSPI
Lucene 9.9 vector format, which encodes numeric vector values into an associated graph connecting
the documents having values. The graph is used to power HNSW search. The format consists of two
files, and uses
Lucene99ScalarQuantizedVectorsFormat
to store the actual vectors: For
details on graph storage and file extensions, see Lucene99HnswVectorsFormat
.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Field Summary
Fields inherited from class org.apache.lucene.codecs.KnnVectorsFormat
DEFAULT_MAX_DIMENSIONS, EMPTY
-
Constructor Summary
ConstructorDescriptionConstructs a format using default graph construction parametersLucene99HnswScalarQuantizedVectorsFormat
(int maxConn, int beamWidth) Constructs a format using the given graph construction parameters.Lucene99HnswScalarQuantizedVectorsFormat
(int maxConn, int beamWidth, int numMergeWorkers, Float confidenceInterval, ExecutorService mergeExec) Constructs a format using the given graph construction parameters and scalar quantization. -
Method Summary
Modifier and TypeMethodDescriptionfieldsReader
(SegmentReadState state) Returns aKnnVectorsReader
to read the vectors from the index.fieldsWriter
(SegmentWriteState state) Returns aKnnVectorsWriter
to write the vectors to the index.int
getMaxDimensions
(String fieldName) Returns the maximum number of vector dimensions supported by this codec for the given field nametoString()
Methods inherited from class org.apache.lucene.codecs.KnnVectorsFormat
forName, getName
-
Constructor Details
-
Lucene99HnswScalarQuantizedVectorsFormat
public Lucene99HnswScalarQuantizedVectorsFormat()Constructs a format using default graph construction parameters -
Lucene99HnswScalarQuantizedVectorsFormat
public Lucene99HnswScalarQuantizedVectorsFormat(int maxConn, int beamWidth) Constructs a format using the given graph construction parameters.- Parameters:
maxConn
- the maximum number of connections to a node in the HNSW graphbeamWidth
- the size of the queue maintained during graph construction.
-
Lucene99HnswScalarQuantizedVectorsFormat
public Lucene99HnswScalarQuantizedVectorsFormat(int maxConn, int beamWidth, int numMergeWorkers, Float confidenceInterval, ExecutorService mergeExec) Constructs a format using the given graph construction parameters and scalar quantization.- Parameters:
maxConn
- the maximum number of connections to a node in the HNSW graphbeamWidth
- the size of the queue maintained during graph construction.numMergeWorkers
- number of workers (threads) that will be used when doing merge. If larger than 1, a non-nullExecutorService
must be passed as mergeExecconfidenceInterval
- the confidenceInterval for scalar quantizing the vectors, when `null` it is calculated based on the vector field dimensions.mergeExec
- theExecutorService
that will be used by ALL vector writers that are generated by this format to do the merge
-
-
Method Details
-
fieldsWriter
Description copied from class:KnnVectorsFormat
Returns aKnnVectorsWriter
to write the vectors to the index.- Specified by:
fieldsWriter
in classKnnVectorsFormat
- Throws:
IOException
-
fieldsReader
Description copied from class:KnnVectorsFormat
Returns aKnnVectorsReader
to read the vectors from the index.- Specified by:
fieldsReader
in classKnnVectorsFormat
- Throws:
IOException
-
getMaxDimensions
Description copied from class:KnnVectorsFormat
Returns the maximum number of vector dimensions supported by this codec for the given field nameCodecs should override this method to specify the maximum number of dimensions they support.
- Overrides:
getMaxDimensions
in classKnnVectorsFormat
- Parameters:
fieldName
- the field name- Returns:
- the maximum number of vector dimensions.
-
toString
-