File Coverage

blib/lib/Paws/CloudSearch/AnalysisOptions.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CloudSearch::AnalysisOptions;
2 1     1   304 use Moose;
  1         3  
  1         6  
3             has AlgorithmicStemming => (is => 'ro', isa => 'Str');
4             has JapaneseTokenizationDictionary => (is => 'ro', isa => 'Str');
5             has StemmingDictionary => (is => 'ro', isa => 'Str');
6             has Stopwords => (is => 'ro', isa => 'Str');
7             has Synonyms => (is => 'ro', isa => 'Str');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::CloudSearch::AnalysisOptions
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::AnalysisOptions object:
26              
27             $service_obj->Method(Att1 => { AlgorithmicStemming => $value, ..., Synonyms => $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::AnalysisOptions object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->AlgorithmicStemming
35              
36             =head1 DESCRIPTION
37              
38             Synonyms, stopwords, and stemming options for an analysis scheme.
39             Includes tokenization dictionary for Japanese.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 AlgorithmicStemming => Str
45              
46             The level of algorithmic stemming to perform: C<none>, C<minimal>,
47             C<light>, or C<full>. The available levels vary depending on the
48             language. For more information, see Language Specific Text Processing
49             Settings in the I<Amazon CloudSearch Developer Guide>
50              
51              
52             =head2 JapaneseTokenizationDictionary => Str
53              
54             A JSON array that contains a collection of terms, tokens, readings and
55             part of speech for Japanese Tokenizaiton. The Japanese tokenization
56             dictionary enables you to override the default tokenization for
57             selected terms. This is only valid for Japanese language fields.
58              
59              
60             =head2 StemmingDictionary => Str
61              
62             A JSON object that contains a collection of string:value pairs that
63             each map a term to its stem. For example, C<{"term1": "stem1", "term2":
64             "stem2", "term3": "stem3"}>. The stemming dictionary is applied in
65             addition to any algorithmic stemming. This enables you to override the
66             results of the algorithmic stemming to correct specific cases of
67             overstemming or understemming. The maximum size of a stemming
68             dictionary is 500 KB.
69              
70              
71             =head2 Stopwords => Str
72              
73             A JSON array of terms to ignore during indexing and searching. For
74             example, C<["a", "an", "the", "of"]>. The stopwords dictionary must
75             explicitly list each word you want to ignore. Wildcards and regular
76             expressions are not supported.
77              
78              
79             =head2 Synonyms => Str
80              
81             A JSON object that defines synonym groups and aliases. A synonym group
82             is an array of arrays, where each sub-array is a group of terms where
83             each term in the group is considered a synonym of every other term in
84             the group. The aliases value is an object that contains a collection of
85             string:value pairs where the string specifies a term and the array of
86             values specifies each of the aliases for that term. An alias is
87             considered a synonym of the specified term, but the term is not
88             considered a synonym of the alias. For more information about
89             specifying synonyms, see Synonyms in the I<Amazon CloudSearch Developer
90             Guide>.
91              
92              
93              
94             =head1 SEE ALSO
95              
96             This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearch>
97              
98             =head1 BUGS and CONTRIBUTIONS
99              
100             The source code is located here: https://github.com/pplu/aws-sdk-perl
101              
102             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
103              
104             =cut
105