The Personalization interface

You can override or update a widget's configuration at runtime. You do this in the search request itself. Various rules are driven by the attributes of the entity in the request.

The interface contains the following properties:

Property	Type	Description
`algorithm`	string	Algorithm to use to get personalized results for the user. You can use either the mlt or affinity algorithm. The algorithms are similar but use different techniques to personalize results. mlt uses specific documents from the user's past interactions and shows similar items in the results. For example, if a visitor has interacted with blogs about cloud services, this algorithm will show items that are like blogs about cloud services. affinity does not use specific documents. Instead, it considers the user's browsing history and looks at metrics for different attributes. For example, this algorithm might learn that a specific visitor likes the color red based on their past searches and clicks. The algorithm then boosts results that have the attribute red.
`field`	Array<string>	List of attributes to use for determining similar content. To mark an attribute for search ranking in Sitecore Search, on the menu bar, click Administration > Domain Settings > Attributes, then select an attribute, click Use For Features, and select the Personalization check box. If the `field` property is empty, all attributes marked for personalization in the Sitecore Search interface are used.
`ids`	Array<string>	List of IDs to use to look similar content. For example, the ID of a blog post the visitor has recently clicked. If you do not pass any ID, the user's past event data is used. The `ids` parameter only applies to the mlt algorithm.

Property

Type

Description

algorithm

string

Algorithm to use to get personalized results for the user. You can use either the mlt or affinity algorithm. The algorithms are similar but use different techniques to personalize results.

mlt uses specific documents from the user's past interactions and shows similar items in the results. For example, if a visitor has interacted with blogs about cloud services, this algorithm will show items that are like blogs about cloud services.
affinity does not use specific documents. Instead, it considers the user's browsing history and looks at metrics for different attributes. For example, this algorithm might learn that a specific visitor likes the color red based on their past searches and clicks. The algorithm then boosts results that have the attribute red.

field

Array<string>

List of attributes to use for determining similar content.

To mark an attribute for search ranking in Sitecore Search, on the menu bar, click Administration > Domain Settings > Attributes, then select an attribute, click Use For Features, and select the Personalization check box.

If the field property is empty, all attributes marked for personalization in the Sitecore Search interface are used.

ids

Array<string>

List of IDs to use to look similar content. For example, the ID of a blog post the visitor has recently clicked. If you do not pass any ID, the user's past event data is used.

The ids parameter only applies to the mlt algorithm.

Note

Unless indicated otherwise, all values are optional.

Do you have some feedback for us?

If you have suggestions for improving this article,