Highlight - Amazon Kendra API Reference

Highlight

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

Contents

BeginOffset

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

Type: Integer

Required: Yes

EndOffset

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

Type: Integer

Required: Yes

TopAnswer

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

Type: Boolean

Required: No

Type

The highlight type.

Type: String

Valid Values: STANDARD | THESAURUS_SYNONYM

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: