software.amazon.awssdk.services.comprehend.model

Class EntityRecognizerMetadata

java.lang.Object

software.amazon.awssdk.services.comprehend.model.EntityRecognizerMetadata

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EntityRecognizerMetadata.Builder,EntityRecognizerMetadata>

@Generated(value="software.amazon.awssdk:codegen")
public final class EntityRecognizerMetadata
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EntityRecognizerMetadata.Builder,EntityRecognizerMetadata>

Detailed information about an entity recognizer.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EntityRecognizerMetadata.Builder

Method Summary

Modifier and Type	Method and Description
static EntityRecognizerMetadata.Builder	builder()
List<EntityRecognizerMetadataEntityTypesListItem>	entityTypes() Entity types from the metadata of an entity recognizer.
boolean	equals(Object obj)
EntityRecognizerEvaluationMetrics	evaluationMetrics() Detailed information about the accuracy of an entity recognizer.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	numberOfTestDocuments() The number of documents in the input data that were used to test the entity recognizer.
Integer	numberOfTrainedDocuments() The number of documents in the input data that were used to train the entity recognizer.
List<SdkField<?>>	sdkFields()
static Class<? extends EntityRecognizerMetadata.Builder>	serializableBuilderClass()
EntityRecognizerMetadata.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

numberOfTrainedDocuments

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

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.

numberOfTestDocuments

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

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.

evaluationMetrics

public EntityRecognizerEvaluationMetrics evaluationMetrics()

Detailed information about the accuracy of an entity recognizer.

Returns:

Detailed information about the accuracy of an entity recognizer.

entityTypes

public List<EntityRecognizerMetadataEntityTypesListItem> entityTypes()

Entity types from the metadata of an entity recognizer.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Entity types from the metadata of an entity recognizer.

toBuilder

public EntityRecognizerMetadata.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<EntityRecognizerMetadata.Builder,EntityRecognizerMetadata>

Returns:

a builder for type T

builder

public static EntityRecognizerMetadata.Builder builder()

serializableBuilderClass

public static Class<? extends EntityRecognizerMetadata.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.