EntityRecognizerInputDataConfig (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.comprehend.model.EntityRecognizerInputDataConfig

All Implemented Interfaces:

java.io.Serializable
```
public class EntityRecognizerInputDataConfig
extends java.lang.Object
implements java.io.Serializable
```
Specifies the format and location of the input data.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

EntityRecognizerInputDataConfig()

Constructors
Constructor and Description
`EntityRecognizerInputDataConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`EntityRecognizerAnnotations`	`getAnnotations()` The S3 location of the CSV file that annotates your training documents.
`java.util.List<AugmentedManifestsListItem>`	`getAugmentedManifests()` A list of augmented manifest files that provide training data for your custom model.
`java.lang.String`	`getDataFormat()` The format of your training data:
`EntityRecognizerDocuments`	`getDocuments()` The S3 location of the folder that contains the training documents for your custom entity recognizer.
`EntityRecognizerEntityList`	`getEntityList()` The S3 location of the CSV file that has the entity list for your custom entity recognizer.
`java.util.List<EntityTypesListItem>`	`getEntityTypes()` The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer.
`int`	`hashCode()`
`void`	`setAnnotations(EntityRecognizerAnnotations annotations)` The S3 location of the CSV file that annotates your training documents.
`void`	`setAugmentedManifests(java.util.Collection<AugmentedManifestsListItem> augmentedManifests)` A list of augmented manifest files that provide training data for your custom model.
`void`	`setDataFormat(EntityRecognizerDataFormat dataFormat)` The format of your training data:
`void`	`setDataFormat(java.lang.String dataFormat)` The format of your training data:
`void`	`setDocuments(EntityRecognizerDocuments documents)` The S3 location of the folder that contains the training documents for your custom entity recognizer.
`void`	`setEntityList(EntityRecognizerEntityList entityList)` The S3 location of the CSV file that has the entity list for your custom entity recognizer.
`void`	`setEntityTypes(java.util.Collection<EntityTypesListItem> entityTypes)` The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`EntityRecognizerInputDataConfig`	`withAnnotations(EntityRecognizerAnnotations annotations)` The S3 location of the CSV file that annotates your training documents.
`EntityRecognizerInputDataConfig`	`withAugmentedManifests(AugmentedManifestsListItem... augmentedManifests)` A list of augmented manifest files that provide training data for your custom model.
`EntityRecognizerInputDataConfig`	`withAugmentedManifests(java.util.Collection<AugmentedManifestsListItem> augmentedManifests)` A list of augmented manifest files that provide training data for your custom model.
`EntityRecognizerInputDataConfig`	`withDataFormat(EntityRecognizerDataFormat dataFormat)` The format of your training data:
`EntityRecognizerInputDataConfig`	`withDataFormat(java.lang.String dataFormat)` The format of your training data:
`EntityRecognizerInputDataConfig`	`withDocuments(EntityRecognizerDocuments documents)` The S3 location of the folder that contains the training documents for your custom entity recognizer.
`EntityRecognizerInputDataConfig`	`withEntityList(EntityRecognizerEntityList entityList)` The S3 location of the CSV file that has the entity list for your custom entity recognizer.
`EntityRecognizerInputDataConfig`	`withEntityTypes(java.util.Collection<EntityTypesListItem> entityTypes)` The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer.
`EntityRecognizerInputDataConfig`	`withEntityTypes(EntityTypesListItem... entityTypes)` The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EntityRecognizerInputDataConfig
```
public EntityRecognizerInputDataConfig()
```
- Method Detail
  - getDataFormat
```
public java.lang.String getDataFormat()
```
    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.
    
    Constraints:
    Allowed Values: COMPREHEND_CSV, AUGMENTED_MANIFEST
    Returns:
    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.
    See Also:
    
    EntityRecognizerDataFormat
  - setDataFormat
```
public void setDataFormat(java.lang.String 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.
    
    Constraints:
    Allowed Values: COMPREHEND_CSV, AUGMENTED_MANIFEST
    Parameters:
    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.
    See Also:
    
    EntityRecognizerDataFormat
  - withDataFormat
```
public EntityRecognizerInputDataConfig withDataFormat(java.lang.String 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: COMPREHEND_CSV, AUGMENTED_MANIFEST
    Parameters:
    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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    EntityRecognizerDataFormat
  - setDataFormat
```
public void setDataFormat(EntityRecognizerDataFormat 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.
    
    Constraints:
    Allowed Values: COMPREHEND_CSV, AUGMENTED_MANIFEST
    Parameters:
    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.
    See Also:
    
    EntityRecognizerDataFormat
  - withDataFormat
```
public EntityRecognizerInputDataConfig withDataFormat(EntityRecognizerDataFormat 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: COMPREHEND_CSV, AUGMENTED_MANIFEST
    Parameters:
    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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    EntityRecognizerDataFormat
  - getEntityTypes
```
public java.util.List<EntityTypesListItem> getEntityTypes()
```
    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:
    
    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).
  - setEntityTypes
```
public void setEntityTypes(java.util.Collection<EntityTypesListItem> 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).
    
    Parameters:
    
    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).
  - withEntityTypes
```
public EntityRecognizerInputDataConfig withEntityTypes(EntityTypesListItem... 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).
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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).
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withEntityTypes
```
public EntityRecognizerInputDataConfig withEntityTypes(java.util.Collection<EntityTypesListItem> 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).
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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).
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDocuments
```
public EntityRecognizerDocuments getDocuments()
```
    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:
    
    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.
  - setDocuments
```
public void setDocuments(EntityRecognizerDocuments 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.
    
    Parameters:
    
    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.
  - withDocuments
```
public EntityRecognizerInputDataConfig withDocuments(EntityRecognizerDocuments 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAnnotations
```
public EntityRecognizerAnnotations getAnnotations()
```
    The S3 location of the CSV file that annotates your training documents.
    
    Returns:
    
    The S3 location of the CSV file that annotates your training documents.
  - setAnnotations
```
public void setAnnotations(EntityRecognizerAnnotations annotations)
```
    The S3 location of the CSV file that annotates your training documents.
    
    Parameters:
    
    annotations -
    The S3 location of the CSV file that annotates your training documents.
  - withAnnotations
```
public EntityRecognizerInputDataConfig withAnnotations(EntityRecognizerAnnotations annotations)
```
    The S3 location of the CSV file that annotates your training documents.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    annotations -
    The S3 location of the CSV file that annotates your training documents.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEntityList
```
public EntityRecognizerEntityList getEntityList()
```
    The S3 location of the CSV file that has the entity list for your custom entity recognizer.
    
    Returns:
    
    The S3 location of the CSV file that has the entity list for your custom entity recognizer.
  - setEntityList
```
public void setEntityList(EntityRecognizerEntityList entityList)
```
    The S3 location of the CSV file that has the entity list for your custom entity recognizer.
    
    Parameters:
    
    entityList -
    The S3 location of the CSV file that has the entity list for your custom entity recognizer.
  - withEntityList
```
public EntityRecognizerInputDataConfig withEntityList(EntityRecognizerEntityList entityList)
```
    The S3 location of the CSV file that has the entity list for your custom entity recognizer.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    entityList -
    The S3 location of the CSV file that has the entity list for your custom entity recognizer.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAugmentedManifests
```
public java.util.List<AugmentedManifestsListItem> getAugmentedManifests()
```
    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:
    
    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.
  - setAugmentedManifests
```
public void setAugmentedManifests(java.util.Collection<AugmentedManifestsListItem> 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.
    
    Parameters:
    
    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.
  - withAugmentedManifests
```
public EntityRecognizerInputDataConfig withAugmentedManifests(AugmentedManifestsListItem... 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAugmentedManifests
```
public EntityRecognizerInputDataConfig withAugmentedManifests(java.util.Collection<AugmentedManifestsListItem> 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class EntityRecognizerInputDataConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EntityRecognizerInputDataConfig

Method Detail

getDataFormat

setDataFormat

withDataFormat

setDataFormat

withDataFormat

getEntityTypes

setEntityTypes

withEntityTypes

withEntityTypes

getDocuments

setDocuments

withDocuments

getAnnotations

setAnnotations

withAnnotations

getEntityList

setEntityList

withEntityList

getAugmentedManifests

setAugmentedManifests

withAugmentedManifests

withAugmentedManifests

toString

hashCode

equals