Uses of Enum Class
org.apache.lucene.index.VectorSimilarityFunction
Packages that use VectorSimilarityFunction
Package
Description
Lucene 9.0 file format.
Lucene 9.1 file format.
Lucene 9.2 file format.
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.
Code to search indices.
Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.
-
Uses of VectorSimilarityFunction in org.apache.lucene.backward_codecs.lucene90
Fields in org.apache.lucene.backward_codecs.lucene90 declared as VectorSimilarityFunctionModifier and TypeFieldDescriptionprivate final VectorSimilarityFunction
Lucene90HnswGraphBuilder.similarityFunction
(package private) final VectorSimilarityFunction
Lucene90HnswVectorsReader.FieldEntry.similarityFunction
Methods in org.apache.lucene.backward_codecs.lucene90 that return VectorSimilarityFunctionModifier and TypeMethodDescriptionprivate static VectorSimilarityFunction
Lucene90FieldInfosFormat.getDistFunc
(IndexInput input, byte b) private VectorSimilarityFunction
Lucene90HnswVectorsReader.readSimilarityFunction
(DataInput input) Methods in org.apache.lucene.backward_codecs.lucene90 with parameters of type VectorSimilarityFunctionModifier and TypeMethodDescriptionstatic NeighborQueue
Lucene90OnHeapHnswGraph.search
(float[] query, int topK, int numSeed, RandomAccessVectorValues vectors, VectorSimilarityFunction similarityFunction, HnswGraph graphValues, Bits acceptOrds, int visitedLimit, SplittableRandom random) Searches for the nearest neighbors of a query vector.Constructors in org.apache.lucene.backward_codecs.lucene90 with parameters of type VectorSimilarityFunctionModifierConstructorDescription(package private)
FieldEntry
(DataInput input, VectorSimilarityFunction similarityFunction) Lucene90HnswGraphBuilder
(RandomAccessVectorValues vectors, VectorSimilarityFunction similarityFunction, int maxConn, 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. -
Uses of VectorSimilarityFunction in org.apache.lucene.backward_codecs.lucene91
Fields in org.apache.lucene.backward_codecs.lucene91 declared as VectorSimilarityFunctionModifier and TypeFieldDescription(package private) final VectorSimilarityFunction
Lucene91HnswVectorsReader.FieldEntry.similarityFunction
Methods in org.apache.lucene.backward_codecs.lucene91 that return VectorSimilarityFunctionModifier and TypeMethodDescriptionprivate VectorSimilarityFunction
Lucene91HnswVectorsReader.readSimilarityFunction
(DataInput input) Constructors in org.apache.lucene.backward_codecs.lucene91 with parameters of type VectorSimilarityFunctionModifierConstructorDescription(package private)
FieldEntry
(DataInput input, VectorSimilarityFunction similarityFunction) -
Uses of VectorSimilarityFunction in org.apache.lucene.backward_codecs.lucene92
Fields in org.apache.lucene.backward_codecs.lucene92 declared as VectorSimilarityFunctionModifier and TypeFieldDescription(package private) final VectorSimilarityFunction
Lucene92HnswVectorsReader.FieldEntry.similarityFunction
Methods in org.apache.lucene.backward_codecs.lucene92 that return VectorSimilarityFunctionModifier and TypeMethodDescriptionprivate VectorSimilarityFunction
Lucene92HnswVectorsReader.readSimilarityFunction
(DataInput input) Constructors in org.apache.lucene.backward_codecs.lucene92 with parameters of type VectorSimilarityFunctionModifierConstructorDescription(package private)
FieldEntry
(IndexInput input, VectorSimilarityFunction similarityFunction) -
Uses of VectorSimilarityFunction in org.apache.lucene.codecs.lucene94
Fields in org.apache.lucene.codecs.lucene94 declared as VectorSimilarityFunctionModifier and TypeFieldDescription(package private) final VectorSimilarityFunction
Lucene94HnswVectorsReader.FieldEntry.similarityFunction
Methods in org.apache.lucene.codecs.lucene94 that return VectorSimilarityFunctionModifier and TypeMethodDescriptionprivate static VectorSimilarityFunction
Lucene94FieldInfosFormat.getDistFunc
(IndexInput input, byte b) private VectorSimilarityFunction
Lucene94HnswVectorsReader.readSimilarityFunction
(DataInput input) Constructors in org.apache.lucene.codecs.lucene94 with parameters of type VectorSimilarityFunctionModifierConstructorDescription(package private)
FieldEntry
(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) -
Uses of VectorSimilarityFunction in org.apache.lucene.codecs.simpletext
Methods in org.apache.lucene.codecs.simpletext that return VectorSimilarityFunctionModifier and TypeMethodDescriptionSimpleTextFieldInfosFormat.distanceFunction
(String scoreFunction) -
Uses of VectorSimilarityFunction in org.apache.lucene.document
Fields in org.apache.lucene.document declared as VectorSimilarityFunctionModifier and TypeFieldDescriptionprivate VectorSimilarityFunction
FieldType.vectorSimilarityFunction
Methods in org.apache.lucene.document that return VectorSimilarityFunctionMethods in org.apache.lucene.document with parameters of type VectorSimilarityFunctionModifier and TypeMethodDescriptionstatic FieldType
KnnVectorField.createFieldType
(int dimension, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) A convenience method for creating a vector field type.static FieldType
KnnVectorField.createFieldType
(int dimension, VectorSimilarityFunction similarityFunction) A convenience method for creating a vector field type with the default FLOAT32 encoding.private static FieldType
KnnVectorField.createType
(float[] v, VectorSimilarityFunction similarityFunction) private static FieldType
KnnVectorField.createType
(int dimension, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) private static FieldType
KnnVectorField.createType
(BytesRef v, VectorSimilarityFunction similarityFunction) void
FieldType.setVectorAttributes
(int numDimensions, VectorEncoding encoding, VectorSimilarityFunction similarity) Enable vector indexing, with the specified number of dimensions and distance function.Constructors in org.apache.lucene.document with parameters of type VectorSimilarityFunctionModifierConstructorDescriptionKnnVectorField
(String name, float[] vector, VectorSimilarityFunction similarityFunction) Creates a numeric vector field.KnnVectorField
(String name, BytesRef vector, VectorSimilarityFunction similarityFunction) Creates a numeric vector field. -
Uses of VectorSimilarityFunction in org.apache.lucene.index
Fields in org.apache.lucene.index declared as VectorSimilarityFunctionModifier and TypeFieldDescription(package private) final VectorSimilarityFunction
FieldInfos.FieldVectorProperties.similarityFunction
private final VectorSimilarityFunction
FieldInfo.vectorSimilarityFunction
private VectorSimilarityFunction
IndexingChain.FieldSchema.vectorSimilarityFunction
Methods in org.apache.lucene.index that return VectorSimilarityFunctionModifier and TypeMethodDescriptionFieldInfo.getVectorSimilarityFunction()
ReturnsVectorSimilarityFunction
for the fieldstatic VectorSimilarityFunction
Returns the enum constant of this class with the specified name.static VectorSimilarityFunction[]
VectorSimilarityFunction.values()
Returns an array containing the constants of this enum class, in the order they are declared.IndexableFieldType.vectorSimilarityFunction()
TheVectorSimilarityFunction
of the field's vector valueMethods in org.apache.lucene.index with parameters of type VectorSimilarityFunctionModifier 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 VectorSimilarityFunctionModifierConstructorDescriptionFieldInfo
(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 VectorSimilarityFunction in org.apache.lucene.search
Fields in org.apache.lucene.search declared as VectorSimilarityFunctionModifier and TypeFieldDescriptionprotected final VectorSimilarityFunction
VectorScorer.similarity
Constructors in org.apache.lucene.search with parameters of type VectorSimilarityFunctionModifierConstructorDescriptionprotected
ByteVectorScorer
(VectorValues values, float[] query, VectorSimilarityFunction similarity) protected
FloatVectorScorer
(VectorValues values, float[] query, VectorSimilarityFunction similarity) (package private)
VectorScorer
(VectorValues values, VectorSimilarityFunction similarity) -
Uses of VectorSimilarityFunction in org.apache.lucene.util.hnsw
Fields in org.apache.lucene.util.hnsw declared as VectorSimilarityFunctionModifier and TypeFieldDescriptionprivate final VectorSimilarityFunction
HnswGraphBuilder.similarityFunction
private final VectorSimilarityFunction
HnswGraphSearcher.similarityFunction
Methods in org.apache.lucene.util.hnsw with parameters of type VectorSimilarityFunctionModifier 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 VectorSimilarityFunctionModifierConstructorDescriptionprivate
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.