Interface DetectEntitiesResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,ComprehendResponse.Builder
,CopyableBuilder<DetectEntitiesResponse.Builder,
,DetectEntitiesResponse> SdkBuilder<DetectEntitiesResponse.Builder,
,DetectEntitiesResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DetectEntitiesResponse
-
Method Summary
Modifier and TypeMethodDescriptionblocks
(Collection<Block> blocks) Information about each block of text in the input document.blocks
(Consumer<Block.Builder>... blocks) Information about each block of text in the input document.Information about each block of text in the input document.default DetectEntitiesResponse.Builder
documentMetadata
(Consumer<DocumentMetadata.Builder> documentMetadata) Information about the document, discovered during text extraction.documentMetadata
(DocumentMetadata documentMetadata) Information about the document, discovered during text extraction.documentType
(Collection<DocumentTypeListItem> documentType) The document type for each page in the input document.documentType
(Consumer<DocumentTypeListItem.Builder>... documentType) The document type for each page in the input document.documentType
(DocumentTypeListItem... documentType) The document type for each page in the input document.entities
(Collection<Entity> entities) A collection of entities identified in the input text.entities
(Consumer<Entity.Builder>... entities) A collection of entities identified in the input text.A collection of entities identified in the input text.errors
(Collection<ErrorsListItem> errors) Page-level errors that the system detected while processing the input document.errors
(Consumer<ErrorsListItem.Builder>... errors) Page-level errors that the system detected while processing the input document.errors
(ErrorsListItem... errors) Page-level errors that the system detected while processing the input document.Methods inherited from interface software.amazon.awssdk.services.comprehend.model.ComprehendResponse.Builder
build, responseMetadata, responseMetadata
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
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
entities
A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
- Parameters:
entities
- A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
entities
A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
- Parameters:
entities
- A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
entities
A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
This is a convenience method that creates an instance of theEntity.Builder
avoiding the need to create one manually viaEntity.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toentities(List<Entity>)
.- Parameters:
entities
- a consumer that will call methods onEntity.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
documentMetadata
Information about the document, discovered during text extraction. This field is present in the response only if your request used the
Byte
parameter.- Parameters:
documentMetadata
- Information about the document, discovered during text extraction. This field is present in the response only if your request used theByte
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentMetadata
default DetectEntitiesResponse.Builder documentMetadata(Consumer<DocumentMetadata.Builder> documentMetadata) Information about the document, discovered during text extraction. This field is present in the response only if your request used the
This is a convenience method that creates an instance of theByte
parameter.DocumentMetadata.Builder
avoiding the need to create one manually viaDocumentMetadata.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todocumentMetadata(DocumentMetadata)
.- Parameters:
documentMetadata
- a consumer that will call methods onDocumentMetadata.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
documentType
The document type for each page in the input document. This field is present in the response only if your request used the
Byte
parameter.- Parameters:
documentType
- The document type for each page in the input document. This field is present in the response only if your request used theByte
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentType
The document type for each page in the input document. This field is present in the response only if your request used the
Byte
parameter.- Parameters:
documentType
- The document type for each page in the input document. This field is present in the response only if your request used theByte
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentType
The document type for each page in the input document. This field is present in the response only if your request used the
This is a convenience method that creates an instance of theByte
parameter.DocumentTypeListItem.Builder
avoiding the need to create one manually viaDocumentTypeListItem.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todocumentType(List<DocumentTypeListItem>)
.- Parameters:
documentType
- a consumer that will call methods onDocumentTypeListItem.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
blocks
Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.
The
Block
content for a Word input document does not include aGeometry
field.The
Block
field is not present in the response for plain-text inputs.- Parameters:
blocks
- Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.The
Block
content for a Word input document does not include aGeometry
field.The
Block
field is not present in the response for plain-text inputs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blocks
Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.
The
Block
content for a Word input document does not include aGeometry
field.The
Block
field is not present in the response for plain-text inputs.- Parameters:
blocks
- Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.The
Block
content for a Word input document does not include aGeometry
field.The
Block
field is not present in the response for plain-text inputs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blocks
Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.
The
Block
content for a Word input document does not include aGeometry
field.The
This is a convenience method that creates an instance of theBlock
field is not present in the response for plain-text inputs.Block.Builder
avoiding the need to create one manually viaBlock.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toblocks(List<Block>)
.- Parameters:
blocks
- a consumer that will call methods onBlock.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
errors
Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
- Parameters:
errors
- Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
errors
Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
- Parameters:
errors
- Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
errors
Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
This is a convenience method that creates an instance of theErrorsListItem.Builder
avoiding the need to create one manually viaErrorsListItem.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toerrors(List<ErrorsListItem>)
.- Parameters:
errors
- a consumer that will call methods onErrorsListItem.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-