Uses of Enum
org.apache.lucene.index.VectorSimilarityFunction
Packages that use VectorSimilarityFunction
Package
Description
The logical representation of a
Document
for indexing and
searching.Code to maintain and access indices.
Some utility classes.
Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.
-
Uses of VectorSimilarityFunction in org.apache.lucene.document
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.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
Methods in org.apache.lucene.index that return VectorSimilarityFunctionModifier and TypeMethodDescriptionFieldInfo.getVectorSimilarityFunction()
ReturnsVectorSimilarityFunction
for the fieldstatic VectorSimilarityFunction
Returns the enum constant of this type with the specified name.static VectorSimilarityFunction[]
VectorSimilarityFunction.values()
Returns an array containing the constants of this enum type, in the order they are declared.IndexableFieldType.vectorSimilarityFunction()
TheVectorSimilarityFunction
of the field's vector valueConstructors 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. -
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
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.