Class: Aws::ComprehendMedical::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ComprehendMedical::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb
Overview
An API client for ComprehendMedical. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ComprehendMedical::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#describe_entities_detection_v2_job(params = {}) ⇒ Types::DescribeEntitiesDetectionV2JobResponse
Gets the properties associated with a medical entities detection job.
-
#describe_icd10cm_inference_job(params = {}) ⇒ Types::DescribeICD10CMInferenceJobResponse
Gets the properties associated with an InferICD10CM job.
-
#describe_phi_detection_job(params = {}) ⇒ Types::DescribePHIDetectionJobResponse
Gets the properties associated with a protected health information (PHI) detection job.
-
#describe_rx_norm_inference_job(params = {}) ⇒ Types::DescribeRxNormInferenceJobResponse
Gets the properties associated with an InferRxNorm job.
-
#detect_entities(params = {}) ⇒ Types::DetectEntitiesResponse
The
DetectEntities
operation is deprecated. -
#detect_entities_v2(params = {}) ⇒ Types::DetectEntitiesV2Response
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.
-
#detect_phi(params = {}) ⇒ Types::DetectPHIResponse
Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity.
-
#infer_icd10cm(params = {}) ⇒ Types::InferICD10CMResponse
InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control.
-
#infer_rx_norm(params = {}) ⇒ Types::InferRxNormResponse
InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine.
-
#list_entities_detection_v2_jobs(params = {}) ⇒ Types::ListEntitiesDetectionV2JobsResponse
Gets a list of medical entity detection jobs that you have submitted.
-
#list_icd10cm_inference_jobs(params = {}) ⇒ Types::ListICD10CMInferenceJobsResponse
Gets a list of InferICD10CM jobs that you have submitted.
-
#list_phi_detection_jobs(params = {}) ⇒ Types::ListPHIDetectionJobsResponse
Gets a list of protected health information (PHI) detection jobs that you have submitted.
-
#list_rx_norm_inference_jobs(params = {}) ⇒ Types::ListRxNormInferenceJobsResponse
Gets a list of InferRxNorm jobs that you have submitted.
-
#start_entities_detection_v2_job(params = {}) ⇒ Types::StartEntitiesDetectionV2JobResponse
Starts an asynchronous medical entity detection job for a collection of documents.
-
#start_icd10cm_inference_job(params = {}) ⇒ Types::StartICD10CMInferenceJobResponse
Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology.
-
#start_phi_detection_job(params = {}) ⇒ Types::StartPHIDetectionJobResponse
Starts an asynchronous job to detect protected health information (PHI).
-
#start_rx_norm_inference_job(params = {}) ⇒ Types::StartRxNormInferenceJobResponse
Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology.
-
#stop_entities_detection_v2_job(params = {}) ⇒ Types::StopEntitiesDetectionV2JobResponse
Stops a medical entities detection job in progress.
-
#stop_icd10cm_inference_job(params = {}) ⇒ Types::StopICD10CMInferenceJobResponse
Stops an InferICD10CM inference job in progress.
-
#stop_phi_detection_job(params = {}) ⇒ Types::StopPHIDetectionJobResponse
Stops a protected health information (PHI) detection job in progress.
-
#stop_rx_norm_inference_job(params = {}) ⇒ Types::StopRxNormInferenceJobResponse
Stops an InferRxNorm inference job in progress.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
334 335 336 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#describe_entities_detection_v2_job(params = {}) ⇒ Types::DescribeEntitiesDetectionV2JobResponse
Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.
381 382 383 384 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 381 def describe_entities_detection_v2_job(params = {}, = {}) req = build_request(:describe_entities_detection_v2_job, params) req.send_request() end |
#describe_icd10cm_inference_job(params = {}) ⇒ Types::DescribeICD10CMInferenceJobResponse
Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.
427 428 429 430 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 427 def describe_icd10cm_inference_job(params = {}, = {}) req = build_request(:describe_icd10cm_inference_job, params) req.send_request() end |
#describe_phi_detection_job(params = {}) ⇒ Types::DescribePHIDetectionJobResponse
Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.
474 475 476 477 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 474 def describe_phi_detection_job(params = {}, = {}) req = build_request(:describe_phi_detection_job, params) req.send_request() end |
#describe_rx_norm_inference_job(params = {}) ⇒ Types::DescribeRxNormInferenceJobResponse
Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.
520 521 522 523 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 520 def describe_rx_norm_inference_job(params = {}, = {}) req = build_request(:describe_rx_norm_inference_job, params) req.send_request() end |
#detect_entities(params = {}) ⇒ Types::DetectEntitiesResponse
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 .
597 598 599 600 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 597 def detect_entities(params = {}, = {}) req = build_request(:detect_entities, params) req.send_request() end |
#detect_entities_v2(params = {}) ⇒ Types::DetectEntitiesV2Response
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. Amazon Comprehend Medical only detects medical entities in English language texts.
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.
681 682 683 684 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 681 def detect_entities_v2(params = {}, = {}) req = build_request(:detect_entities_v2, params) req.send_request() end |
#detect_phi(params = {}) ⇒ Types::DetectPHIResponse
Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts.
741 742 743 744 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 741 def detect_phi(params = {}, = {}) req = build_request(:detect_phi, params) req.send_request() end |
#infer_icd10cm(params = {}) ⇒ Types::InferICD10CMResponse
InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control. Amazon Comprehend Medical only detects medical entities in English language texts.
803 804 805 806 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 803 def infer_icd10cm(params = {}, = {}) req = build_request(:infer_icd10cm, params) req.send_request() end |
#infer_rx_norm(params = {}) ⇒ Types::InferRxNormResponse
InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine. Amazon Comprehend Medical only detects medical entities in English language texts.
864 865 866 867 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 864 def infer_rx_norm(params = {}, = {}) req = build_request(:infer_rx_norm, params) req.send_request() end |
#list_entities_detection_v2_jobs(params = {}) ⇒ Types::ListEntitiesDetectionV2JobsResponse
Gets a list of medical entity detection jobs that you have submitted.
926 927 928 929 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 926 def list_entities_detection_v2_jobs(params = {}, = {}) req = build_request(:list_entities_detection_v2_jobs, params) req.send_request() end |
#list_icd10cm_inference_jobs(params = {}) ⇒ Types::ListICD10CMInferenceJobsResponse
Gets a list of InferICD10CM jobs that you have submitted.
988 989 990 991 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 988 def list_icd10cm_inference_jobs(params = {}, = {}) req = build_request(:list_icd10cm_inference_jobs, params) req.send_request() end |
#list_phi_detection_jobs(params = {}) ⇒ Types::ListPHIDetectionJobsResponse
Gets a list of protected health information (PHI) detection jobs that you have submitted.
1051 1052 1053 1054 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1051 def list_phi_detection_jobs(params = {}, = {}) req = build_request(:list_phi_detection_jobs, params) req.send_request() end |
#list_rx_norm_inference_jobs(params = {}) ⇒ Types::ListRxNormInferenceJobsResponse
Gets a list of InferRxNorm jobs that you have submitted.
1112 1113 1114 1115 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1112 def list_rx_norm_inference_jobs(params = {}, = {}) req = build_request(:list_rx_norm_inference_jobs, params) req.send_request() end |
#start_entities_detection_v2_job(params = {}) ⇒ Types::StartEntitiesDetectionV2JobResponse
Starts an asynchronous medical entity detection job for a collection
of documents. Use the DescribeEntitiesDetectionV2Job
operation to
track the status of a job.
1185 1186 1187 1188 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1185 def start_entities_detection_v2_job(params = {}, = {}) req = build_request(:start_entities_detection_v2_job, params) req.send_request() end |
#start_icd10cm_inference_job(params = {}) ⇒ Types::StartICD10CMInferenceJobResponse
Starts an asynchronous job to detect medical conditions and link them
to the ICD-10-CM ontology. Use the DescribeICD10CMInferenceJob
operation to track the status of a job.
1258 1259 1260 1261 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1258 def start_icd10cm_inference_job(params = {}, = {}) req = build_request(:start_icd10cm_inference_job, params) req.send_request() end |
#start_phi_detection_job(params = {}) ⇒ Types::StartPHIDetectionJobResponse
Starts an asynchronous job to detect protected health information
(PHI). Use the DescribePHIDetectionJob
operation to track the status
of a job.
1331 1332 1333 1334 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1331 def start_phi_detection_job(params = {}, = {}) req = build_request(:start_phi_detection_job, params) req.send_request() end |
#start_rx_norm_inference_job(params = {}) ⇒ Types::StartRxNormInferenceJobResponse
Starts an asynchronous job to detect medication entities and link them
to the RxNorm ontology. Use the DescribeRxNormInferenceJob
operation
to track the status of a job.
1404 1405 1406 1407 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1404 def start_rx_norm_inference_job(params = {}, = {}) req = build_request(:start_rx_norm_inference_job, params) req.send_request() end |
#stop_entities_detection_v2_job(params = {}) ⇒ Types::StopEntitiesDetectionV2JobResponse
Stops a medical entities detection job in progress.
1432 1433 1434 1435 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1432 def stop_entities_detection_v2_job(params = {}, = {}) req = build_request(:stop_entities_detection_v2_job, params) req.send_request() end |
#stop_icd10cm_inference_job(params = {}) ⇒ Types::StopICD10CMInferenceJobResponse
Stops an InferICD10CM inference job in progress.
1460 1461 1462 1463 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1460 def stop_icd10cm_inference_job(params = {}, = {}) req = build_request(:stop_icd10cm_inference_job, params) req.send_request() end |
#stop_phi_detection_job(params = {}) ⇒ Types::StopPHIDetectionJobResponse
Stops a protected health information (PHI) detection job in progress.
1488 1489 1490 1491 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1488 def stop_phi_detection_job(params = {}, = {}) req = build_request(:stop_phi_detection_job, params) req.send_request() end |
#stop_rx_norm_inference_job(params = {}) ⇒ Types::StopRxNormInferenceJobResponse
Stops an InferRxNorm inference job in progress.
1516 1517 1518 1519 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1516 def stop_rx_norm_inference_job(params = {}, = {}) req = build_request(:stop_rx_norm_inference_job, params) req.send_request() end |