MagnitudeScoringFunction interface

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

Properties

parameters	Parameter values for the magnitude scoring function.
type	Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case.

boost	A multiplier for the raw score. Must be a positive number not equal to 1.0.
fieldName	The name of the field used as input to the scoring function.
interpolation	A value indicating how boosting will be interpolated across document scores; defaults to "Linear".

Parameter values for the magnitude scoring function.

parameters: MagnitudeScoringParameters

Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case.

type: "magnitude"

"magnitude"

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

boost: number

number

Inherited From ScoringFunction.boost

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

fieldName: string

string

Inherited From ScoringFunction.fieldName

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

interpolation?: ScoringFunctionInterpolation

Inherited From ScoringFunction.interpolation