@sitecore-cloudsdk/search/server

Boost

Version:

Type	Interface
Import path	`@sitecore-cloudsdk/search/server`

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

Name	Type	Description	Value
`filter`	`Filter`	Required. Various filter criteria that can be used to filter search results or recommendations.	N/A
`slots`	`integer[]`	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]`
`weight`	One of: `integer` `float`	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.0` Minimum: `0.1` Maximum: `100`	`1.0` `0.4` `99`

Name

Type

Description

Value

filter

Filter

Required.

Various filter criteria that can be used to filter search results or recommendations.

N/A

slots

integer[]

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]

weight

One of:

integer
float

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.0

Minimum: 0.1

Maximum: 100

1.0
0.4
99

If you have suggestions for improving this article, let us know!