QueryResultItem

A single query result.

A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

AdditionalAttributes

One or more additional fields/attributes associated with the query result.

Type: Array of AdditionalResultAttribute objects

Required: No

CollapsedResultDetail

Provides details about a collapsed group of search results.

Type: CollapsedResultDetail object

Required: No

DocumentAttributes

An array of document fields/attributes assigned to a 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

An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

Type: TextWithHighlights object

Required: No

DocumentId

The identifier for the document.

Type: String

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

Required: No

DocumentTitle

The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

Type: TextWithHighlights object

Required: No

DocumentURI

The URI of the original location of the 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 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

Format

If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt.

Type: String

Valid Values: TABLE | TEXT

Required: No

Id

The unique identifier for the query result item id (Id) and the query result item document id (DocumentId) combined. The value of this field changes with every request, even when you have the same documents.

Type: String

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

Required: No

ScoreAttributes

Indicates the confidence level of Amazon Kendra providing a relevant result for the query. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result is relevant to the query.

Type: ScoreAttributes object

Required: No

TableExcerpt

An excerpt from a table within a document.

Type: TableExcerpt object

Required: No

Type

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

Type: String

Valid Values: DOCUMENT | QUESTION_ANSWER | ANSWER

Required: No

QueryResultItem

Contents

See Also