blib/lib/Paws/Kendra/QueryResultItem.pm untested

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 14 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Kendra::QueryResultItem;
3 use Moose;
4 has AdditionalAttributes => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::AdditionalResultAttribute]');
5 has DocumentAttributes => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::DocumentAttribute]');
6 has DocumentExcerpt => (is => 'ro', isa => 'Paws::Kendra::TextWithHighlights');
7 has DocumentId => (is => 'ro', isa => 'Str');
8 has DocumentTitle => (is => 'ro', isa => 'Paws::Kendra::TextWithHighlights');
9 has DocumentURI => (is => 'ro', isa => 'Str');
10 has FeedbackToken => (is => 'ro', isa => 'Str');
11 has Id => (is => 'ro', isa => 'Str');
12 has ScoreAttributes => (is => 'ro', isa => 'Paws::Kendra::ScoreAttributes');
13 has Type => (is => 'ro', isa => 'Str');
14  
15 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::Kendra::QueryResultItem
22  
23 =head1 USAGE
24  
25 This class represents one of two things:
26  
27 =head3 Arguments in a call to a service
28  
29 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
30 Each attribute should be used as a named argument in the calls that expect this type of object.
31  
32 As an example, if Att1 is expected to be a Paws::Kendra::QueryResultItem object:
33  
34 $service_obj->Method(Att1 => { AdditionalAttributes => $value, ..., Type => $value });
35  
36 =head3 Results returned from an API call
37  
38 Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::QueryResultItem object:
39  
40 $result = $service_obj->Method(...);
41 $result->Att1->AdditionalAttributes
42  
43 =head1 DESCRIPTION
44  
45 A single query result.
46  
47 A query result contains information about a document returned by the
48 query. This includes the original location of the document, a list of
49 attributes assigned to the document, and relevant text from the
50 document that satisfies the query.
51  
52 =head1 ATTRIBUTES
53  
54  
55 =head2 AdditionalAttributes => ArrayRef[L<Paws::Kendra::AdditionalResultAttribute>]
56  
57 One or more additional attributes associated with the query result.
58  
59  
60 =head2 DocumentAttributes => ArrayRef[L<Paws::Kendra::DocumentAttribute>]
61  
62 An array of document attributes for the document that the query result
63 maps to. For example, the document author (Author) or the source URI
64 (SourceUri) of the document.
65  
66  
67 =head2 DocumentExcerpt => L<Paws::Kendra::TextWithHighlights>
68  
69 An extract of the text in the document. Contains information about
70 highlighting the relevant terms in the excerpt.
71  
72  
73 =head2 DocumentId => Str
74  
75 The unique identifier for the document.
76  
77  
78 =head2 DocumentTitle => L<Paws::Kendra::TextWithHighlights>
79  
80 The title of the document. Contains the text of the title and
81 information for highlighting the relevant terms in the title.
82  
83  
84 =head2 DocumentURI => Str
85  
86 The URI of the original location of the document.
87  
88  
89 =head2 FeedbackToken => Str
90  
91 A token that identifies a particular result from a particular query.
92 Use this token to provide click-through feedback for the result. For
93 more information, see Submitting feedback
94 (https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html).
95  
96  
97 =head2 Id => Str
98  
99 The unique identifier for the query result.
100  
101  
102 =head2 ScoreAttributes => L<Paws::Kendra::ScoreAttributes>
103  
104 Indicates the confidence that Amazon Kendra has that a result matches
105 the query that you provided. Each result is placed into a bin that
106 indicates the confidence, C<VERY_HIGH>, C<HIGH>, C<MEDIUM> and C<LOW>.
107 You can use the score to determine if a response meets the confidence
108 needed for your application.
109  
110 The field is only set to C<LOW> when the C<Type> field is set to
111 C<DOCUMENT> and Amazon Kendra is not confident that the result matches
112 the query.
113  
114  
115 =head2 Type => Str
116  
117 The type of document.
118  
119  
120  
121 =head1 SEE ALSO
122  
123 This class forms part of L<Paws>, describing an object used in L<Paws::Kendra>
124  
125 =head1 BUGS and CONTRIBUTIONS
126  
127 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
128  
129 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
130  
131 =cut
132