« blib/lib/Paws/CloudSearch/AccessPoliciesStatus.pm
↑ Summary
blib/lib/Paws/CloudSearch/AnalysisScheme.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudSearch::AnalysisOptions; | ||
| 3 | use Moose; | ||
| 4 | has AlgorithmicStemming => (is => 'ro', isa => 'Str'); | ||
| 5 | has JapaneseTokenizationDictionary => (is => 'ro', isa => 'Str'); | ||
| 6 | has StemmingDictionary => (is => 'ro', isa => 'Str'); | ||
| 7 | has Stopwords => (is => 'ro', isa => 'Str'); | ||
| 8 | has Synonyms => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::CloudSearch::AnalysisOptions | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::CloudSearch::AnalysisOptions object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { AlgorithmicStemming => $value, ..., Synonyms => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudSearch::AnalysisOptions object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->AlgorithmicStemming | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Synonyms, stopwords, and stemming options for an analysis scheme. | ||
| 41 | Includes tokenization dictionary for Japanese. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 AlgorithmicStemming => Str | ||
| 47 | |||
| 48 | The level of algorithmic stemming to perform: C<none>, C<minimal>, | ||
| 49 | C<light>, or C<full>. The available levels vary depending on the | ||
| 50 | language. For more information, see Language Specific Text Processing | ||
| 51 | Settings | ||
| 52 | (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings) | ||
| 53 | in the I<Amazon CloudSearch Developer Guide> | ||
| 54 | |||
| 55 | |||
| 56 | =head2 JapaneseTokenizationDictionary => Str | ||
| 57 | |||
| 58 | A JSON array that contains a collection of terms, tokens, readings and | ||
| 59 | part of speech for Japanese Tokenizaiton. The Japanese tokenization | ||
| 60 | dictionary enables you to override the default tokenization for | ||
| 61 | selected terms. This is only valid for Japanese language fields. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 StemmingDictionary => Str | ||
| 65 | |||
| 66 | A JSON object that contains a collection of string:value pairs that | ||
| 67 | each map a term to its stem. For example, C<{"term1": "stem1", "term2": | ||
| 68 | "stem2", "term3": "stem3"}>. The stemming dictionary is applied in | ||
| 69 | addition to any algorithmic stemming. This enables you to override the | ||
| 70 | results of the algorithmic stemming to correct specific cases of | ||
| 71 | overstemming or understemming. The maximum size of a stemming | ||
| 72 | dictionary is 500 KB. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 Stopwords => Str | ||
| 76 | |||
| 77 | A JSON array of terms to ignore during indexing and searching. For | ||
| 78 | example, C<["a", "an", "the", "of"]>. The stopwords dictionary must | ||
| 79 | explicitly list each word you want to ignore. Wildcards and regular | ||
| 80 | expressions are not supported. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 Synonyms => Str | ||
| 84 | |||
| 85 | A JSON object that defines synonym groups and aliases. A synonym group | ||
| 86 | is an array of arrays, where each sub-array is a group of terms where | ||
| 87 | each term in the group is considered a synonym of every other term in | ||
| 88 | the group. The aliases value is an object that contains a collection of | ||
| 89 | string:value pairs where the string specifies a term and the array of | ||
| 90 | values specifies each of the aliases for that term. An alias is | ||
| 91 | considered a synonym of the specified term, but the term is not | ||
| 92 | considered a synonym of the alias. For more information about | ||
| 93 | specifying synonyms, see Synonyms | ||
| 94 | (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms) | ||
| 95 | in the I<Amazon CloudSearch Developer Guide>. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearch> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |