MagnitudeScoringParameters Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.8.1
  • java.lang.Object
    • com.azure.search.documents.indexes.models.MagnitudeScoringParameters

Implements

JsonSerializable<MagnitudeScoringParameters>

public final class MagnitudeScoringParameters
implements JsonSerializable<MagnitudeScoringParameters>

Provides parameter values to a magnitude scoring function.

Constructor Summary

Constructor Description
MagnitudeScoringParameters(double boostingRangeStart, double boostingRangeEnd)

Creates an instance of MagnitudeScoringParameters class.

Method Summary

Modifier and Type Method and Description
static MagnitudeScoringParameters fromJson(JsonReader jsonReader)

Reads an instance of MagnitudeScoringParameters from the JsonReader.
double getBoostingRangeEnd()

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

Get the boostingRangeStart property: The field value at which boosting starts.
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.
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.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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

fromJson

public static MagnitudeScoringParameters fromJson(JsonReader jsonReader)

Reads an instance of MagnitudeScoringParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of MagnitudeScoringParameters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getBoostingRangeEnd

public double getBoostingRangeEnd()

Get the boostingRangeEnd property: The field value at which boosting ends.

Returns:

the boostingRangeEnd value.

getBoostingRangeStart

public double getBoostingRangeStart()

Get the boostingRangeStart property: The field value at which boosting starts.

Returns:

the boostingRangeStart 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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to