software.amazon.awssdk.services.comprehend.model

Class Entity

java.lang.Object

software.amazon.awssdk.services.comprehend.model.Entity

All Implemented Interfaces:

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

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

Provides information about an entity.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Entity.Builder

Method Summary

Modifier and Type	Method and Description
Integer	beginOffset() The zero-based offset from the beginning of the source text to the first character in the entity.
List<BlockReference>	blockReferences() A reference to each block for this entity.
static Entity.Builder	builder()
Integer	endOffset() The zero-based offset from the beginning of the source text to the last character in the entity.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBlockReferences() For responses, this returns true if the service returned a value for the BlockReferences property.
int	hashCode()
Float	score() The level of confidence that Amazon Comprehend has in the accuracy of the detection.
List<SdkField<?>>	sdkFields()
static Class<? extends Entity.Builder>	serializableBuilderClass()
String	text() The text of the entity.
Entity.Builder	toBuilder()
String	toString() Returns a string representation of this object.
EntityType	type() The entity type.
String	typeAsString() The entity type.

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

score

public final Float score()

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Returns:

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

type

public final EntityType type()

The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.

For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.

If the service returns an enum value that is not available in the current SDK version, type will return EntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.

For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.

See Also:

EntityType

typeAsString

public final String typeAsString()

The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.

For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.

If the service returns an enum value that is not available in the current SDK version, type will return EntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.

For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.

See Also:

EntityType

text

public final String text()

The text of the entity.

Returns:

The text of the entity.

beginOffset

public final Integer beginOffset()

The zero-based offset from the beginning of the source text to the first character in the entity.

This field is empty for non-text input.

Returns:

The zero-based offset from the beginning of the source text to the first character in the entity.

This field is empty for non-text input.

endOffset

public final Integer endOffset()

The zero-based offset from the beginning of the source text to the last character in the entity.

This field is empty for non-text input.

Returns:

The zero-based offset from the beginning of the source text to the last character in the entity.

This field is empty for non-text input.

hasBlockReferences

public final boolean hasBlockReferences()

For responses, this returns true if the service returned a value for the BlockReferences 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.

blockReferences

public final List<BlockReference> blockReferences()

A reference to each block for this entity. This field is empty for plain-text input.

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 hasBlockReferences() method.

Returns:

A reference to each block for this entity. This field is empty for plain-text input.

toBuilder

public Entity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Entity.Builder,Entity>

builder

public static Entity.Builder builder()

serializableBuilderClass

public static Class<? extends Entity.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