DistanceScoringFunction 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.DistanceScoringFunction

public final class DistanceScoringFunction
extends ScoringFunction

Defines a function that boosts scores based on distance from a geographic location.

Constructor Summary

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

Method Summary

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

DistanceScoringFunction

public DistanceScoringFunction(String fieldName, double boost, DistanceScoringParameters parameters)

Creates an instance of DistanceScoringFunction 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 DistanceScoringFunction fromJson(JsonReader jsonReader)

Reads an instance of DistanceScoringFunction from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DistanceScoringFunction 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 DistanceScoringParameters getParameters()

Get the parameters property: Parameter values for the distance 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:

DistanceScoringFunction.getType()

Returns:

the type value.

setInterpolation

public DistanceScoringFunction setInterpolation(ScoringFunctionInterpolation interpolation)

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

Overrides:

DistanceScoringFunction.setInterpolation(ScoringFunctionInterpolation interpolation)

Parameters:

interpolation

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DistanceScoringFunction.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException