SearchModelFactory.MagnitudeScoringFunction Method

Definition

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

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

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
MagnitudeScoringParameters

Parameter values for the magnitude scoring function.

Returns

A new MagnitudeScoringFunction instance for mocking.

Applies to