aws-sdk-comprehendmedical 1.29.0 → 1.33.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 +327 -39
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4f0fd500494bd0422d40d91f749c3f29cea8b67c2462c593211be9f8514644ab
|
4
|
+
data.tar.gz: 9c264ad83af552ae456adee2ee84db5d3d8522a5d276a054363194e907c4578e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6352ea321f49428bf9f7f8934f60993d4cc51f0d752892554bb8c4739755dc350ddbbb33633a32455db10989ce2388b3f2a4940c9d769bed92e186325d1a3443
|
7
|
+
data.tar.gz: 0e74d6cc2966fced58d3893fef80d09aa991e022f3f529abe74214422508c42032978a056d932630f97895325c079ed866e04eefac09f9be9d77d88db60ef4ae
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.33.0 (2021-12-08)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds a new set of APIs (synchronous and batch) to support the SNOMED-CT ontology.
|
8
|
+
|
9
|
+
1.32.0 (2021-11-30)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.31.0 (2021-11-04)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.30.0 (2021-10-18)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.29.0 (2021-09-01)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.33.0
|
@@ -119,7 +119,9 @@ module Aws::ComprehendMedical
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
124
|
+
# to true.
|
123
125
|
#
|
124
126
|
# @option options [required, String] :region
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -285,6 +287,15 @@ module Aws::ComprehendMedical
|
|
285
287
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
288
|
# requests are made, and retries are disabled.
|
287
289
|
#
|
290
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
291
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
292
|
+
# will be used if available.
|
293
|
+
#
|
294
|
+
# @option options [Boolean] :use_fips_endpoint
|
295
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
296
|
+
# When a `fips` region is used, the region is normalized and this config
|
297
|
+
# is set to `true`.
|
298
|
+
#
|
288
299
|
# @option options [Boolean] :validate_params (true)
|
289
300
|
# When `true`, request parameters are validated before
|
290
301
|
# sending the request.
|
@@ -341,9 +352,9 @@ module Aws::ComprehendMedical
|
|
341
352
|
# Use this operation to get the status of a detection job.
|
342
353
|
#
|
343
354
|
# @option params [required, String] :job_id
|
344
|
-
# The identifier that
|
345
|
-
#
|
346
|
-
#
|
355
|
+
# The identifier that Comprehend Medical; generated for the job. The
|
356
|
+
# `StartEntitiesDetectionV2Job` operation returns this identifier in its
|
357
|
+
# response.
|
347
358
|
#
|
348
359
|
# @return [Types::DescribeEntitiesDetectionV2JobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
349
360
|
#
|
@@ -434,8 +445,8 @@ module Aws::ComprehendMedical
|
|
434
445
|
# detection job.
|
435
446
|
#
|
436
447
|
# @option params [required, String] :job_id
|
437
|
-
# The identifier that
|
438
|
-
#
|
448
|
+
# The identifier that Comprehend Medical; generated for the job. The
|
449
|
+
# `StartPHIDetectionJob` operation returns this identifier in its
|
439
450
|
# response.
|
440
451
|
#
|
441
452
|
# @return [Types::DescribePHIDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -522,6 +533,52 @@ module Aws::ComprehendMedical
|
|
522
533
|
req.send_request(options)
|
523
534
|
end
|
524
535
|
|
536
|
+
# Gets the properties associated with an InferSNOMEDCT job. Use this
|
537
|
+
# operation to get the status of an inference job.
|
538
|
+
#
|
539
|
+
# @option params [required, String] :job_id
|
540
|
+
# The identifier that Amazon Comprehend Medical generated for the job.
|
541
|
+
# The StartSNOMEDCTInferenceJob operation returns this identifier in its
|
542
|
+
# response.
|
543
|
+
#
|
544
|
+
# @return [Types::DescribeSNOMEDCTInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
545
|
+
#
|
546
|
+
# * {Types::DescribeSNOMEDCTInferenceJobResponse#comprehend_medical_async_job_properties #comprehend_medical_async_job_properties} => Types::ComprehendMedicalAsyncJobProperties
|
547
|
+
#
|
548
|
+
# @example Request syntax with placeholder values
|
549
|
+
#
|
550
|
+
# resp = client.describe_snomedct_inference_job({
|
551
|
+
# job_id: "JobId", # required
|
552
|
+
# })
|
553
|
+
#
|
554
|
+
# @example Response structure
|
555
|
+
#
|
556
|
+
# resp.comprehend_medical_async_job_properties.job_id #=> String
|
557
|
+
# resp.comprehend_medical_async_job_properties.job_name #=> String
|
558
|
+
# resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
|
559
|
+
# resp.comprehend_medical_async_job_properties.message #=> String
|
560
|
+
# resp.comprehend_medical_async_job_properties.submit_time #=> Time
|
561
|
+
# resp.comprehend_medical_async_job_properties.end_time #=> Time
|
562
|
+
# resp.comprehend_medical_async_job_properties.expiration_time #=> Time
|
563
|
+
# resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
|
564
|
+
# resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
|
565
|
+
# resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
|
566
|
+
# resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
|
567
|
+
# resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
|
568
|
+
# resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
|
569
|
+
# resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
|
570
|
+
# resp.comprehend_medical_async_job_properties.kms_key #=> String
|
571
|
+
# resp.comprehend_medical_async_job_properties.model_version #=> String
|
572
|
+
#
|
573
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeSNOMEDCTInferenceJob AWS API Documentation
|
574
|
+
#
|
575
|
+
# @overload describe_snomedct_inference_job(params = {})
|
576
|
+
# @param [Hash] params ({})
|
577
|
+
def describe_snomedct_inference_job(params = {}, options = {})
|
578
|
+
req = build_request(:describe_snomedct_inference_job, params)
|
579
|
+
req.send_request(options)
|
580
|
+
end
|
581
|
+
|
525
582
|
# The `DetectEntities` operation is deprecated. You should use the
|
526
583
|
# DetectEntitiesV2 operation instead.
|
527
584
|
#
|
@@ -556,15 +613,15 @@ module Aws::ComprehendMedical
|
|
556
613
|
# resp.entities[0].score #=> Float
|
557
614
|
# resp.entities[0].text #=> String
|
558
615
|
# 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"
|
616
|
+
# 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
617
|
# resp.entities[0].traits #=> Array
|
561
618
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
562
619
|
# resp.entities[0].traits[0].score #=> Float
|
563
620
|
# 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"
|
621
|
+
# 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
622
|
# resp.entities[0].attributes[0].score #=> Float
|
566
623
|
# 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"
|
624
|
+
# 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
625
|
# resp.entities[0].attributes[0].id #=> Integer
|
569
626
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
570
627
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
@@ -575,10 +632,10 @@ module Aws::ComprehendMedical
|
|
575
632
|
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
576
633
|
# resp.unmapped_attributes #=> Array
|
577
634
|
# 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"
|
635
|
+
# 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
636
|
# resp.unmapped_attributes[0].attribute.score #=> Float
|
580
637
|
# 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"
|
638
|
+
# 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
639
|
# resp.unmapped_attributes[0].attribute.id #=> Integer
|
583
640
|
# resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
|
584
641
|
# resp.unmapped_attributes[0].attribute.end_offset #=> Integer
|
@@ -640,15 +697,15 @@ module Aws::ComprehendMedical
|
|
640
697
|
# resp.entities[0].score #=> Float
|
641
698
|
# resp.entities[0].text #=> String
|
642
699
|
# 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"
|
700
|
+
# 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
701
|
# resp.entities[0].traits #=> Array
|
645
702
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
646
703
|
# resp.entities[0].traits[0].score #=> Float
|
647
704
|
# 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"
|
705
|
+
# 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
706
|
# resp.entities[0].attributes[0].score #=> Float
|
650
707
|
# 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"
|
708
|
+
# 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
709
|
# resp.entities[0].attributes[0].id #=> Integer
|
653
710
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
654
711
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
@@ -659,10 +716,10 @@ module Aws::ComprehendMedical
|
|
659
716
|
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
660
717
|
# resp.unmapped_attributes #=> Array
|
661
718
|
# 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"
|
719
|
+
# 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
720
|
# resp.unmapped_attributes[0].attribute.score #=> Float
|
664
721
|
# 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"
|
722
|
+
# 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
723
|
# resp.unmapped_attributes[0].attribute.id #=> Integer
|
667
724
|
# resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
|
668
725
|
# resp.unmapped_attributes[0].attribute.end_offset #=> Integer
|
@@ -714,15 +771,15 @@ module Aws::ComprehendMedical
|
|
714
771
|
# resp.entities[0].score #=> Float
|
715
772
|
# resp.entities[0].text #=> String
|
716
773
|
# 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"
|
774
|
+
# 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
775
|
# resp.entities[0].traits #=> Array
|
719
776
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
720
777
|
# resp.entities[0].traits[0].score #=> Float
|
721
778
|
# 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"
|
779
|
+
# 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
780
|
# resp.entities[0].attributes[0].score #=> Float
|
724
781
|
# 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"
|
782
|
+
# 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
783
|
# resp.entities[0].attributes[0].id #=> Integer
|
727
784
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
728
785
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
@@ -868,6 +925,78 @@ module Aws::ComprehendMedical
|
|
868
925
|
req.send_request(options)
|
869
926
|
end
|
870
927
|
|
928
|
+
# InferSNOMEDCT detects possible medical concepts as entities and links
|
929
|
+
# them to codes from the Systematized Nomenclature of Medicine, Clinical
|
930
|
+
# Terms (SNOMED-CT) ontology
|
931
|
+
#
|
932
|
+
# @option params [required, String] :text
|
933
|
+
# The input text to be analyzed using InferSNOMEDCT. The text should be
|
934
|
+
# a string with 1 to 10000 characters.
|
935
|
+
#
|
936
|
+
# @return [Types::InferSNOMEDCTResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
937
|
+
#
|
938
|
+
# * {Types::InferSNOMEDCTResponse#entities #entities} => Array<Types::SNOMEDCTEntity>
|
939
|
+
# * {Types::InferSNOMEDCTResponse#pagination_token #pagination_token} => String
|
940
|
+
# * {Types::InferSNOMEDCTResponse#model_version #model_version} => String
|
941
|
+
# * {Types::InferSNOMEDCTResponse#snomedct_details #snomedct_details} => Types::SNOMEDCTDetails
|
942
|
+
# * {Types::InferSNOMEDCTResponse#characters #characters} => Types::Characters
|
943
|
+
#
|
944
|
+
# @example Request syntax with placeholder values
|
945
|
+
#
|
946
|
+
# resp = client.infer_snomedct({
|
947
|
+
# text: "OntologyLinkingBoundedLengthString", # required
|
948
|
+
# })
|
949
|
+
#
|
950
|
+
# @example Response structure
|
951
|
+
#
|
952
|
+
# resp.entities #=> Array
|
953
|
+
# resp.entities[0].id #=> Integer
|
954
|
+
# resp.entities[0].text #=> String
|
955
|
+
# resp.entities[0].category #=> String, one of "MEDICAL_CONDITION", "ANATOMY", "TEST_TREATMENT_PROCEDURE"
|
956
|
+
# resp.entities[0].type #=> String, one of "DX_NAME", "TEST_NAME", "PROCEDURE_NAME", "TREATMENT_NAME"
|
957
|
+
# resp.entities[0].score #=> Float
|
958
|
+
# resp.entities[0].begin_offset #=> Integer
|
959
|
+
# resp.entities[0].end_offset #=> Integer
|
960
|
+
# resp.entities[0].attributes #=> Array
|
961
|
+
# resp.entities[0].attributes[0].category #=> String, one of "MEDICAL_CONDITION", "ANATOMY", "TEST_TREATMENT_PROCEDURE"
|
962
|
+
# resp.entities[0].attributes[0].type #=> String, one of "ACUITY", "QUALITY", "DIRECTION", "SYSTEM_ORGAN_SITE", "TEST_VALUE", "TEST_UNIT"
|
963
|
+
# resp.entities[0].attributes[0].score #=> Float
|
964
|
+
# resp.entities[0].attributes[0].relationship_score #=> Float
|
965
|
+
# resp.entities[0].attributes[0].relationship_type #=> String, one of "ACUITY", "QUALITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
966
|
+
# resp.entities[0].attributes[0].id #=> Integer
|
967
|
+
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
968
|
+
# resp.entities[0].attributes[0].end_offset #=> Integer
|
969
|
+
# resp.entities[0].attributes[0].text #=> String
|
970
|
+
# resp.entities[0].attributes[0].traits #=> Array
|
971
|
+
# resp.entities[0].attributes[0].traits[0].name #=> String, one of "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM"
|
972
|
+
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
973
|
+
# resp.entities[0].attributes[0].snomedct_concepts #=> Array
|
974
|
+
# resp.entities[0].attributes[0].snomedct_concepts[0].description #=> String
|
975
|
+
# resp.entities[0].attributes[0].snomedct_concepts[0].code #=> String
|
976
|
+
# resp.entities[0].attributes[0].snomedct_concepts[0].score #=> Float
|
977
|
+
# resp.entities[0].traits #=> Array
|
978
|
+
# resp.entities[0].traits[0].name #=> String, one of "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM"
|
979
|
+
# resp.entities[0].traits[0].score #=> Float
|
980
|
+
# resp.entities[0].snomedct_concepts #=> Array
|
981
|
+
# resp.entities[0].snomedct_concepts[0].description #=> String
|
982
|
+
# resp.entities[0].snomedct_concepts[0].code #=> String
|
983
|
+
# resp.entities[0].snomedct_concepts[0].score #=> Float
|
984
|
+
# resp.pagination_token #=> String
|
985
|
+
# resp.model_version #=> String
|
986
|
+
# resp.snomedct_details.edition #=> String
|
987
|
+
# resp.snomedct_details.language #=> String
|
988
|
+
# resp.snomedct_details.version_date #=> String
|
989
|
+
# resp.characters.original_text_characters #=> Integer
|
990
|
+
#
|
991
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferSNOMEDCT AWS API Documentation
|
992
|
+
#
|
993
|
+
# @overload infer_snomedct(params = {})
|
994
|
+
# @param [Hash] params ({})
|
995
|
+
def infer_snomedct(params = {}, options = {})
|
996
|
+
req = build_request(:infer_snomedct, params)
|
997
|
+
req.send_request(options)
|
998
|
+
end
|
999
|
+
|
871
1000
|
# Gets a list of medical entity detection jobs that you have submitted.
|
872
1001
|
#
|
873
1002
|
# @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
|
@@ -1116,21 +1245,83 @@ module Aws::ComprehendMedical
|
|
1116
1245
|
req.send_request(options)
|
1117
1246
|
end
|
1118
1247
|
|
1248
|
+
# Gets a list of InferSNOMEDCT jobs a user has submitted.
|
1249
|
+
#
|
1250
|
+
# @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
|
1251
|
+
# Provides information for filtering a list of detection jobs.
|
1252
|
+
#
|
1253
|
+
# @option params [String] :next_token
|
1254
|
+
# Identifies the next page of InferSNOMEDCT results to return.
|
1255
|
+
#
|
1256
|
+
# @option params [Integer] :max_results
|
1257
|
+
# The maximum number of results to return in each page. The default is
|
1258
|
+
# 100.
|
1259
|
+
#
|
1260
|
+
# @return [Types::ListSNOMEDCTInferenceJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1261
|
+
#
|
1262
|
+
# * {Types::ListSNOMEDCTInferenceJobsResponse#comprehend_medical_async_job_properties_list #comprehend_medical_async_job_properties_list} => Array<Types::ComprehendMedicalAsyncJobProperties>
|
1263
|
+
# * {Types::ListSNOMEDCTInferenceJobsResponse#next_token #next_token} => String
|
1264
|
+
#
|
1265
|
+
# @example Request syntax with placeholder values
|
1266
|
+
#
|
1267
|
+
# resp = client.list_snomedct_inference_jobs({
|
1268
|
+
# filter: {
|
1269
|
+
# job_name: "JobName",
|
1270
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
|
1271
|
+
# submit_time_before: Time.now,
|
1272
|
+
# submit_time_after: Time.now,
|
1273
|
+
# },
|
1274
|
+
# next_token: "String",
|
1275
|
+
# max_results: 1,
|
1276
|
+
# })
|
1277
|
+
#
|
1278
|
+
# @example Response structure
|
1279
|
+
#
|
1280
|
+
# resp.comprehend_medical_async_job_properties_list #=> Array
|
1281
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
|
1282
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
|
1283
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1284
|
+
# resp.comprehend_medical_async_job_properties_list[0].message #=> String
|
1285
|
+
# resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
|
1286
|
+
# resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
|
1287
|
+
# resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
|
1288
|
+
# resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
|
1289
|
+
# resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
|
1290
|
+
# resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
|
1291
|
+
# resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
|
1292
|
+
# resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
|
1293
|
+
# resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
|
1294
|
+
# resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
|
1295
|
+
# resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
|
1296
|
+
# resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
|
1297
|
+
# resp.next_token #=> String
|
1298
|
+
#
|
1299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListSNOMEDCTInferenceJobs AWS API Documentation
|
1300
|
+
#
|
1301
|
+
# @overload list_snomedct_inference_jobs(params = {})
|
1302
|
+
# @param [Hash] params ({})
|
1303
|
+
def list_snomedct_inference_jobs(params = {}, options = {})
|
1304
|
+
req = build_request(:list_snomedct_inference_jobs, params)
|
1305
|
+
req.send_request(options)
|
1306
|
+
end
|
1307
|
+
|
1119
1308
|
# Starts an asynchronous medical entity detection job for a collection
|
1120
1309
|
# of documents. Use the `DescribeEntitiesDetectionV2Job` operation to
|
1121
1310
|
# track the status of a job.
|
1122
1311
|
#
|
1123
1312
|
# @option params [required, Types::InputDataConfig] :input_data_config
|
1124
|
-
#
|
1313
|
+
# The input configuration that specifies the format and location of the
|
1314
|
+
# input data for the job.
|
1125
1315
|
#
|
1126
1316
|
# @option params [required, Types::OutputDataConfig] :output_data_config
|
1127
|
-
#
|
1317
|
+
# The output configuration that specifies where to send the output
|
1318
|
+
# files.
|
1128
1319
|
#
|
1129
1320
|
# @option params [required, String] :data_access_role_arn
|
1130
1321
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1131
|
-
# Management (IAM) role that grants
|
1132
|
-
#
|
1133
|
-
#
|
1322
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
1323
|
+
# your input data. For more information, see [ Role-Based Permissions
|
1324
|
+
# Required for Asynchronous Operations][1].
|
1134
1325
|
#
|
1135
1326
|
#
|
1136
1327
|
#
|
@@ -1141,7 +1332,7 @@ module Aws::ComprehendMedical
|
|
1141
1332
|
#
|
1142
1333
|
# @option params [String] :client_request_token
|
1143
1334
|
# A unique identifier for the request. If you don't set the client
|
1144
|
-
# request token,
|
1335
|
+
# request token, Comprehend Medical; generates one for you.
|
1145
1336
|
#
|
1146
1337
|
# **A suitable default value is auto-generated.** You should normally
|
1147
1338
|
# not need to pass this option.**
|
@@ -1152,7 +1343,7 @@ module Aws::ComprehendMedical
|
|
1152
1343
|
#
|
1153
1344
|
# @option params [required, String] :language_code
|
1154
1345
|
# The language of the input documents. All documents must be in the same
|
1155
|
-
# language.
|
1346
|
+
# language. Comprehend Medical; processes files in US English (en).
|
1156
1347
|
#
|
1157
1348
|
# @return [Types::StartEntitiesDetectionV2JobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1158
1349
|
#
|
@@ -1201,9 +1392,9 @@ module Aws::ComprehendMedical
|
|
1201
1392
|
#
|
1202
1393
|
# @option params [required, String] :data_access_role_arn
|
1203
1394
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1204
|
-
# Management (IAM) role that grants
|
1205
|
-
#
|
1206
|
-
#
|
1395
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
1396
|
+
# your input data. For more information, see [ Role-Based Permissions
|
1397
|
+
# Required for Asynchronous Operations][1].
|
1207
1398
|
#
|
1208
1399
|
#
|
1209
1400
|
#
|
@@ -1214,7 +1405,7 @@ module Aws::ComprehendMedical
|
|
1214
1405
|
#
|
1215
1406
|
# @option params [String] :client_request_token
|
1216
1407
|
# A unique identifier for the request. If you don't set the client
|
1217
|
-
# request token,
|
1408
|
+
# request token, Comprehend Medical; generates one.
|
1218
1409
|
#
|
1219
1410
|
# **A suitable default value is auto-generated.** You should normally
|
1220
1411
|
# not need to pass this option.**
|
@@ -1274,9 +1465,9 @@ module Aws::ComprehendMedical
|
|
1274
1465
|
#
|
1275
1466
|
# @option params [required, String] :data_access_role_arn
|
1276
1467
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1277
|
-
# Management (IAM) role that grants
|
1278
|
-
#
|
1279
|
-
#
|
1468
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
1469
|
+
# your input data. For more information, see [ Role-Based Permissions
|
1470
|
+
# Required for Asynchronous Operations][1].
|
1280
1471
|
#
|
1281
1472
|
#
|
1282
1473
|
#
|
@@ -1287,7 +1478,7 @@ module Aws::ComprehendMedical
|
|
1287
1478
|
#
|
1288
1479
|
# @option params [String] :client_request_token
|
1289
1480
|
# A unique identifier for the request. If you don't set the client
|
1290
|
-
# request token,
|
1481
|
+
# request token, Comprehend Medical; generates one.
|
1291
1482
|
#
|
1292
1483
|
# **A suitable default value is auto-generated.** You should normally
|
1293
1484
|
# not need to pass this option.**
|
@@ -1347,9 +1538,9 @@ module Aws::ComprehendMedical
|
|
1347
1538
|
#
|
1348
1539
|
# @option params [required, String] :data_access_role_arn
|
1349
1540
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1350
|
-
# Management (IAM) role that grants
|
1351
|
-
#
|
1352
|
-
#
|
1541
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
1542
|
+
# your input data. For more information, see [ Role-Based Permissions
|
1543
|
+
# Required for Asynchronous Operations][1].
|
1353
1544
|
#
|
1354
1545
|
#
|
1355
1546
|
#
|
@@ -1360,7 +1551,7 @@ module Aws::ComprehendMedical
|
|
1360
1551
|
#
|
1361
1552
|
# @option params [String] :client_request_token
|
1362
1553
|
# A unique identifier for the request. If you don't set the client
|
1363
|
-
# request token,
|
1554
|
+
# request token, Comprehend Medical; generates one.
|
1364
1555
|
#
|
1365
1556
|
# **A suitable default value is auto-generated.** You should normally
|
1366
1557
|
# not need to pass this option.**
|
@@ -1408,6 +1599,75 @@ module Aws::ComprehendMedical
|
|
1408
1599
|
req.send_request(options)
|
1409
1600
|
end
|
1410
1601
|
|
1602
|
+
# Starts an asynchronous job to detect medical concepts and link them to
|
1603
|
+
# the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation
|
1604
|
+
# to track the status of a job.
|
1605
|
+
#
|
1606
|
+
# @option params [required, Types::InputDataConfig] :input_data_config
|
1607
|
+
# The input properties for an entities detection job. This includes the
|
1608
|
+
# name of the S3 bucket and the path to the files to be analyzed.
|
1609
|
+
#
|
1610
|
+
# @option params [required, Types::OutputDataConfig] :output_data_config
|
1611
|
+
# The output properties for a detection job.
|
1612
|
+
#
|
1613
|
+
# @option params [required, String] :data_access_role_arn
|
1614
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1615
|
+
# Management (IAM) role that grants Amazon Comprehend Medical read
|
1616
|
+
# access to your input data.
|
1617
|
+
#
|
1618
|
+
# @option params [String] :job_name
|
1619
|
+
# The user generated name the asynchronous InferSNOMEDCT job.
|
1620
|
+
#
|
1621
|
+
# @option params [String] :client_request_token
|
1622
|
+
# A unique identifier for the request. If you don't set the client
|
1623
|
+
# request token, Amazon Comprehend Medical generates one.
|
1624
|
+
#
|
1625
|
+
# **A suitable default value is auto-generated.** You should normally
|
1626
|
+
# not need to pass this option.**
|
1627
|
+
#
|
1628
|
+
# @option params [String] :kms_key
|
1629
|
+
# An AWS Key Management Service key used to encrypt your output files.
|
1630
|
+
# If you do not specify a key, the files are written in plain text.
|
1631
|
+
#
|
1632
|
+
# @option params [required, String] :language_code
|
1633
|
+
# The language of the input documents. All documents must be in the same
|
1634
|
+
# language.
|
1635
|
+
#
|
1636
|
+
# @return [Types::StartSNOMEDCTInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1637
|
+
#
|
1638
|
+
# * {Types::StartSNOMEDCTInferenceJobResponse#job_id #job_id} => String
|
1639
|
+
#
|
1640
|
+
# @example Request syntax with placeholder values
|
1641
|
+
#
|
1642
|
+
# resp = client.start_snomedct_inference_job({
|
1643
|
+
# input_data_config: { # required
|
1644
|
+
# s3_bucket: "S3Bucket", # required
|
1645
|
+
# s3_key: "S3Key",
|
1646
|
+
# },
|
1647
|
+
# output_data_config: { # required
|
1648
|
+
# s3_bucket: "S3Bucket", # required
|
1649
|
+
# s3_key: "S3Key",
|
1650
|
+
# },
|
1651
|
+
# data_access_role_arn: "IamRoleArn", # required
|
1652
|
+
# job_name: "JobName",
|
1653
|
+
# client_request_token: "ClientRequestTokenString",
|
1654
|
+
# kms_key: "KMSKey",
|
1655
|
+
# language_code: "en", # required, accepts en
|
1656
|
+
# })
|
1657
|
+
#
|
1658
|
+
# @example Response structure
|
1659
|
+
#
|
1660
|
+
# resp.job_id #=> String
|
1661
|
+
#
|
1662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartSNOMEDCTInferenceJob AWS API Documentation
|
1663
|
+
#
|
1664
|
+
# @overload start_snomedct_inference_job(params = {})
|
1665
|
+
# @param [Hash] params ({})
|
1666
|
+
def start_snomedct_inference_job(params = {}, options = {})
|
1667
|
+
req = build_request(:start_snomedct_inference_job, params)
|
1668
|
+
req.send_request(options)
|
1669
|
+
end
|
1670
|
+
|
1411
1671
|
# Stops a medical entities detection job in progress.
|
1412
1672
|
#
|
1413
1673
|
# @option params [required, String] :job_id
|
@@ -1520,6 +1780,34 @@ module Aws::ComprehendMedical
|
|
1520
1780
|
req.send_request(options)
|
1521
1781
|
end
|
1522
1782
|
|
1783
|
+
# Stops an InferSNOMEDCT inference job in progress.
|
1784
|
+
#
|
1785
|
+
# @option params [required, String] :job_id
|
1786
|
+
# The job id of the asynchronous InferSNOMEDCT job to be stopped.
|
1787
|
+
#
|
1788
|
+
# @return [Types::StopSNOMEDCTInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1789
|
+
#
|
1790
|
+
# * {Types::StopSNOMEDCTInferenceJobResponse#job_id #job_id} => String
|
1791
|
+
#
|
1792
|
+
# @example Request syntax with placeholder values
|
1793
|
+
#
|
1794
|
+
# resp = client.stop_snomedct_inference_job({
|
1795
|
+
# job_id: "JobId", # required
|
1796
|
+
# })
|
1797
|
+
#
|
1798
|
+
# @example Response structure
|
1799
|
+
#
|
1800
|
+
# resp.job_id #=> String
|
1801
|
+
#
|
1802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopSNOMEDCTInferenceJob AWS API Documentation
|
1803
|
+
#
|
1804
|
+
# @overload stop_snomedct_inference_job(params = {})
|
1805
|
+
# @param [Hash] params ({})
|
1806
|
+
def stop_snomedct_inference_job(params = {}, options = {})
|
1807
|
+
req = build_request(:stop_snomedct_inference_job, params)
|
1808
|
+
req.send_request(options)
|
1809
|
+
end
|
1810
|
+
|
1523
1811
|
# @!endgroup
|
1524
1812
|
|
1525
1813
|
# @param params ({})
|
@@ -1533,7 +1821,7 @@ module Aws::ComprehendMedical
|
|
1533
1821
|
params: params,
|
1534
1822
|
config: config)
|
1535
1823
|
context[:gem_name] = 'aws-sdk-comprehendmedical'
|
1536
|
-
context[:gem_version] = '1.
|
1824
|
+
context[:gem_version] = '1.33.0'
|
1537
1825
|
Seahorse::Client::Request.new(handlers, context)
|
1538
1826
|
end
|
1539
1827
|
|