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

Interface TargetedSentimentMention.Builder

All Superinterfaces:

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

Enclosing class:

TargetedSentimentMention

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

Method Summary

Modifier and Type	Method	Description
TargetedSentimentMention.Builder	beginOffset(Integer beginOffset)	The offset into the document text where the mention begins.
TargetedSentimentMention.Builder	endOffset(Integer endOffset)	The offset into the document text where the mention ends.
TargetedSentimentMention.Builder	groupScore(Float groupScore)	The confidence that all the entities mentioned in the group relate to the same entity.
default TargetedSentimentMention.Builder	mentionSentiment(Consumer<MentionSentiment.Builder> mentionSentiment)	Contains the sentiment and sentiment score for the mention.
TargetedSentimentMention.Builder	mentionSentiment(MentionSentiment mentionSentiment)	Contains the sentiment and sentiment score for the mention.
TargetedSentimentMention.Builder	score(Float score)	Model confidence that the entity is relevant.
TargetedSentimentMention.Builder	text(String text)	The text in the document that identifies the entity.
TargetedSentimentMention.Builder	type(String type)	The type of the entity.
TargetedSentimentMention.Builder	type(TargetedSentimentEntityType type)	The type of the entity.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Detail

score

TargetedSentimentMention.Builder score(Float score)

Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.

Parameters:

score - Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.

Returns:

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

groupScore

TargetedSentimentMention.Builder groupScore(Float groupScore)

The confidence that all the entities mentioned in the group relate to the same entity.

Parameters:

groupScore - The confidence that all the entities mentioned in the group relate to the same entity.

Returns:

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

text

TargetedSentimentMention.Builder text(String text)

The text in the document that identifies the entity.

Parameters:

text - The text in the document that identifies the entity.

Returns:

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

type

TargetedSentimentMention.Builder type(String type)

The type of the entity. Amazon Comprehend supports a variety of entity types.

Parameters:

type - The type of the entity. Amazon Comprehend supports a variety of entity types.

Returns:

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

See Also:

TargetedSentimentEntityType, TargetedSentimentEntityType

type

TargetedSentimentMention.Builder type(TargetedSentimentEntityType type)

The type of the entity. Amazon Comprehend supports a variety of entity types.

Parameters:

type - The type of the entity. Amazon Comprehend supports a variety of entity types.

Returns:

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

See Also:

TargetedSentimentEntityType, TargetedSentimentEntityType

mentionSentiment

TargetedSentimentMention.Builder mentionSentiment(MentionSentiment mentionSentiment)

Contains the sentiment and sentiment score for the mention.

Parameters:

mentionSentiment - Contains the sentiment and sentiment score for the mention.

Returns:

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

mentionSentiment

default TargetedSentimentMention.Builder mentionSentiment(Consumer<MentionSentiment.Builder> mentionSentiment)

Contains the sentiment and sentiment score for the mention.

This is a convenience method that creates an instance of the MentionSentiment.Builder avoiding the need to create one manually via MentionSentiment.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mentionSentiment(MentionSentiment).

Parameters:

mentionSentiment - a consumer that will call methods on MentionSentiment.Builder

Returns:

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

See Also:

mentionSentiment(MentionSentiment)

beginOffset

TargetedSentimentMention.Builder beginOffset(Integer beginOffset)

The offset into the document text where the mention begins.

Parameters:

beginOffset - The offset into the document text where the mention begins.

Returns:

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

endOffset

TargetedSentimentMention.Builder endOffset(Integer endOffset)

The offset into the document text where the mention ends.

Parameters:

endOffset - The offset into the document text where the mention ends.

Returns:

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