software.amazon.awssdk.services.comprehendmedical

Interface ComprehendMedicalAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface ComprehendMedicalAsyncClient
extends SdkClient

Service client for accessing ComprehendMedical asynchronously. This can be created using the static builder() method.

Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static ComprehendMedicalAsyncClientBuilder	builder() Create a builder that can be used to configure and create a ComprehendMedicalAsyncClient.
static ComprehendMedicalAsyncClient	create() Create a ComprehendMedicalAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<DetectEntitiesResponse>	detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest) Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .
default CompletableFuture<DetectEntitiesResponse>	detectEntities(DetectEntitiesRequest detectEntitiesRequest) Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .
default CompletableFuture<DetectPhiResponse>	detectPHI(Consumer<DetectPhiRequest.Builder> detectPhiRequest) Inspects the clinical text for personal health information (PHI) entities and entity category, location, and confidence score on that information.
default CompletableFuture<DetectPhiResponse>	detectPHI(DetectPhiRequest detectPhiRequest) Inspects the clinical text for personal health information (PHI) entities and entity category, location, and confidence score on that information.

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

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static ComprehendMedicalAsyncClient create()

Create a ComprehendMedicalAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ComprehendMedicalAsyncClientBuilder builder()

Create a builder that can be used to configure and create a ComprehendMedicalAsyncClient.

detectEntities

default CompletableFuture<DetectEntitiesResponse> detectEntities(DetectEntitiesRequest detectEntitiesRequest)

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .

Parameters:

detectEntitiesRequest -

Returns:

A Java Future containing the result of the DetectEntities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException An internal server error occurred. Retry your request.
• ServiceUnavailableException The Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
• InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
• InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
• TextSizeLimitExceededException The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

detectEntities

default CompletableFuture<DetectEntitiesResponse> detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest)

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .

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

Parameters:

detectEntitiesRequest - A Consumer that will call methods on DetectEntitiesRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DetectEntities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException An internal server error occurred. Retry your request.
• ServiceUnavailableException The Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
• InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
• InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
• TextSizeLimitExceededException The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

detectPHI

default CompletableFuture<DetectPhiResponse> detectPHI(DetectPhiRequest detectPhiRequest)

Inspects the clinical text for personal health information (PHI) entities and entity category, location, and confidence score on that information.

Parameters:

detectPhiRequest -

Returns:

A Java Future containing the result of the DetectPHI operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException An internal server error occurred. Retry your request.
• ServiceUnavailableException The Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
• InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
• InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
• TextSizeLimitExceededException The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

detectPHI

default CompletableFuture<DetectPhiResponse> detectPHI(Consumer<DetectPhiRequest.Builder> detectPhiRequest)

Inspects the clinical text for personal health information (PHI) entities and entity category, location, and confidence score on that information.

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

Parameters:

detectPhiRequest - A Consumer that will call methods on DetectPHIRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DetectPHI operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalServerException An internal server error occurred. Retry your request.
• ServiceUnavailableException The Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
• InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
• InvalidEncodingException The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
• TextSizeLimitExceededException The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ComprehendMedicalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation