Package com.azure.search.documents.indexes.models

Class MagnitudeScoringParameters

java.lang.Object
com.azure.search.documents.indexes.models.MagnitudeScoringParameters
public final class MagnitudeScoringParameters extends Object
Provides parameter values to a magnitude scoring function.

  • Constructor Details

    • MagnitudeScoringParameters

      public MagnitudeScoringParameters(double boostingRangeStart, double boostingRangeEnd)
      Creates an instance of MagnitudeScoringParameters class.
      Parameters:
      boostingRangeStart - the boostingRangeStart value to set.
      boostingRangeEnd - the boostingRangeEnd value to set.

  • Method Details

    • getBoostingRangeStart

      public double getBoostingRangeStart()
      Get the boostingRangeStart property: The field value at which boosting starts.
      Returns:
      the boostingRangeStart value.

    • getBoostingRangeEnd

      public double getBoostingRangeEnd()
      Get the boostingRangeEnd property: The field value at which boosting ends.
      Returns:
      the boostingRangeEnd value.

    • shouldBoostBeyondRangeByConstant

      public Boolean shouldBoostBeyondRangeByConstant()
      Get the shouldBoostBeyondRangeByConstant property: A value indicating whether to apply a constant boost for field values beyond the range end value; default is false.
      Returns:
      the shouldBoostBeyondRangeByConstant value.

    • setShouldBoostBeyondRangeByConstant

      public MagnitudeScoringParameters setShouldBoostBeyondRangeByConstant(Boolean shouldBoostBeyondRangeByConstant)
      Set the shouldBoostBeyondRangeByConstant property: A value indicating whether to apply a constant boost for field values beyond the range end value; default is false.
      Parameters:
      shouldBoostBeyondRangeByConstant - the shouldBoostBeyondRangeByConstant value to set.
      Returns:
      the MagnitudeScoringParameters object itself.