NAME

Paws::Kendra::QueryResultItem

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::QueryResultItem object:

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

Results returned from an API call

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

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

DESCRIPTION

A single query result.

A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

ATTRIBUTES

AdditionalAttributes => ArrayRef[Paws::Kendra::AdditionalResultAttribute]

DocumentAttributes => ArrayRef[Paws::Kendra::DocumentAttribute]

An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.

DocumentExcerpt => Paws::Kendra::TextWithHighlights

An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

DocumentId => Str

The unique identifier for the document.

DocumentTitle => Paws::Kendra::TextWithHighlights

The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

DocumentURI => Str

The URI of the original location of the document.

Id => Str

The unique identifier for the query result.

Type => Str

The type of document.

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