Coveo Recommendations

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

Usage Notes

Insertion Location

Coveo Hive

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 Hive SXA

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 the resultsPerPage component option.

Hide if no results

See the hideIfNoResults component option.

Main search interface

See the mainSearchInterface component option. If left empty, the rendering acts as a standalone search interface.

Filter results based on the current Sitecore context database

See the Sitecore Instance Filter rendering data source options.

Filter results on the current context language

See the Sitecore Instance Filter rendering data source options.

Filter results on the latest version

See the Sitecore Instance Filter rendering data source options.

Query pipeline

See the pipeline component option.

Maximum age

See the maximumAge component option.

DOM unique ID

Randomly generated HTML element ID.

Additional data attributes

Allows use of the Coveo JavaScript Search Framework Recommendation component options that aren’t directly available in the data source.

Sample Generated HTML and Corresponding Visual Output

<div id="coveof3fa2f49" class="CoveoRecommendation CoveoSearchInterface Coveostate
CoveoComponentState CoveoComponentOptions CoveoQueryController CoveoDebug coveo-after-initialization"
data-results-per-page="3" data-prebind-maximum-age="currentMaximumAge"
data-pipeline="recommendations" data-title="Recommendations"
data-prebind-main-search-interface="mainSearchInterfaceSelector"
data-main-search-interface="#coveo20ee610d" data-applied-prebind="true" data-maximum-age="0"
style="" data-coveo-for-sitecore-event-registered="true">
Recommendation Rendering Example
What's next for me?