« blib/lib/Paws/Kendra/FaqSummary.pm
↑ Summary
blib/lib/Paws/Kendra/GetQuerySuggestionsResponse.pm »
| 1 | |||
| 2 | package Paws::Kendra::GetQuerySuggestions; | ||
| 3 | use Moose; | ||
| 4 | has IndexId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has MaxSuggestionsCount => (is => 'ro', isa => 'Int'); | ||
| 6 | has QueryText => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetQuerySuggestions'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kendra::GetQuerySuggestionsResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Kendra::GetQuerySuggestions - Arguments for method GetQuerySuggestions on L<Paws::Kendra> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method GetQuerySuggestions on the | ||
| 24 | L<AWSKendraFrontendService|Paws::Kendra> service. Use the attributes of this class | ||
| 25 | as arguments to method GetQuerySuggestions. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetQuerySuggestions. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $kendra = Paws->service('Kendra'); | ||
| 32 | my $GetQuerySuggestionsResponse = $kendra->GetQuerySuggestions( | ||
| 33 | IndexId => 'MyIndexId', | ||
| 34 | QueryText => 'MySuggestionQueryText', | ||
| 35 | MaxSuggestionsCount => 1, # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $QuerySuggestionsId = $GetQuerySuggestionsResponse->QuerySuggestionsId; | ||
| 40 | my $Suggestions = $GetQuerySuggestionsResponse->Suggestions; | ||
| 41 | |||
| 42 | # Returns a L<Paws::Kendra::GetQuerySuggestionsResponse> object. | ||
| 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/GetQuerySuggestions> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> IndexId => Str | ||
| 51 | |||
| 52 | The identifier of the index you want to get query suggestions from. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 MaxSuggestionsCount => Int | ||
| 57 | |||
| 58 | The maximum number of query suggestions you want to show to your users. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> QueryText => Str | ||
| 63 | |||
| 64 | The text of a user's query to generate query suggestions. | ||
| 65 | |||
| 66 | A query is suggested if the query prefix matches what a user starts to | ||
| 67 | type as their query. | ||
| 68 | |||
| 69 | Amazon Kendra does not show any suggestions if a user types fewer than | ||
| 70 | two characters or more than 60 characters. A query must also have at | ||
| 71 | least one search result and contain at least one word of more than four | ||
| 72 | characters. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head1 SEE ALSO | ||
| 78 | |||
| 79 | This class forms part of L<Paws>, documenting arguments for method GetQuerySuggestions in L<Paws::Kendra> | ||
| 80 | |||
| 81 | =head1 BUGS and CONTRIBUTIONS | ||
| 82 | |||
| 83 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 84 | |||
| 85 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 86 | |||
| 87 | =cut | ||
| 88 |