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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-kendra/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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #additional_attributes ⇒ Array<Types::AdditionalResultAttribute>

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

• #collapsed_result_detail ⇒ Types::CollapsedResultDetail

  Provides details about a collapsed group of search results.

• #document_attributes ⇒ Array<Types::DocumentAttribute>

  An array of document fields/attributes assigned to a document in the search results.

• #document_excerpt ⇒ Types::TextWithHighlights

  An extract of the text in the document.

• #document_id ⇒ String

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

• #feedback_token ⇒ String

  A token that identifies a particular result from a particular query.

• #format ⇒ String

  If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer.

• #id ⇒ String

  The unique identifier for the query result item id (Id) and the query result item document id (DocumentId) combined.

• #score_attributes ⇒ Types::ScoreAttributes

  Indicates the confidence level of Amazon Kendra providing a relevant result for the query.

• #table_excerpt ⇒ Types::TableExcerpt

  An excerpt from a table within a document.

• #type ⇒ String

  The type of document within the response.

Instance Attribute Details

#additional_attributes ⇒ Array<Types::AdditionalResultAttribute>

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

Returns:

• (Array<Types::AdditionalResultAttribute>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8174

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_detail ⇒ Types::CollapsedResultDetail

Provides details about a collapsed group of search results.

Returns:

• (Types::CollapsedResultDetail)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8174

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_attributes ⇒ Array<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:

• (Array<Types::DocumentAttribute>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8174

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_excerpt ⇒ Types::TextWithHighlights

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

Returns:

• (Types::TextWithHighlights)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8174

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_id ⇒ String

The identifier for the document.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8174

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_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)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8174

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_uri ⇒ String

The URI of the original location of the document.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8174

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_token ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8174

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

#format ⇒ String

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)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8174

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

#id ⇒ String

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)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8174

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_attributes ⇒ Types::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.

Returns:

• (Types::ScoreAttributes)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8174

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_excerpt ⇒ Types::TableExcerpt

An excerpt from a table within a document.

Returns:

• (Types::TableExcerpt)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8174

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

#type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8174

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