Coveo Recommendations

This is for:

Developer System Administrator

In this article

Usage notes
Insertion location
Data source options
Sample generated HTML and corresponding visual output

Legacy feature

This article pertains to the Coveo Hive framework which is now in maintenance mode.

Choose one of Coveo’s more modern, lightweight, and responsive libraries for any future search interface development. See the search interface Implementation guide for more details.

Pro and Enterprise editions

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

Usage notes

The Coveo Recommendations rendering always acts as a full-fledged search interface and requires a dedicated analytics component (see Coveo for Sitecore Analytics).
When bound to a search interface through the Main search interface data source option, the Coveo Recommendations rendering inherits the Sitecore Instance Filter configurations set on that search interface.
Coveo for Sitecore 5.0.822.2

The Sitecore Instance Filter rendering is now added automatically with the Coveo Recommendations rendering. This adds the new Filter results based on the current Sitecore context database data source option which lets you control whether to add a filter on the current Sitecore context database in the constant query expression (cq). Prior to the October 30, 2020 release, content recommendations were automatically filtered on the current Sitecore context database.
See Getting content recommendations for full step-by-step instructions on getting content recommendations in Coveo for Sitecore.
For leading practices in the implementation of Coveo Content Recommendations, see Deploy Content Recommendations (CR).
You can customize the CSS associated with this rendering.

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

The following table lists the available data source options for this rendering.

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.
Coveo for Sitecore 5.0.822.2 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.

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.

Coveo for Sitecore 5.0.822.2

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 | Coveo for Sitecore 5