Interface TargetedSentimentMention.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<TargetedSentimentMention.Builder,
,TargetedSentimentMention> SdkBuilder<TargetedSentimentMention.Builder,
,TargetedSentimentMention> SdkPojo
- Enclosing class:
TargetedSentimentMention
-
Method Summary
Modifier and TypeMethodDescriptionbeginOffset
(Integer beginOffset) The offset into the document text where the mention begins.The offset into the document text where the mention ends.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.mentionSentiment
(MentionSentiment mentionSentiment) Contains the sentiment and sentiment score for the mention.Model confidence that the entity is relevant.The text in the document that identifies the entity.The type of the entity.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 Details
-
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
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
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
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:
-
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:
-
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 theMentionSentiment.Builder
avoiding the need to create one manually viaMentionSentiment.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomentionSentiment(MentionSentiment)
.- Parameters:
mentionSentiment
- a consumer that will call methods onMentionSentiment.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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.
-