software.amazon.awssdk.services.comprehend.model

Interface KeyPhrase.Builder

All Superinterfaces:

Buildable, CopyableBuilder<KeyPhrase.Builder,KeyPhrase>, SdkBuilder<KeyPhrase.Builder,KeyPhrase>, SdkPojo

Enclosing class:

KeyPhrase

public static interface KeyPhrase.Builder
extends SdkPojo, CopyableBuilder<KeyPhrase.Builder,KeyPhrase>

Method Summary

Modifier and Type	Method and Description
KeyPhrase.Builder	beginOffset(Integer beginOffset) A character offset in the input text that shows where the key phrase begins (the first character is at position 0).
KeyPhrase.Builder	endOffset(Integer endOffset) A character offset in the input text where the key phrase ends.
KeyPhrase.Builder	score(Float score) The level of confidence that Amazon Comprehend has in the accuracy of the detection.
KeyPhrase.Builder	text(String text) The text of a key noun phrase.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

score

KeyPhrase.Builder score(Float score)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

text

KeyPhrase.Builder text(String text)

The text of a key noun phrase.

Parameters:

text - The text of a key noun phrase.

Returns:

Returns a reference to this object so that method calls can be chained together.

beginOffset

KeyPhrase.Builder beginOffset(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

endOffset

KeyPhrase.Builder endOffset(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.