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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::RetrieveResultItem

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

A single retrieved relevant passage result.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #content ⇒ String

  The contents of the relevant passage.

• #document_attributes ⇒ Array<Types::DocumentAttribute>

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

• #document_id ⇒ String

  The identifier of the document.

• #document_title ⇒ String

  The title of the document.

• #document_uri ⇒ String

  The URI of the original location of the document.

• #id ⇒ String

  The identifier of the relevant passage result.

• #score_attributes ⇒ Types::ScoreAttributes

  The confidence score bucket for a retrieved passage result.

Instance Attribute Details

#content ⇒ String

The contents of the relevant passage.

Returns:

• (String)

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

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

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

#document_id ⇒ String

The identifier of the document.

Returns:

• (String)

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

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

#document_title ⇒ String

The title of the document.

Returns:

• (String)

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

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

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

#id ⇒ String

The identifier of the relevant passage result.

Returns:

• (String)

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

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

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

Returns:

• (Types::ScoreAttributes)

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

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