SearchScoreDefinitionBuilder<TDocument>.Boost Method (SearchPathDefinition<TDocument>, Double)

Creates a score modifier that multiples a result's base score by the value of a numeric field in the documents.

Namespace: MongoDB.Driver.Search
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242

Syntax

Copy

public SearchScoreDefinition<TDocument> Boost(
	SearchPathDefinition<TDocument> path,
	double undefined = 0
)

Public Function Boost ( 
	path As SearchPathDefinition(Of TDocument),
	Optional undefined As Double = 0
) As SearchScoreDefinition(Of TDocument)

member Boost : 
        path : SearchPathDefinition<'TDocument> * 
        ?undefined : float 
(* Defaults:
        let _undefined = defaultArg undefined 0
*)
-> SearchScoreDefinition<'TDocument>

Parameters

path: Type: MongoDB.Driver.Search.SearchPathDefinition<TDocument>
The path to the numeric field whose value to multiply the default base score by.
undefined (Optional): Type: System.Double
The numeric value to substitute if the numeric field is not found in the documents.

Return Value

Type: SearchScoreDefinition<TDocument>
A boost score modifier.

Reference

SearchScoreDefinitionBuilder<TDocument> Class

Boost Overload

MongoDB.Driver.Search Namespace