com.azure.search.documents.indexes.models

Class DistanceScoringFunction

java.lang.Object

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

com.azure.search.documents.indexes.models.DistanceScoringFunction

public final class DistanceScoringFunction
extends ScoringFunction

Defines a function that boosts scores based on distance from a geographic location.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
DistanceScoringParameters	getParameters() Get the parameters property: Parameter values for the distance 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

DistanceScoringFunction

public DistanceScoringFunction(String fieldName,
                               double boost,
                               DistanceScoringParameters parameters)

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.

parameters - Parameter values for the distance scoring function.

Method Detail

getParameters

public DistanceScoringParameters getParameters()

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

Returns:

the parameters value.