You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ComprehendMedical::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::ComprehendMedical::Client

show all

Defined in:: (unknown)

Overview

An API client for AWS Comprehend Medical. To construct a client, you need to configure a :region and :credentials.

comprehendmedical = Aws::ComprehendMedical::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

ENV['AWS_REGION']
Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
The shared credentials ini file at ~/.aws/credentials (more information)
From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::ComprehendMedical::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::ComprehendMedical::Client constructor
Constructs an API client.

API Operations collapse

#describe_entities_detection_v2_job(options = {}) ⇒ Types::DescribeEntitiesDetectionV2JobResponse
Gets the properties associated with a medical entities detection job.
#describe_icd10cm_inference_job(options = {}) ⇒ Types::DescribeICD10CMInferenceJobResponse
Gets the properties associated with an InferICD10CM job.
#describe_phi_detection_job(options = {}) ⇒ Types::DescribePHIDetectionJobResponse
Gets the properties associated with a protected health information (PHI) detection job.
#describe_rx_norm_inference_job(options = {}) ⇒ Types::DescribeRxNormInferenceJobResponse
Gets the properties associated with an InferRxNorm job.
#detect_entities(options = {}) ⇒ Types::DetectEntitiesResponse
The DetectEntities operation is deprecated.
#detect_entities_v2(options = {}) ⇒ 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(options = {}) ⇒ 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(options = {}) ⇒ 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(options = {}) ⇒ 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(options = {}) ⇒ Types::ListEntitiesDetectionV2JobsResponse
Gets a list of medical entity detection jobs that you have submitted.

.
#list_icd10cm_inference_jobs(options = {}) ⇒ Types::ListICD10CMInferenceJobsResponse
Gets a list of InferICD10CM jobs that you have submitted.

.
#list_phi_detection_jobs(options = {}) ⇒ Types::ListPHIDetectionJobsResponse
Gets a list of protected health information (PHI) detection jobs that you have submitted.

.
#list_rx_norm_inference_jobs(options = {}) ⇒ Types::ListRxNormInferenceJobsResponse
Gets a list of InferRxNorm jobs that you have submitted.

.
#start_entities_detection_v2_job(options = {}) ⇒ Types::StartEntitiesDetectionV2JobResponse
Starts an asynchronous medical entity detection job for a collection of documents.
#start_icd10cm_inference_job(options = {}) ⇒ Types::StartICD10CMInferenceJobResponse
Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology.
#start_phi_detection_job(options = {}) ⇒ Types::StartPHIDetectionJobResponse
Starts an asynchronous job to detect protected health information (PHI).
#start_rx_norm_inference_job(options = {}) ⇒ Types::StartRxNormInferenceJobResponse
Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology.
#stop_entities_detection_v2_job(options = {}) ⇒ Types::StopEntitiesDetectionV2JobResponse
Stops a medical entities detection job in progress.

.
#stop_icd10cm_inference_job(options = {}) ⇒ Types::StopICD10CMInferenceJobResponse
Stops an InferICD10CM inference job in progress.

.
#stop_phi_detection_job(options = {}) ⇒ Types::StopPHIDetectionJobResponse
Stops a protected health information (PHI) detection job in progress.

.
#stop_rx_norm_inference_job(options = {}) ⇒ Types::StopRxNormInferenceJobResponse
Stops an InferRxNorm inference job in progress.

.

Instance Method Summary collapse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ `Aws::ComprehendMedical::Client`

Constructs an API client.

Options Hash (options):

:access_key_id (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:active_endpoint_cache (Boolean) —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.
:credentials (required, Credentials) —
Your AWS credentials. The following locations will be searched in order for credentials:
- :access_key_id, :secret_access_key, and :session_token options
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
- HOME/.aws/credentials shared credentials file
- EC2 instance profile credentials See Plugins::RequestSigner for more details.
:disable_host_prefix_injection (Boolean) —
Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.
:endpoint (String) —
A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.
:endpoint_cache_max_entries (Integer) —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_max_threads (Integer) —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_poll_interval (Integer) —
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.
:endpoint_discovery (Boolean) —
When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.
:http_continue_timeout (Float) — default: 1 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_idle_timeout (Integer) — default: 5 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_open_timeout (Integer) — default: 15 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_proxy (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_read_timeout (Integer) — default: 60 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_wire_trace (Boolean) — default: false —
See Seahorse::Client::Plugins::NetHttp for more details.
:log_level (Symbol) — default: :info —
The log level to send messages to the logger at. See Plugins::Logging for more details.
:log_formatter (Logging::LogFormatter) —
The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.
:logger (Logger) — default: nil —
The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.
:profile (String) —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.
:raise_response_errors (Boolean) — default: true —
When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.
:region (required, String) —
The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.
:retry_limit (Integer) — default: 3 —
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.
:secret_access_key (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:session_token (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:simple_json (Boolean) — default: false —
Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.
:ssl_ca_bundle (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_directory (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_store (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_verify_peer (Boolean) — default: true —
See Seahorse::Client::Plugins::NetHttp for more details.
:stub_responses (Boolean) — default: false —
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.
:validate_params (Boolean) — default: true —
When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#describe_entities_detection_v2_job(options = {}) ⇒ `Types::DescribeEntitiesDetectionV2JobResponse`

Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_entities_detection_v2_job({
  job_id: "JobId", # required
})

Response structure


resp.comprehend_medical_async_job_properties.job_id #=> String
resp.comprehend_medical_async_job_properties.job_name #=> String
resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties.message #=> String
resp.comprehend_medical_async_job_properties.submit_time #=> Time
resp.comprehend_medical_async_job_properties.end_time #=> Time
resp.comprehend_medical_async_job_properties.expiration_time #=> Time
resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
resp.comprehend_medical_async_job_properties.kms_key #=> String
resp.comprehend_medical_async_job_properties.model_version #=> String

Options Hash (options):

:job_id (required, String) —
The identifier that Amazon Comprehend Medical generated for the job. The StartEntitiesDetectionV2Job operation returns this identifier in its response.

Returns:

(Types::DescribeEntitiesDetectionV2JobResponse) —
Returns a response object which responds to the following methods:
- #comprehend_medical_async_job_properties => Types::ComprehendMedicalAsyncJobProperties

See Also:

AWS API Documentation

#describe_icd10cm_inference_job(options = {}) ⇒ `Types::DescribeICD10CMInferenceJobResponse`

Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.

Examples:

Request syntax with placeholder values


resp = client.describe_icd10cm_inference_job({
  job_id: "JobId", # required
})

Response structure


resp.comprehend_medical_async_job_properties.job_id #=> String
resp.comprehend_medical_async_job_properties.job_name #=> String
resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties.message #=> String
resp.comprehend_medical_async_job_properties.submit_time #=> Time
resp.comprehend_medical_async_job_properties.end_time #=> Time
resp.comprehend_medical_async_job_properties.expiration_time #=> Time
resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
resp.comprehend_medical_async_job_properties.kms_key #=> String
resp.comprehend_medical_async_job_properties.model_version #=> String

Options Hash (options):

:job_id (required, String) —
The identifier that Amazon Comprehend Medical generated for the job. The StartICD10CMInferenceJob operation returns this identifier in its response.

Returns:

(Types::DescribeICD10CMInferenceJobResponse) —
Returns a response object which responds to the following methods:
- #comprehend_medical_async_job_properties => Types::ComprehendMedicalAsyncJobProperties

See Also:

AWS API Documentation

#describe_phi_detection_job(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.describe_phi_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.comprehend_medical_async_job_properties.job_id #=> String
resp.comprehend_medical_async_job_properties.job_name #=> String
resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties.message #=> String
resp.comprehend_medical_async_job_properties.submit_time #=> Time
resp.comprehend_medical_async_job_properties.end_time #=> Time
resp.comprehend_medical_async_job_properties.expiration_time #=> Time
resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
resp.comprehend_medical_async_job_properties.kms_key #=> String
resp.comprehend_medical_async_job_properties.model_version #=> String

Options Hash (options):

:job_id (required, String) —
The identifier that Amazon Comprehend Medical generated for the job. The StartPHIDetectionJob operation returns this identifier in its response.

Returns:

(Types::DescribePHIDetectionJobResponse) —
Returns a response object which responds to the following methods:
- #comprehend_medical_async_job_properties => Types::ComprehendMedicalAsyncJobProperties

See Also:

AWS API Documentation

#describe_rx_norm_inference_job(options = {}) ⇒ `Types::DescribeRxNormInferenceJobResponse`

Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.

Examples:

Request syntax with placeholder values


resp = client.describe_rx_norm_inference_job({
  job_id: "JobId", # required
})

Response structure


resp.comprehend_medical_async_job_properties.job_id #=> String
resp.comprehend_medical_async_job_properties.job_name #=> String
resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties.message #=> String
resp.comprehend_medical_async_job_properties.submit_time #=> Time
resp.comprehend_medical_async_job_properties.end_time #=> Time
resp.comprehend_medical_async_job_properties.expiration_time #=> Time
resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
resp.comprehend_medical_async_job_properties.kms_key #=> String
resp.comprehend_medical_async_job_properties.model_version #=> String

Options Hash (options):

:job_id (required, String) —
The identifier that Amazon Comprehend Medical generated for the job. The StartRxNormInferenceJob operation returns this identifier in its response.

Returns:

(Types::DescribeRxNormInferenceJobResponse) —
Returns a response object which responds to the following methods:
- #comprehend_medical_async_job_properties => Types::ComprehendMedicalAsyncJobProperties

See Also:

AWS API Documentation

#detect_entities(options = {}) ⇒ `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 .

Examples:

Request syntax with placeholder values


resp = client.detect_entities({
  text: "BoundedLengthString", # required
})

Response structure


resp.entities #=> Array
resp.entities[0].id #=> Integer
resp.entities[0].begin_offset #=> Integer
resp.entities[0].end_offset #=> Integer
resp.entities[0].score #=> Float
resp.entities[0].text #=> String
resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
resp.entities[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
resp.entities[0].traits #=> Array
resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
resp.entities[0].traits[0].score #=> Float
resp.entities[0].attributes #=> Array
resp.entities[0].attributes[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
resp.entities[0].attributes[0].score #=> Float
resp.entities[0].attributes[0].relationship_score #=> Float
resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE"
resp.entities[0].attributes[0].id #=> Integer
resp.entities[0].attributes[0].begin_offset #=> Integer
resp.entities[0].attributes[0].end_offset #=> Integer
resp.entities[0].attributes[0].text #=> String
resp.entities[0].attributes[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
resp.entities[0].attributes[0].traits #=> Array
resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
resp.entities[0].attributes[0].traits[0].score #=> Float
resp.unmapped_attributes #=> Array
resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
resp.unmapped_attributes[0].attribute.type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
resp.unmapped_attributes[0].attribute.score #=> Float
resp.unmapped_attributes[0].attribute.relationship_score #=> Float
resp.unmapped_attributes[0].attribute.relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE"
resp.unmapped_attributes[0].attribute.id #=> Integer
resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
resp.unmapped_attributes[0].attribute.end_offset #=> Integer
resp.unmapped_attributes[0].attribute.text #=> String
resp.unmapped_attributes[0].attribute.category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
resp.unmapped_attributes[0].attribute.traits #=> Array
resp.unmapped_attributes[0].attribute.traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
resp.unmapped_attributes[0].attribute.traits[0].score #=> Float
resp.pagination_token #=> String
resp.model_version #=> String

Options Hash (options):

:text (required, String) —
A UTF-8 text string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.

Returns:

(Types::DetectEntitiesResponse) —
Returns a response object which responds to the following methods:
- #entities => Array<Types::Entity>
- #unmapped_attributes => Array<Types::UnmappedAttribute>
- #pagination_token => String
- #model_version => String

See Also:

AWS API Documentation

#detect_entities_v2(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.detect_entities_v2({
  text: "BoundedLengthString", # required
})

Response structure


resp.entities #=> Array
resp.entities[0].id #=> Integer
resp.entities[0].begin_offset #=> Integer
resp.entities[0].end_offset #=> Integer
resp.entities[0].score #=> Float
resp.entities[0].text #=> String
resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
resp.entities[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
resp.entities[0].traits #=> Array
resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
resp.entities[0].traits[0].score #=> Float
resp.entities[0].attributes #=> Array
resp.entities[0].attributes[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
resp.entities[0].attributes[0].score #=> Float
resp.entities[0].attributes[0].relationship_score #=> Float
resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE"
resp.entities[0].attributes[0].id #=> Integer
resp.entities[0].attributes[0].begin_offset #=> Integer
resp.entities[0].attributes[0].end_offset #=> Integer
resp.entities[0].attributes[0].text #=> String
resp.entities[0].attributes[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
resp.entities[0].attributes[0].traits #=> Array
resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
resp.entities[0].attributes[0].traits[0].score #=> Float
resp.unmapped_attributes #=> Array
resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
resp.unmapped_attributes[0].attribute.type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
resp.unmapped_attributes[0].attribute.score #=> Float
resp.unmapped_attributes[0].attribute.relationship_score #=> Float
resp.unmapped_attributes[0].attribute.relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE"
resp.unmapped_attributes[0].attribute.id #=> Integer
resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
resp.unmapped_attributes[0].attribute.end_offset #=> Integer
resp.unmapped_attributes[0].attribute.text #=> String
resp.unmapped_attributes[0].attribute.category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
resp.unmapped_attributes[0].attribute.traits #=> Array
resp.unmapped_attributes[0].attribute.traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
resp.unmapped_attributes[0].attribute.traits[0].score #=> Float
resp.pagination_token #=> String
resp.model_version #=> String

Options Hash (options):

:text (required, String) —
A UTF-8 string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.

Returns:

(Types::DetectEntitiesV2Response) —
Returns a response object which responds to the following methods:
- #entities => Array<Types::Entity>
- #unmapped_attributes => Array<Types::UnmappedAttribute>
- #pagination_token => String
- #model_version => String

See Also:

AWS API Documentation

#detect_phi(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.detect_phi({
  text: "BoundedLengthString", # required
})

Response structure


resp.entities #=> Array
resp.entities[0].id #=> Integer
resp.entities[0].begin_offset #=> Integer
resp.entities[0].end_offset #=> Integer
resp.entities[0].score #=> Float
resp.entities[0].text #=> String
resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
resp.entities[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
resp.entities[0].traits #=> Array
resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
resp.entities[0].traits[0].score #=> Float
resp.entities[0].attributes #=> Array
resp.entities[0].attributes[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
resp.entities[0].attributes[0].score #=> Float
resp.entities[0].attributes[0].relationship_score #=> Float
resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE"
resp.entities[0].attributes[0].id #=> Integer
resp.entities[0].attributes[0].begin_offset #=> Integer
resp.entities[0].attributes[0].end_offset #=> Integer
resp.entities[0].attributes[0].text #=> String
resp.entities[0].attributes[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
resp.entities[0].attributes[0].traits #=> Array
resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
resp.entities[0].attributes[0].traits[0].score #=> Float
resp.pagination_token #=> String
resp.model_version #=> String

Options Hash (options):

:text (required, String) —
A UTF-8 text string containing the clinical content being examined for PHI entities. Each string must contain fewer than 20,000 bytes of characters.

Returns:

(Types::DetectPHIResponse) —
Returns a response object which responds to the following methods:
- #entities => Array<Types::Entity>
- #pagination_token => String
- #model_version => String

See Also:

AWS API Documentation

#infer_icd10cm(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.infer_icd10cm({
  text: "OntologyLinkingBoundedLengthString", # required
})

Response structure


resp.entities #=> Array
resp.entities[0].id #=> Integer
resp.entities[0].text #=> String
resp.entities[0].category #=> String, one of "MEDICAL_CONDITION"
resp.entities[0].type #=> String, one of "DX_NAME"
resp.entities[0].score #=> Float
resp.entities[0].begin_offset #=> Integer
resp.entities[0].end_offset #=> Integer
resp.entities[0].attributes #=> Array
resp.entities[0].attributes[0].type #=> String, one of "ACUITY", "DIRECTION", "SYSTEM_ORGAN_SITE", "QUALITY", "QUANTITY"
resp.entities[0].attributes[0].score #=> Float
resp.entities[0].attributes[0].relationship_score #=> Float
resp.entities[0].attributes[0].id #=> Integer
resp.entities[0].attributes[0].begin_offset #=> Integer
resp.entities[0].attributes[0].end_offset #=> Integer
resp.entities[0].attributes[0].text #=> String
resp.entities[0].attributes[0].traits #=> Array
resp.entities[0].attributes[0].traits[0].name #=> String, one of "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM"
resp.entities[0].attributes[0].traits[0].score #=> Float
resp.entities[0].traits #=> Array
resp.entities[0].traits[0].name #=> String, one of "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM"
resp.entities[0].traits[0].score #=> Float
resp.entities[0].icd10cm_concepts #=> Array
resp.entities[0].icd10cm_concepts[0].description #=> String
resp.entities[0].icd10cm_concepts[0].code #=> String
resp.entities[0].icd10cm_concepts[0].score #=> Float
resp.pagination_token #=> String
resp.model_version #=> String

Options Hash (options):

:text (required, String) —
The input text used for analysis. The input for InferICD10CM is a string from 1 to 10000 characters.

Returns:

(Types::InferICD10CMResponse) —
Returns a response object which responds to the following methods:
- #entities => Array<Types::ICD10CMEntity>
- #pagination_token => String
- #model_version => String

See Also:

AWS API Documentation

#infer_rx_norm(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.infer_rx_norm({
  text: "OntologyLinkingBoundedLengthString", # required
})

Response structure


resp.entities #=> Array
resp.entities[0].id #=> Integer
resp.entities[0].text #=> String
resp.entities[0].category #=> String, one of "MEDICATION"
resp.entities[0].type #=> String, one of "BRAND_NAME", "GENERIC_NAME"
resp.entities[0].score #=> Float
resp.entities[0].begin_offset #=> Integer
resp.entities[0].end_offset #=> Integer
resp.entities[0].attributes #=> Array
resp.entities[0].attributes[0].type #=> String, one of "DOSAGE", "DURATION", "FORM", "FREQUENCY", "RATE", "ROUTE_OR_MODE", "STRENGTH"
resp.entities[0].attributes[0].score #=> Float
resp.entities[0].attributes[0].relationship_score #=> Float
resp.entities[0].attributes[0].id #=> Integer
resp.entities[0].attributes[0].begin_offset #=> Integer
resp.entities[0].attributes[0].end_offset #=> Integer
resp.entities[0].attributes[0].text #=> String
resp.entities[0].attributes[0].traits #=> Array
resp.entities[0].attributes[0].traits[0].name #=> String, one of "NEGATION"
resp.entities[0].attributes[0].traits[0].score #=> Float
resp.entities[0].traits #=> Array
resp.entities[0].traits[0].name #=> String, one of "NEGATION"
resp.entities[0].traits[0].score #=> Float
resp.entities[0].rx_norm_concepts #=> Array
resp.entities[0].rx_norm_concepts[0].description #=> String
resp.entities[0].rx_norm_concepts[0].code #=> String
resp.entities[0].rx_norm_concepts[0].score #=> Float
resp.pagination_token #=> String
resp.model_version #=> String

Options Hash (options):

:text (required, String) —
The input text used for analysis. The input for InferRxNorm is a string from 1 to 10000 characters.

Returns:

(Types::InferRxNormResponse) —
Returns a response object which responds to the following methods:
- #entities => Array<Types::RxNormEntity>
- #pagination_token => String
- #model_version => String

See Also:

AWS API Documentation

#list_entities_detection_v2_jobs(options = {}) ⇒ `Types::ListEntitiesDetectionV2JobsResponse`

Gets a list of medical entity detection jobs that you have submitted.

Examples:

Request syntax with placeholder values


resp = client.list_entities_detection_v2_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.comprehend_medical_async_job_properties_list #=> Array
resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties_list[0].message #=> String
resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
resp.next_token #=> String

Options Hash (options):

:filter (Types::ComprehendMedicalAsyncJobFilter) —
Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.
:next_token (String) —
Identifies the next page of results to return.
:max_results (Integer) —
The maximum number of results to return in each page. The default is 100.

Returns:

(Types::ListEntitiesDetectionV2JobsResponse) —
Returns a response object which responds to the following methods:
- #comprehend_medical_async_job_properties_list => Array<Types::ComprehendMedicalAsyncJobProperties>
- #next_token => String

See Also:

AWS API Documentation

#list_icd10cm_inference_jobs(options = {}) ⇒ `Types::ListICD10CMInferenceJobsResponse`

Gets a list of InferICD10CM jobs that you have submitted.

Examples:

Request syntax with placeholder values


resp = client.list_icd10cm_inference_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.comprehend_medical_async_job_properties_list #=> Array
resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties_list[0].message #=> String
resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
resp.next_token #=> String

Options Hash (options):

:filter (Types::ComprehendMedicalAsyncJobFilter) —
Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.
:next_token (String) —
Identifies the next page of results to return.
:max_results (Integer) —
The maximum number of results to return in each page. The default is 100.

Returns:

(Types::ListICD10CMInferenceJobsResponse) —
Returns a response object which responds to the following methods:
- #comprehend_medical_async_job_properties_list => Array<Types::ComprehendMedicalAsyncJobProperties>
- #next_token => String

See Also:

AWS API Documentation

#list_phi_detection_jobs(options = {}) ⇒ `Types::ListPHIDetectionJobsResponse`

Gets a list of protected health information (PHI) detection jobs that you have submitted.

Examples:

Request syntax with placeholder values


resp = client.list_phi_detection_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.comprehend_medical_async_job_properties_list #=> Array
resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties_list[0].message #=> String
resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
resp.next_token #=> String

Options Hash (options):

:filter (Types::ComprehendMedicalAsyncJobFilter) —
Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.
:next_token (String) —
Identifies the next page of results to return.
:max_results (Integer) —
The maximum number of results to return in each page. The default is 100.

Returns:

(Types::ListPHIDetectionJobsResponse) —
Returns a response object which responds to the following methods:
- #comprehend_medical_async_job_properties_list => Array<Types::ComprehendMedicalAsyncJobProperties>
- #next_token => String

See Also:

AWS API Documentation

#list_rx_norm_inference_jobs(options = {}) ⇒ `Types::ListRxNormInferenceJobsResponse`

Gets a list of InferRxNorm jobs that you have submitted.

Examples:

Request syntax with placeholder values


resp = client.list_rx_norm_inference_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.comprehend_medical_async_job_properties_list #=> Array
resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties_list[0].message #=> String
resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
resp.next_token #=> String

Options Hash (options):

:filter (Types::ComprehendMedicalAsyncJobFilter) —
Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.
:next_token (String) —
Identifies the next page of results to return.
:max_results (Integer) —
Identifies the next page of results to return.

Returns:

(Types::ListRxNormInferenceJobsResponse) —
Returns a response object which responds to the following methods:
- #comprehend_medical_async_job_properties_list => Array<Types::ComprehendMedicalAsyncJobProperties>
- #next_token => String

See Also:

AWS API Documentation

#start_entities_detection_v2_job(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.start_entities_detection_v2_job({
  input_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  output_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  client_request_token: "ClientRequestTokenString",
  kms_key: "KMSKey",
  language_code: "en", # required, accepts en
})

Response structure


resp.job_id #=> String

Options Hash (options):

:input_data_config (required, Types::InputDataConfig) —
Specifies the format and location of the input data for the job.
:output_data_config (required, Types::OutputDataConfig) —
Specifies where to send the output files.
:data_access_role_arn (required, String) —
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
:job_name (String) —
The identifier of the job.
:client_request_token (String) —
This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A unique identifier for the request. If you don\'t set the client request token, Amazon Comprehend Medical generates one.
:kms_key (String) —
An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.
:language_code (required, String) —
The language of the input documents. All documents must be in the same language.

Returns:

(Types::StartEntitiesDetectionV2JobResponse) —
Returns a response object which responds to the following methods:
- #job_id => String

See Also:

AWS API Documentation

#start_icd10cm_inference_job(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.start_icd10cm_inference_job({
  input_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  output_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  client_request_token: "ClientRequestTokenString",
  kms_key: "KMSKey",
  language_code: "en", # required, accepts en
})

Response structure


resp.job_id #=> String

Options Hash (options):

:input_data_config (required, Types::InputDataConfig) —
Specifies the format and location of the input data for the job.
:output_data_config (required, Types::OutputDataConfig) —
Specifies where to send the output files.
:data_access_role_arn (required, String) —
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
:job_name (String) —
The identifier of the job.
:client_request_token (String) —
This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A unique identifier for the request. If you don\'t set the client request token, Amazon Comprehend Medical generates one.
:kms_key (String) —
An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.
:language_code (required, String) —
The language of the input documents. All documents must be in the same language.

Returns:

(Types::StartICD10CMInferenceJobResponse) —
Returns a response object which responds to the following methods:
- #job_id => String

See Also:

AWS API Documentation

#start_phi_detection_job(options = {}) ⇒ `Types::StartPHIDetectionJobResponse`

Starts an asynchronous job to detect protected health information (PHI). Use the DescribePHIDetectionJob operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_phi_detection_job({
  input_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  output_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  client_request_token: "ClientRequestTokenString",
  kms_key: "KMSKey",
  language_code: "en", # required, accepts en
})

Response structure


resp.job_id #=> String

Options Hash (options):

:input_data_config (required, Types::InputDataConfig) —
Specifies the format and location of the input data for the job.
:output_data_config (required, Types::OutputDataConfig) —
Specifies where to send the output files.
:data_access_role_arn (required, String) —
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
:job_name (String) —
The identifier of the job.
:client_request_token (String) —
This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A unique identifier for the request. If you don\'t set the client request token, Amazon Comprehend Medical generates one.
:kms_key (String) —
An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.
:language_code (required, String) —
The language of the input documents. All documents must be in the same language.

Returns:

(Types::StartPHIDetectionJobResponse) —
Returns a response object which responds to the following methods:
- #job_id => String

See Also:

AWS API Documentation

#start_rx_norm_inference_job(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.start_rx_norm_inference_job({
  input_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  output_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  client_request_token: "ClientRequestTokenString",
  kms_key: "KMSKey",
  language_code: "en", # required, accepts en
})

Response structure


resp.job_id #=> String

Options Hash (options):

:input_data_config (required, Types::InputDataConfig) —
Specifies the format and location of the input data for the job.
:output_data_config (required, Types::OutputDataConfig) —
Specifies where to send the output files.
:data_access_role_arn (required, String) —
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
:job_name (String) —
The identifier of the job.
:client_request_token (String) —
This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A unique identifier for the request. If you don\'t set the client request token, Amazon Comprehend Medical generates one.
:kms_key (String) —
An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.
:language_code (required, String) —
The language of the input documents. All documents must be in the same language.

Returns:

(Types::StartRxNormInferenceJobResponse) —
Returns a response object which responds to the following methods:
- #job_id => String

See Also:

AWS API Documentation

#stop_entities_detection_v2_job(options = {}) ⇒ `Types::StopEntitiesDetectionV2JobResponse`

Stops a medical entities detection job in progress.

Examples:

Request syntax with placeholder values


resp = client.stop_entities_detection_v2_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String

Options Hash (options):

:job_id (required, String) —
The identifier of the medical entities job to stop.

Returns:

(Types::StopEntitiesDetectionV2JobResponse) —
Returns a response object which responds to the following methods:
- #job_id => String

See Also:

AWS API Documentation

#stop_icd10cm_inference_job(options = {}) ⇒ `Types::StopICD10CMInferenceJobResponse`

Stops an InferICD10CM inference job in progress.

Examples:

Request syntax with placeholder values


resp = client.stop_icd10cm_inference_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String

Options Hash (options):

:job_id (required, String) —
The identifier of the job.

Returns:

(Types::StopICD10CMInferenceJobResponse) —
Returns a response object which responds to the following methods:
- #job_id => String

See Also:

AWS API Documentation

#stop_phi_detection_job(options = {}) ⇒ `Types::StopPHIDetectionJobResponse`

Stops a protected health information (PHI) detection job in progress.

Examples:

Request syntax with placeholder values


resp = client.stop_phi_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String

Options Hash (options):

:job_id (required, String) —
The identifier of the PHI detection job to stop.

Returns:

(Types::StopPHIDetectionJobResponse) —
Returns a response object which responds to the following methods:
- #job_id => String

See Also:

AWS API Documentation

#stop_rx_norm_inference_job(options = {}) ⇒ `Types::StopRxNormInferenceJobResponse`

Stops an InferRxNorm inference job in progress.

Examples:

Request syntax with placeholder values


resp = client.stop_rx_norm_inference_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String

Options Hash (options):

:job_id (required, String) —
The identifier of the job.

Returns:

(Types::StopRxNormInferenceJobResponse) —
Returns a response object which responds to the following methods:
- #job_id => String

See Also:

AWS API Documentation

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

waiter_name (Symbol) —
The name of the waiter. See #waiter_names for a full list of supported waiters.
params (Hash) (defaults to: {}) —
Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

waiter (Waiters::Waiter) —
Yields a Waiter object that can be configured prior to waiting.

Returns:

(Boolean) —
Returns true if the waiter was successful.

Raises:

(Errors::FailureStateError) —
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.
(Errors::TooManyAttemptsError) —
Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.
(Errors::UnexpectedError) —
Raised when an error is encounted while polling for a resource that is not expected.
(Errors::NoSuchWaiterError) —
Raised when you request to wait for an unknown state.

#waiter_names ⇒ `Array<Symbol>`

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter Name	Client Method	Default Delay:	Default Max Attempts:

Returns:

(Array<Symbol>) —
the list of supported waiters.

Class: Aws::ComprehendMedical::Client

Overview

Region

Credentials

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options = {}) ⇒ Aws::ComprehendMedical::Client

Instance Method Details

#describe_entities_detection_v2_job(options = {}) ⇒ Types::DescribeEntitiesDetectionV2JobResponse

#describe_icd10cm_inference_job(options = {}) ⇒ Types::DescribeICD10CMInferenceJobResponse

#describe_phi_detection_job(options = {}) ⇒ Types::DescribePHIDetectionJobResponse

#describe_rx_norm_inference_job(options = {}) ⇒ Types::DescribeRxNormInferenceJobResponse

#detect_entities(options = {}) ⇒ Types::DetectEntitiesResponse

#detect_entities_v2(options = {}) ⇒ Types::DetectEntitiesV2Response

#detect_phi(options = {}) ⇒ Types::DetectPHIResponse

#infer_icd10cm(options = {}) ⇒ Types::InferICD10CMResponse

#infer_rx_norm(options = {}) ⇒ Types::InferRxNormResponse

#list_entities_detection_v2_jobs(options = {}) ⇒ Types::ListEntitiesDetectionV2JobsResponse

#list_icd10cm_inference_jobs(options = {}) ⇒ Types::ListICD10CMInferenceJobsResponse

#list_phi_detection_jobs(options = {}) ⇒ Types::ListPHIDetectionJobsResponse

#list_rx_norm_inference_jobs(options = {}) ⇒ Types::ListRxNormInferenceJobsResponse

#start_entities_detection_v2_job(options = {}) ⇒ Types::StartEntitiesDetectionV2JobResponse

#start_icd10cm_inference_job(options = {}) ⇒ Types::StartICD10CMInferenceJobResponse

#start_phi_detection_job(options = {}) ⇒ Types::StartPHIDetectionJobResponse

#start_rx_norm_inference_job(options = {}) ⇒ Types::StartRxNormInferenceJobResponse

#stop_entities_detection_v2_job(options = {}) ⇒ Types::StopEntitiesDetectionV2JobResponse

#stop_icd10cm_inference_job(options = {}) ⇒ Types::StopICD10CMInferenceJobResponse

#stop_phi_detection_job(options = {}) ⇒ Types::StopPHIDetectionJobResponse

#stop_rx_norm_inference_job(options = {}) ⇒ Types::StopRxNormInferenceJobResponse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Basic Usage

Configuration

Callbacks

Handling Errors

#waiter_names ⇒ Array<Symbol>

#initialize(options = {}) ⇒ `Aws::ComprehendMedical::Client`

#describe_entities_detection_v2_job(options = {}) ⇒ `Types::DescribeEntitiesDetectionV2JobResponse`

#describe_icd10cm_inference_job(options = {}) ⇒ `Types::DescribeICD10CMInferenceJobResponse`

#describe_phi_detection_job(options = {}) ⇒ `Types::DescribePHIDetectionJobResponse`

#describe_rx_norm_inference_job(options = {}) ⇒ `Types::DescribeRxNormInferenceJobResponse`

#detect_entities(options = {}) ⇒ `Types::DetectEntitiesResponse`

#detect_entities_v2(options = {}) ⇒ `Types::DetectEntitiesV2Response`

#detect_phi(options = {}) ⇒ `Types::DetectPHIResponse`

#infer_icd10cm(options = {}) ⇒ `Types::InferICD10CMResponse`

#infer_rx_norm(options = {}) ⇒ `Types::InferRxNormResponse`

#list_entities_detection_v2_jobs(options = {}) ⇒ `Types::ListEntitiesDetectionV2JobsResponse`

#list_icd10cm_inference_jobs(options = {}) ⇒ `Types::ListICD10CMInferenceJobsResponse`

#list_phi_detection_jobs(options = {}) ⇒ `Types::ListPHIDetectionJobsResponse`

#list_rx_norm_inference_jobs(options = {}) ⇒ `Types::ListRxNormInferenceJobsResponse`

#start_entities_detection_v2_job(options = {}) ⇒ `Types::StartEntitiesDetectionV2JobResponse`

#start_icd10cm_inference_job(options = {}) ⇒ `Types::StartICD10CMInferenceJobResponse`

#start_phi_detection_job(options = {}) ⇒ `Types::StartPHIDetectionJobResponse`

#start_rx_norm_inference_job(options = {}) ⇒ `Types::StartRxNormInferenceJobResponse`

#stop_entities_detection_v2_job(options = {}) ⇒ `Types::StopEntitiesDetectionV2JobResponse`

#stop_icd10cm_inference_job(options = {}) ⇒ `Types::StopICD10CMInferenceJobResponse`

#stop_phi_detection_job(options = {}) ⇒ `Types::StopPHIDetectionJobResponse`

#stop_rx_norm_inference_job(options = {}) ⇒ `Types::StopRxNormInferenceJobResponse`

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

#waiter_names ⇒ `Array<Symbol>`