« blib/lib/Paws/Kendra/DescribeQuerySuggestionsConfig.pm
↑ Summary
blib/lib/Paws/Kendra/DescribeThesaurus.pm »
| 1 | |||
| 2 | package Paws::Kendra::DescribeQuerySuggestionsConfigResponse; | ||
| 3 | use Moose; | ||
| 4 | has IncludeQueriesWithoutUserInformation => (is => 'ro', isa => 'Bool'); | ||
| 5 | has LastClearTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has LastSuggestionsBuildTime => (is => 'ro', isa => 'Str'); | ||
| 7 | has MinimumNumberOfQueryingUsers => (is => 'ro', isa => 'Int'); | ||
| 8 | has MinimumQueryCount => (is => 'ro', isa => 'Int'); | ||
| 9 | has Mode => (is => 'ro', isa => 'Str'); | ||
| 10 | has QueryLogLookBackWindowInDays => (is => 'ro', isa => 'Int'); | ||
| 11 | has Status => (is => 'ro', isa => 'Str'); | ||
| 12 | has TotalSuggestionsCount => (is => 'ro', isa => 'Int'); | ||
| 13 | |||
| 14 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Kendra::DescribeQuerySuggestionsConfigResponse | ||
| 21 | |||
| 22 | =head1 ATTRIBUTES | ||
| 23 | |||
| 24 | |||
| 25 | =head2 IncludeQueriesWithoutUserInformation => Bool | ||
| 26 | |||
| 27 | Shows whether Amazon Kendra uses all queries or only uses queries that | ||
| 28 | include user information to generate query suggestions. | ||
| 29 | |||
| 30 | |||
| 31 | =head2 LastClearTime => Str | ||
| 32 | |||
| 33 | Shows the date-time query suggestions for an index was last cleared. | ||
| 34 | |||
| 35 | After you clear suggestions, Amazon Kendra learns new suggestions based | ||
| 36 | on new queries added to the query log from the time you cleared | ||
| 37 | suggestions. Amazon Kendra only considers re-occurences of a query from | ||
| 38 | the time you cleared suggestions. | ||
| 39 | |||
| 40 | |||
| 41 | =head2 LastSuggestionsBuildTime => Str | ||
| 42 | |||
| 43 | Shows the date-time query suggestions for an index was last updated. | ||
| 44 | |||
| 45 | |||
| 46 | =head2 MinimumNumberOfQueryingUsers => Int | ||
| 47 | |||
| 48 | Shows the minimum number of unique users who must search a query in | ||
| 49 | order for the query to be eligible to suggest to your users. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 MinimumQueryCount => Int | ||
| 53 | |||
| 54 | Shows the minimum number of times a query must be searched in order for | ||
| 55 | the query to be eligible to suggest to your users. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Mode => Str | ||
| 59 | |||
| 60 | Shows whether query suggestions are currently in C<ENABLED> mode or | ||
| 61 | C<LEARN_ONLY> mode. | ||
| 62 | |||
| 63 | By default, Amazon Kendra enables query suggestions.C<LEARN_ONLY> turns | ||
| 64 | off query suggestions for your users. You can change the mode using the | ||
| 65 | UpdateQuerySuggestionsConfig | ||
| 66 | (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html) | ||
| 67 | operation. | ||
| 68 | |||
| 69 | Valid values are: C<"ENABLED">, C<"LEARN_ONLY"> | ||
| 70 | =head2 QueryLogLookBackWindowInDays => Int | ||
| 71 | |||
| 72 | Shows how recent your queries are in your query log time window (in | ||
| 73 | days). | ||
| 74 | |||
| 75 | |||
| 76 | =head2 Status => Str | ||
| 77 | |||
| 78 | Shows whether the status of query suggestions settings is currently | ||
| 79 | Active or Updating. | ||
| 80 | |||
| 81 | Active means the current settings apply and Updating means your changed | ||
| 82 | settings are in the process of applying. | ||
| 83 | |||
| 84 | Valid values are: C<"ACTIVE">, C<"UPDATING"> | ||
| 85 | =head2 TotalSuggestionsCount => Int | ||
| 86 | |||
| 87 | Shows the current total count of query suggestions for an index. | ||
| 88 | |||
| 89 | This count can change when you update your query suggestions settings, | ||
| 90 | if you filter out certain queries from suggestions using a block list, | ||
| 91 | and as the query log accumulates more queries for Amazon Kendra to | ||
| 92 | learn from. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 _request_id => Str | ||
| 96 | |||
| 97 | |||
| 98 | =cut | ||
| 99 | |||
| 100 | 1; |