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

Interface ElasticsearchVectorFieldCodec<F>

All Superinterfaces:

ElasticsearchFieldCodec<F>

All Known Implementing Classes:

AbstractElasticsearchVectorFieldCodec, ElasticsearchByteVectorFieldCodec, ElasticsearchFloatVectorFieldCodec

public interface ElasticsearchVectorFieldCodec<F>
extends ElasticsearchFieldCodec<F>

Method Summary

Modifier and Type	Method	Description
int	getConfiguredDimensions()
float	scoreToSimilarity(float score)	Convert the score vale to the similarity to be passed to the knn filter.
Class<?>	vectorElementsType()

Methods inherited from interface org.hibernate.search.backend.elasticsearch.types.codec.impl.ElasticsearchFieldCodec

canDecodeArrays, decode, decodeAggregationKey, encode, encodeForAggregation, encodeForMissing, fromJsonElementToString, fromJsonStringToElement, isCompatibleWith

Method Details

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.

scoreToSimilarity

float scoreToSimilarity(float score)

Convert the score vale to the similarity to be passed to the knn filter.