Skip to Navigation
Boost Search Results
-
When querying with some filtering conditions,
a basic score is calculated for each document in the results by the underlying engine. -
In order to prioritize results,
you can provide a boost value to the searched terms which will be integrated with the basic score. -
Usually, the higher the boost value, the more relevant the term will be,
resulting in a higher ranking of its matching document in the results. -
In this page:
Boost results - when making a full-text search
const employees = await session
// Make a dynamic full-text search Query on 'Employees' collection
.query({ collection: "Employees"})
// This search predicate will use the default boost value of 1
.search('Notes', 'English')
// This search predicate will use a boost value of 10
.search('Notes', 'Italian')
// Call 'boost' to set the boost value of the previous 'search' call
.boost(10)
.all();
// * Results will contain all Employee documents that have
// EITHER 'English' OR 'Italian' in their 'Notes' field.
//
// * Matching documents with 'Italian' will be listed FIRST in the results,
// before those with 'English'.
//
// * Search is case-insensitive.from "Employees" where
search(Notes, "English") or boost(search(Notes, "Italian"), 10)
{"p0":"English","p1":"Italian"}
Boost results - when querying with where clause
const companies = await session
// Make a dynamic DocumentQuery on 'Companies' collection
.query({ collection: "Companies"})
// Define a 'where' condition
.whereStartsWith("Name", "O")
// Call 'boost' to set the boost value of the previous 'where' predicate
.boost(10)
// Call 'orElse' so that OR operator will be used between statements
.orElse()
.whereStartsWith("Name", "P")
.boost(50)
.orElse()
.whereEndsWith("Name", "OP")
.boost(90)
.all();
// * Results will contain all Company documents that either
// (start-with 'O') OR (start-with 'P') OR (end-with 'OP') in their 'Name' field.
//
// * Matching documents the end-with 'OP' will be listed FIRST.
// Matching documents that start-with 'P' will then be listed.
// Matching documents that start-with 'O' will be listed LAST.
//
// * Search is case-insensitive.from "Companies" where
boost(startsWith(Name, "O"), 10) or
boost(startsWith(Name, "P"), 50) or
boost(endsWith(Name, "OP"), 90)
Get resulting score
-
The score can be retrieved by either:
-
Request to include explanations when making the query.
See include query explanations. -
Get the metadata of the resulting entities that were loaded to the session.
See example below.
-
// Make a query:
// =============
const employees = await session
.query({ collection: "Employees"})
.search('Notes', 'English')
.search('Notes', 'Italian')
.boost(10)
.all();
// Get the score:
// ==============
// Call 'getMetadataFor', pass an entity from the resulting employees list
const metadata = session.advanced.getMetadataFor(employees[0]);
// Score is available in the '@index-score' metadata property
const score = metadata[CONSTANTS.Documents.Metadata.INDEX_SCORE];
Related Articles