Class SimilarityNormalizer

java.lang.Object

org.springframework.data.jpa.repository.query.SimilarityNormalizer

public class SimilarityNormalizer
extends Object

Normalizes the score returned by a database to a similarity value and vice versa.

Since:

4.0

Author:

Mark Paluch

See Also:

• Similarity

Field Summary

Fields

Modifier and Type	Field	Description
static final SimilarityNormalizer	COSINE	Normalizer for Cosine scores using cosine_distance(…) as the scoring function.
static final SimilarityNormalizer	DOT_PRODUCT	Normalizer for Negative Inner Product (Dot) scores using negative_inner_product(…) as the scoring function.
static final SimilarityNormalizer	EUCLIDEAN	Normalizer for Euclidean scores using euclidean_distance(…) as the scoring function.
static final SimilarityNormalizer	IDENTITY	Identity normalizer for ScoringFunction.unspecified() scoring function without altering the score.

Method Summary

Modifier and Type	Method	Description
static SimilarityNormalizer	get(ScoringFunction scoringFunction)	Lookup a SimilarityNormalizer for a given ScoringFunction.
double	getScore(double similarity)
double	getSimilarity(double score)
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

IDENTITY

public static final SimilarityNormalizer IDENTITY

Identity normalizer for ScoringFunction.unspecified() scoring function without altering the score.

EUCLIDEAN

public static final SimilarityNormalizer EUCLIDEAN

Normalizer for Euclidean scores using euclidean_distance(…) as the scoring function.

COSINE

public static final SimilarityNormalizer COSINE

Normalizer for Cosine scores using cosine_distance(…) as the scoring function.

DOT_PRODUCT

public static final SimilarityNormalizer DOT_PRODUCT

Normalizer for Negative Inner Product (Dot) scores using negative_inner_product(…) as the scoring function.

Method Details

get

public static SimilarityNormalizer get(ScoringFunction scoringFunction)

Lookup a SimilarityNormalizer for a given ScoringFunction.

Parameters:

scoringFunction - the scoring function to translate.

Returns:

the SimilarityNormalizer for the given ScoringFunction.

Throws:

IllegalArgumentException - if the ScoringFunction is not associated with a SimilarityNormalizer.

getSimilarity

public double getSimilarity(double score)

Parameters:

score - score value as returned by the database.

Returns:

the Similarity value.

getScore

public double getScore(double similarity)

Parameters:

similarity - similarity value as requested by the query mechanism.

Returns:

database score value.

toString

public String toString()

Overrides:

toString in class Object