SearchScore

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

Alphabetic
By Inheritance

Inherited

SearchScore
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
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
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
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
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
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
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
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
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.
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Ungrouped

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
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
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
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
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
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
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
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
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.
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)

Packages

Driver structure

SearchScore

object SearchScore

Value Members

Deprecated Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

Packages

Driver structure

SearchScore

object SearchScore

Value Members

Deprecated Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

SearchScore