/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Comprehend::EntityRecognizerInputDataConfig

NAME

Paws::Comprehend::EntityRecognizerInputDataConfig

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::Comprehend::EntityRecognizerInputDataConfig object:

$service_obj->Method(Att1 => { Annotations => $value, ..., EntityTypes => $value  });

Results returned from an API call

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

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

DESCRIPTION

Specifies the format and location of the input data.

ATTRIBUTES

Annotations => Paws::Comprehend::EntityRecognizerAnnotations

The S3 location of the CSV file that annotates your training documents.

AugmentedManifests => ArrayRef[Paws::Comprehend::AugmentedManifestsListItem]

A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.

DataFormat => Str

The format of your training data:

  • COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.

    If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.

  • AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document.

    If you use this value, you must provide the AugmentedManifests parameter in your request.

If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.

Documents => Paws::Comprehend::EntityRecognizerDocuments

The S3 location of the folder that contains the training documents for your custom entity recognizer.

This parameter is required if you set DataFormat to COMPREHEND_CSV.

EntityList => Paws::Comprehend::EntityRecognizerEntityList

The S3 location of the CSV file that has the entity list for your custom entity recognizer.

REQUIRED EntityTypes => ArrayRef[Paws::Comprehend::EntityTypesListItem]

The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.

A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break), \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).

SEE ALSO

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