SearchRankingOptions

Version:


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

The ranking parameter of the search widget item. Used to configure search result ranking.

Signature

export interface SearchRankingOptions {
  name: string;
  weight?: number;
}

Name	Type	Description	Value
name	string	Required.The name of the attribute to use for ranking. The attribute must be enabled for search ranking.To check that the attribute is enabled for search ranking in Sitecore Search, click Administration > Domain Settings > Attributes > the attribute of your choice > Use For Features > Search Ranking.	"last_modified"
weight	integer	Optional.Weight to apply to this ranking attribute. We recommend that you pass a low value to minimize the impact of a single component on the overall scoring system.If you rank by a timestamp attribute such as last_modified, the weight for potential matches changes with time as follows matches whose timestamp attribute exactly matches the request's timestamp get the full weight.Potential matches whose timestamp attribute is within one week of the request's timestamp get half the weight.Potential matches whose timestamp attribute is more than one week behind the request's timestamp get zero weight.For example, you send a request on Friday, May 26 at `1:30` p.m. with a ranking weight of 3. An index document whose last_modified attribute has a value of May 23 will get a ranking weight of 1.5. However, an index document whose last_modified attribute has the value May 15 will get a ranking weight of 0.Default: 1.0Minimum: 1Maximum: 100	1.0

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