Class: Aws::Comprehend::Types::DocumentClassifierInputDataConfig

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::DocumentClassifierInputDataConfig

Includes:

Structure

Defined in:

lib/aws-sdk-comprehend/types.rb

Overview

The input properties for training a document classifier.

For more information on how the input file is formatted, see

Preparing training data][1

in the Comprehend Developer Guide.

[1]: docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #augmented_manifests ⇒ Array<Types::AugmentedManifestsListItem>

  A list of augmented manifest files that provide training data for your custom model.

• #data_format ⇒ String

  The format of your training data:.

• #document_reader_config ⇒ Types::DocumentReaderConfig

  Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

• #document_type ⇒ String

  The type of input documents for training the model.

• #documents ⇒ Types::DocumentClassifierDocuments

  The S3 location of the training documents.

• #label_delimiter ⇒ String

  Indicates the delimiter used to separate each label for training a multi-label classifier.

• #s3_uri ⇒ String

  The Amazon S3 URI for the input data.

• #test_s3_uri ⇒ String

  This specifies the Amazon S3 location that contains the test annotations for the document classifier.

Instance Attribute Details

#augmented_manifests ⇒ Array<Types::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`.

Returns:

• (Array<Types::AugmentedManifestsListItem>)

# File 'lib/aws-sdk-comprehend/types.rb', line 3071

class DocumentClassifierInputDataConfig < Struct.new(
  :data_format,
  :s3_uri,
  :test_s3_uri,
  :label_delimiter,
  :augmented_manifests,
  :document_type,
  :documents,
  :document_reader_config)
  SENSITIVE = []
  include Aws::Structure
end

#data_format ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 3071

class DocumentClassifierInputDataConfig < Struct.new(
  :data_format,
  :s3_uri,
  :test_s3_uri,
  :label_delimiter,
  :augmented_manifests,
  :document_type,
  :documents,
  :document_reader_config)
  SENSITIVE = []
  include Aws::Structure
end

#document_reader_config ⇒ Types::DocumentReaderConfig

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:

• **Word files** - Amazon Comprehend parser extracts the text.

• **Digital PDF files** - Amazon Comprehend parser extracts the text.

• **Image files and scanned PDF files** - Amazon Comprehend uses the Amazon Textract ‘DetectDocumentText` API to extract the text.

‘DocumentReaderConfig` does not apply to plain text files or Word files.

For image files and PDF documents, you can override these default actions using the fields listed below. For more information, see [ Setting text extraction options] in the Comprehend Developer Guide.

[1]: docs.aws.amazon.com/comprehend/latest/dg/idp-set-textract-options.html

Returns:

• (Types::DocumentReaderConfig)

# File 'lib/aws-sdk-comprehend/types.rb', line 3071

class DocumentClassifierInputDataConfig < Struct.new(
  :data_format,
  :s3_uri,
  :test_s3_uri,
  :label_delimiter,
  :augmented_manifests,
  :document_type,
  :documents,
  :document_reader_config)
  SENSITIVE = []
  include Aws::Structure
end

#document_type ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 3071

class DocumentClassifierInputDataConfig < Struct.new(
  :data_format,
  :s3_uri,
  :test_s3_uri,
  :label_delimiter,
  :augmented_manifests,
  :document_type,
  :documents,
  :document_reader_config)
  SENSITIVE = []
  include Aws::Structure
end

#documents ⇒ Types::DocumentClassifierDocuments

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

Returns:

• (Types::DocumentClassifierDocuments)

# File 'lib/aws-sdk-comprehend/types.rb', line 3071

class DocumentClassifierInputDataConfig < Struct.new(
  :data_format,
  :s3_uri,
  :test_s3_uri,
  :label_delimiter,
  :augmented_manifests,
  :document_type,
  :documents,
  :document_reader_config)
  SENSITIVE = []
  include Aws::Structure
end

#label_delimiter ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 3071

class DocumentClassifierInputDataConfig < Struct.new(
  :data_format,
  :s3_uri,
  :test_s3_uri,
  :label_delimiter,
  :augmented_manifests,
  :document_type,
  :documents,
  :document_reader_config)
  SENSITIVE = []
  include Aws::Structure
end

#s3_uri ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 3071

class DocumentClassifierInputDataConfig < Struct.new(
  :data_format,
  :s3_uri,
  :test_s3_uri,
  :label_delimiter,
  :augmented_manifests,
  :document_type,
  :documents,
  :document_reader_config)
  SENSITIVE = []
  include Aws::Structure
end

#test_s3_uri ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 3071

class DocumentClassifierInputDataConfig < Struct.new(
  :data_format,
  :s3_uri,
  :test_s3_uri,
  :label_delimiter,
  :augmented_manifests,
  :document_type,
  :documents,
  :document_reader_config)
  SENSITIVE = []
  include Aws::Structure
end