The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::Kendra::Search

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Kendra::Search object:

  $service_obj->Method(Att1 => { Displayable => $value, ..., Sortable => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::Search object:

  $result = $service_obj->Method(...);
  $result->Att1->Displayable

DESCRIPTION

Provides information about how a custom index field is used during a search.

ATTRIBUTES

Displayable => Bool

Determines whether the field is returned in the query response. The default is true.

Facetable => Bool

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

Searchable => Bool

Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

Sortable => Bool

Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

SEE ALSO

This class forms part of Paws, describing an object used 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