Interface DetectPhiResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,ComprehendMedicalResponse.Builder
,CopyableBuilder<DetectPhiResponse.Builder,
,DetectPhiResponse> SdkBuilder<DetectPhiResponse.Builder,
,DetectPhiResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DetectPhiResponse
-
Method Summary
Modifier and TypeMethodDescriptionentities
(Collection<Entity> entities) The collection of PHI entities extracted from the input text and their associated information.entities
(Consumer<Entity.Builder>... entities) The collection of PHI entities extracted from the input text and their associated information.The collection of PHI entities extracted from the input text and their associated information.modelVersion
(String modelVersion) The version of the model used to analyze the documents.paginationToken
(String paginationToken) If the result of the previous request toDetectPHI
was truncated, include thePaginationToken
to fetch the next page of PHI entities.Methods inherited from interface software.amazon.awssdk.services.comprehendmedical.model.ComprehendMedicalResponse.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
The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its detection.
- Parameters:
entities
- The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its detection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
entities
The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its detection.
- Parameters:
entities
- The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its detection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
entities
The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its detection.
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:
-
paginationToken
If the result of the previous request to
DetectPHI
was truncated, include thePaginationToken
to fetch the next page of PHI entities.- Parameters:
paginationToken
- If the result of the previous request toDetectPHI
was truncated, include thePaginationToken
to fetch the next page of PHI entities.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
modelVersion
The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.
- Parameters:
modelVersion
- The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-