Interfaces

SearchOptions

Version:


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

Options for the search widget item object.

Extends ResultsOptions.

Signature

export interface SearchOptions extends ResultsOptions {
  facet?: FacetOptions;
  query?: QueryOptions;
  offset?: number;
  sort?: SearchSortOptions;
  rule?: SearchRuleOptions;
  suggestion?: ArrayOfAtLeastOne<SearchSuggestionOptions>;
  ranking?: ArrayOfAtLeastOne<SearchRankingOptions>;
  personalization?: SearchPersonalizationOptions;
  disableGrouping?: boolean;
  responseContext?: boolean;
}

Properties

Name	Type	Description
facet	FacetOptions	Optional.The facet object of the search widget item. Contains facet settings for the search request. For example, how many individual facets to retrieve and in what order.
query	QueryOptions	Optional.The query object of the search widget item. Settings related to the site visitor's search query.
offset	integer	Optional.The number of items to skip in the results that are returned.Used for pagination by indicating how many results to skip.For example, 10 means the search result shows the 11th item onwards.Minimum: 1.
sort	SearchSortOptions	Optional.Sorting configuration for search results.
rule	SearchRuleOptions	Optional.Options for rules. Rules are modifications to widget behavior that can be used to overwrite the natural set of search results, for example, to boost, bury, pin, and blacklist items.
suggestion	SearchSuggestionOptions[]	The suggestion parameter of the search widget item. Used to configure search suggestions.Minimum length: 1.
ranking	SearchRankingOptions[]	The ranking parameter of the search widget item. Used to configure search result ranking.Minimum length: 1.
personalization	SearchPersonalizationOptions	Options for personalizing search results.
disableGrouping	boolean	Optional.Whether to disable the grouping of results by the grouping attribute.Document grouping must be enabled for the attribute in Sitecore Search > Administration > Domain Settings > General Settings > Document Display Settings.For example, for a clearance sale page, return each color variation of a product separately, ungrouped. For a product listing page, group all variations and return a single product.If unset, this property will not be part of the payload.
responseContext	boolean	Optional.Whether to retrieve additional context details, both explicit and inferred, that Sitecore Search used for returning personalized search results.If true, the response will include the following attributes - the text the site visitor entered in the search field to perform a search.keyphrase - the keyphrase that Sitecore Search used to return results. This might differ from the original keyphrase the site visitor entered.For example, if keyphraseFallback in SearchSuggestionOptions is set to true, Sitecore Search uses the first suggestion as the keyphrase to return results.Default: false

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