Packages

object SearchScore

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

Annotations
@Beta()
Since

4.7

See also

Scoring

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SearchScore
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def boost(path: FieldSearchPath): PathBoostSearchScore

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

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

    path

    The numeric field whose value to multiply the score by.

    returns

    The requested SearchScore.

    See also

    boost score modifier

    SearchScoreExpression.pathExpression

  6. def boost(value: Float): ValueBoostSearchScore

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

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

    value

    The positive value to multiply the score by.

    returns

    The requested SearchScore.

    See also

    boost score modifier

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. def constant(value: Float): ConstantSearchScore

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

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

    value

    The positive value to replace the score with.

    returns

    The requested SearchScore.

    See also

    constant score modifier

    SearchScoreExpression.constantExpression

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def function(expression: SearchScoreExpression): FunctionSearchScore

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

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

    expression

    The expression to use when calculating the score.

    returns

    The requested SearchScore.

    See also

    function score modifier

  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. def of(score: Bson): SearchScore

    Creates a SearchScore from a Bson in situations when there is no builder method that better satisfies your needs.

    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.

    val score1: SearchScore = SearchScore.boost(
  SearchPath.fieldPath("fieldName"))
val score2: SearchScore = SearchScore.of(Document("boost" ->
  Document("path" -> SearchPath.fieldPath("fieldName").toValue)))
    score

    A Bson representing the required SearchScore.

    returns

    The requested SearchScore.

  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped