MagnitudeScoringFunction Class

Definition

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

[Newtonsoft.Json.JsonObject("magnitude")]
public class MagnitudeScoringFunction : Microsoft.Azure.Search.Models.ScoringFunction
type MagnitudeScoringFunction = class
    inherit ScoringFunction
Public Class MagnitudeScoringFunction
Inherits ScoringFunction
Inheritance
MagnitudeScoringFunction
Attributes

Constructors

MagnitudeScoringFunction()

Initializes a new instance of the MagnitudeScoringFunction class.

MagnitudeScoringFunction(String, Double, Double, Double, Nullable<Boolean>, Nullable<ScoringFunctionInterpolation>)

Initializes a new instance of the MagnitudeScoringFunction class.

MagnitudeScoringFunction(String, Double, MagnitudeScoringParameters, Nullable<ScoringFunctionInterpolation>)

Initializes a new instance of the MagnitudeScoringFunction 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 magnitude scoring function.

Methods

Validate()

Validate the object.

Applies to