MagnitudeScoringFunction Class

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Service.dll

Package:

Microsoft.Azure.Search.Service v10.1.0

Source:

MagnitudeScoringFunction.cs

Defines a function that boosts scores based on the magnitude of a numeric field. https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index

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

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

Public Class MagnitudeScoringFunction
Inherits ScoringFunction

Inheritance

Object

ScoringFunction

MagnitudeScoringFunction

Attributes

Newtonsoft.Json.JsonObjectAttribute

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.