blib/lib/Paws/Kendra/UpdateQuerySuggestionsConfig.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Kendra::UpdateQuerySuggestionsConfig;
3 use Moose;
4 has IncludeQueriesWithoutUserInformation => (is => 'ro', isa => 'Bool');
5 has IndexId => (is => 'ro', isa => 'Str', required => 1);
6 has MinimumNumberOfQueryingUsers => (is => 'ro', isa => 'Int');
7 has MinimumQueryCount => (is => 'ro', isa => 'Int');
8 has Mode => (is => 'ro', isa => 'Str');
9 has QueryLogLookBackWindowInDays => (is => 'ro', isa => 'Int');
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateQuerySuggestionsConfig');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
15 class_has _result_key => (isa => 'Str', is => 'ro');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::Kendra::UpdateQuerySuggestionsConfig - Arguments for method UpdateQuerySuggestionsConfig on L<Paws::Kendra>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method UpdateQuerySuggestionsConfig on the
27 L<AWSKendraFrontendService|Paws::Kendra> service. Use the attributes of this class
28 as arguments to method UpdateQuerySuggestionsConfig.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateQuerySuggestionsConfig.
31  
32 =head1 SYNOPSIS
33  
34 my $kendra = Paws->service('Kendra');
35 $kendra->UpdateQuerySuggestionsConfig(
36 IndexId => 'MyIndexId',
37 IncludeQueriesWithoutUserInformation => 1, # OPTIONAL
38 MinimumNumberOfQueryingUsers => 1, # OPTIONAL
39 MinimumQueryCount => 1, # OPTIONAL
40 Mode => 'ENABLED', # OPTIONAL
41 QueryLogLookBackWindowInDays => 1, # OPTIONAL
42 );
43  
44 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
45 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kendra/UpdateQuerySuggestionsConfig>
46  
47 =head1 ATTRIBUTES
48  
49  
50 =head2 IncludeQueriesWithoutUserInformation => Bool
51  
52 C<TRUE> to include queries without user information (i.e. all queries,
53 irrespective of the user), otherwise C<FALSE> to only include queries
54 with user information.
55  
56 If you pass user information to Amazon Kendra along with the queries,
57 you can set this flag to C<FALSE> and instruct Amazon Kendra to only
58 consider queries with user information.
59  
60 If you set to C<FALSE>, Amazon Kendra only considers queries searched
61 at least C<MinimumQueryCount> times across
62 C<MinimumNumberOfQueryingUsers> unique users for suggestions.
63  
64 If you set to C<TRUE>, Amazon Kendra ignores all user information and
65 learns from all queries.
66  
67  
68  
69 =head2 B<REQUIRED> IndexId => Str
70  
71 The identifier of the index you want to update query suggestions
72 settings for.
73  
74  
75  
76 =head2 MinimumNumberOfQueryingUsers => Int
77  
78 The minimum number of unique users who must search a query in order for
79 the query to be eligible to suggest to your users.
80  
81 Increasing this number might decrease the number of suggestions.
82 However, this ensures a query is searched by many users and is truly
83 popular to suggest to users.
84  
85 How you tune this setting depends on your specific needs.
86  
87  
88  
89 =head2 MinimumQueryCount => Int
90  
91 The the minimum number of times a query must be searched in order to be
92 eligible to suggest to your users.
93  
94 Decreasing this number increases the number of suggestions. However,
95 this affects the quality of suggestions as it sets a low bar for a
96 query to be considered popular to suggest to users.
97  
98 How you tune this setting depends on your specific needs.
99  
100  
101  
102 =head2 Mode => Str
103  
104 Set the mode to C<ENABLED> or C<LEARN_ONLY>.
105  
106 By default, Amazon Kendra enables query suggestions. C<LEARN_ONLY> mode
107 allows you to turn off query suggestions. You can to update this at any
108 time.
109  
110 In C<LEARN_ONLY> mode, Amazon Kendra continues to learn from new
111 queries to keep suggestions up to date for when you are ready to switch
112 to ENABLED mode again.
113  
114 Valid values are: C<"ENABLED">, C<"LEARN_ONLY">
115  
116 =head2 QueryLogLookBackWindowInDays => Int
117  
118 How recent your queries are in your query log time window.
119  
120 The time window is the number of days from current day to past days.
121  
122 By default, Amazon Kendra sets this to 180.
123  
124  
125  
126  
127 =head1 SEE ALSO
128  
129 This class forms part of L<Paws>, documenting arguments for method UpdateQuerySuggestionsConfig in L<Paws::Kendra>
130  
131 =head1 BUGS and CONTRIBUTIONS
132  
133 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
134  
135 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
136  
137 =cut
138