Package org.hibernate.search.backend.lucene.types.codec.impl

Interface LuceneVectorFieldCodec<F>

Type Parameters:

F - The field type exposed to the mapper.

All Superinterfaces:

LuceneFieldCodec<F,F>

All Known Implementing Classes:

AbstractLuceneVectorFieldCodec, LuceneByteVectorCodec, LuceneFloatVectorCodec

public interface LuceneVectorFieldCodec<F>
extends LuceneFieldCodec<F,F>

Vector field specific codec that allows redefining KnnVectorsFormat.

Method Summary

Modifier and Type	Method	Description
int	getConfiguredDimensions()
org.apache.lucene.index.VectorSimilarityFunction	getVectorSimilarity()
org.apache.lucene.codecs.KnnVectorsFormat	knnVectorFormat()	Custom knn vector format that will be used in PerFieldKnnVectorsFormat and can for example define custom efConstruction or m or even provide a completely custom implementation (needs to be registered via ServiceLoader mechanism).
float	similarityDistanceToScore(float similarity)
Class<?>	vectorElementsType()

Methods inherited from interface org.hibernate.search.backend.lucene.types.codec.impl.LuceneFieldCodec

addToDocument, decode, decode, encode, encodedType, isCompatibleWith, raw

Method Details

knnVectorFormat

org.apache.lucene.codecs.KnnVectorsFormat knnVectorFormat()

Custom knn vector format that will be used in PerFieldKnnVectorsFormat and can for example define custom efConstruction or m or even provide a completely custom implementation (needs to be registered via ServiceLoader mechanism).

vectorElementsType

Class<?> vectorElementsType()

Returns:

The type of vector elements expected to get either float.class or byte.class.

getConfiguredDimensions

int getConfiguredDimensions()

Returns:

The number of dimensions (array length) of vectors to be indexed that this codec can process.

getVectorSimilarity

org.apache.lucene.index.VectorSimilarityFunction getVectorSimilarity()

Returns:

The vector similarity function used by this codec.

similarityDistanceToScore

float similarityDistanceToScore(float similarity)