Class: Aws::Kendra::Types::ExpandedResultItem

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

Overview

A single expanded result in a collapsed group of search results.

An expanded result item contains information about an expanded result document within a collapsed group of search results. 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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_attributes ⇒ Array<Types::DocumentAttribute>

An array of document 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:



4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4970

class ExpandedResultItem < Struct.new(
  :id,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#document_excerpt ⇒ Types::TextWithHighlights

Provides text and information about where to highlight the text.

Returns:



4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4970

class ExpandedResultItem < Struct.new(
  :id,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#document_id ⇒ String

The idenitifier of the document.

Returns:

  • (String) 


4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4970

class ExpandedResultItem < Struct.new(
  :id,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#document_title ⇒ Types::TextWithHighlights

Provides text and information about where to highlight the text.

Returns:



4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4970

class ExpandedResultItem < Struct.new(
  :id,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#document_uri ⇒ String

The URI of the original location of the document.

Returns:

  • (String) 


4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4970

class ExpandedResultItem < Struct.new(
  :id,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The identifier for the expanded result.

Returns:

  • (String) 


4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4970

class ExpandedResultItem < Struct.new(
  :id,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes)
  SENSITIVE = []
  include Aws::Structure
end