Interface Result

interface Result {
    absentTerms: string[];
    clickUri: string;
    excerpt: string;
    excerptHighlights: HighlightKeyword[];
    firstSentences: string;
    firstSentencesHighlights: HighlightKeyword[];
    flags: string;
    hasHtmlVersion: boolean;
    isRecommendation: boolean;
    isTopResult: boolean;
    isUserActionView: boolean;
    percentScore: number;
    printableUri: string;
    printableUriHighlights: HighlightKeyword[];
    rankingInfo: null | string;
    rankingModifier?: string;
    raw: Raw;
    score: number;
    searchUid: string;
    summary: null;
    summaryHighlights: HighlightKeyword[];
    title: string;
    titleHighlights: HighlightKeyword[];
    uniqueId: string;
    uri: string;
}

Properties

absentTerms

absentTerms: string[]

The basic query expression terms which this query result item does not match. Note: This property is populated by terms from the query pipeline-processed q value (not from the original q value).

Example

["platform", "native", "solution"]

clickUri

clickUri: string

The hyperlinkable item URI. Notes: Use the clickUri value when you want to create hyperlinks to the item, rather than the uri or printableUri value.

Example

https://example.com/t/1/898/2

excerpt

excerpt: string

The contextual excerpt generated for the item (see the excerptLength query parameter).

Example

... the new Coveo Cloud V2 and Coveo Cloud V1 ... the main differences between the two Coveo Cloud versions ...

excerptHighlights

excerptHighlights: HighlightKeyword[]

The length and offset of each word to highlight in the item excerpt string.

firstSentences

firstSentences: string

The first sentences retrieved from the item (see the retrieveFirstSentences query parameter).

Example

Hello, I know Coveo currently hosts organizations in two independent cloud platforms, the new Coveo Cloud V2 and Coveo Cloud V1, the original Coveo offering in the cloud. I would like to learn the main differences between the two Coveo Cloud versions ...

firstSentencesHighlights

firstSentencesHighlights: HighlightKeyword[]

The length and offset of each word to highlight in the item firstSentences string.

flags

flags: string

The flags that are set on the item by the index. Distinct values are separated by semicolons.

Example

HasHtmlVersion;HasMobileHtmlVersion

hasHtmlVersion

hasHtmlVersion: boolean

Whether the index contains an HTML version of this item.

isRecommendation

isRecommendation: boolean

Whether the item score was boosted as a Coveo ML recommendation.

isTopResult

isTopResult: boolean

Whether the item score was boosted by a featured result rule in the query pipeline.

isUserActionView

isUserActionView: boolean

Whether the result item has been previously viewed by one of the users specified in the canSeeUserProfileOf section of the search token generated to perform the search request.

percentScore

percentScore: number

The item ranking score expressed as a percentage (see the sortCriteria and rankingFunctions query parameters).

Example

90.7539

printableUri

printableUri: string

The human readable item URI. Note: Avoid using the printableUri value to create hyperlinks to the item. Use the clickUri value instead.

Example

https://example.com/topic:898/post:2

printableUriHighlights

printableUriHighlights: HighlightKeyword[]

The length and offset of each word to highlight in the item printableUri string.

rankingInfo

rankingInfo: null | string

The raw debug information generated by the index to detail how the item was ranked. This property is null unless the debug query parameter is set to true.

Example

Document weights:\nTitle: 0; Quality: 180; Date: 596; Adjacency: 0; Source: 500; Custom: 350; Collaborative rating: 0; QRE: 0; Ranking functions: 0; \n\nTotal weight: 1626

`Optional`rankingModifier

rankingModifier?: string

If applicable, represents the type of ranking modification that was applied to this result.

Example

TopResult

raw

raw: Raw

The values of the fields which were retrieved for this item (see the fieldsToInclude and fieldsToExclude query parameters).

Example

{
   *   "clickableuri": "https://example.com/",
   *   "author": "Anonymous",
   *   "date": 1502796809427,
   *   "filetype": "forumpost",
   *   "language":["English"],
   *   "conversationid": 898,
   *   "messageid": 2,
   *   "childid": 2,
   *   "adjustednumberoflikes": 46
   * }

score

score: number

The total ranking score computed for the item (see the sortCriteria and rankingFunctions query parameters).

Example

searchUid

searchUid: string

The unique identifier of the search that returned this result.

summary

summary: null

The item summary (see the summaryLength query parameter).

Example

Document

summaryHighlights

summaryHighlights: HighlightKeyword[]

The length and offset of each word to highlight in the item summary string.

title

title: string

Contains the title of the item.

titleHighlights

titleHighlights: HighlightKeyword[]

The length and offset of each word to highlight in the item title string.

uniqueId

uniqueId: string

The unique item identifier. You should consider the uniqueId value as an opaque string.

Example

84.72597$https://example.com/Root:0/Topic:898/Post:2

uri

uri: string

The item URI. Notes: Avoid using the uri value to create hyperlinks to the item. Use the clickUri value instead.

Example

https://example.com/Root:0/topic:898/post:2

Interface Result

Index

Properties

Properties

absentTerms

Example

clickUri

Example

excerpt

Example

excerptHighlights

firstSentences

Example

firstSentencesHighlights

flags

Example

hasHtmlVersion

isRecommendation

isTopResult

isUserActionView

percentScore

Example

printableUri

Example

printableUriHighlights

rankingInfo

Example

OptionalrankingModifier

Example

raw

Example

score

Example

searchUid

summary

Example

summaryHighlights

title

titleHighlights

uniqueId

Example

uri

Example

Settings

On This Page

`Optional`rankingModifier