Class SearchScoreFunctionBuilder<TDocument>

Namespace: MongoDB.Driver.Search

Assembly: MongoDB.Driver.dll

A builder for a score function.

public sealed class SearchScoreFunctionBuilder<TDocument>

Type Parameters

TDocument: The type of the document.

Inheritance: object

SearchScoreFunctionBuilder<TDocument>

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Add(params SearchScoreFunction<TDocument>[]): Creates a function that adds a series of numbers.

Add(IEnumerable<SearchScoreFunction<TDocument>>): Creates a function that adds a series of numbers.

Constant(double): Creates a function that represents a constant number.

Gauss(SearchPathDefinition<TDocument>, double, double, double, double): Creates a function that decays, or reduces by multiplying, the final scores of the documents based on the distance of a numeric field from a specified origin point.

Gauss(Expression<Func<TDocument, double>>, double, double, double, double): Creates a function that decays, or reduces by multiplying, the final scores of the documents based on the distance of a numeric field from a specified origin point.

Log(SearchScoreFunction<TDocument>): Creates a function that calculates the base-10 logarithm of a number.

Log1p(SearchScoreFunction<TDocument>): Creates a function that adds 1 to a number and then calculates its base-10 logarithm.

Multiply(params SearchScoreFunction<TDocument>[]): Creates a function that multiplies a series of numbers.

Multiply(IEnumerable<SearchScoreFunction<TDocument>>): Creates a function that multiplies a series of numbers.

Path(SearchPathDefinition<TDocument>, double): Creates a function that incorporates an indexed numeric field value into the score.

Path(Expression<Func<TDocument, double>>, double): Creates a function that incorporates an indexed numeric field value into the score.

Relevance(): Creates a function that represents the relevance score, which is the score Atlas Search assigns documents based on relevance.