SearchModelFactory.DistanceScoringFunction Method

Definition

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

public static Azure.Search.Documents.Indexes.Models.DistanceScoringFunction DistanceScoringFunction(string fieldName = default, double boost = 0, Azure.Search.Documents.Indexes.Models.ScoringFunctionInterpolation? interpolation = default, Azure.Search.Documents.Indexes.Models.DistanceScoringParameters parameters = default);
static member DistanceScoringFunction : string * double * Nullable<Azure.Search.Documents.Indexes.Models.ScoringFunctionInterpolation> * Azure.Search.Documents.Indexes.Models.DistanceScoringParameters -> Azure.Search.Documents.Indexes.Models.DistanceScoringFunction
Public Shared Function DistanceScoringFunction (Optional fieldName As String = Nothing, Optional boost As Double = 0, Optional interpolation As Nullable(Of ScoringFunctionInterpolation) = Nothing, Optional parameters As DistanceScoringParameters = Nothing) As DistanceScoringFunction

Parameters

fieldName
String

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

boost
Double

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

interpolation
Nullable<ScoringFunctionInterpolation>

A value indicating how boosting will be interpolated across document scores; defaults to "Linear".

parameters
DistanceScoringParameters

Parameter values for the distance scoring function.

Returns

A new DistanceScoringFunction instance for mocking.

Applies to