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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_attributesArray<Types::AdditionalResultAttribute>

One or more additional attributes associated with the query result.


4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
# File 'lib/aws-sdk-kendra/types.rb', line 4631

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#document_attributesArray<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:


4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
# File 'lib/aws-sdk-kendra/types.rb', line 4631

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#document_excerptTypes::TextWithHighlights

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


4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
# File 'lib/aws-sdk-kendra/types.rb', line 4631

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#document_idString

The unique identifier for the document.

Returns:

  • (String)

4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
# File 'lib/aws-sdk-kendra/types.rb', line 4631

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#document_titleTypes::TextWithHighlights

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


4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
# File 'lib/aws-sdk-kendra/types.rb', line 4631

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#document_uriString

The URI of the original location of the document.

Returns:

  • (String)

4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
# File 'lib/aws-sdk-kendra/types.rb', line 4631

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#feedback_tokenString

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]: docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html

Returns:

  • (String)

4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
# File 'lib/aws-sdk-kendra/types.rb', line 4631

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The unique identifier for the query result.

Returns:

  • (String)

4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
# File 'lib/aws-sdk-kendra/types.rb', line 4631

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#score_attributesTypes::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.


4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
# File 'lib/aws-sdk-kendra/types.rb', line 4631

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of document.

Returns:

  • (String)

4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
# File 'lib/aws-sdk-kendra/types.rb', line 4631

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end