Class MagnitudeScoringFunction

java.lang.Object

com.azure.search.documents.indexes.models.ScoringFunction

com.azure.search.documents.indexes.models.MagnitudeScoringFunction

All Implemented Interfaces:

com.azure.json.JsonSerializable<ScoringFunction>

public final class MagnitudeScoringFunction
extends ScoringFunction

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

Constructor Summary

Constructors

Constructor	Description
MagnitudeScoringFunction(String fieldName, double boost, MagnitudeScoringParameters parameters)	Creates an instance of MagnitudeScoringFunction class.

Method Summary

Modifier and Type	Method	Description
static MagnitudeScoringFunction	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of MagnitudeScoringFunction from the JsonReader.
MagnitudeScoringParameters	getParameters()	Get the parameters property: Parameter values for the magnitude scoring function.
String	getType()	Get the type property: Indicates the type of function to use.
MagnitudeScoringFunction	setInterpolation(ScoringFunctionInterpolation interpolation)	Set the interpolation property: A value indicating how boosting will be interpolated across document scores; defaults to "Linear".
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class ScoringFunction

getBoost, getFieldName, getInterpolation

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

MagnitudeScoringFunction

public MagnitudeScoringFunction(String fieldName,
 double boost,
 MagnitudeScoringParameters parameters)

Creates an instance of MagnitudeScoringFunction class.

Parameters:

fieldName - the fieldName value to set.

boost - the boost value to set.

parameters - the parameters value to set.

Method Details

getType

public String getType()

Get the type property: Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case.

Overrides:

getType in class ScoringFunction

Returns:

the type value.

getParameters

public MagnitudeScoringParameters getParameters()

Get the parameters property: Parameter values for the magnitude scoring function.

Returns:

the parameters value.

setInterpolation

public MagnitudeScoringFunction setInterpolation(ScoringFunctionInterpolation interpolation)

Set the interpolation property: A value indicating how boosting will be interpolated across document scores; defaults to "Linear".

Overrides:

setInterpolation in class ScoringFunction

Parameters:

interpolation - the interpolation value to set.

Returns:

the ScoringFunction object itself.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<ScoringFunction>

Overrides:

toJson in class ScoringFunction

Throws:

IOException

fromJson

public static MagnitudeScoringFunction fromJson(com.azure.json.JsonReader jsonReader)
                                         throws IOException

Reads an instance of MagnitudeScoringFunction from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

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

IOException - If an error occurs while reading the MagnitudeScoringFunction.