DistanceScoringFunction Class

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Service.dll

Package:

Microsoft.Azure.Search.Service v10.1.0

Source:

DistanceScoringFunction.cs

Defines a function that boosts scores based on distance from a geographic location. https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index

[Newtonsoft.Json.JsonObject("distance")]
public class DistanceScoringFunction : Microsoft.Azure.Search.Models.ScoringFunction

[<Newtonsoft.Json.JsonObject("distance")>]
type DistanceScoringFunction = class
    inherit ScoringFunction

Public Class DistanceScoringFunction
Inherits ScoringFunction

Inheritance

Object

ScoringFunction

DistanceScoringFunction

Attributes

Newtonsoft.Json.JsonObjectAttribute

Constructors

DistanceScoringFunction()	Initializes a new instance of the DistanceScoringFunction class.
DistanceScoringFunction(String, Double, DistanceScoringParameters, Nullable<ScoringFunctionInterpolation>)	Initializes a new instance of the DistanceScoringFunction class.
DistanceScoringFunction(String, Double, String, Double, Nullable<ScoringFunctionInterpolation>)	Initializes a new instance of the DistanceScoringFunction class.

Properties

Boost	Gets or sets a multiplier for the raw score. Must be a positive number not equal to 1.0. (Inherited from ScoringFunction)
FieldName	Gets or sets the name of the field used as input to the scoring function. (Inherited from ScoringFunction)
Interpolation	Gets or sets a value indicating how boosting will be interpolated across document scores; defaults to "Linear". Possible values include: 'linear', 'constant', 'quadratic', 'logarithmic' (Inherited from ScoringFunction)
Parameters	Gets or sets parameter values for the distance scoring function.

Methods

Validate()

Validate the object.