You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

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:

Instance Attribute Summary collapse

Instance Attribute Details

#begin_offset ⇒ Integer

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

Returns:

  • (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.

Returns:

  • (Integer) —

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

#top_answer ⇒ Boolean

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

Returns:

  • (Boolean) —

    Indicates whether the response is the best response.