Package com.mongodb.client.model.search

Interface SearchScoreExpression

All Superinterfaces:

Bson

All Known Subinterfaces:

AddSearchScoreExpression, ConstantSearchScoreExpression, GaussSearchScoreExpression, Log1pSearchScoreExpression, LogSearchScoreExpression, MultiplySearchScoreExpression, PathSearchScoreExpression, RelevanceSearchScoreExpression

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

Since:

4.7

See Also:

• SearchScore.function(SearchScoreExpression)

MongoDB Atlas documentation

Expressions for the function score modifier

Field Summary

Fields inherited from interface org.bson.conversions.Bson

DEFAULT_CODEC_REGISTRY

Method Summary

Static Methods

Modifier and Type	Method	Description
static AddSearchScoreExpression	addExpression(Iterable<? extends SearchScoreExpression> expressions)	Returns a SearchScoreExpression that evaluates into the sum of the values of the specified expressions.
static ConstantSearchScoreExpression	constantExpression(float value)	Returns a SearchScoreExpression that evaluates into the specified value.
static GaussSearchScoreExpression	gaussExpression(double origin, PathSearchScoreExpression path, double scale)	Returns a SearchScoreExpression that represents a Gaussian function whose output is within the interval [0, 1].
static Log1pSearchScoreExpression	log1pExpression(SearchScoreExpression expression)	Returns a SearchScoreExpression that evaluates into log10(expressionValue + 1), where expressionValue is the value of the expression.
static LogSearchScoreExpression	logExpression(SearchScoreExpression expression)	Returns a SearchScoreExpression that evaluates into log10(expressionValue), where expressionValue is the value of the expression.
static MultiplySearchScoreExpression	multiplyExpression(Iterable<? extends SearchScoreExpression> expressions)	Returns a SearchScoreExpression that evaluates into the product of the values of the specified expressions.
static SearchScoreExpression	of(Bson expression)	Creates a SearchScoreExpression from a Bson in situations when there is no builder method that better satisfies your needs.
static PathSearchScoreExpression	pathExpression(FieldSearchPath path)	Returns a SearchScoreExpression that evaluates into the value of the specified field.
static RelevanceSearchScoreExpression	relevanceExpression()	Returns a SearchScoreExpression that evaluates into the relevance score of a document.

Methods inherited from interface org.bson.conversions.Bson

toBsonDocument, toBsonDocument

Method Details

relevanceExpression

static RelevanceSearchScoreExpression relevanceExpression()

Returns a SearchScoreExpression that evaluates into the relevance score of a document.

Returns:

The requested SearchScoreExpression.

pathExpression

static PathSearchScoreExpression pathExpression(FieldSearchPath path)

Returns a SearchScoreExpression that evaluates into the value of the specified field.

Parameters:

path - The numeric field whose value to use as the result of the expression.

Returns:

The requested SearchScoreExpression.

See Also:

• SearchScore.boost(FieldSearchPath)

constantExpression

static ConstantSearchScoreExpression constantExpression(float value)

Returns a SearchScoreExpression that evaluates into the specified value.

Parameters:

value - The value to use as the result of the expression. Unlike SearchScore.constant(float), does not have constraints.

Returns:

The requested SearchScoreExpression.

See Also:

• SearchScore.constant(float)

gaussExpression

static GaussSearchScoreExpression gaussExpression(double origin,
 PathSearchScoreExpression path,
 double scale)

Returns a SearchScoreExpression that represents a Gaussian function whose output is within the interval [0, 1]. Roughly speaking, the further the value of the path expression is from the origin, the smaller the output of the function.

The scale and decay are parameters of the Gaussian function, they define the rate at which the function decays. The input of the Gaussian function is the output of another function: max(0, abs(pathValue - origin) - offset), where pathValue is the value of the path expression.

Parameters:

origin - The point of origin, see GaussSearchScoreExpression.offset(double). The value of the Gaussian function is 1 if the value of the path expression is origin.

path - The expression whose value is used to calculate the input of the Gaussian function.

scale - The distance from the points origin ± offset at which the output of the Gaussian function must decay by the factor of decay.

Returns:

The requested SearchScoreExpression.

logExpression

static LogSearchScoreExpression logExpression(SearchScoreExpression expression)

Returns a SearchScoreExpression that evaluates into log10(expressionValue), where expressionValue is the value of the expression.

Parameters:

expression - The expression whose value is the input of the log10 function.

Returns:

The requested SearchScoreExpression.

log1pExpression

static Log1pSearchScoreExpression log1pExpression(SearchScoreExpression expression)

Returns a SearchScoreExpression that evaluates into log10(expressionValue + 1), where expressionValue is the value of the expression.

Parameters:

expression - The expression whose value is used to calculate the input of the log10 function.

Returns:

The requested SearchScoreExpression.

addExpression

static AddSearchScoreExpression addExpression(Iterable<? extends SearchScoreExpression> expressions)

Returns a SearchScoreExpression that evaluates into the sum of the values of the specified expressions.

Parameters:

expressions - The expressions whose values to add. Must contain at least two expressions.

Returns:

The requested SearchScoreExpression.

multiplyExpression

static MultiplySearchScoreExpression multiplyExpression(Iterable<? extends SearchScoreExpression> expressions)

Returns a SearchScoreExpression that evaluates into the product of the values of the specified expressions.

Parameters:

expressions - The expressions whose values to multiply. Must contain at least two expressions.

Returns:

The requested SearchScoreExpression.

of

static SearchScoreExpression of(Bson expression)

Creates a SearchScoreExpression 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 SearchScoreExpressions, though they may not be equal.

  SearchScoreExpression expression1 = SearchScoreExpression.pathExpression(
          SearchPath.fieldPath("fieldName"))
          .undefined(-1.5f);
  SearchScoreExpression expression2 = new Document("path",
          new Document("value", SearchPath.fieldPath("fieldName").toValue())
                  .append("undefined", -1.5));
 

Parameters:

expression - A Bson representing the required SearchScoreExpression.

Returns:

The requested SearchScoreExpression.