ejsBoostFactorScoreFunction

The boost_factor score allows you to multiply the score by the provided boost_factor. This can sometimes be desired since boost value set on specific queries gets normalized, while for this score function it does not.

Module

 BoostFactorScoreFunction

BoostFactorScoreFunction ( boostVal )

Multiply the score by the provided boost_factor.


Parameters
boostVal <Float> the boost factor.

Method Summary

Returns Name Description
String_type()The type of ejs object. For internal use only.
Objectboost(b)Sets the boost factor.
Objectfilter(oFilter)Adds a filter whose matching documents will have the score function applied.
StringtoJSON()

Retrieves the internal agg object. This is typically used by internal API functions so use with caution.


Method Detail

 _type

String _type ( )
The type of ejs object. For internal use only.

Returns
the type of object

 boost

Object boost ( b )
Sets the boost factor.

Parameters
b <Float> the boost factor.
Returns
returns this so that calls can be chained.

 filter

Object filter ( oFilter )
Adds a filter whose matching documents will have the score function applied.

Parameters
oFilter <Filter> Any valid Filter object.
Returns
returns this so that calls can be chained.

 toJSON

String toJSON ( )

Retrieves the internal agg object. This is typically used by internal API functions so use with caution.


Returns
returns this object's internal object.

Request

Queries

Filters

Aggregations

Facets

Suggesters

Geo