NAME

Paws::Comprehend::DetectEntities - Arguments for method DetectEntities on Paws::Comprehend

DESCRIPTION

This class represents the parameters used for calling the method DetectEntities on the Amazon Comprehend service. Use the attributes of this class as arguments to method DetectEntities.

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

SYNOPSIS

    my $comprehend = Paws->service('Comprehend');
    my $DetectEntitiesResponse = $comprehend->DetectEntities(
      Text         => 'MyCustomerInputString',
      EndpointArn  => 'MyEntityRecognizerEndpointArn',    # OPTIONAL
      LanguageCode => 'en',                               # OPTIONAL
    );

    # Results:
    my $Entities = $DetectEntitiesResponse->Entities;

    # Returns a L<Paws::Comprehend::DetectEntitiesResponse> 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/comprehend/DetectEntities

ATTRIBUTES

EndpointArn => Str

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

LanguageCode => Str

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Valid values are: "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"

REQUIRED Text => Str

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

SEE ALSO

This class forms part of Paws, documenting arguments for method DetectEntities in Paws::Comprehend

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