@SearchPrimitive

Package com.atlassian.confluence.search.v2.score

This package provides search engine agnostic primitives required to construct FunctionScoreQuery. It was designed to work when the search engine is remote. Classes encapsulate just enough information for mapping FunctionScoreQuery to a concrete search engine implementation. The inspiration has been taken from Elasticsearch function score query.

Since:

7.0

Interface Summary

Interface	Description
ComposableScoreFunction	Marker interface for a function that can be composed by e.g.
FieldValueSource	Specifies a numerical field from which data will be drawn for score function.
FunctionScoreQueryFactory	A factory to apply function scoring on search queries
ScoreFunction	Marker interface for a function providing score for FunctionScoreQuery.
ScoreFunctionFactory	Factory for creating ScoreFunction which are used in site-wide confluence search.

Class Summary

Class	Description
AverageScoreFunction	Scores of component functions are averaged according to weights.
AverageScoreFunction.Builder
ConstantScoreFunction	A function that returns a constant score
DecayParameters	Parameters for decay function.
DecayParameters.Builder
DocValuesFieldValueSource	Deprecated, for removal: This API element is subject to removal in a future version. since 8.7, not supported on OpenSearch.
DoubleFieldValueSource	Represents field its value is of type double.
ExpDecayFunction	An exponential decay function.
FieldValueFactorFunction
FilteredScoreFunction	A function that delegates to the provided function if the document satisfies a filter, otherwise it will return an empty score.
FirstScoreFunction	The score of the first matching component functions is used.
FloatFieldValueSource	Represents field its value is of type float.
GaussDecayFunction	A gaussian decay function.
IntFieldValueSource	Represents field its value is of type int.
LinearDecayFunction	Linear decay function applied to a field value.
LongFieldValueSource	Represents field its value is of type long.
MaxScoreFunction	Maximum score of component functions is used.
MinScoreFunction	Minimum score of component functions is used.
MultiplyScoreFunction	Scores of component functions are multiplied.
StaircaseFunction	Deprecated. since 8.7.
SumScoreFunction	ScoreFunction which sums composed functions and constants.

Enum Summary

Enum	Description
FieldValueFactorFunction.Modifier	The Type class encapsulates the modification types that can be applied to the score/value product.