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 fields/attributes associated with the query result.



8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
# File 'lib/aws-sdk-kendra/types.rb', line 8126

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

#collapsed_result_detailTypes::CollapsedResultDetail

Provides details about a collapsed group of search results.



8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
# File 'lib/aws-sdk-kendra/types.rb', line 8126

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

#document_attributesArray<Types::DocumentAttribute>

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.

Returns:



8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
# File 'lib/aws-sdk-kendra/types.rb', line 8126

class QueryResultItem < Struct.new(
  :id,
  :type,
  :format,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token,
  :table_excerpt,
  :collapsed_result_detail)
  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.



8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
# File 'lib/aws-sdk-kendra/types.rb', line 8126

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

#document_idString

The identifier for the document.

Returns:

  • (String)


8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
# File 'lib/aws-sdk-kendra/types.rb', line 8126

class QueryResultItem < Struct.new(
  :id,
  :type,
  :format,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token,
  :table_excerpt,
  :collapsed_result_detail)
  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.



8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
# File 'lib/aws-sdk-kendra/types.rb', line 8126

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

#document_uriString

The URI of the original location of the document.

Returns:

  • (String)


8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
# File 'lib/aws-sdk-kendra/types.rb', line 8126

class QueryResultItem < Struct.new(
  :id,
  :type,
  :format,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token,
  :table_excerpt,
  :collapsed_result_detail)
  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]: docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html

Returns:

  • (String)


8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
# File 'lib/aws-sdk-kendra/types.rb', line 8126

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

#formatString

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`.

Returns:

  • (String)


8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
# File 'lib/aws-sdk-kendra/types.rb', line 8126

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

#idString

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.

Returns:

  • (String)


8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
# File 'lib/aws-sdk-kendra/types.rb', line 8126

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

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



8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
# File 'lib/aws-sdk-kendra/types.rb', line 8126

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

#table_excerptTypes::TableExcerpt

An excerpt from a table within a document.

Returns:



8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
# File 'lib/aws-sdk-kendra/types.rb', line 8126

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

#typeString

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

Returns:

  • (String)


8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
# File 'lib/aws-sdk-kendra/types.rb', line 8126

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