org.apache.lucene.codecs.hnsw (Lucene 10.5.1 core API)
Description: declaration: package: org.apache.lucene.codecs.hnsw

# Package org.apache.lucene.codecs.hnsw

package org.apache.lucene.codecs.hnsw
HNSW vector helper classes. The classes in this package provide a scoring and storing mechanism for vectors stored in a flat file. This allows for HNSW formats to be extended with other flat storage formats or scoring without significant changes to the HNSW code. Some examples for scoring include `ScalarQuantizedVectorScorer` and `DefaultFlatVectorScorer`. Some examples for storing include `Lucene99FlatVectorsFormat`.

- Related Packages
  Package
  Description
  org.apache.lucene.codecs
  Codecs API: API for customization of the encoding and structure of the index.
- Class
  Description
  DefaultFlatVectorScorer
  Default implementation of `FlatVectorsScorer`.
  FlatFieldVectorsWriter<T>
  Vectors' writer for a field
  FlatVectorScorerUtil
  Utilities for `FlatVectorsScorer`.
  FlatVectorsFormat
  Encodes/decodes per-document vectors and provides a scoring interface for the flat stored vectors
  FlatVectorsReader
  Reads vectors from an index.
  FlatVectorsScorer
  Provides mechanisms to score vectors that are stored in a flat file The purpose of this class is for providing flexibility to the codec utilizing the vectors
  FlatVectorsWriter
  Vectors' writer for a field that allows additional indexing logic to be implemented by the caller
  HnswGraphProvider
  An interface that provides an HNSW graph.
  PrefetchableFlatVectorScorer
  A `FlatVectorsScorer` wrapper that enables prefetching of vector data before scoring.
  ScalarQuantizedVectorScorer
  Default scalar quantized implementation of `FlatVectorsScorer`.
  ScalarQuantizedVectorScorer.ScalarQuantizedRandomVectorScorerSupplier
  Quantized vector scorer supplier