MagnitudeScoringFunction interface

  • Reference
Package:
@azure/search-documents

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

Extends
BaseScoringFunction

Properties

parameters

Parameter values for the magnitude scoring function.
type

Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

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".

Property Details

parameters

Parameter values for the magnitude scoring function.

parameters: MagnitudeScoringParameters

Property Value

MagnitudeScoringParameters

type

Polymorphic discriminator, which specifies the different types this object can be

type: "magnitude"

Property Value

"magnitude"

Inherited Property Details

boost

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

boost: number

Property Value

number

Inherited From BaseScoringFunction.boost

fieldName

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

fieldName: string

Property Value

string

Inherited From BaseScoringFunction.fieldName

interpolation

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

interpolation?: ScoringFunctionInterpolation

Property Value

ScoringFunctionInterpolation

Inherited From BaseScoringFunction.interpolation