ScoringFunction Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.7.4

• java.lang.Object
• • com.azure.search.documents.indexes.models.ScoringFunction

Implements

JsonSerializable<ScoringFunction>

public class ScoringFunction
implements JsonSerializable<ScoringFunction>

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

Constructor Summary

Constructor	Description
ScoringFunction(String fieldName, double boost)	Creates an instance of ScoringFunction class.

Method Summary

Modifier and Type	Method and Description
static ScoringFunction	fromJson(JsonReader jsonReader) Reads an instance of ScoringFunction from the JsonReader.
double	getBoost() Get the boost property: A multiplier for the raw score.
String	getFieldName() Get the fieldName property: The name of the field used as input to the scoring function.
ScoringFunctionInterpolation	getInterpolation() Get the interpolation property: A value indicating how boosting will be interpolated across document scores; defaults to "Linear".
String	getType() Get the type property: Indicates the type of function to use.
ScoringFunction	setInterpolation(ScoringFunctionInterpolation interpolation) Set the interpolation property: A value indicating how boosting will be interpolated across document scores; defaults to "Linear".
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ScoringFunction

public ScoringFunction(String fieldName, double boost)

Creates an instance of ScoringFunction class.

Parameters:

fieldName - the fieldName value to set.

boost - the boost value to set.

Method Details

fromJson

public static ScoringFunction fromJson(JsonReader jsonReader)

Reads an instance of ScoringFunction from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ScoringFunction 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.

getBoost

public double getBoost()

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

Returns:

the boost value.

getFieldName

public String getFieldName()

Get the fieldName property: The name of the field used as input to the scoring function.

Returns:

the fieldName value.

getInterpolation

public ScoringFunctionInterpolation getInterpolation()

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

Returns:

the interpolation value.

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.

Returns:

the type value.

setInterpolation

public ScoringFunction setInterpolation(ScoringFunctionInterpolation interpolation)

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

Parameters:

interpolation - the interpolation value to set.

Returns:

the ScoringFunction object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

Azure SDK for Java

Latest