com.azure.search.models

Class ScoringProfile

java.lang.Object

com.azure.search.models.ScoringProfile

public final class ScoringProfile
extends Object

Defines parameters for a search index that influence scoring in search queries.

Constructor Summary

Constructors

Constructor and Description
ScoringProfile()

Method Summary

Modifier and Type	Method and Description
ScoringFunctionAggregation	getFunctionAggregation() Get the functionAggregation property: A value indicating how the results of individual scoring functions should be combined.
List<ScoringFunction>	getFunctions() Get the functions property: The collection of functions that influence the scoring of documents.
String	getName() Get the name property: The name of the scoring profile.
TextWeights	getTextWeights() Get the textWeights property: Parameters that boost scoring based on text matches in certain index fields.
ScoringProfile	setFunctionAggregation(ScoringFunctionAggregation functionAggregation) Set the functionAggregation property: A value indicating how the results of individual scoring functions should be combined.
ScoringProfile	setFunctions(List<ScoringFunction> functions) Set the functions property: The collection of functions that influence the scoring of documents.
ScoringProfile	setName(String name) Set the name property: The name of the scoring profile.
ScoringProfile	setTextWeights(TextWeights textWeights) Set the textWeights property: Parameters that boost scoring based on text matches in certain index fields.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScoringProfile

public ScoringProfile()

Method Detail

getName

public String getName()

Get the name property: The name of the scoring profile.

Returns:

the name value.

setName

public ScoringProfile setName(String name)

Set the name property: The name of the scoring profile.

Parameters:

name - the name value to set.

Returns:

the ScoringProfile object itself.

getTextWeights

public TextWeights getTextWeights()

Get the textWeights property: Parameters that boost scoring based on text matches in certain index fields.

Returns:

the textWeights value.

setTextWeights

public ScoringProfile setTextWeights(TextWeights textWeights)

Set the textWeights property: Parameters that boost scoring based on text matches in certain index fields.

Parameters:

textWeights - the textWeights value to set.

Returns:

the ScoringProfile object itself.

getFunctions

public List<ScoringFunction> getFunctions()

Get the functions property: The collection of functions that influence the scoring of documents.

Returns:

the functions value.

setFunctions

public ScoringProfile setFunctions(List<ScoringFunction> functions)

Set the functions property: The collection of functions that influence the scoring of documents.

Parameters:

functions - the functions value to set.

Returns:

the ScoringProfile object itself.

getFunctionAggregation

public ScoringFunctionAggregation getFunctionAggregation()

Get the functionAggregation property: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. Possible values include: 'sum', 'average', 'minimum', 'maximum', 'firstMatching'.

Returns:

the functionAggregation value.

setFunctionAggregation

public ScoringProfile setFunctionAggregation(ScoringFunctionAggregation functionAggregation)

Set the functionAggregation property: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. Possible values include: 'sum', 'average', 'minimum', 'maximum', 'firstMatching'.

Parameters:

functionAggregation - the functionAggregation value to set.

Returns:

the ScoringProfile object itself.