Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ScoringFunction

Package version

Base type for functions that can modify document scores during ranking. Contains the possible cases for ScoringFunction.

Hierarchy

  • ScoringFunction

Index

Properties

boost

boost: number

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

fieldName

fieldName: string

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

Optional interpolation

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

type

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

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

Generated using TypeDoc