/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Kendra::GetQuerySuggestions

NAME

Paws::Kendra::GetQuerySuggestions - Arguments for method GetQuerySuggestions on Paws::Kendra

DESCRIPTION

This class represents the parameters used for calling the method GetQuerySuggestions on the AWSKendraFrontendService service. Use the attributes of this class as arguments to method GetQuerySuggestions.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetQuerySuggestions.

SYNOPSIS

my $kendra = Paws->service('Kendra');
my $GetQuerySuggestionsResponse = $kendra->GetQuerySuggestions(
  IndexId             => 'MyIndexId',
  QueryText           => 'MySuggestionQueryText',
  MaxSuggestionsCount => 1,                         # OPTIONAL
);

# Results:
my $QuerySuggestionsId = $GetQuerySuggestionsResponse->QuerySuggestionsId;
my $Suggestions        = $GetQuerySuggestionsResponse->Suggestions;

# Returns a L<Paws::Kendra::GetQuerySuggestionsResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/kendra/GetQuerySuggestions

ATTRIBUTES

REQUIRED IndexId => Str

The identifier of the index you want to get query suggestions from.

MaxSuggestionsCount => Int

The maximum number of query suggestions you want to show to your users.

REQUIRED QueryText => Str

The text of a user's query to generate query suggestions.

A query is suggested if the query prefix matches what a user starts to type as their query.

Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetQuerySuggestions in Paws::Kendra

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues