| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::Search; | ||
| 3 | use Moose; | ||
| 4 | has Displayable => (is => 'ro', isa => 'Bool'); | ||
| 5 | has Facetable => (is => 'ro', isa => 'Bool'); | ||
| 6 | has Searchable => (is => 'ro', isa => 'Bool'); | ||
| 7 | has Sortable => (is => 'ro', isa => 'Bool'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::Kendra::Search | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::Kendra::Search object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Displayable => $value, ..., Sortable => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::Search object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Displayable | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Provides information about how a custom index field is used during a | ||
| 40 | search. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 Displayable => Bool | ||
| 46 | |||
| 47 | Determines whether the field is returned in the query response. The | ||
| 48 | default is C<true>. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 Facetable => Bool | ||
| 52 | |||
| 53 | Indicates that the field can be used to create search facets, a count | ||
| 54 | of results for each value in the field. The default is C<false> . | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Searchable => Bool | ||
| 58 | |||
| 59 | Determines whether the field is used in the search. If the | ||
| 60 | C<Searchable> field is C<true>, you can use relevance tuning to | ||
| 61 | manually tune how Amazon Kendra weights the field in the search. The | ||
| 62 | default is C<true> for string fields and C<false> for number and date | ||
| 63 | fields. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 Sortable => Bool | ||
| 67 | |||
| 68 | Determines whether the field can be used to sort the results of a | ||
| 69 | query. If you specify sorting on a field that does not have C<Sortable> | ||
| 70 | set to C<true>, Amazon Kendra returns an exception. The default is | ||
| 71 | C<false>. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |