aws-sdk-comprehendmedical 1.30.0 → 1.34.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-comprehendmedical/client.rb +337 -40
- data/lib/aws-sdk-comprehendmedical/client_api.rb +180 -0
- data/lib/aws-sdk-comprehendmedical/types.rb +559 -48
- data/lib/aws-sdk-comprehendmedical.rb +1 -1
- metadata +4 -4
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
32
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
33
|
|
@@ -73,6 +74,7 @@ module Aws::ComprehendMedical
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
79
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
80
|
|
@@ -119,7 +121,9 @@ module Aws::ComprehendMedical
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
126
|
+
# to true.
|
123
127
|
#
|
124
128
|
# @option options [required, String] :region
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +177,10 @@ module Aws::ComprehendMedical
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
179
|
#
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
183
|
+
#
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
178
186
|
# to default service endpoint when available.
|
@@ -285,6 +293,15 @@ module Aws::ComprehendMedical
|
|
285
293
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
294
|
# requests are made, and retries are disabled.
|
287
295
|
#
|
296
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
297
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
298
|
+
# will be used if available.
|
299
|
+
#
|
300
|
+
# @option options [Boolean] :use_fips_endpoint
|
301
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
302
|
+
# When a `fips` region is used, the region is normalized and this config
|
303
|
+
# is set to `true`.
|
304
|
+
#
|
288
305
|
# @option options [Boolean] :validate_params (true)
|
289
306
|
# When `true`, request parameters are validated before
|
290
307
|
# sending the request.
|
@@ -296,7 +313,7 @@ module Aws::ComprehendMedical
|
|
296
313
|
# seconds to wait when opening a HTTP session before raising a
|
297
314
|
# `Timeout::Error`.
|
298
315
|
#
|
299
|
-
# @option options [
|
316
|
+
# @option options [Float] :http_read_timeout (60) The default
|
300
317
|
# number of seconds to wait for response data. This value can
|
301
318
|
# safely be set per-request on the session.
|
302
319
|
#
|
@@ -312,6 +329,9 @@ module Aws::ComprehendMedical
|
|
312
329
|
# disables this behaviour. This value can safely be set per
|
313
330
|
# request on the session.
|
314
331
|
#
|
332
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
333
|
+
# in seconds.
|
334
|
+
#
|
315
335
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
316
336
|
# HTTP debug output will be sent to the `:logger`.
|
317
337
|
#
|
@@ -341,9 +361,9 @@ module Aws::ComprehendMedical
|
|
341
361
|
# Use this operation to get the status of a detection job.
|
342
362
|
#
|
343
363
|
# @option params [required, String] :job_id
|
344
|
-
# The identifier that
|
345
|
-
#
|
346
|
-
#
|
364
|
+
# The identifier that Comprehend Medical; generated for the job. The
|
365
|
+
# `StartEntitiesDetectionV2Job` operation returns this identifier in its
|
366
|
+
# response.
|
347
367
|
#
|
348
368
|
# @return [Types::DescribeEntitiesDetectionV2JobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
349
369
|
#
|
@@ -434,8 +454,8 @@ module Aws::ComprehendMedical
|
|
434
454
|
# detection job.
|
435
455
|
#
|
436
456
|
# @option params [required, String] :job_id
|
437
|
-
# The identifier that
|
438
|
-
#
|
457
|
+
# The identifier that Comprehend Medical; generated for the job. The
|
458
|
+
# `StartPHIDetectionJob` operation returns this identifier in its
|
439
459
|
# response.
|
440
460
|
#
|
441
461
|
# @return [Types::DescribePHIDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -522,6 +542,52 @@ module Aws::ComprehendMedical
|
|
522
542
|
req.send_request(options)
|
523
543
|
end
|
524
544
|
|
545
|
+
# Gets the properties associated with an InferSNOMEDCT job. Use this
|
546
|
+
# operation to get the status of an inference job.
|
547
|
+
#
|
548
|
+
# @option params [required, String] :job_id
|
549
|
+
# The identifier that Amazon Comprehend Medical generated for the job.
|
550
|
+
# The StartSNOMEDCTInferenceJob operation returns this identifier in its
|
551
|
+
# response.
|
552
|
+
#
|
553
|
+
# @return [Types::DescribeSNOMEDCTInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
554
|
+
#
|
555
|
+
# * {Types::DescribeSNOMEDCTInferenceJobResponse#comprehend_medical_async_job_properties #comprehend_medical_async_job_properties} => Types::ComprehendMedicalAsyncJobProperties
|
556
|
+
#
|
557
|
+
# @example Request syntax with placeholder values
|
558
|
+
#
|
559
|
+
# resp = client.describe_snomedct_inference_job({
|
560
|
+
# job_id: "JobId", # required
|
561
|
+
# })
|
562
|
+
#
|
563
|
+
# @example Response structure
|
564
|
+
#
|
565
|
+
# resp.comprehend_medical_async_job_properties.job_id #=> String
|
566
|
+
# resp.comprehend_medical_async_job_properties.job_name #=> String
|
567
|
+
# resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
|
568
|
+
# resp.comprehend_medical_async_job_properties.message #=> String
|
569
|
+
# resp.comprehend_medical_async_job_properties.submit_time #=> Time
|
570
|
+
# resp.comprehend_medical_async_job_properties.end_time #=> Time
|
571
|
+
# resp.comprehend_medical_async_job_properties.expiration_time #=> Time
|
572
|
+
# resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
|
573
|
+
# resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
|
574
|
+
# resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
|
575
|
+
# resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
|
576
|
+
# resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
|
577
|
+
# resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
|
578
|
+
# resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
|
579
|
+
# resp.comprehend_medical_async_job_properties.kms_key #=> String
|
580
|
+
# resp.comprehend_medical_async_job_properties.model_version #=> String
|
581
|
+
#
|
582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeSNOMEDCTInferenceJob AWS API Documentation
|
583
|
+
#
|
584
|
+
# @overload describe_snomedct_inference_job(params = {})
|
585
|
+
# @param [Hash] params ({})
|
586
|
+
def describe_snomedct_inference_job(params = {}, options = {})
|
587
|
+
req = build_request(:describe_snomedct_inference_job, params)
|
588
|
+
req.send_request(options)
|
589
|
+
end
|
590
|
+
|
525
591
|
# The `DetectEntities` operation is deprecated. You should use the
|
526
592
|
# DetectEntitiesV2 operation instead.
|
527
593
|
#
|
@@ -556,15 +622,15 @@ module Aws::ComprehendMedical
|
|
556
622
|
# resp.entities[0].score #=> Float
|
557
623
|
# resp.entities[0].text #=> String
|
558
624
|
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
559
|
-
# 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"
|
625
|
+
# resp.entities[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "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"
|
560
626
|
# resp.entities[0].traits #=> Array
|
561
627
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
562
628
|
# resp.entities[0].traits[0].score #=> Float
|
563
629
|
# resp.entities[0].attributes #=> Array
|
564
|
-
# 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"
|
630
|
+
# resp.entities[0].attributes[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "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"
|
565
631
|
# resp.entities[0].attributes[0].score #=> Float
|
566
632
|
# resp.entities[0].attributes[0].relationship_score #=> Float
|
567
|
-
# 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"
|
633
|
+
# 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", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
568
634
|
# resp.entities[0].attributes[0].id #=> Integer
|
569
635
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
570
636
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
@@ -575,10 +641,10 @@ module Aws::ComprehendMedical
|
|
575
641
|
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
576
642
|
# resp.unmapped_attributes #=> Array
|
577
643
|
# resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
578
|
-
# 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"
|
644
|
+
# resp.unmapped_attributes[0].attribute.type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "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"
|
579
645
|
# resp.unmapped_attributes[0].attribute.score #=> Float
|
580
646
|
# resp.unmapped_attributes[0].attribute.relationship_score #=> Float
|
581
|
-
# 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"
|
647
|
+
# 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", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
582
648
|
# resp.unmapped_attributes[0].attribute.id #=> Integer
|
583
649
|
# resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
|
584
650
|
# resp.unmapped_attributes[0].attribute.end_offset #=> Integer
|
@@ -640,15 +706,15 @@ module Aws::ComprehendMedical
|
|
640
706
|
# resp.entities[0].score #=> Float
|
641
707
|
# resp.entities[0].text #=> String
|
642
708
|
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
643
|
-
# 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"
|
709
|
+
# resp.entities[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "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"
|
644
710
|
# resp.entities[0].traits #=> Array
|
645
711
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
646
712
|
# resp.entities[0].traits[0].score #=> Float
|
647
713
|
# resp.entities[0].attributes #=> Array
|
648
|
-
# 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"
|
714
|
+
# resp.entities[0].attributes[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "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"
|
649
715
|
# resp.entities[0].attributes[0].score #=> Float
|
650
716
|
# resp.entities[0].attributes[0].relationship_score #=> Float
|
651
|
-
# 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"
|
717
|
+
# 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", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
652
718
|
# resp.entities[0].attributes[0].id #=> Integer
|
653
719
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
654
720
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
@@ -659,10 +725,10 @@ module Aws::ComprehendMedical
|
|
659
725
|
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
660
726
|
# resp.unmapped_attributes #=> Array
|
661
727
|
# resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
662
|
-
# 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"
|
728
|
+
# resp.unmapped_attributes[0].attribute.type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "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"
|
663
729
|
# resp.unmapped_attributes[0].attribute.score #=> Float
|
664
730
|
# resp.unmapped_attributes[0].attribute.relationship_score #=> Float
|
665
|
-
# 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"
|
731
|
+
# 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", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
666
732
|
# resp.unmapped_attributes[0].attribute.id #=> Integer
|
667
733
|
# resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
|
668
734
|
# resp.unmapped_attributes[0].attribute.end_offset #=> Integer
|
@@ -714,15 +780,15 @@ module Aws::ComprehendMedical
|
|
714
780
|
# resp.entities[0].score #=> Float
|
715
781
|
# resp.entities[0].text #=> String
|
716
782
|
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
717
|
-
# 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"
|
783
|
+
# resp.entities[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "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"
|
718
784
|
# resp.entities[0].traits #=> Array
|
719
785
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
720
786
|
# resp.entities[0].traits[0].score #=> Float
|
721
787
|
# resp.entities[0].attributes #=> Array
|
722
|
-
# 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"
|
788
|
+
# resp.entities[0].attributes[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "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"
|
723
789
|
# resp.entities[0].attributes[0].score #=> Float
|
724
790
|
# resp.entities[0].attributes[0].relationship_score #=> Float
|
725
|
-
# 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"
|
791
|
+
# 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", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
726
792
|
# resp.entities[0].attributes[0].id #=> Integer
|
727
793
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
728
794
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
@@ -868,6 +934,78 @@ module Aws::ComprehendMedical
|
|
868
934
|
req.send_request(options)
|
869
935
|
end
|
870
936
|
|
937
|
+
# InferSNOMEDCT detects possible medical concepts as entities and links
|
938
|
+
# them to codes from the Systematized Nomenclature of Medicine, Clinical
|
939
|
+
# Terms (SNOMED-CT) ontology
|
940
|
+
#
|
941
|
+
# @option params [required, String] :text
|
942
|
+
# The input text to be analyzed using InferSNOMEDCT. The text should be
|
943
|
+
# a string with 1 to 10000 characters.
|
944
|
+
#
|
945
|
+
# @return [Types::InferSNOMEDCTResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
946
|
+
#
|
947
|
+
# * {Types::InferSNOMEDCTResponse#entities #entities} => Array<Types::SNOMEDCTEntity>
|
948
|
+
# * {Types::InferSNOMEDCTResponse#pagination_token #pagination_token} => String
|
949
|
+
# * {Types::InferSNOMEDCTResponse#model_version #model_version} => String
|
950
|
+
# * {Types::InferSNOMEDCTResponse#snomedct_details #snomedct_details} => Types::SNOMEDCTDetails
|
951
|
+
# * {Types::InferSNOMEDCTResponse#characters #characters} => Types::Characters
|
952
|
+
#
|
953
|
+
# @example Request syntax with placeholder values
|
954
|
+
#
|
955
|
+
# resp = client.infer_snomedct({
|
956
|
+
# text: "OntologyLinkingBoundedLengthString", # required
|
957
|
+
# })
|
958
|
+
#
|
959
|
+
# @example Response structure
|
960
|
+
#
|
961
|
+
# resp.entities #=> Array
|
962
|
+
# resp.entities[0].id #=> Integer
|
963
|
+
# resp.entities[0].text #=> String
|
964
|
+
# resp.entities[0].category #=> String, one of "MEDICAL_CONDITION", "ANATOMY", "TEST_TREATMENT_PROCEDURE"
|
965
|
+
# resp.entities[0].type #=> String, one of "DX_NAME", "TEST_NAME", "PROCEDURE_NAME", "TREATMENT_NAME"
|
966
|
+
# resp.entities[0].score #=> Float
|
967
|
+
# resp.entities[0].begin_offset #=> Integer
|
968
|
+
# resp.entities[0].end_offset #=> Integer
|
969
|
+
# resp.entities[0].attributes #=> Array
|
970
|
+
# resp.entities[0].attributes[0].category #=> String, one of "MEDICAL_CONDITION", "ANATOMY", "TEST_TREATMENT_PROCEDURE"
|
971
|
+
# resp.entities[0].attributes[0].type #=> String, one of "ACUITY", "QUALITY", "DIRECTION", "SYSTEM_ORGAN_SITE", "TEST_VALUE", "TEST_UNIT"
|
972
|
+
# resp.entities[0].attributes[0].score #=> Float
|
973
|
+
# resp.entities[0].attributes[0].relationship_score #=> Float
|
974
|
+
# resp.entities[0].attributes[0].relationship_type #=> String, one of "ACUITY", "QUALITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
975
|
+
# resp.entities[0].attributes[0].id #=> Integer
|
976
|
+
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
977
|
+
# resp.entities[0].attributes[0].end_offset #=> Integer
|
978
|
+
# resp.entities[0].attributes[0].text #=> String
|
979
|
+
# resp.entities[0].attributes[0].traits #=> Array
|
980
|
+
# resp.entities[0].attributes[0].traits[0].name #=> String, one of "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM"
|
981
|
+
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
982
|
+
# resp.entities[0].attributes[0].snomedct_concepts #=> Array
|
983
|
+
# resp.entities[0].attributes[0].snomedct_concepts[0].description #=> String
|
984
|
+
# resp.entities[0].attributes[0].snomedct_concepts[0].code #=> String
|
985
|
+
# resp.entities[0].attributes[0].snomedct_concepts[0].score #=> Float
|
986
|
+
# resp.entities[0].traits #=> Array
|
987
|
+
# resp.entities[0].traits[0].name #=> String, one of "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM"
|
988
|
+
# resp.entities[0].traits[0].score #=> Float
|
989
|
+
# resp.entities[0].snomedct_concepts #=> Array
|
990
|
+
# resp.entities[0].snomedct_concepts[0].description #=> String
|
991
|
+
# resp.entities[0].snomedct_concepts[0].code #=> String
|
992
|
+
# resp.entities[0].snomedct_concepts[0].score #=> Float
|
993
|
+
# resp.pagination_token #=> String
|
994
|
+
# resp.model_version #=> String
|
995
|
+
# resp.snomedct_details.edition #=> String
|
996
|
+
# resp.snomedct_details.language #=> String
|
997
|
+
# resp.snomedct_details.version_date #=> String
|
998
|
+
# resp.characters.original_text_characters #=> Integer
|
999
|
+
#
|
1000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferSNOMEDCT AWS API Documentation
|
1001
|
+
#
|
1002
|
+
# @overload infer_snomedct(params = {})
|
1003
|
+
# @param [Hash] params ({})
|
1004
|
+
def infer_snomedct(params = {}, options = {})
|
1005
|
+
req = build_request(:infer_snomedct, params)
|
1006
|
+
req.send_request(options)
|
1007
|
+
end
|
1008
|
+
|
871
1009
|
# Gets a list of medical entity detection jobs that you have submitted.
|
872
1010
|
#
|
873
1011
|
# @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
|
@@ -1116,21 +1254,83 @@ module Aws::ComprehendMedical
|
|
1116
1254
|
req.send_request(options)
|
1117
1255
|
end
|
1118
1256
|
|
1257
|
+
# Gets a list of InferSNOMEDCT jobs a user has submitted.
|
1258
|
+
#
|
1259
|
+
# @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
|
1260
|
+
# Provides information for filtering a list of detection jobs.
|
1261
|
+
#
|
1262
|
+
# @option params [String] :next_token
|
1263
|
+
# Identifies the next page of InferSNOMEDCT results to return.
|
1264
|
+
#
|
1265
|
+
# @option params [Integer] :max_results
|
1266
|
+
# The maximum number of results to return in each page. The default is
|
1267
|
+
# 100.
|
1268
|
+
#
|
1269
|
+
# @return [Types::ListSNOMEDCTInferenceJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1270
|
+
#
|
1271
|
+
# * {Types::ListSNOMEDCTInferenceJobsResponse#comprehend_medical_async_job_properties_list #comprehend_medical_async_job_properties_list} => Array<Types::ComprehendMedicalAsyncJobProperties>
|
1272
|
+
# * {Types::ListSNOMEDCTInferenceJobsResponse#next_token #next_token} => String
|
1273
|
+
#
|
1274
|
+
# @example Request syntax with placeholder values
|
1275
|
+
#
|
1276
|
+
# resp = client.list_snomedct_inference_jobs({
|
1277
|
+
# filter: {
|
1278
|
+
# job_name: "JobName",
|
1279
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
|
1280
|
+
# submit_time_before: Time.now,
|
1281
|
+
# submit_time_after: Time.now,
|
1282
|
+
# },
|
1283
|
+
# next_token: "String",
|
1284
|
+
# max_results: 1,
|
1285
|
+
# })
|
1286
|
+
#
|
1287
|
+
# @example Response structure
|
1288
|
+
#
|
1289
|
+
# resp.comprehend_medical_async_job_properties_list #=> Array
|
1290
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
|
1291
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
|
1292
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1293
|
+
# resp.comprehend_medical_async_job_properties_list[0].message #=> String
|
1294
|
+
# resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
|
1295
|
+
# resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
|
1296
|
+
# resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
|
1297
|
+
# resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
|
1298
|
+
# resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
|
1299
|
+
# resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
|
1300
|
+
# resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
|
1301
|
+
# resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
|
1302
|
+
# resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
|
1303
|
+
# resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
|
1304
|
+
# resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
|
1305
|
+
# resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
|
1306
|
+
# resp.next_token #=> String
|
1307
|
+
#
|
1308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListSNOMEDCTInferenceJobs AWS API Documentation
|
1309
|
+
#
|
1310
|
+
# @overload list_snomedct_inference_jobs(params = {})
|
1311
|
+
# @param [Hash] params ({})
|
1312
|
+
def list_snomedct_inference_jobs(params = {}, options = {})
|
1313
|
+
req = build_request(:list_snomedct_inference_jobs, params)
|
1314
|
+
req.send_request(options)
|
1315
|
+
end
|
1316
|
+
|
1119
1317
|
# Starts an asynchronous medical entity detection job for a collection
|
1120
1318
|
# of documents. Use the `DescribeEntitiesDetectionV2Job` operation to
|
1121
1319
|
# track the status of a job.
|
1122
1320
|
#
|
1123
1321
|
# @option params [required, Types::InputDataConfig] :input_data_config
|
1124
|
-
#
|
1322
|
+
# The input configuration that specifies the format and location of the
|
1323
|
+
# input data for the job.
|
1125
1324
|
#
|
1126
1325
|
# @option params [required, Types::OutputDataConfig] :output_data_config
|
1127
|
-
#
|
1326
|
+
# The output configuration that specifies where to send the output
|
1327
|
+
# files.
|
1128
1328
|
#
|
1129
1329
|
# @option params [required, String] :data_access_role_arn
|
1130
1330
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1131
|
-
# Management (IAM) role that grants
|
1132
|
-
#
|
1133
|
-
#
|
1331
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
1332
|
+
# your input data. For more information, see [ Role-Based Permissions
|
1333
|
+
# Required for Asynchronous Operations][1].
|
1134
1334
|
#
|
1135
1335
|
#
|
1136
1336
|
#
|
@@ -1141,7 +1341,7 @@ module Aws::ComprehendMedical
|
|
1141
1341
|
#
|
1142
1342
|
# @option params [String] :client_request_token
|
1143
1343
|
# A unique identifier for the request. If you don't set the client
|
1144
|
-
# request token,
|
1344
|
+
# request token, Comprehend Medical; generates one for you.
|
1145
1345
|
#
|
1146
1346
|
# **A suitable default value is auto-generated.** You should normally
|
1147
1347
|
# not need to pass this option.**
|
@@ -1152,7 +1352,7 @@ module Aws::ComprehendMedical
|
|
1152
1352
|
#
|
1153
1353
|
# @option params [required, String] :language_code
|
1154
1354
|
# The language of the input documents. All documents must be in the same
|
1155
|
-
# language.
|
1355
|
+
# language. Comprehend Medical; processes files in US English (en).
|
1156
1356
|
#
|
1157
1357
|
# @return [Types::StartEntitiesDetectionV2JobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1158
1358
|
#
|
@@ -1201,9 +1401,9 @@ module Aws::ComprehendMedical
|
|
1201
1401
|
#
|
1202
1402
|
# @option params [required, String] :data_access_role_arn
|
1203
1403
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1204
|
-
# Management (IAM) role that grants
|
1205
|
-
#
|
1206
|
-
#
|
1404
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
1405
|
+
# your input data. For more information, see [ Role-Based Permissions
|
1406
|
+
# Required for Asynchronous Operations][1].
|
1207
1407
|
#
|
1208
1408
|
#
|
1209
1409
|
#
|
@@ -1214,7 +1414,7 @@ module Aws::ComprehendMedical
|
|
1214
1414
|
#
|
1215
1415
|
# @option params [String] :client_request_token
|
1216
1416
|
# A unique identifier for the request. If you don't set the client
|
1217
|
-
# request token,
|
1417
|
+
# request token, Comprehend Medical; generates one.
|
1218
1418
|
#
|
1219
1419
|
# **A suitable default value is auto-generated.** You should normally
|
1220
1420
|
# not need to pass this option.**
|
@@ -1274,9 +1474,9 @@ module Aws::ComprehendMedical
|
|
1274
1474
|
#
|
1275
1475
|
# @option params [required, String] :data_access_role_arn
|
1276
1476
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1277
|
-
# Management (IAM) role that grants
|
1278
|
-
#
|
1279
|
-
#
|
1477
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
1478
|
+
# your input data. For more information, see [ Role-Based Permissions
|
1479
|
+
# Required for Asynchronous Operations][1].
|
1280
1480
|
#
|
1281
1481
|
#
|
1282
1482
|
#
|
@@ -1287,7 +1487,7 @@ module Aws::ComprehendMedical
|
|
1287
1487
|
#
|
1288
1488
|
# @option params [String] :client_request_token
|
1289
1489
|
# A unique identifier for the request. If you don't set the client
|
1290
|
-
# request token,
|
1490
|
+
# request token, Comprehend Medical; generates one.
|
1291
1491
|
#
|
1292
1492
|
# **A suitable default value is auto-generated.** You should normally
|
1293
1493
|
# not need to pass this option.**
|
@@ -1347,9 +1547,9 @@ module Aws::ComprehendMedical
|
|
1347
1547
|
#
|
1348
1548
|
# @option params [required, String] :data_access_role_arn
|
1349
1549
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1350
|
-
# Management (IAM) role that grants
|
1351
|
-
#
|
1352
|
-
#
|
1550
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
1551
|
+
# your input data. For more information, see [ Role-Based Permissions
|
1552
|
+
# Required for Asynchronous Operations][1].
|
1353
1553
|
#
|
1354
1554
|
#
|
1355
1555
|
#
|
@@ -1360,7 +1560,7 @@ module Aws::ComprehendMedical
|
|
1360
1560
|
#
|
1361
1561
|
# @option params [String] :client_request_token
|
1362
1562
|
# A unique identifier for the request. If you don't set the client
|
1363
|
-
# request token,
|
1563
|
+
# request token, Comprehend Medical; generates one.
|
1364
1564
|
#
|
1365
1565
|
# **A suitable default value is auto-generated.** You should normally
|
1366
1566
|
# not need to pass this option.**
|
@@ -1408,6 +1608,75 @@ module Aws::ComprehendMedical
|
|
1408
1608
|
req.send_request(options)
|
1409
1609
|
end
|
1410
1610
|
|
1611
|
+
# Starts an asynchronous job to detect medical concepts and link them to
|
1612
|
+
# the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation
|
1613
|
+
# to track the status of a job.
|
1614
|
+
#
|
1615
|
+
# @option params [required, Types::InputDataConfig] :input_data_config
|
1616
|
+
# The input properties for an entities detection job. This includes the
|
1617
|
+
# name of the S3 bucket and the path to the files to be analyzed.
|
1618
|
+
#
|
1619
|
+
# @option params [required, Types::OutputDataConfig] :output_data_config
|
1620
|
+
# The output properties for a detection job.
|
1621
|
+
#
|
1622
|
+
# @option params [required, String] :data_access_role_arn
|
1623
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1624
|
+
# Management (IAM) role that grants Amazon Comprehend Medical read
|
1625
|
+
# access to your input data.
|
1626
|
+
#
|
1627
|
+
# @option params [String] :job_name
|
1628
|
+
# The user generated name the asynchronous InferSNOMEDCT job.
|
1629
|
+
#
|
1630
|
+
# @option params [String] :client_request_token
|
1631
|
+
# A unique identifier for the request. If you don't set the client
|
1632
|
+
# request token, Amazon Comprehend Medical generates one.
|
1633
|
+
#
|
1634
|
+
# **A suitable default value is auto-generated.** You should normally
|
1635
|
+
# not need to pass this option.**
|
1636
|
+
#
|
1637
|
+
# @option params [String] :kms_key
|
1638
|
+
# An AWS Key Management Service key used to encrypt your output files.
|
1639
|
+
# If you do not specify a key, the files are written in plain text.
|
1640
|
+
#
|
1641
|
+
# @option params [required, String] :language_code
|
1642
|
+
# The language of the input documents. All documents must be in the same
|
1643
|
+
# language.
|
1644
|
+
#
|
1645
|
+
# @return [Types::StartSNOMEDCTInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1646
|
+
#
|
1647
|
+
# * {Types::StartSNOMEDCTInferenceJobResponse#job_id #job_id} => String
|
1648
|
+
#
|
1649
|
+
# @example Request syntax with placeholder values
|
1650
|
+
#
|
1651
|
+
# resp = client.start_snomedct_inference_job({
|
1652
|
+
# input_data_config: { # required
|
1653
|
+
# s3_bucket: "S3Bucket", # required
|
1654
|
+
# s3_key: "S3Key",
|
1655
|
+
# },
|
1656
|
+
# output_data_config: { # required
|
1657
|
+
# s3_bucket: "S3Bucket", # required
|
1658
|
+
# s3_key: "S3Key",
|
1659
|
+
# },
|
1660
|
+
# data_access_role_arn: "IamRoleArn", # required
|
1661
|
+
# job_name: "JobName",
|
1662
|
+
# client_request_token: "ClientRequestTokenString",
|
1663
|
+
# kms_key: "KMSKey",
|
1664
|
+
# language_code: "en", # required, accepts en
|
1665
|
+
# })
|
1666
|
+
#
|
1667
|
+
# @example Response structure
|
1668
|
+
#
|
1669
|
+
# resp.job_id #=> String
|
1670
|
+
#
|
1671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartSNOMEDCTInferenceJob AWS API Documentation
|
1672
|
+
#
|
1673
|
+
# @overload start_snomedct_inference_job(params = {})
|
1674
|
+
# @param [Hash] params ({})
|
1675
|
+
def start_snomedct_inference_job(params = {}, options = {})
|
1676
|
+
req = build_request(:start_snomedct_inference_job, params)
|
1677
|
+
req.send_request(options)
|
1678
|
+
end
|
1679
|
+
|
1411
1680
|
# Stops a medical entities detection job in progress.
|
1412
1681
|
#
|
1413
1682
|
# @option params [required, String] :job_id
|
@@ -1520,6 +1789,34 @@ module Aws::ComprehendMedical
|
|
1520
1789
|
req.send_request(options)
|
1521
1790
|
end
|
1522
1791
|
|
1792
|
+
# Stops an InferSNOMEDCT inference job in progress.
|
1793
|
+
#
|
1794
|
+
# @option params [required, String] :job_id
|
1795
|
+
# The job id of the asynchronous InferSNOMEDCT job to be stopped.
|
1796
|
+
#
|
1797
|
+
# @return [Types::StopSNOMEDCTInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1798
|
+
#
|
1799
|
+
# * {Types::StopSNOMEDCTInferenceJobResponse#job_id #job_id} => String
|
1800
|
+
#
|
1801
|
+
# @example Request syntax with placeholder values
|
1802
|
+
#
|
1803
|
+
# resp = client.stop_snomedct_inference_job({
|
1804
|
+
# job_id: "JobId", # required
|
1805
|
+
# })
|
1806
|
+
#
|
1807
|
+
# @example Response structure
|
1808
|
+
#
|
1809
|
+
# resp.job_id #=> String
|
1810
|
+
#
|
1811
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopSNOMEDCTInferenceJob AWS API Documentation
|
1812
|
+
#
|
1813
|
+
# @overload stop_snomedct_inference_job(params = {})
|
1814
|
+
# @param [Hash] params ({})
|
1815
|
+
def stop_snomedct_inference_job(params = {}, options = {})
|
1816
|
+
req = build_request(:stop_snomedct_inference_job, params)
|
1817
|
+
req.send_request(options)
|
1818
|
+
end
|
1819
|
+
|
1523
1820
|
# @!endgroup
|
1524
1821
|
|
1525
1822
|
# @param params ({})
|
@@ -1533,7 +1830,7 @@ module Aws::ComprehendMedical
|
|
1533
1830
|
params: params,
|
1534
1831
|
config: config)
|
1535
1832
|
context[:gem_name] = 'aws-sdk-comprehendmedical'
|
1536
|
-
context[:gem_version] = '1.
|
1833
|
+
context[:gem_version] = '1.34.0'
|
1537
1834
|
Seahorse::Client::Request.new(handlers, context)
|
1538
1835
|
end
|
1539
1836
|
|