AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Specifies the format and location of the input data.

Inheritance Hierarchy

System.Object
  Amazon.Comprehend.Model.EntityRecognizerInputDataConfig

Namespace: Amazon.Comprehend.Model
Assembly: AWSSDK.Comprehend.dll
Version: 3.x.y.z

Syntax

C#
public class EntityRecognizerInputDataConfig

The EntityRecognizerInputDataConfig type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Annotations Amazon.Comprehend.Model.EntityRecognizerAnnotations

Gets and sets the property Annotations.

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

Public Property AugmentedManifests System.Collections.Generic.List<Amazon.Comprehend.Model.AugmentedManifestsListItem>

Gets and sets the property AugmentedManifests.

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.

Public Property DataFormat Amazon.Comprehend.EntityRecognizerDataFormat

Gets and sets the property DataFormat.

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.

Public Property Documents Amazon.Comprehend.Model.EntityRecognizerDocuments

Gets and sets the property Documents.

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.

Public Property EntityList Amazon.Comprehend.Model.EntityRecognizerEntityList

Gets and sets the property EntityList.

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

Public Property EntityTypes System.Collections.Generic.List<Amazon.Comprehend.Model.EntityTypesListItem>

Gets and sets the property EntityTypes.

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).

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5