FreshnessScoringFunction 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.ScoringFunction
  • • com.azure.search.documents.indexes.models.FreshnessScoringFunction

public final class FreshnessScoringFunction
extends ScoringFunction

Defines a function that boosts scores based on the value of a date-time field.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static FreshnessScoringFunction	fromJson(JsonReader jsonReader) Reads an instance of FreshnessScoringFunction from the JsonReader.
FreshnessScoringParameters	getParameters() Get the parameters property: Parameter values for the freshness scoring function.
String	getType() Get the type property: Indicates the type of function to use.
FreshnessScoringFunction	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 ScoringFunction

fromJson getBoost getFieldName getInterpolation getType setInterpolation toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FreshnessScoringFunction

public FreshnessScoringFunction(String fieldName, double boost, FreshnessScoringParameters parameters)

Creates an instance of FreshnessScoringFunction class.

Parameters:

fieldName - the fieldName value to set.

boost - the boost value to set.

parameters - the parameters value to set.

Method Details

fromJson

public static FreshnessScoringFunction fromJson(JsonReader jsonReader)

Reads an instance of FreshnessScoringFunction from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getParameters

public FreshnessScoringParameters getParameters()

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

Returns:

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

Overrides:

FreshnessScoringFunction.getType()

Returns:

the type value.

setInterpolation

public FreshnessScoringFunction setInterpolation(ScoringFunctionInterpolation interpolation)

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

Overrides:

FreshnessScoringFunction.setInterpolation(ScoringFunctionInterpolation interpolation)

Parameters:

interpolation

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

FreshnessScoringFunction.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException