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(value="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 and Description
static interface	KeyPhrase.Builder

Method Summary

Modifier and Type	Method and Description
Integer	beginOffset() A character offset in the input text that shows where the key phrase begins (the first character is at position 0).
static KeyPhrase.Builder	builder()
Integer	endOffset() A character offset in the input text where the key phrase ends.
boolean	equals(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() 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

score

public 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 String text()

The text of a key noun phrase.

Returns:

The text of a key noun phrase.

beginOffset

public Integer beginOffset()

A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Returns:

A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

endOffset

public Integer endOffset()

A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Returns:

A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

toBuilder

public KeyPhrase.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<KeyPhrase.Builder,KeyPhrase>

Returns:

a builder for type T

builder

public static KeyPhrase.Builder builder()

serializableBuilderClass

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