The query terms that are not matched by the result.
Contains the child results of the item, if parent-child loading was performed.
See the Folding component.
Contains the clickable URI of the item, which you can set on an href in your search interface.
See the ResultLink component.
Contains an excerpt of the item. Can be empty for certain types of items (e.g., images, videos, etc.).
See the Excerpt component.
Contains the list of flags for the item. Values are separated by a semicolon characters (;).
Contains a value specifying whether the item has an HTML version.
See the Quickview component.
Contains the 0-based index value of the result, as returned by the Coveo REST Search API.
Contains a value that specifies whether the result was recommended by the Coveo Machine Learning service.
See the Recommendation component.
See also Coveo Machine Learning.
Specifies whether the result is a Featured Result in the Coveo Query Pipeline (see Adding and Managing Query Pipeline Featured Results).
Whether the result item was previously viewed by the user specified in the userActions request of the query.
Contains the parent result of the item, if parent-child loading was performed.
See the Folding component.
Contains a printable URI (or path) to the item.
Contains the query UID, as returned by the Coveo REST Search API.
This value is used mainly for usage analytics.
The Coveo JavaScript Search Framework adds this property client-side to each result.
Contains ranking information, which the Coveo REST Search API returns along with the item when the query
debug property is true.
Note:
The Coveo Cloud V2 platform does not support collaborative rating. Therefore, this property is obsolete in Coveo Cloud V2.
Contains the collaborative rating value for the item.
See the ResultRating component.
Contains the raw field values of the item, expressed as key-value pairs.
The SearchInterface inside which this result is rendered.
This value is used mainly to allow for conditional rendering of results templates.
The Coveo JavaScript Search Framework adds this property client-side to each result.
Contains the query state of the SearchInterface inside which this result is rendered.
This value is used mainly to allow for conditional rendering of results templates.
The Coveo JavaScript Search Framework adds this property client-side to each result.
Contains the title of the item.
Contains the unique ID of the item.
This parameter is useful when making certain calls to a SearchEndpoint.
Contains the URI of the item.
The
IQueryResultinterface describes a single result returned by the Coveo REST Search API.