The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Kendra::QueryResultItem

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]

One or more additional attributes associated with the query result.

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.

FeedbackToken => Str

A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback (https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html).

Id => Str

The unique identifier for the query result.

ScoreAttributes => Paws::Kendra::ScoreAttributes

Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

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