« blib/lib/Paws/CloudSearch/DescribeSuggestersResponse.pm
↑ Summary
blib/lib/Paws/CloudSearch/DomainEndpointOptions.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudSearch::DocumentSuggesterOptions; | ||
| 3 | use Moose; | ||
| 4 | has FuzzyMatching => (is => 'ro', isa => 'Str'); | ||
| 5 | has SortExpression => (is => 'ro', isa => 'Str'); | ||
| 6 | has SourceField => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::CloudSearch::DocumentSuggesterOptions | ||
| 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::CloudSearch::DocumentSuggesterOptions object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { FuzzyMatching => $value, ..., SourceField => $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::CloudSearch::DocumentSuggesterOptions object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->FuzzyMatching | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Options for a search suggester. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 FuzzyMatching => Str | ||
| 44 | |||
| 45 | The level of fuzziness allowed when suggesting matches for a string: | ||
| 46 | C<none>, C<low>, or C<high>. With none, the specified string is treated | ||
| 47 | as an exact prefix. With low, suggestions must differ from the | ||
| 48 | specified string by no more than one character. With high, suggestions | ||
| 49 | can differ by up to two characters. The default is none. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 SortExpression => Str | ||
| 53 | |||
| 54 | An expression that computes a score for each suggestion to control how | ||
| 55 | they are sorted. The scores are rounded to the nearest integer, with a | ||
| 56 | floor of 0 and a ceiling of 2^31-1. A document's relevance score is not | ||
| 57 | computed for suggestions, so sort expressions cannot reference the | ||
| 58 | C<_score> value. To sort suggestions using a numeric field or existing | ||
| 59 | expression, simply specify the name of the field or expression. If no | ||
| 60 | expression is configured for the suggester, the suggestions are sorted | ||
| 61 | with the closest matches listed first. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> SourceField => Str | ||
| 65 | |||
| 66 | The name of the index field you want to use for suggestions. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head1 SEE ALSO | ||
| 71 | |||
| 72 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearch> | ||
| 73 | |||
| 74 | =head1 BUGS and CONTRIBUTIONS | ||
| 75 | |||
| 76 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 77 | |||
| 78 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 79 | |||
| 80 | =cut | ||
| 81 |