Interface Entity.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Entity.Builder,
,Entity> SdkBuilder<Entity.Builder,
,Entity> SdkPojo
- Enclosing class:
Entity
-
Method Summary
Modifier and TypeMethodDescriptionbeginOffset
(Integer beginOffset) The zero-based offset from the beginning of the source text to the first character in the entity.blockReferences
(Collection<BlockReference> blockReferences) A reference to each block for this entity.blockReferences
(Consumer<BlockReference.Builder>... blockReferences) A reference to each block for this entity.blockReferences
(BlockReference... blockReferences) A reference to each block for this entity.The zero-based offset from the beginning of the source text to the last character in the entity.The level of confidence that Amazon Comprehend has in the accuracy of the detection.The text of the entity.The entity type.type
(EntityType type) The entity type.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
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.
-
type
The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
- Parameters:
type
- The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
- Parameters:
type
- The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
text
The text of the entity.
- Parameters:
text
- The text of the entity.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
beginOffset
The zero-based offset from the beginning of the source text to the first character in the entity.
This field is empty for non-text input.
- Parameters:
beginOffset
- The zero-based offset from the beginning of the source text to the first character in the entity.This field is empty for non-text input.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endOffset
The zero-based offset from the beginning of the source text to the last character in the entity.
This field is empty for non-text input.
- Parameters:
endOffset
- The zero-based offset from the beginning of the source text to the last character in the entity.This field is empty for non-text input.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blockReferences
A reference to each block for this entity. This field is empty for plain-text input.
- Parameters:
blockReferences
- A reference to each block for this entity. This field is empty for plain-text input.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blockReferences
A reference to each block for this entity. This field is empty for plain-text input.
- Parameters:
blockReferences
- A reference to each block for this entity. This field is empty for plain-text input.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blockReferences
A reference to each block for this entity. This field is empty for plain-text input.
This is a convenience method that creates an instance of theBlockReference.Builder
avoiding the need to create one manually viaBlockReference.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toblockReferences(List<BlockReference>)
.- Parameters:
blockReferences
- a consumer that will call methods onBlockReference.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-