class Aws::Kendra::Types::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.

@!attribute [rw] id

The unique identifier for the query result.
@return [String]

@!attribute [rw] type

The type of document.
@return [String]

@!attribute [rw] additional_attributes

One or more additional attributes associated with the query result.
@return [Array<Types::AdditionalResultAttribute>]

@!attribute [rw] document_id

The unique identifier for the document.
@return [String]

@!attribute [rw] document_title

The title of the document. Contains the text of the title and
information for highlighting the relevant terms in the title.
@return [Types::TextWithHighlights]

@!attribute [rw] document_excerpt

An extract of the text in the document. Contains information about
highlighting the relevant terms in the excerpt.
@return [Types::TextWithHighlights]

@!attribute [rw] document_uri

The URI of the original location of the document.
@return [String]

@!attribute [rw] document_attributes

An array of document attributes for the document that the query
result maps to. For example, the document author (Author) or the
source URI (SourceUri) of the document.
@return [Array<Types::DocumentAttribute>]

@!attribute [rw] score_attributes

Indicates the confidence that Amazon Kendra has that a result
matches the query that you provided. 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
matches the query.
@return [Types::ScoreAttributes]

@!attribute [rw] feedback_token

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 ][1].

[1]: https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResultItem AWS API Documentation

Constants

SENSITIVE