Include

Version:

Type

Interface

Import path

@sitecore-cloudsdk/search/browser

Include rules for a search request. Used to force a list of items or categories to appear in specific slots, even if they are not in the natural results set for a request.

To force a single item or category to appear in a fixed slot, use PinItem.

Signature

interface Include {
  filter: Filter;
  slots: ArrayOfAtLeastOne<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[]

Required.

A position or positions in a list of search results to which you can apply pin, include, or boost rules.

Minimum length: 1.

[4, 5]

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