BaseScoringFunction interface

Base type for functions that can modify document scores during ranking.

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

type

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

Property Details

boost

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

boost: number

Property Value

number

fieldName

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

fieldName: string

Property Value

string

interpolation

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

interpolation?: ScoringFunctionInterpolation

Property Value

type

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

type: "distance" | "freshness" | "magnitude" | "tag"

Property Value

"distance" | "freshness" | "magnitude" | "tag"