Class: Aws::Kendra::Types::QueryResultItem

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::QueryResultItem

Defined in:

(unknown)

Overview

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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #additional_attributes ⇒ Array<Types::AdditionalResultAttribute>

  One or more additional attributes associated with the query result.

• #document_attributes ⇒ Array<Types::DocumentAttribute>

  An array of document attributes for the document that the query result maps to.

• #document_excerpt ⇒ Types::TextWithHighlights

  An extract of the text in the document.

• #document_id ⇒ String

  The unique identifier for the document.

• #document_title ⇒ Types::TextWithHighlights

  The title of the document.

• #document_uri ⇒ String

  The URI of the original location of the document.

• #id ⇒ String

  The unique identifier for the query result.

• #score_attributes ⇒ Types::ScoreAttributes

  Indicates the confidence that Amazon Kendra has that a result matches the query that you provided.

• #type ⇒ String

  The type of document.

Instance Attribute Details

#additional_attributes ⇒ Array<Types::AdditionalResultAttribute>

One or more additional attributes associated with the query result.

Returns:

• (Array<Types::AdditionalResultAttribute>) —

  One or more additional attributes associated with the query result.

#document_attributes ⇒ Array<Types::DocumentAttribute>

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.

Returns:

• (Array<Types::DocumentAttribute>) —

  An array of document attributes for the document that the query result maps to.

#document_excerpt ⇒ Types::TextWithHighlights

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

Returns:

• (Types::TextWithHighlights) —

  An extract of the text in the document.

#document_id ⇒ String

The unique identifier for the document.

Returns:

• (String) —

  The unique identifier for the document.

#document_title ⇒ Types::TextWithHighlights

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

Returns:

• (Types::TextWithHighlights) —

  The title of the document.

#document_uri ⇒ String

The URI of the original location of the document.

Returns:

• (String) —

  The URI of the original location of the document.

#id ⇒ String

The unique identifier for the query result.

Returns:

• (String) —

  The unique identifier for the query result.

#score_attributes ⇒ Types::ScoreAttributes

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.

Returns:

• (Types::ScoreAttributes) —

  Indicates the confidence that Amazon Kendra has that a result matches the query that you provided.

#type ⇒ String

The type of document.

Possible values:

• DOCUMENT
• QUESTION_ANSWER
• ANSWER

Returns:

• (String) —

  The type of document.