FeaturedResultsItem

A single featured result item. A featured result is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.

AdditionalAttributes

One or more additional attributes associated with the featured result.

Type: Array of AdditionalResultAttribute objects

Required: No

DocumentAttributes

An array of document attributes assigned to a featured document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.

Type: Array of DocumentAttribute objects

Required: No

DocumentExcerpt

Provides text and information about where to highlight the text.

Type: TextWithHighlights object

Required: No

DocumentId

The identifier of the featured document.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

DocumentTitle

Provides text and information about where to highlight the text.

Type: TextWithHighlights object

Required: No

DocumentURI

The source URI location of the featured document.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^(https?|ftp|file):\/\/([^\s]*)

Required: No

FeedbackToken

A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^\P{C}*.\P{C}*$

Required: No

Id

The identifier of the featured result.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 73.

Required: No

Type

The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.

Type: String

Valid Values: DOCUMENT | QUESTION_ANSWER | ANSWER

Required: No

FeaturedResultsItem

Contents

See Also