EntityRecognizerMetadata (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EntityRecognizerMetadata
extends Object
implements Serializable, Cloneable, StructuredPojo

Detailed information about an entity recognizer.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EntityRecognizerMetadata()

Constructors
Constructor and Description
`EntityRecognizerMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EntityRecognizerMetadata`	`clone()`
`boolean`	`equals(Object obj)`
`List<EntityRecognizerMetadataEntityTypesListItem>`	`getEntityTypes()` Entity types from the metadata of an entity recognizer.
`EntityRecognizerEvaluationMetrics`	`getEvaluationMetrics()` Detailed information about the accuracy of an entity recognizer.
`Integer`	`getNumberOfTestDocuments()` The number of documents in the input data that were used to test the entity recognizer.
`Integer`	`getNumberOfTrainedDocuments()` The number of documents in the input data that were used to train the entity recognizer.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEntityTypes(Collection<EntityRecognizerMetadataEntityTypesListItem> entityTypes)` Entity types from the metadata of an entity recognizer.
`void`	`setEvaluationMetrics(EntityRecognizerEvaluationMetrics evaluationMetrics)` Detailed information about the accuracy of an entity recognizer.
`void`	`setNumberOfTestDocuments(Integer numberOfTestDocuments)` The number of documents in the input data that were used to test the entity recognizer.
`void`	`setNumberOfTrainedDocuments(Integer numberOfTrainedDocuments)` The number of documents in the input data that were used to train the entity recognizer.
`String`	`toString()` Returns a string representation of this object.
`EntityRecognizerMetadata`	`withEntityTypes(Collection<EntityRecognizerMetadataEntityTypesListItem> entityTypes)` Entity types from the metadata of an entity recognizer.
`EntityRecognizerMetadata`	`withEntityTypes(EntityRecognizerMetadataEntityTypesListItem... entityTypes)` Entity types from the metadata of an entity recognizer.
`EntityRecognizerMetadata`	`withEvaluationMetrics(EntityRecognizerEvaluationMetrics evaluationMetrics)` Detailed information about the accuracy of an entity recognizer.
`EntityRecognizerMetadata`	`withNumberOfTestDocuments(Integer numberOfTestDocuments)` The number of documents in the input data that were used to test the entity recognizer.
`EntityRecognizerMetadata`	`withNumberOfTrainedDocuments(Integer numberOfTrainedDocuments)` The number of documents in the input data that were used to train the entity recognizer.

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

- Constructor Detail
  - EntityRecognizerMetadata
```
public EntityRecognizerMetadata()
```
- Method Detail
  - setNumberOfTrainedDocuments
```
public void setNumberOfTrainedDocuments(Integer numberOfTrainedDocuments)
```
    The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.
    
    Parameters:
    
    numberOfTrainedDocuments - The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.
  - getNumberOfTrainedDocuments
```
public Integer getNumberOfTrainedDocuments()
```
    The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.
    
    Returns:
    
    The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.
  - withNumberOfTrainedDocuments
```
public EntityRecognizerMetadata withNumberOfTrainedDocuments(Integer numberOfTrainedDocuments)
```
    The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.
    
    Parameters:
    
    numberOfTrainedDocuments - The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNumberOfTestDocuments
```
public void setNumberOfTestDocuments(Integer numberOfTestDocuments)
```
    The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.
    
    Parameters:
    
    numberOfTestDocuments - The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.
  - getNumberOfTestDocuments
```
public Integer getNumberOfTestDocuments()
```
    The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.
    
    Returns:
    
    The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.
  - withNumberOfTestDocuments
```
public EntityRecognizerMetadata withNumberOfTestDocuments(Integer numberOfTestDocuments)
```
    The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.
    
    Parameters:
    
    numberOfTestDocuments - The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEvaluationMetrics
```
public void setEvaluationMetrics(EntityRecognizerEvaluationMetrics evaluationMetrics)
```
    Detailed information about the accuracy of an entity recognizer.
    
    Parameters:
    
    evaluationMetrics - Detailed information about the accuracy of an entity recognizer.
  - getEvaluationMetrics
```
public EntityRecognizerEvaluationMetrics getEvaluationMetrics()
```
    Detailed information about the accuracy of an entity recognizer.
    
    Returns:
    
    Detailed information about the accuracy of an entity recognizer.
  - withEvaluationMetrics
```
public EntityRecognizerMetadata withEvaluationMetrics(EntityRecognizerEvaluationMetrics evaluationMetrics)
```
    Detailed information about the accuracy of an entity recognizer.
    
    Parameters:
    
    evaluationMetrics - Detailed information about the accuracy of an entity recognizer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEntityTypes
```
public List<EntityRecognizerMetadataEntityTypesListItem> getEntityTypes()
```
    Entity types from the metadata of an entity recognizer.
    
    Returns:
    
    Entity types from the metadata of an entity recognizer.
  - setEntityTypes
```
public void setEntityTypes(Collection<EntityRecognizerMetadataEntityTypesListItem> entityTypes)
```
    Entity types from the metadata of an entity recognizer.
    
    Parameters:
    
    entityTypes - Entity types from the metadata of an entity recognizer.
  - withEntityTypes
```
public EntityRecognizerMetadata withEntityTypes(EntityRecognizerMetadataEntityTypesListItem... entityTypes)
```
    Entity types from the metadata of an entity recognizer.
    
    NOTE: This method appends the values to the existing list (if any). Use setEntityTypes(java.util.Collection) or withEntityTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    entityTypes - Entity types from the metadata of an entity recognizer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEntityTypes
```
public EntityRecognizerMetadata withEntityTypes(Collection<EntityRecognizerMetadataEntityTypesListItem> entityTypes)
```
    Entity types from the metadata of an entity recognizer.
    
    Parameters:
    
    entityTypes - Entity types from the metadata of an entity recognizer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EntityRecognizerMetadata clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class EntityRecognizerMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EntityRecognizerMetadata

Method Detail

setNumberOfTrainedDocuments

getNumberOfTrainedDocuments

withNumberOfTrainedDocuments

setNumberOfTestDocuments

getNumberOfTestDocuments

withNumberOfTestDocuments

setEvaluationMetrics

getEvaluationMetrics

withEvaluationMetrics

getEntityTypes

setEntityTypes

withEntityTypes

withEntityTypes

toString

equals

hashCode

clone

marshall