NAME

Paws::Kendra::Highlight

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Kendra::Highlight object:

$service_obj->Method(Att1 => { BeginOffset => $value, ..., Type => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::Highlight object:

$result = $service_obj->Method(...);
$result->Att1->BeginOffset

DESCRIPTION

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

ATTRIBUTES

REQUIRED BeginOffset => Int

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

REQUIRED EndOffset => Int

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

TopAnswer => Bool

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

Type => Str

The highlight type.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Kendra

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues