com.azure.search.documents.indexes.models

Class ScoringFunction

java.lang.Object

com.azure.search.documents.indexes.models.ScoringFunction

Direct Known Subclasses:

DistanceScoringFunction, FreshnessScoringFunction, MagnitudeScoringFunction, TagScoringFunction

public abstract class ScoringFunction
extends Object

Base type for functions that can modify document scores during ranking.

Constructor Summary

Constructors

Constructor and Description
ScoringFunction(String fieldName, double boost) Constructor of ScoringFunction.

Method Summary

Modifier and Type	Method and Description
double	getBoost() Get the boost property: A multiplier for the raw score.
String	getFieldName() Get the fieldName property: The name of the field used as input to the scoring function.
ScoringFunctionInterpolation	getInterpolation() Get the interpolation property: A value indicating how boosting will be interpolated across document scores; defaults to "Linear".
ScoringFunction	setInterpolation(ScoringFunctionInterpolation interpolation) Set the interpolation property: A value indicating how boosting will be interpolated across document scores; defaults to "Linear".

Methods inherited from class java.lang.Object

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

Constructor Detail

ScoringFunction

public ScoringFunction(String fieldName,
                       double boost)

Constructor of ScoringFunction.

Parameters:

fieldName - The name of the field used as input to the scoring function.

boost - A multiplier for the raw score. Must be a positive number not equal to 1.0.

Method Detail

getFieldName

public String getFieldName()

Get the fieldName property: The name of the field used as input to the scoring function.

Returns:

the fieldName value.

getBoost

public double getBoost()

Get the boost property: A multiplier for the raw score. Must be a positive number not equal to 1.0.

Returns:

the boost value.

getInterpolation

public ScoringFunctionInterpolation getInterpolation()

Get the interpolation property: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". Possible values include: 'Linear', 'Constant', 'Quadratic', 'Logarithmic'.

Returns:

the interpolation value.

setInterpolation

public ScoringFunction setInterpolation(ScoringFunctionInterpolation interpolation)

Set the interpolation property: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". Possible values include: 'Linear', 'Constant', 'Quadratic', 'Logarithmic'.

Parameters:

interpolation - the interpolation value to set.

Returns:

the ScoringFunction object itself.