Class: Aws::Kendra::Types::RetrieveResultItem

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

Overview

A single retrieved relevant passage result.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#contentString

The contents of the relevant passage.

Returns:

  • (String)


8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8614

class RetrieveResultItem < Struct.new(
  :id,
  :document_id,
  :document_title,
  :content,
  :document_uri,
  :document_attributes,
  :score_attributes)
  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:



8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8614

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

#document_idString

The identifier of the document.

Returns:

  • (String)


8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8614

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

#document_titleString

The title of the document.

Returns:

  • (String)


8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8614

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

#document_uriString

The URI of the original location of the document.

Returns:

  • (String)


8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8614

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

#idString

The identifier of the relevant passage result.

Returns:

  • (String)


8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8614

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

#score_attributesTypes::ScoreAttributes

The confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.



8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8614

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