Class: Aws::Comprehend::Types::EntityRecognizerInputDataConfig

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::EntityRecognizerInputDataConfig

Includes:

Structure

Defined in:

lib/aws-sdk-comprehend/types.rb

Overview

Specifies the format and location of the input data.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #annotations ⇒ Types::EntityRecognizerAnnotations

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

• #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:.

• #documents ⇒ Types::EntityRecognizerDocuments

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

• #entity_list ⇒ Types::EntityRecognizerEntityList

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

• #entity_types ⇒ Array<Types::EntityTypesListItem>

  The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer.

Instance Attribute Details

#annotations ⇒ Types::EntityRecognizerAnnotations

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

Returns:

• (Types::EntityRecognizerAnnotations)

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

class EntityRecognizerInputDataConfig < Struct.new(
  :data_format,
  :entity_types,
  :documents,
  :annotations,
  :entity_list,
  :augmented_manifests)
  SENSITIVE = []
  include Aws::Structure
end

#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 4186

class EntityRecognizerInputDataConfig < Struct.new(
  :data_format,
  :entity_types,
  :documents,
  :annotations,
  :entity_list,
  :augmented_manifests)
  SENSITIVE = []
  include Aws::Structure
end

#data_format ⇒ String

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.

Returns:

• (String)

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

class EntityRecognizerInputDataConfig < Struct.new(
  :data_format,
  :entity_types,
  :documents,
  :annotations,
  :entity_list,
  :augmented_manifests)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (Types::EntityRecognizerDocuments)

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

class EntityRecognizerInputDataConfig < Struct.new(
  :data_format,
  :entity_types,
  :documents,
  :annotations,
  :entity_list,
  :augmented_manifests)
  SENSITIVE = []
  include Aws::Structure
end

#entity_list ⇒ Types::EntityRecognizerEntityList

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

Returns:

• (Types::EntityRecognizerEntityList)

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

class EntityRecognizerInputDataConfig < Struct.new(
  :data_format,
  :entity_types,
  :documents,
  :annotations,
  :entity_list,
  :augmented_manifests)
  SENSITIVE = []
  include Aws::Structure
end

#entity_types ⇒ Array<Types::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).

Returns:

• (Array<Types::EntityTypesListItem>)

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

class EntityRecognizerInputDataConfig < Struct.new(
  :data_format,
  :entity_types,
  :documents,
  :annotations,
  :entity_list,
  :augmented_manifests)
  SENSITIVE = []
  include Aws::Structure
end