Struct DocumentClassifierInputDataConfig

#[non_exhaustive]
pub struct DocumentClassifierInputDataConfig {
    pub data_format: Option<DocumentClassifierDataFormat>,
    pub s3_uri: Option<String>,
    pub test_s3_uri: Option<String>,
    pub label_delimiter: Option<String>,
    pub augmented_manifests: Option<Vec<AugmentedManifestsListItem>>,
    pub document_type: Option<DocumentClassifierDocumentTypeFormat>,
    pub documents: Option<DocumentClassifierDocuments>,
    pub document_reader_config: Option<DocumentReaderConfig>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

data_format: Option<DocumentClassifierDataFormat>

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.

s3_uri: Option<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.

test_s3_uri: Option<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.

label_delimiter: Option<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.

augmented_manifests: Option<Vec<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.

document_type: Option<DocumentClassifierDocumentTypeFormat>

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.

documents: Option<DocumentClassifierDocuments>

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

document_reader_config: Option<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.

Implementations

impl DocumentClassifierInputDataConfig

pub fn data_format(&self) -> Option<&DocumentClassifierDataFormat>

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.

pub fn s3_uri(&self) -> Option<&str>

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.

pub fn test_s3_uri(&self) -> Option<&str>

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.

pub fn label_delimiter(&self) -> Option<&str>

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.

pub fn augmented_manifests(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .augmented_manifests.is_none().

pub fn document_type(&self) -> Option<&DocumentClassifierDocumentTypeFormat>

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.

pub fn documents(&self) -> Option<&DocumentClassifierDocuments>

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

pub fn document_reader_config(&self) -> Option<&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.

impl DocumentClassifierInputDataConfig

pub fn builder() -> DocumentClassifierInputDataConfigBuilder

Creates a new builder-style object to manufacture DocumentClassifierInputDataConfig.

Trait Implementations

impl Clone for DocumentClassifierInputDataConfig

fn clone(&self) -> DocumentClassifierInputDataConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentClassifierInputDataConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DocumentClassifierInputDataConfig

fn eq(&self, other: &DocumentClassifierInputDataConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DocumentClassifierInputDataConfig