Package com.azure.search.documents.indexes.models

Enum ScoringFunctionInterpolation

java.lang.Object

java.lang.Enum<ScoringFunctionInterpolation>

com.azure.search.documents.indexes.models.ScoringFunctionInterpolation

All Implemented Interfaces:

Serializable, Comparable<ScoringFunctionInterpolation>, java.lang.constant.Constable

public enum ScoringFunctionInterpolation
extends Enum<ScoringFunctionInterpolation>

Defines the function used to interpolate score boosting across a range of documents.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONSTANT	Boosts scores by a constant factor.
LINEAR	Boosts scores by a linearly decreasing amount.
LOGARITHMIC	Boosts scores by an amount that decreases logarithmically.
QUADRATIC	Boosts scores by an amount that decreases quadratically.

Method Summary

Modifier and Type	Method	Description
static ScoringFunctionInterpolation	fromString(String value)	Parses a serialized value to a ScoringFunctionInterpolation instance.
String	toString()
static ScoringFunctionInterpolation	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ScoringFunctionInterpolation[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LINEAR

public static final ScoringFunctionInterpolation LINEAR

Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions.

CONSTANT

public static final ScoringFunctionInterpolation CONSTANT

Boosts scores by a constant factor.

QUADRATIC

public static final ScoringFunctionInterpolation QUADRATIC

Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions.

LOGARITHMIC

public static final ScoringFunctionInterpolation LOGARITHMIC

Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions.

Method Details

values

public static ScoringFunctionInterpolation[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ScoringFunctionInterpolation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static ScoringFunctionInterpolation fromString(String value)

Parses a serialized value to a ScoringFunctionInterpolation instance.

Parameters:

value - the serialized value to parse.

Returns:

the parsed ScoringFunctionInterpolation object, or null if unable to parse.

toString

public String toString()

Overrides:

toString in class Enum<ScoringFunctionInterpolation>