FunctionScoreQuery
Attributes
- Graph
-
- Supertypes
Members list
Value members
Abstract methods
Sets the boostMode parameter for the zio.elasticsearch.query.FunctionScoreQuery. It defines how computed score is combined with score of the query.
Sets the boostMode parameter for the zio.elasticsearch.query.FunctionScoreQuery. It defines how computed score is combined with score of the query.
Value parameters
- value
-
Computed score and score of the query can be combined in following ways:
- zio.elasticsearch.query.FunctionScoreBoostMode.Avg
- zio.elasticsearch.query.FunctionScoreBoostMode.Max
- zio.elasticsearch.query.FunctionScoreBoostMode.Min
- zio.elasticsearch.query.FunctionScoreBoostMode.Multiply
- zio.elasticsearch.query.FunctionScoreBoostMode.Replace
- zio.elasticsearch.query.FunctionScoreBoostMode.Sum
Attributes
- Returns
-
an instance of zio.elasticsearch.query.FunctionScoreQuery enriched with the
boostModeparameter.
Sets the maxBoost parameter for the zio.elasticsearch.query.FunctionScoreQuery. It restricts the new score not to exceed a certain limit by setting this parameter.
Sets the maxBoost parameter for the zio.elasticsearch.query.FunctionScoreQuery. It restricts the new score not to exceed a certain limit by setting this parameter.
Value parameters
- value
-
a non-negative real number used for the
maxBoost
Attributes
- Returns
-
an instance of zio.elasticsearch.query.FunctionScoreQuery enriched with the
maxBoostparameter.
Sets the minScore parameter for the zio.elasticsearch.query.FunctionScoreQuery. To exclude documents that do not meet a certain score threshold the minScore parameter can be set to the desired score threshold.
Sets the minScore parameter for the zio.elasticsearch.query.FunctionScoreQuery. To exclude documents that do not meet a certain score threshold the minScore parameter can be set to the desired score threshold.
Value parameters
- value
-
a non-negative real number used for the
minScore
Attributes
- Returns
-
an instance of zio.elasticsearch.query.FunctionScoreQuery enriched with the
minScoreparameter.
Sets the query parameter for the zio.elasticsearch.query.FunctionScoreQuery. Represents a query to be executed in elasticsearch and modified by zio.elasticsearch.query.FunctionScore parameters.
Sets the query parameter for the zio.elasticsearch.query.FunctionScoreQuery. Represents a query to be executed in elasticsearch and modified by zio.elasticsearch.query.FunctionScore parameters.
Type parameters
- S1
-
the type of the zio.elasticsearch.query.ElasticQuery for type shrinking
Value parameters
- value
-
a zio.elasticsearch.query.ElasticQuery to be executed
Attributes
- Returns
-
an instance of zio.elasticsearch.query.FunctionScoreQuery enriched with the
queryparameter.
Sets the scoreMode parameter for the zio.elasticsearch.query.FunctionScoreQuery. The scoreMode parameter specifies how the computed scores are combined.
Sets the scoreMode parameter for the zio.elasticsearch.query.FunctionScoreQuery. The scoreMode parameter specifies how the computed scores are combined.
Value parameters
- value
-
a value that we want to set
scoreModeto, possible values are:- zio.elasticsearch.query.FunctionScoreScoreMode.Avg
- zio.elasticsearch.query.FunctionScoreScoreMode.First
- zio.elasticsearch.query.FunctionScoreScoreMode.Max
- zio.elasticsearch.query.FunctionScoreScoreMode.Min
- zio.elasticsearch.query.FunctionScoreScoreMode.Multiply
- zio.elasticsearch.query.FunctionScoreScoreMode.None
- zio.elasticsearch.query.FunctionScoreScoreMode.Sum
Attributes
- Returns
-
an instance of zio.elasticsearch.query.FunctionScoreQuery enriched with the
scoreModeparameter.
Adds one or multiple zio.elasticsearch.query.FunctionScoreFunction to existing zio.elasticsearch.query.FunctionScore query.
Adds one or multiple zio.elasticsearch.query.FunctionScoreFunction to existing zio.elasticsearch.query.FunctionScore query.
Type parameters
- S1
-
the type of the zio.elasticsearch.query.FunctionScoreFunction for type shrinking
Value parameters
- functions
-
multiple zio.elasticsearch.query.FunctionScoreFunction to be added to query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.FunctionScoreQuery enriched with the
functionScoreFunctionsparameter.
Inherited and Abstract methods
Sets the boost parameter for this zio.elasticsearch.query.ElasticQuery. The boost value is a positive multiplier applied to the score of documents matching the query. A value greater than 1 increases the relevance score of matching documents, while a value less than 1 decreases it. The default boost value is 1.
Sets the boost parameter for this zio.elasticsearch.query.ElasticQuery. The boost value is a positive multiplier applied to the score of documents matching the query. A value greater than 1 increases the relevance score of matching documents, while a value less than 1 decreases it. The default boost value is 1.
Value parameters
- value
-
a non-negative real number to set
boostparameter to
Attributes
- Returns
-
a new instance of the zio.elasticsearch.query.ElasticQuery with the
boostvalue set. - Inherited from:
- HasBoost (hidden)