Package 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("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	Description
static interface	EntityRecognizerMetadata.Builder

Method Summary

Modifier and Type	Method	Description
static EntityRecognizerMetadata.Builder	builder()
List<EntityRecognizerMetadataEntityTypesListItem>	entityTypes()	Entity types from the metadata of an entity recognizer.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EntityRecognizerEvaluationMetrics	evaluationMetrics()	Detailed information about the accuracy of an entity recognizer.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEntityTypes()	For responses, this returns true if the service returned a value for the EntityTypes property.
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()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

numberOfTrainedDocuments

public final 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 final 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 final EntityRecognizerEvaluationMetrics evaluationMetrics()

Detailed information about the accuracy of an entity recognizer.

Returns:

Detailed information about the accuracy of an entity recognizer.

hasEntityTypes

public final boolean hasEntityTypes()

For responses, this returns true if the service returned a value for the EntityTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

entityTypes

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEntityTypes() method.

Returns:

Entity types from the metadata of an entity recognizer.

toBuilder

public EntityRecognizerMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EntityRecognizerMetadata.Builder,EntityRecognizerMetadata>

builder

public static EntityRecognizerMetadata.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo