Class: Aws::Kendra::Types::Highlight

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::Highlight

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #begin_offset ⇒ Integer

  The zero-based location in the response string where the highlight starts.

• #end_offset ⇒ Integer

  The zero-based location in the response string where the highlight ends.

• #top_answer ⇒ Boolean

  Indicates whether the response is the best response.

• #type ⇒ String

  The highlight type.

Instance Attribute Details

#begin_offset ⇒ Integer

The zero-based location in the response string where the highlight starts.

Returns:

• (Integer)

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

class Highlight < Struct.new(
  :begin_offset,
  :end_offset,
  :top_answer,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#end_offset ⇒ Integer

The zero-based location in the response string where the highlight ends.

Returns:

• (Integer)

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

class Highlight < Struct.new(
  :begin_offset,
  :end_offset,
  :top_answer,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#top_answer ⇒ Boolean

Indicates whether the response is the best response. True if this is the best response; otherwise, false.

Returns:

• (Boolean)

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

class Highlight < Struct.new(
  :begin_offset,
  :end_offset,
  :top_answer,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The highlight type.

Returns:

• (String)

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

class Highlight < Struct.new(
  :begin_offset,
  :end_offset,
  :top_answer,
  :type)
  SENSITIVE = []
  include Aws::Structure
end