Package software.amazon.awssdk.services.comprehend.model

Class KeyPhrase

java.lang.Object

software.amazon.awssdk.services.comprehend.model.KeyPhrase

All Implemented Interfaces:

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

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

Describes a key noun phrase.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KeyPhrase.Builder

Method Summary

Modifier and Type	Method	Description
Integer	beginOffset()	The zero-based offset from the beginning of the source text to the first character in the key phrase.
static KeyPhrase.Builder	builder()
Integer	endOffset()	The zero-based offset from the beginning of the source text to the last character in the key phrase.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Float	score()	The level of confidence that Amazon Comprehend has in the accuracy of the detection.
List<SdkField<?>>	sdkFields()
static Class<? extends KeyPhrase.Builder>	serializableBuilderClass()
String	text()	The text of a key noun phrase.
KeyPhrase.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

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.

text

public final String text()

The text of a key noun phrase.

Returns:

The text of a key noun phrase.

beginOffset

public final Integer beginOffset()

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

Returns:

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

endOffset

public final Integer endOffset()

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

Returns:

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

toBuilder

public KeyPhrase.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KeyPhrase.Builder,KeyPhrase>

builder

public static KeyPhrase.Builder builder()

serializableBuilderClass

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