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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#begin_offsetInteger

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

Returns:

  • (Integer)

3696
3697
3698
3699
3700
3701
3702
3703
# File 'lib/aws-sdk-kendra/types.rb', line 3696

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

#end_offsetInteger

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

Returns:

  • (Integer)

3696
3697
3698
3699
3700
3701
3702
3703
# File 'lib/aws-sdk-kendra/types.rb', line 3696

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

#top_answerBoolean

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

Returns:

  • (Boolean)

3696
3697
3698
3699
3700
3701
3702
3703
# File 'lib/aws-sdk-kendra/types.rb', line 3696

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

#typeString

The highlight type.

Returns:

  • (String)

3696
3697
3698
3699
3700
3701
3702
3703
# File 'lib/aws-sdk-kendra/types.rb', line 3696

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