1. Interfaces

Boost

Version:
TypeInterface
Import path@sitecore-cloudsdk/search/browser

Boost rules for a search request. Used to improve the visibility of certain content by making an item or group of items appear higher in the search results.

Signature

interface Boost {
  filter: Filter;
  slots?: ArrayOfAtLeastOne<number>;
  weight?: number;
}

Properties

NameTypeDescriptionValue
filterFilterRequired.Various filter criteria that can be used to filter search results or recommendations.N/A
slotsinteger[]Optional.A position or positions in a list of search results to which you can apply pin, include, or boost rules.Minimum: 1.[4, 5]
weightOne of
Optional.Weight to apply for this boost rule. We recommend that you do not set a value to a number greater than 5.0. This is to minimize the impact of a single component on the overall scoring system.To boost index documents without using slots, we recommend that you add a weight greater than the default.Default: 1.0Minimum: 0.1Maximum: 1001.00.499
If you have suggestions for improving this article, let us know!