| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::FacetResult; | ||
| 3 | use Moose; | ||
| 4 | has DocumentAttributeKey => (is => 'ro', isa => 'Str'); | ||
| 5 | has DocumentAttributeValueCountPairs => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::DocumentAttributeValueCountPair]'); | ||
| 6 | has DocumentAttributeValueType => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Kendra::FacetResult | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::Kendra::FacetResult object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { DocumentAttributeKey => $value, ..., DocumentAttributeValueType => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::FacetResult object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->DocumentAttributeKey | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | The facet values for the documents in the response. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 DocumentAttributeKey => Str | ||
| 44 | |||
| 45 | The key for the facet values. This is the same as the | ||
| 46 | C<DocumentAttributeKey> provided in the query. | ||
| 47 | |||
| 48 | |||
| 49 | =head2 DocumentAttributeValueCountPairs => ArrayRef[L<Paws::Kendra::DocumentAttributeValueCountPair>] | ||
| 50 | |||
| 51 | An array of key/value pairs, where the key is the value of the | ||
| 52 | attribute and the count is the number of documents that share the key | ||
| 53 | value. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 DocumentAttributeValueType => Str | ||
| 57 | |||
| 58 | The data type of the facet value. This is the same as the type defined | ||
| 59 | for the index field when it was created. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head1 SEE ALSO | ||
| 64 | |||
| 65 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 66 | |||
| 67 | =head1 BUGS and CONTRIBUTIONS | ||
| 68 | |||
| 69 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 70 | |||
| 71 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 72 | |||
| 73 | =cut | ||
| 74 |