Uses of Enum Class
org.apache.lucene.index.VectorEncoding
Packages that use VectorEncoding
Package
Description
Lucene 9.3 file format.
Simpletext Codec: writes human readable postings.
The logical representation of a
Document
for indexing and
searching.Code to maintain and access indices.
Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.
-
Uses of VectorEncoding in org.apache.lucene.codecs.lucene94
Fields in org.apache.lucene.codecs.lucene94 declared as VectorEncodingModifier and TypeFieldDescription(package private) final VectorEncoding
Lucene94HnswVectorsReader.FieldEntry.vectorEncoding
Methods in org.apache.lucene.codecs.lucene94 that return VectorEncodingModifier and TypeMethodDescriptionprivate static VectorEncoding
Lucene94FieldInfosFormat.getVectorEncoding
(IndexInput input, byte b) private VectorEncoding
Lucene94HnswVectorsReader.readVectorEncoding
(DataInput input) Constructors in org.apache.lucene.codecs.lucene94 with parameters of type VectorEncodingModifierConstructorDescription(package private)
FieldEntry
(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) -
Uses of VectorEncoding in org.apache.lucene.codecs.simpletext
Methods in org.apache.lucene.codecs.simpletext that return VectorEncodingModifier and TypeMethodDescriptionSimpleTextFieldInfosFormat.vectorEncoding
(String vectorEncoding) -
Uses of VectorEncoding in org.apache.lucene.document
Fields in org.apache.lucene.document declared as VectorEncodingMethods in org.apache.lucene.document that return VectorEncodingMethods in org.apache.lucene.document with parameters of type VectorEncodingModifier and TypeMethodDescriptionstatic FieldType
KnnVectorField.createFieldType
(int dimension, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) A convenience method for creating a vector field type.private static FieldType
KnnVectorField.createType
(int dimension, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) void
FieldType.setVectorAttributes
(int numDimensions, VectorEncoding encoding, VectorSimilarityFunction similarity) Enable vector indexing, with the specified number of dimensions and distance function. -
Uses of VectorEncoding in org.apache.lucene.index
Fields in org.apache.lucene.index declared as VectorEncodingModifier and TypeFieldDescriptionprivate final VectorEncoding
FieldInfo.vectorEncoding
(package private) final VectorEncoding
FieldInfos.FieldVectorProperties.vectorEncoding
private VectorEncoding
IndexingChain.FieldSchema.vectorEncoding
Methods in org.apache.lucene.index that return VectorEncodingModifier and TypeMethodDescriptionFieldInfo.getVectorEncoding()
Returns the number of dimensions of the vector valuestatic VectorEncoding
Returns the enum constant of this class with the specified name.static VectorEncoding[]
VectorEncoding.values()
Returns an array containing the constants of this enum class, in the order they are declared.IndexableFieldType.vectorEncoding()
TheVectorEncoding
of the field's vector valueMethods in org.apache.lucene.index with parameters of type VectorEncodingModifier and TypeMethodDescription(package private) void
IndexingChain.FieldSchema.setVectors
(VectorEncoding encoding, VectorSimilarityFunction similarityFunction, int dimension) (package private) static void
FieldInfo.verifySameVectorOptions
(String fieldName, int vd1, VectorEncoding ve1, VectorSimilarityFunction vsf1, int vd2, VectorEncoding ve2, VectorSimilarityFunction vsf2) Verify that the provided vector indexing options are the sameConstructors in org.apache.lucene.index with parameters of type VectorEncodingModifierConstructorDescriptionFieldInfo
(String name, int number, boolean storeTermVector, boolean omitNorms, boolean storePayloads, IndexOptions indexOptions, DocValuesType docValues, long dvGen, Map<String, String> attributes, int pointDimensionCount, int pointIndexDimensionCount, int pointNumBytes, int vectorDimension, VectorEncoding vectorEncoding, VectorSimilarityFunction vectorSimilarityFunction, boolean softDeletesField) Sole constructor.(package private)
FieldVectorProperties
(int numDimensions, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) -
Uses of VectorEncoding in org.apache.lucene.util.hnsw
Fields in org.apache.lucene.util.hnsw declared as VectorEncodingModifier and TypeFieldDescriptionprivate final VectorEncoding
HnswGraphBuilder.vectorEncoding
private final VectorEncoding
HnswGraphSearcher.vectorEncoding
Methods in org.apache.lucene.util.hnsw with parameters of type VectorEncodingModifier and TypeMethodDescriptionstatic HnswGraphBuilder<?>
HnswGraphBuilder.create
(RandomAccessVectorValues vectors, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction, int M, int beamWidth, long seed) static NeighborQueue
HnswGraphSearcher.search
(float[] query, int topK, RandomAccessVectorValues vectors, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction, HnswGraph graph, Bits acceptOrds, int visitedLimit) Searches HNSW graph for the nearest neighbors of a query vector.private static NeighborQueue
HnswGraphSearcher.search
(BytesRef query, int topK, RandomAccessVectorValues vectors, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction, HnswGraph graph, Bits acceptOrds, int visitedLimit) Constructors in org.apache.lucene.util.hnsw with parameters of type VectorEncodingModifierConstructorDescriptionprivate
HnswGraphBuilder
(RandomAccessVectorValues vectors, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction, int M, int beamWidth, long seed) Reads all the vectors from a VectorValues, builds a graph connecting them by their dense ordinals, using the given hyperparameter settings, and returns the resulting graph.HnswGraphSearcher
(VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction, NeighborQueue candidates, BitSet visited) Creates a new graph searcher.