com.azure.search.documents.indexes.models

Class MagnitudeScoringFunction

java.lang.Object

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

com.azure.search.documents.indexes.models.MagnitudeScoringFunction

public final class MagnitudeScoringFunction
extends ScoringFunction

Defines a function that boosts scores based on the magnitude of a numeric field.

Constructor Summary

Constructors

Constructor and Description
MagnitudeScoringFunction(String fieldName, double boost, MagnitudeScoringParameters parameters) Constructor of MagnitudeScoringFunction.

Method Summary

Modifier and Type	Method and Description
MagnitudeScoringParameters	getParameters() Get the parameters property: Parameter values for the magnitude scoring function.

Methods inherited from class com.azure.search.documents.indexes.models.ScoringFunction

getBoost, getFieldName, getInterpolation, setInterpolation

Methods inherited from class java.lang.Object

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

Constructor Detail

MagnitudeScoringFunction

public MagnitudeScoringFunction(String fieldName,
                                double boost,
                                MagnitudeScoringParameters parameters)

Constructor of MagnitudeScoringFunction.

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.

parameters - Parameter values for the magnitude scoring function.

Method Detail

getParameters

public MagnitudeScoringParameters getParameters()

Get the parameters property: Parameter values for the magnitude scoring function.

Returns:

the parameters value.