Class DistanceScoringFunction

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

Inheritance

System.Object

ScoringFunction

DistanceScoringFunction

Inherited Members

ScoringFunction.Boost

ScoringFunction.FieldName

ScoringFunction.Interpolation

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Search.Documents.dll

Syntax

public class DistanceScoringFunction : Azure.Search.Documents.Indexes.Models.ScoringFunction

Constructors

DistanceScoringFunction(String, Double, DistanceScoringParameters)

Initializes a new instance of DistanceScoringFunction.

Declaration

public DistanceScoringFunction (string fieldName, double boost, Azure.Search.Documents.Indexes.Models.DistanceScoringParameters parameters);

Parameters

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

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

DistanceScoringParameters parameters Parameter values for the distance scoring function.

Exceptions

System.ArgumentException fieldName is an empty string.

System.ArgumentNullException fieldName or parameters is null.

Properties

Parameters

Parameter values for the distance scoring function.

Declaration

public Azure.Search.Documents.Indexes.Models.DistanceScoringParameters Parameters { get; set; }

Property Value

DistanceScoringParameters