Uses of Enum Class
org.apache.lucene.index.VectorSimilarityFunction
Packages that use VectorSimilarityFunction
Package
Description
Analysis components for Synonyms using Word2Vec model.
Lucene 9.0 file format.
Lucene 9.1 file format.
Lucene 9.2 file format.
Lucene 9.4 file format.
Lucene 9.5 file format.
Lucene 9.4 file format.
Lucene 9.9 file format.
Simpletext Codec: writes human readable postings.
The logical representation of a
Document
for indexing and
searching.Code to maintain and access indices.
A variety of functions to use with FunctionQuery.
Code to search indices.
Support for index-time and query-time joins.
Some utility classes.
Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.
-
Uses of VectorSimilarityFunction in org.apache.lucene.analysis.synonym.word2vec
Fields in org.apache.lucene.analysis.synonym.word2vec declared as VectorSimilarityFunctionModifier and TypeFieldDescriptionprivate static final VectorSimilarityFunction
Word2VecSynonymProvider.SIMILARITY_FUNCTION
-
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<float[]> vectors, VectorSimilarityFunction similarityFunction, HnswGraph graphValues, Bits acceptOrds, long 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<float[]> vectors, VectorSimilarityFunction similarityFunction, int maxConn, int beamWidth, long seed) Reads all the vectors from vector values, 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.backward_codecs.lucene94
Fields in org.apache.lucene.backward_codecs.lucene94 declared as VectorSimilarityFunctionModifier and TypeFieldDescription(package private) final VectorSimilarityFunction
Lucene94HnswVectorsReader.FieldEntry.similarityFunction
Methods in org.apache.lucene.backward_codecs.lucene94 that return VectorSimilarityFunctionModifier and TypeMethodDescriptionprivate VectorSimilarityFunction
Lucene94HnswVectorsReader.readSimilarityFunction
(DataInput input) Constructors in org.apache.lucene.backward_codecs.lucene94 with parameters of type VectorSimilarityFunctionModifierConstructorDescription(package private)
FieldEntry
(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) -
Uses of VectorSimilarityFunction in org.apache.lucene.backward_codecs.lucene95
Fields in org.apache.lucene.backward_codecs.lucene95 declared as VectorSimilarityFunctionModifier and TypeFieldDescription(package private) final VectorSimilarityFunction
Lucene95HnswVectorsReader.FieldEntry.similarityFunction
Methods in org.apache.lucene.backward_codecs.lucene95 that return VectorSimilarityFunctionModifier and TypeMethodDescriptionprivate VectorSimilarityFunction
Lucene95HnswVectorsReader.readSimilarityFunction
(DataInput input) Constructors in org.apache.lucene.backward_codecs.lucene95 with parameters of type VectorSimilarityFunctionModifierConstructorDescription(package private)
FieldEntry
(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) -
Uses of VectorSimilarityFunction in org.apache.lucene.codecs.lucene94
Methods in org.apache.lucene.codecs.lucene94 that return VectorSimilarityFunctionModifier and TypeMethodDescriptionprivate static VectorSimilarityFunction
Lucene94FieldInfosFormat.getDistFunc
(IndexInput input, byte b) -
Uses of VectorSimilarityFunction in org.apache.lucene.codecs.lucene99
Fields in org.apache.lucene.codecs.lucene99 declared as VectorSimilarityFunctionModifier and TypeFieldDescription(package private) final VectorSimilarityFunction
Lucene99FlatVectorsReader.FieldEntry.similarityFunction
(package private) final VectorSimilarityFunction
Lucene99HnswVectorsReader.FieldEntry.similarityFunction
(package private) final VectorSimilarityFunction
Lucene99ScalarQuantizedVectorsReader.FieldEntry.similarityFunction
private final VectorSimilarityFunction
Lucene99ScalarQuantizedVectorsWriter.OffsetCorrectedQuantizedByteVectorValues.vectorSimilarityFunction
private final VectorSimilarityFunction
Lucene99ScalarQuantizedVectorsWriter.QuantizedFloatVectorValues.vectorSimilarityFunction
Methods in org.apache.lucene.codecs.lucene99 that return VectorSimilarityFunctionModifier and TypeMethodDescriptionprivate VectorSimilarityFunction
Lucene99FlatVectorsReader.readSimilarityFunction
(DataInput input) private VectorSimilarityFunction
Lucene99HnswVectorsReader.readSimilarityFunction
(DataInput input) private VectorSimilarityFunction
Lucene99ScalarQuantizedVectorsReader.readSimilarityFunction
(DataInput input) Methods in org.apache.lucene.codecs.lucene99 with parameters of type VectorSimilarityFunctionModifier and TypeMethodDescriptionprivate static float
ScalarQuantizedRandomVectorScorer.quantizeQuery
(float[] query, byte[] quantizedQuery, VectorSimilarityFunction similarityFunction, ScalarQuantizer scalarQuantizer) Constructors in org.apache.lucene.codecs.lucene99 with parameters of type VectorSimilarityFunctionModifierConstructorDescription(package private)
FieldEntry
(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) (package private)
FieldEntry
(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) (package private)
FieldEntry
(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) private
OffsetCorrectedQuantizedByteVectorValues
(QuantizedByteVectorValues in, VectorSimilarityFunction vectorSimilarityFunction, ScalarQuantizer scalarQuantizer, ScalarQuantizer oldScalarQuantizer) QuantizedFloatVectorValues
(FloatVectorValues values, VectorSimilarityFunction vectorSimilarityFunction, ScalarQuantizer quantizer) (package private)
ScalarQuantizedRandomVectorScorer
(VectorSimilarityFunction similarityFunction, ScalarQuantizer scalarQuantizer, RandomAccessQuantizedByteVectorValues values, float[] query) (package private)
ScalarQuantizedRandomVectorScorerSupplier
(VectorSimilarityFunction similarityFunction, ScalarQuantizer scalarQuantizer, RandomAccessQuantizedByteVectorValues values) -
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
KnnByteVectorField.createFieldType
(int dimension, VectorSimilarityFunction similarityFunction) A convenience method for creating a vector field type.static FieldType
KnnFloatVectorField.createFieldType
(int dimension, VectorSimilarityFunction similarityFunction) A convenience method for creating a vector field type.private static FieldType
KnnByteVectorField.createType
(byte[] v, VectorSimilarityFunction similarityFunction) private static FieldType
KnnFloatVectorField.createType
(float[] 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 VectorSimilarityFunctionModifierConstructorDescriptionKnnByteVectorField
(String name, byte[] vector, VectorSimilarityFunction similarityFunction) Creates a numeric vector field.KnnFloatVectorField
(String name, float[] vector, VectorSimilarityFunction similarityFunction) Creates a numeric vector field.KnnVectorField
(String name, float[] vector, VectorSimilarityFunction similarityFunction) Deprecated.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.queries.function.valuesource
Fields in org.apache.lucene.queries.function.valuesource declared as VectorSimilarityFunctionModifier and TypeFieldDescriptionprotected final VectorSimilarityFunction
VectorSimilarityFunction.similarityFunction
Constructors in org.apache.lucene.queries.function.valuesource with parameters of type VectorSimilarityFunctionModifierConstructorDescriptionByteVectorSimilarityFunction
(VectorSimilarityFunction similarityFunction, ValueSource vector1, ValueSource vector2) FloatVectorSimilarityFunction
(VectorSimilarityFunction similarityFunction, ValueSource vector1, ValueSource vector2) VectorSimilarityFunction
(VectorSimilarityFunction similarityFunction, ValueSource vector1, ValueSource vector2) -
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
(ByteVectorValues values, byte[] query, VectorSimilarityFunction similarity) protected
FloatVectorScorer
(FloatVectorValues values, float[] query, VectorSimilarityFunction similarity) (package private)
VectorScorer
(VectorSimilarityFunction similarity) -
Uses of VectorSimilarityFunction in org.apache.lucene.search.join
Fields in org.apache.lucene.search.join declared as VectorSimilarityFunctionModifier and TypeFieldDescriptionprivate final VectorSimilarityFunction
DiversifyingChildrenByteKnnVectorQuery.ParentBlockJoinByteVectorScorer.similarity
private final VectorSimilarityFunction
DiversifyingChildrenFloatKnnVectorQuery.DiversifyingChildrenFloatVectorScorer.similarity
Constructors in org.apache.lucene.search.join with parameters of type VectorSimilarityFunctionModifierConstructorDescriptionprotected
DiversifyingChildrenFloatVectorScorer
(FloatVectorValues values, DocIdSetIterator acceptedChildrenIterator, BitSet parentBitSet, float[] query, VectorSimilarityFunction similarity) protected
ParentBlockJoinByteVectorScorer
(ByteVectorValues values, DocIdSetIterator acceptedChildrenIterator, BitSet parentBitSet, byte[] query, VectorSimilarityFunction similarity) -
Uses of VectorSimilarityFunction in org.apache.lucene.util
Methods in org.apache.lucene.util with parameters of type VectorSimilarityFunctionModifier and TypeMethodDescriptionScalarQuantizedVectorSimilarity.fromVectorSimilarity
(VectorSimilarityFunction sim, float constMultiplier) Creates aScalarQuantizedVectorSimilarity
from aVectorSimilarityFunction
and the constant multiplier used for quantization.float
ScalarQuantizer.quantize
(float[] src, byte[] dest, VectorSimilarityFunction similarityFunction) Quantize a float vector into a byte vectorfloat
ScalarQuantizer.recalculateCorrectiveOffset
(byte[] quantizedVector, ScalarQuantizer oldQuantizer, VectorSimilarityFunction similarityFunction) Recalculate the old score corrective value given new current quantiles -
Uses of VectorSimilarityFunction in org.apache.lucene.util.hnsw
Fields in org.apache.lucene.util.hnsw declared as VectorSimilarityFunctionModifier and TypeFieldDescriptionprivate final VectorSimilarityFunction
RandomVectorScorerSupplier.ByteScoringSupplier.similarityFunction
private final VectorSimilarityFunction
RandomVectorScorerSupplier.FloatScoringSupplier.similarityFunction
Methods in org.apache.lucene.util.hnsw with parameters of type VectorSimilarityFunctionModifier and TypeMethodDescriptionstatic RandomVectorScorer
RandomVectorScorer.createBytes
(RandomAccessVectorValues<byte[]> vectors, VectorSimilarityFunction similarityFunction, byte[] query) Creates a default scorer for byte vectors.static RandomVectorScorerSupplier
RandomVectorScorerSupplier.createBytes
(RandomAccessVectorValues<byte[]> vectors, VectorSimilarityFunction similarityFunction) Creates aRandomVectorScorerSupplier
to compare byte vectors.static RandomVectorScorer
RandomVectorScorer.createFloats
(RandomAccessVectorValues<float[]> vectors, VectorSimilarityFunction similarityFunction, float[] query) Creates a default scorer for float vectors.static RandomVectorScorerSupplier
RandomVectorScorerSupplier.createFloats
(RandomAccessVectorValues<float[]> vectors, VectorSimilarityFunction similarityFunction) Creates aRandomVectorScorerSupplier
to compare float vectors.Constructors in org.apache.lucene.util.hnsw with parameters of type VectorSimilarityFunctionModifierConstructorDescriptionprivate
ByteScoringSupplier
(RandomAccessVectorValues<byte[]> vectors, VectorSimilarityFunction similarityFunction) private
FloatScoringSupplier
(RandomAccessVectorValues<float[]> vectors, VectorSimilarityFunction similarityFunction)