Coveo Recommendations

Implements the Coveo JavaScript Search Framework Recommendation component to get Recommendations from the Coveo Machine Learning engine.

Usage Notes

The Coveo Recommendations rendering can be used as a standalone search interface. It always acts as a full-fledged search interface and requires a dedicated analytics component (see Coveo For Sitecore Analytics).

For leading practices in the implementation of Coveo Recommendations, see Deploying Coveo Machine Learning Event Recommendations (ER).

Insertion Location

The Coveo Recommendations rendering is an Allowed Control in the following placeholder(s): Coveo UI, Recommendations.

Example insertion sequence for the Coveo Recommendations rendering.

Coveo for Sitecore SXA rendering insertion locations aren’t limited by placeholder Allowed Controls. The Coveo Recommendations rendering may therefore be inserted throughout the partial design, whether in Coveo for Sitecore or Sitecore placeholders.

Example insertion sequence for the Coveo Recommendations rendering.

Data Source Options

Option name Description
Title The text to show in the header
Results per page See resultsPerPage component option
Hide if no results See hideIfNoResults component option
Coveo for Sitecore (February 28, 2020)
Main search interface
See mainSearchInterface component option. If left empty, the rendering acts as a standalone search interface.
Query pipeline See pipeline component option
Maximum age See maximumAge component option
DOM unique Id Randomly generated HTML element id
Additional data attributes Allows use of Recommendation component options not directly available in the data source (see Passing Non-Fronted JavaScript Framework Properties to Hive Components)

Sample Generated HTML and Corresponding Visual Output

<div id="coveo1cc93c10" class="CoveoRecommendation CoveoSearchInterface Coveostate
CoveoComponentState CoveoComponentOptions CoveoQueryController coveo-after-initialization
CoveoDebug" data-results-per-page="3" data-prebind-maximum-age="currentMaximumAge" 
data-title="Recommendations" data-applied-prebind="true" data-maximum-age="0" 
data-main-search-interface="#coveo5c7ed6eb" data-coveo-for-sitecore-event-
registered="true">

Recommendation Rendering Example

Recommended Articles