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.
-
#describe_snomedct_inference_job(params = {}) ⇒ Types::DescribeSNOMEDCTInferenceJobResponse
Gets the properties associated with an InferSNOMEDCT job.
-
#detect_entities(params = {}) ⇒ Types::DetectEntitiesResponse
The
DetectEntitiesoperation 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.
-
#infer_snomedct(params = {}) ⇒ Types::InferSNOMEDCTResponse
InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology.
-
#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 you have submitted.
-
#list_rx_norm_inference_jobs(params = {}) ⇒ Types::ListRxNormInferenceJobsResponse
Gets a list of InferRxNorm jobs that you have submitted.
-
#list_snomedct_inference_jobs(params = {}) ⇒ Types::ListSNOMEDCTInferenceJobsResponse
Gets a list of InferSNOMEDCT jobs a user has 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.
-
#start_snomedct_inference_job(params = {}) ⇒ Types::StartSNOMEDCTInferenceJobResponse
Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT 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.
-
#stop_snomedct_inference_job(params = {}) ⇒ Types::StopSNOMEDCTInferenceJobResponse
Stops an InferSNOMEDCT 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.
486 487 488 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 486 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.
533 534 535 536 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 533 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.
579 580 581 582 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 579 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.
626 627 628 629 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 626 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.
672 673 674 675 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 672 def describe_rx_norm_inference_job(params = {}, = {}) req = build_request(:describe_rx_norm_inference_job, params) req.send_request() end |
#describe_snomedct_inference_job(params = {}) ⇒ Types::DescribeSNOMEDCTInferenceJobResponse
Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.
718 719 720 721 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 718 def describe_snomedct_inference_job(params = {}, = {}) req = build_request(:describe_snomedct_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.
794 795 796 797 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 794 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.
877 878 879 880 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 877 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.
936 937 938 939 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 936 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.
999 1000 1001 1002 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 999 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.
1059 1060 1061 1062 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1059 def infer_rx_norm(params = {}, = {}) req = build_request(:infer_rx_norm, params) req.send_request() end |
#infer_snomedct(params = {}) ⇒ Types::InferSNOMEDCTResponse
InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology
1130 1131 1132 1133 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1130 def infer_snomedct(params = {}, = {}) req = build_request(:infer_snomedct, 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.
1192 1193 1194 1195 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1192 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.
1254 1255 1256 1257 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1254 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 you have submitted.
1317 1318 1319 1320 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1317 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.
1378 1379 1380 1381 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1378 def list_rx_norm_inference_jobs(params = {}, = {}) req = build_request(:list_rx_norm_inference_jobs, params) req.send_request() end |
#list_snomedct_inference_jobs(params = {}) ⇒ Types::ListSNOMEDCTInferenceJobsResponse
Gets a list of InferSNOMEDCT jobs a user has submitted.
1438 1439 1440 1441 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1438 def list_snomedct_inference_jobs(params = {}, = {}) req = build_request(:list_snomedct_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.
1514 1515 1516 1517 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1514 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.
1587 1588 1589 1590 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1587 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.
1660 1661 1662 1663 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1660 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.
1733 1734 1735 1736 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1733 def start_rx_norm_inference_job(params = {}, = {}) req = build_request(:start_rx_norm_inference_job, params) req.send_request() end |
#start_snomedct_inference_job(params = {}) ⇒ Types::StartSNOMEDCTInferenceJobResponse
Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job.
1802 1803 1804 1805 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1802 def start_snomedct_inference_job(params = {}, = {}) req = build_request(:start_snomedct_inference_job, params) req.send_request() end |
#stop_entities_detection_v2_job(params = {}) ⇒ Types::StopEntitiesDetectionV2JobResponse
Stops a medical entities detection job in progress.
1830 1831 1832 1833 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1830 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.
1858 1859 1860 1861 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1858 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.
1886 1887 1888 1889 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1886 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.
1914 1915 1916 1917 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1914 def stop_rx_norm_inference_job(params = {}, = {}) req = build_request(:stop_rx_norm_inference_job, params) req.send_request() end |
#stop_snomedct_inference_job(params = {}) ⇒ Types::StopSNOMEDCTInferenceJobResponse
Stops an InferSNOMEDCT inference job in progress.
1942 1943 1944 1945 |
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1942 def stop_snomedct_inference_job(params = {}, = {}) req = build_request(:stop_snomedct_inference_job, params) req.send_request() end |