@Generated(value="software.amazon.awssdk:codegen") public interface ComprehendMedicalAsyncClient extends SdkClient
builder() method.
Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| 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<DescribeEntitiesDetectionV2JobResponse> |
describeEntitiesDetectionV2Job(Consumer<DescribeEntitiesDetectionV2JobRequest.Builder> describeEntitiesDetectionV2JobRequest)
Gets the properties associated with a medical entities detection job.
|
default CompletableFuture<DescribeEntitiesDetectionV2JobResponse> |
describeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest describeEntitiesDetectionV2JobRequest)
Gets the properties associated with a medical entities detection job.
|
default CompletableFuture<DescribePhiDetectionJobResponse> |
describePHIDetectionJob(Consumer<DescribePhiDetectionJobRequest.Builder> describePhiDetectionJobRequest)
Gets the properties associated with a protected health information (PHI) detection job.
|
default CompletableFuture<DescribePhiDetectionJobResponse> |
describePHIDetectionJob(DescribePhiDetectionJobRequest describePhiDetectionJobRequest)
Gets the properties associated with a protected health information (PHI) detection job.
|
default CompletableFuture<DetectEntitiesResponse> |
detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest)
The
DetectEntities operation is deprecated. |
default CompletableFuture<DetectEntitiesResponse> |
detectEntities(DetectEntitiesRequest detectEntitiesRequest)
The
DetectEntities operation is deprecated. |
default CompletableFuture<DetectEntitiesV2Response> |
detectEntitiesV2(Consumer<DetectEntitiesV2Request.Builder> detectEntitiesV2Request)
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<DetectEntitiesV2Response> |
detectEntitiesV2(DetectEntitiesV2Request detectEntitiesV2Request)
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 protected 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 protected health information (PHI) entities and entity category, location, and
confidence score on that information.
|
default CompletableFuture<ListEntitiesDetectionV2JobsResponse> |
listEntitiesDetectionV2Jobs(Consumer<ListEntitiesDetectionV2JobsRequest.Builder> listEntitiesDetectionV2JobsRequest)
Gets a list of medical entity detection jobs that you have submitted.
|
default CompletableFuture<ListEntitiesDetectionV2JobsResponse> |
listEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest listEntitiesDetectionV2JobsRequest)
Gets a list of medical entity detection jobs that you have submitted.
|
default CompletableFuture<ListPhiDetectionJobsResponse> |
listPHIDetectionJobs(Consumer<ListPhiDetectionJobsRequest.Builder> listPhiDetectionJobsRequest)
Gets a list of protected health information (PHI) detection jobs that you have submitted.
|
default CompletableFuture<ListPhiDetectionJobsResponse> |
listPHIDetectionJobs(ListPhiDetectionJobsRequest listPhiDetectionJobsRequest)
Gets a list of protected health information (PHI) detection jobs that you have submitted.
|
default CompletableFuture<StartEntitiesDetectionV2JobResponse> |
startEntitiesDetectionV2Job(Consumer<StartEntitiesDetectionV2JobRequest.Builder> startEntitiesDetectionV2JobRequest)
Starts an asynchronous medical entity detection job for a collection of documents.
|
default CompletableFuture<StartEntitiesDetectionV2JobResponse> |
startEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest startEntitiesDetectionV2JobRequest)
Starts an asynchronous medical entity detection job for a collection of documents.
|
default CompletableFuture<StartPhiDetectionJobResponse> |
startPHIDetectionJob(Consumer<StartPhiDetectionJobRequest.Builder> startPhiDetectionJobRequest)
Starts an asynchronous job to detect protected health information (PHI).
|
default CompletableFuture<StartPhiDetectionJobResponse> |
startPHIDetectionJob(StartPhiDetectionJobRequest startPhiDetectionJobRequest)
Starts an asynchronous job to detect protected health information (PHI).
|
default CompletableFuture<StopEntitiesDetectionV2JobResponse> |
stopEntitiesDetectionV2Job(Consumer<StopEntitiesDetectionV2JobRequest.Builder> stopEntitiesDetectionV2JobRequest)
Stops a medical entities detection job in progress.
|
default CompletableFuture<StopEntitiesDetectionV2JobResponse> |
stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest stopEntitiesDetectionV2JobRequest)
Stops a medical entities detection job in progress.
|
default CompletableFuture<StopPhiDetectionJobResponse> |
stopPHIDetectionJob(Consumer<StopPhiDetectionJobRequest.Builder> stopPhiDetectionJobRequest)
Stops a protected health information (PHI) detection job in progress.
|
default CompletableFuture<StopPhiDetectionJobResponse> |
stopPHIDetectionJob(StopPhiDetectionJobRequest stopPhiDetectionJobRequest)
Stops a protected health information (PHI) detection job in progress.
|
serviceNameclosestatic final String SERVICE_NAME
static ComprehendMedicalAsyncClient create()
ComprehendMedicalAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ComprehendMedicalAsyncClientBuilder builder()
ComprehendMedicalAsyncClient.default CompletableFuture<DescribeEntitiesDetectionV2JobResponse> describeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest describeEntitiesDetectionV2JobRequest)
Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.
describeEntitiesDetectionV2JobRequest - default CompletableFuture<DescribeEntitiesDetectionV2JobResponse> describeEntitiesDetectionV2Job(Consumer<DescribeEntitiesDetectionV2JobRequest.Builder> describeEntitiesDetectionV2JobRequest)
Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.
This is a convenience which creates an instance of the DescribeEntitiesDetectionV2JobRequest.Builder
avoiding the need to create one manually via DescribeEntitiesDetectionV2JobRequest.builder()
describeEntitiesDetectionV2JobRequest - A Consumer that will call methods on DescribeEntitiesDetectionV2JobRequest.Builder to
create a request.default CompletableFuture<DescribePhiDetectionJobResponse> describePHIDetectionJob(DescribePhiDetectionJobRequest describePhiDetectionJobRequest)
Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.
describePhiDetectionJobRequest - default CompletableFuture<DescribePhiDetectionJobResponse> describePHIDetectionJob(Consumer<DescribePhiDetectionJobRequest.Builder> describePhiDetectionJobRequest)
Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.
This is a convenience which creates an instance of the DescribePhiDetectionJobRequest.Builder avoiding
the need to create one manually via DescribePhiDetectionJobRequest.builder()
describePhiDetectionJobRequest - A Consumer that will call methods on DescribePHIDetectionJobRequest.Builder to create a
request.default CompletableFuture<DetectEntitiesResponse> detectEntities(DetectEntitiesRequest detectEntitiesRequest)
The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation
instead.
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 .
detectEntitiesRequest - default CompletableFuture<DetectEntitiesResponse> detectEntities(Consumer<DetectEntitiesRequest.Builder> detectEntitiesRequest)
The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation
instead.
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()
detectEntitiesRequest - A Consumer that will call methods on DetectEntitiesRequest.Builder to create a request.default CompletableFuture<DetectEntitiesV2Response> detectEntitiesV2(DetectEntitiesV2Request detectEntitiesV2Request)
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.
The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a
different model for determining the entities in your medical text and changes the way that some entities are
returned in the output. You should use the DetectEntitiesV2 operation in all new applications.
The DetectEntitiesV2 operation returns the Acuity and Direction entities
as attributes instead of types. It does not return the Quality or Quantity entities.
detectEntitiesV2Request - default CompletableFuture<DetectEntitiesV2Response> detectEntitiesV2(Consumer<DetectEntitiesV2Request.Builder> detectEntitiesV2Request)
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.
The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a
different model for determining the entities in your medical text and changes the way that some entities are
returned in the output. You should use the DetectEntitiesV2 operation in all new applications.
The DetectEntitiesV2 operation returns the Acuity and Direction entities
as attributes instead of types. It does not return the Quality or Quantity entities.
This is a convenience which creates an instance of the DetectEntitiesV2Request.Builder avoiding the need
to create one manually via DetectEntitiesV2Request.builder()
detectEntitiesV2Request - A Consumer that will call methods on DetectEntitiesV2Request.Builder to create a request.default CompletableFuture<DetectPhiResponse> detectPHI(DetectPhiRequest detectPhiRequest)
Inspects the clinical text for protected health information (PHI) entities and entity category, location, and confidence score on that information.
detectPhiRequest - default CompletableFuture<DetectPhiResponse> detectPHI(Consumer<DetectPhiRequest.Builder> detectPhiRequest)
Inspects the clinical text for protected 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()
detectPhiRequest - A Consumer that will call methods on DetectPHIRequest.Builder to create a request.default CompletableFuture<ListEntitiesDetectionV2JobsResponse> listEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest listEntitiesDetectionV2JobsRequest)
Gets a list of medical entity detection jobs that you have submitted.
listEntitiesDetectionV2JobsRequest - default CompletableFuture<ListEntitiesDetectionV2JobsResponse> listEntitiesDetectionV2Jobs(Consumer<ListEntitiesDetectionV2JobsRequest.Builder> listEntitiesDetectionV2JobsRequest)
Gets a list of medical entity detection jobs that you have submitted.
This is a convenience which creates an instance of the ListEntitiesDetectionV2JobsRequest.Builder
avoiding the need to create one manually via ListEntitiesDetectionV2JobsRequest.builder()
listEntitiesDetectionV2JobsRequest - A Consumer that will call methods on ListEntitiesDetectionV2JobsRequest.Builder to create
a request.default CompletableFuture<ListPhiDetectionJobsResponse> listPHIDetectionJobs(ListPhiDetectionJobsRequest listPhiDetectionJobsRequest)
Gets a list of protected health information (PHI) detection jobs that you have submitted.
listPhiDetectionJobsRequest - default CompletableFuture<ListPhiDetectionJobsResponse> listPHIDetectionJobs(Consumer<ListPhiDetectionJobsRequest.Builder> listPhiDetectionJobsRequest)
Gets a list of protected health information (PHI) detection jobs that you have submitted.
This is a convenience which creates an instance of the ListPhiDetectionJobsRequest.Builder avoiding the
need to create one manually via ListPhiDetectionJobsRequest.builder()
listPhiDetectionJobsRequest - A Consumer that will call methods on ListPHIDetectionJobsRequest.Builder to create a
request.default CompletableFuture<StartEntitiesDetectionV2JobResponse> startEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest startEntitiesDetectionV2JobRequest)
Starts an asynchronous medical entity detection job for a collection of documents. Use the
DescribeEntitiesDetectionV2Job operation to track the status of a job.
startEntitiesDetectionV2JobRequest - default CompletableFuture<StartEntitiesDetectionV2JobResponse> startEntitiesDetectionV2Job(Consumer<StartEntitiesDetectionV2JobRequest.Builder> startEntitiesDetectionV2JobRequest)
Starts an asynchronous medical entity detection job for a collection of documents. Use the
DescribeEntitiesDetectionV2Job operation to track the status of a job.
This is a convenience which creates an instance of the StartEntitiesDetectionV2JobRequest.Builder
avoiding the need to create one manually via StartEntitiesDetectionV2JobRequest.builder()
startEntitiesDetectionV2JobRequest - A Consumer that will call methods on StartEntitiesDetectionV2JobRequest.Builder to create
a request.default CompletableFuture<StartPhiDetectionJobResponse> startPHIDetectionJob(StartPhiDetectionJobRequest startPhiDetectionJobRequest)
Starts an asynchronous job to detect protected health information (PHI). Use the
DescribePHIDetectionJob operation to track the status of a job.
startPhiDetectionJobRequest - default CompletableFuture<StartPhiDetectionJobResponse> startPHIDetectionJob(Consumer<StartPhiDetectionJobRequest.Builder> startPhiDetectionJobRequest)
Starts an asynchronous job to detect protected health information (PHI). Use the
DescribePHIDetectionJob operation to track the status of a job.
This is a convenience which creates an instance of the StartPhiDetectionJobRequest.Builder avoiding the
need to create one manually via StartPhiDetectionJobRequest.builder()
startPhiDetectionJobRequest - A Consumer that will call methods on StartPHIDetectionJobRequest.Builder to create a
request.default CompletableFuture<StopEntitiesDetectionV2JobResponse> stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest stopEntitiesDetectionV2JobRequest)
Stops a medical entities detection job in progress.
stopEntitiesDetectionV2JobRequest - default CompletableFuture<StopEntitiesDetectionV2JobResponse> stopEntitiesDetectionV2Job(Consumer<StopEntitiesDetectionV2JobRequest.Builder> stopEntitiesDetectionV2JobRequest)
Stops a medical entities detection job in progress.
This is a convenience which creates an instance of the StopEntitiesDetectionV2JobRequest.Builder avoiding
the need to create one manually via StopEntitiesDetectionV2JobRequest.builder()
stopEntitiesDetectionV2JobRequest - A Consumer that will call methods on StopEntitiesDetectionV2JobRequest.Builder to create a
request.default CompletableFuture<StopPhiDetectionJobResponse> stopPHIDetectionJob(StopPhiDetectionJobRequest stopPhiDetectionJobRequest)
Stops a protected health information (PHI) detection job in progress.
stopPhiDetectionJobRequest - default CompletableFuture<StopPhiDetectionJobResponse> stopPHIDetectionJob(Consumer<StopPhiDetectionJobRequest.Builder> stopPhiDetectionJobRequest)
Stops a protected health information (PHI) detection job in progress.
This is a convenience which creates an instance of the StopPhiDetectionJobRequest.Builder avoiding the
need to create one manually via StopPhiDetectionJobRequest.builder()
stopPhiDetectionJobRequest - A Consumer that will call methods on StopPHIDetectionJobRequest.Builder to create a
request.Copyright © 2019. All rights reserved.