Boost Documents Stage

The Boost Documents query pipeline stage adds boosting parameters to matched documents based on user-defined rules. Boosts are defined with a term value to boost and the boost factor to add. The boosting parameters are added to the bq Solr query parameter.

The Boost Documents rule consists of the following elements:

  • field - the document field to filter on

  • keywords - the words, phrases, or regex used as the filter

  • mode - filtering logic applied to keywords, one of:

    • exact - the keyword and the query must match exactly. This is case-sensitive.

    • phrase phrase matching on the items in the keywords list

    • regex treat items in the keywords list as a regex

    • match must match every item in the keyword list, but doesn’t require phrase matchin

  • boosts - consists of a list of pairs

    • value - one or more terms used for boosting

    • boost - the numeric boost value. Default 100.

Configuration

Tip
 When entering configuration values in the UI, use unescaped characters, such as \t for the tab character. When entering configuration values in the API, use escaped characters, such as \\t for the tab character.