Package com.mongodb.client.model.search

Interface SearchScore

All Superinterfaces:

Bson

All Known Subinterfaces:

ConstantSearchScore, FunctionSearchScore, PathBoostSearchScore, ValueBoostSearchScore

@Sealed
@Beta(CLIENT)
public interface SearchScore
extends Bson

A modifier of the relevance score. You may use the $meta: "searchScore" expression, e.g., via Projections.metaSearchScore(String), to extract the relevance score assigned to each found document.

Since:

4.7

MongoDB Atlas documentation

Scoring

Field Summary

Fields inherited from interface org.bson.conversions.Bson

DEFAULT_CODEC_REGISTRY

Method Summary

Static Methods

Modifier and Type	Method	Description
static ValueBoostSearchScore	boost(float value)	Returns a SearchScore that instructs to multiply the score by the specified value.
static PathBoostSearchScore	boost(FieldSearchPath path)	Returns a SearchScore that instructs to multiply the score by the value of the specified field.
static ConstantSearchScore	constant(float value)	Returns a SearchScore that instructs to replace the score with the specified value.
static FunctionSearchScore	function(SearchScoreExpression expression)	Returns a SearchScore that instructs to compute the score using the specified expression.
static SearchScore	of(Bson score)	Creates a SearchScore from a Bson in situations when there is no builder method that better satisfies your needs.

Methods inherited from interface org.bson.conversions.Bson

toBsonDocument, toBsonDocument

Method Details

boost

static ValueBoostSearchScore boost(float value)

Returns a SearchScore that instructs to multiply the score by the specified value.

Parameters:

value - The value to multiply the score by.

Returns:

The requested SearchScore.

MongoDB Atlas documentation

boost score modifier

boost

static PathBoostSearchScore boost(FieldSearchPath path)

Returns a SearchScore that instructs to multiply the score by the value of the specified field.

Parameters:

path - The numeric field whose value to multiply the score by.

Returns:

The requested SearchScore.

See Also:

• SearchScoreExpression.pathExpression(FieldSearchPath)

MongoDB Atlas documentation

boost score modifier

constant

static ConstantSearchScore constant(float value)

Returns a SearchScore that instructs to replace the score with the specified value.

Parameters:

value - The value to replace the score with.

Returns:

The requested SearchScore.

See Also:

• SearchScoreExpression.constantExpression(float)

MongoDB Atlas documentation

constant score modifier

function

static FunctionSearchScore function(SearchScoreExpression expression)

Returns a SearchScore that instructs to compute the score using the specified expression.

Parameters:

expression - The expression to use when calculating the score.

Returns:

The requested SearchScore.

MongoDB Atlas documentation

function score modifier

of

static SearchScore of(Bson score)

Creates a SearchScore from a Bson in situations when there is no builder method that better satisfies your needs. This method cannot be used to validate the syntax.

Example
The following code creates two functionally equivalent SearchScores, though they may not be equal.

  SearchScore score1 = SearchScore.boost(
      SearchPath.fieldPath("fieldName"));
  SearchScore score2 = SearchScore.of(new Document("boost",
      new Document("path", SearchPath.fieldPath("fieldName").toValue())));
 

Parameters:

score - A Bson representing the required SearchScore.

Returns:

The requested SearchScore.