AWS SDK Version 4 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.

The input properties for training a document classifier.

For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Comprehend.Model.DocumentClassifierInputDataConfig

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

Syntax

C#
public class DocumentClassifierInputDataConfig

The DocumentClassifierInputDataConfig type exposes the following members

Constructors

Properties

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property DataFormat Amazon.Comprehend.DocumentClassifierDataFormat

Gets and sets the property DataFormat.

The format of your training data:

  • COMPREHEND_CSV: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.

  • 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 associated labels.

    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 DocumentReaderConfig Amazon.Comprehend.Model.DocumentReaderConfig

Gets and sets the property DocumentReaderConfig.

Public Property Documents Amazon.Comprehend.Model.DocumentClassifierDocuments

Gets and sets the property Documents.

The S3 location of the training documents. This parameter is required in a request to create a native document model.

Public Property DocumentType Amazon.Comprehend.DocumentClassifierDocumentTypeFormat

Gets and sets the property DocumentType.

The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and provide semi-structured documents to create a native document model.

Public Property LabelDelimiter System.String

Gets and sets the property LabelDelimiter.

Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.

Public Property S3Uri System.String

Gets and sets the property S3Uri.

The Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.

For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

This parameter is required if you set DataFormat to COMPREHEND_CSV.

Public Property TestS3Uri System.String

Gets and sets the property TestS3Uri.

This specifies the Amazon S3 location that contains the test annotations for the document classifier. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer