« blib/lib/Paws/Comprehend/DetectEntitiesResponse.pm
↑ Summary
blib/lib/Paws/Comprehend/DetectKeyPhrasesResponse.pm »
| 1 | |||
| 2 | package Paws::Comprehend::DetectKeyPhrases; | ||
| 3 | use Moose; | ||
| 4 | has LanguageCode => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Text => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DetectKeyPhrases'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Comprehend::DetectKeyPhrasesResponse'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Comprehend::DetectKeyPhrases - Arguments for method DetectKeyPhrases on L<Paws::Comprehend> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DetectKeyPhrases on the | ||
| 23 | L<Amazon Comprehend|Paws::Comprehend> service. Use the attributes of this class | ||
| 24 | as arguments to method DetectKeyPhrases. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DetectKeyPhrases. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $comprehend = Paws->service('Comprehend'); | ||
| 31 | my $DetectKeyPhrasesResponse = $comprehend->DetectKeyPhrases( | ||
| 32 | LanguageCode => 'en', | ||
| 33 | Text => 'MyCustomerInputString', | ||
| 34 | |||
| 35 | ); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $KeyPhrases = $DetectKeyPhrasesResponse->KeyPhrases; | ||
| 39 | |||
| 40 | # Returns a L<Paws::Comprehend::DetectKeyPhrasesResponse> object. | ||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/comprehend/DetectKeyPhrases> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> LanguageCode => Str | ||
| 49 | |||
| 50 | The language of the input documents. You can specify any of the primary | ||
| 51 | languages supported by Amazon Comprehend. All documents must be in the | ||
| 52 | same language. | ||
| 53 | |||
| 54 | Valid values are: C<"en">, C<"es">, C<"fr">, C<"de">, C<"it">, C<"pt">, C<"ar">, C<"hi">, C<"ja">, C<"ko">, C<"zh">, C<"zh-TW"> | ||
| 55 | |||
| 56 | =head2 B<REQUIRED> Text => Str | ||
| 57 | |||
| 58 | A UTF-8 text string. Each string must contain fewer that 5,000 bytes of | ||
| 59 | UTF-8 encoded characters. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head1 SEE ALSO | ||
| 65 | |||
| 66 | This class forms part of L<Paws>, documenting arguments for method DetectKeyPhrases in L<Paws::Comprehend> | ||
| 67 | |||
| 68 | =head1 BUGS and CONTRIBUTIONS | ||
| 69 | |||
| 70 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 71 | |||
| 72 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 73 | |||
| 74 | =cut | ||
| 75 |