Support Menu

Interface IQueryResult

Interface IQueryResult

The IQueryResult interface describes a single result returned by the Coveo REST Search API.

Index

Properties

childResults

childResults: IQueryResult[]

Contains the child results of the item, if parent-child loading was performed.

See the Folding component.

clickUri

clickUri: string

Contains the clickable URI of the item, which you can set on an href in your search interface.

See the ResultLink component.

excerpt

excerpt: string

Contains an excerpt of the item. Can be empty for certain types of items (e.g., images, videos, etc.).

See the Excerpt component.

flags

flags: string

Contains the list of flags for the item. Values are separated by a semicolon characters (;).

hasHtmlVersion

hasHtmlVersion: boolean

Contains a value specifying whether the item has an HTML version.

See the Quickview component.

Optional index

index: number

Contains the 0-based index value of the result, as returned by the Coveo REST Search API.

isRecommendation

isRecommendation: boolean

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.

Optional parentResult

parentResult: IQueryResult

Contains the parent result of the item, if parent-child loading was performed.

See the Folding component.

printableUri

printableUri: string

Contains a printable URI (or path) to the item.

Optional queryUid

queryUid: string

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.

rankingInfo

rankingInfo: string

Contains ranking information, which the Coveo REST Search API returns along with the item when the query debug property is true.

Optional rating

rating: number

Contains the collaborative rating value for the item.

See the ResultRating component.

raw

raw: any

Contains the raw field values of the item, expressed as key-value pairs.

searchInterface

searchInterface: SearchInterface

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.

state

state: object

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.

Type declaration

  • [attribute: string]: any

title

title: string

Contains the title of the item.

uniqueId

uniqueId: string

Contains the unique ID of the item.

This parameter is useful when making certain calls to a SearchEndpoint.

uri

uri: string

Contains the URI of the item.

Hierarchy

  • IQueryResult