aws-sdk-comprehendmedical 1.32.0 → 1.33.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-comprehendmedical/client.rb +315 -38
- 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 +2 -2
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
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.33.0
|
@@ -352,9 +352,9 @@ module Aws::ComprehendMedical
|
|
352
352
|
# Use this operation to get the status of a detection job.
|
353
353
|
#
|
354
354
|
# @option params [required, String] :job_id
|
355
|
-
# The identifier that
|
356
|
-
#
|
357
|
-
#
|
355
|
+
# The identifier that Comprehend Medical; generated for the job. The
|
356
|
+
# `StartEntitiesDetectionV2Job` operation returns this identifier in its
|
357
|
+
# response.
|
358
358
|
#
|
359
359
|
# @return [Types::DescribeEntitiesDetectionV2JobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
360
360
|
#
|
@@ -445,8 +445,8 @@ module Aws::ComprehendMedical
|
|
445
445
|
# detection job.
|
446
446
|
#
|
447
447
|
# @option params [required, String] :job_id
|
448
|
-
# The identifier that
|
449
|
-
#
|
448
|
+
# The identifier that Comprehend Medical; generated for the job. The
|
449
|
+
# `StartPHIDetectionJob` operation returns this identifier in its
|
450
450
|
# response.
|
451
451
|
#
|
452
452
|
# @return [Types::DescribePHIDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -533,6 +533,52 @@ module Aws::ComprehendMedical
|
|
533
533
|
req.send_request(options)
|
534
534
|
end
|
535
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
|
+
|
536
582
|
# The `DetectEntities` operation is deprecated. You should use the
|
537
583
|
# DetectEntitiesV2 operation instead.
|
538
584
|
#
|
@@ -567,15 +613,15 @@ module Aws::ComprehendMedical
|
|
567
613
|
# resp.entities[0].score #=> Float
|
568
614
|
# resp.entities[0].text #=> String
|
569
615
|
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
570
|
-
# 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"
|
571
617
|
# resp.entities[0].traits #=> Array
|
572
618
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
573
619
|
# resp.entities[0].traits[0].score #=> Float
|
574
620
|
# resp.entities[0].attributes #=> Array
|
575
|
-
# 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"
|
576
622
|
# resp.entities[0].attributes[0].score #=> Float
|
577
623
|
# resp.entities[0].attributes[0].relationship_score #=> Float
|
578
|
-
# 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"
|
579
625
|
# resp.entities[0].attributes[0].id #=> Integer
|
580
626
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
581
627
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
@@ -586,10 +632,10 @@ module Aws::ComprehendMedical
|
|
586
632
|
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
587
633
|
# resp.unmapped_attributes #=> Array
|
588
634
|
# resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
589
|
-
# 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"
|
590
636
|
# resp.unmapped_attributes[0].attribute.score #=> Float
|
591
637
|
# resp.unmapped_attributes[0].attribute.relationship_score #=> Float
|
592
|
-
# 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"
|
593
639
|
# resp.unmapped_attributes[0].attribute.id #=> Integer
|
594
640
|
# resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
|
595
641
|
# resp.unmapped_attributes[0].attribute.end_offset #=> Integer
|
@@ -651,15 +697,15 @@ module Aws::ComprehendMedical
|
|
651
697
|
# resp.entities[0].score #=> Float
|
652
698
|
# resp.entities[0].text #=> String
|
653
699
|
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
654
|
-
# 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"
|
655
701
|
# resp.entities[0].traits #=> Array
|
656
702
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
657
703
|
# resp.entities[0].traits[0].score #=> Float
|
658
704
|
# resp.entities[0].attributes #=> Array
|
659
|
-
# 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"
|
660
706
|
# resp.entities[0].attributes[0].score #=> Float
|
661
707
|
# resp.entities[0].attributes[0].relationship_score #=> Float
|
662
|
-
# 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"
|
663
709
|
# resp.entities[0].attributes[0].id #=> Integer
|
664
710
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
665
711
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
@@ -670,10 +716,10 @@ module Aws::ComprehendMedical
|
|
670
716
|
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
671
717
|
# resp.unmapped_attributes #=> Array
|
672
718
|
# resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
673
|
-
# 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"
|
674
720
|
# resp.unmapped_attributes[0].attribute.score #=> Float
|
675
721
|
# resp.unmapped_attributes[0].attribute.relationship_score #=> Float
|
676
|
-
# 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"
|
677
723
|
# resp.unmapped_attributes[0].attribute.id #=> Integer
|
678
724
|
# resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
|
679
725
|
# resp.unmapped_attributes[0].attribute.end_offset #=> Integer
|
@@ -725,15 +771,15 @@ module Aws::ComprehendMedical
|
|
725
771
|
# resp.entities[0].score #=> Float
|
726
772
|
# resp.entities[0].text #=> String
|
727
773
|
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
728
|
-
# 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"
|
729
775
|
# resp.entities[0].traits #=> Array
|
730
776
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
731
777
|
# resp.entities[0].traits[0].score #=> Float
|
732
778
|
# resp.entities[0].attributes #=> Array
|
733
|
-
# 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"
|
734
780
|
# resp.entities[0].attributes[0].score #=> Float
|
735
781
|
# resp.entities[0].attributes[0].relationship_score #=> Float
|
736
|
-
# 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"
|
737
783
|
# resp.entities[0].attributes[0].id #=> Integer
|
738
784
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
739
785
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
@@ -879,6 +925,78 @@ module Aws::ComprehendMedical
|
|
879
925
|
req.send_request(options)
|
880
926
|
end
|
881
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
|
+
|
882
1000
|
# Gets a list of medical entity detection jobs that you have submitted.
|
883
1001
|
#
|
884
1002
|
# @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
|
@@ -1127,21 +1245,83 @@ module Aws::ComprehendMedical
|
|
1127
1245
|
req.send_request(options)
|
1128
1246
|
end
|
1129
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
|
+
|
1130
1308
|
# Starts an asynchronous medical entity detection job for a collection
|
1131
1309
|
# of documents. Use the `DescribeEntitiesDetectionV2Job` operation to
|
1132
1310
|
# track the status of a job.
|
1133
1311
|
#
|
1134
1312
|
# @option params [required, Types::InputDataConfig] :input_data_config
|
1135
|
-
#
|
1313
|
+
# The input configuration that specifies the format and location of the
|
1314
|
+
# input data for the job.
|
1136
1315
|
#
|
1137
1316
|
# @option params [required, Types::OutputDataConfig] :output_data_config
|
1138
|
-
#
|
1317
|
+
# The output configuration that specifies where to send the output
|
1318
|
+
# files.
|
1139
1319
|
#
|
1140
1320
|
# @option params [required, String] :data_access_role_arn
|
1141
1321
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1142
|
-
# Management (IAM) role that grants
|
1143
|
-
#
|
1144
|
-
#
|
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].
|
1145
1325
|
#
|
1146
1326
|
#
|
1147
1327
|
#
|
@@ -1152,7 +1332,7 @@ module Aws::ComprehendMedical
|
|
1152
1332
|
#
|
1153
1333
|
# @option params [String] :client_request_token
|
1154
1334
|
# A unique identifier for the request. If you don't set the client
|
1155
|
-
# request token,
|
1335
|
+
# request token, Comprehend Medical; generates one for you.
|
1156
1336
|
#
|
1157
1337
|
# **A suitable default value is auto-generated.** You should normally
|
1158
1338
|
# not need to pass this option.**
|
@@ -1163,7 +1343,7 @@ module Aws::ComprehendMedical
|
|
1163
1343
|
#
|
1164
1344
|
# @option params [required, String] :language_code
|
1165
1345
|
# The language of the input documents. All documents must be in the same
|
1166
|
-
# language.
|
1346
|
+
# language. Comprehend Medical; processes files in US English (en).
|
1167
1347
|
#
|
1168
1348
|
# @return [Types::StartEntitiesDetectionV2JobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1169
1349
|
#
|
@@ -1212,9 +1392,9 @@ module Aws::ComprehendMedical
|
|
1212
1392
|
#
|
1213
1393
|
# @option params [required, String] :data_access_role_arn
|
1214
1394
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1215
|
-
# Management (IAM) role that grants
|
1216
|
-
#
|
1217
|
-
#
|
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].
|
1218
1398
|
#
|
1219
1399
|
#
|
1220
1400
|
#
|
@@ -1225,7 +1405,7 @@ module Aws::ComprehendMedical
|
|
1225
1405
|
#
|
1226
1406
|
# @option params [String] :client_request_token
|
1227
1407
|
# A unique identifier for the request. If you don't set the client
|
1228
|
-
# request token,
|
1408
|
+
# request token, Comprehend Medical; generates one.
|
1229
1409
|
#
|
1230
1410
|
# **A suitable default value is auto-generated.** You should normally
|
1231
1411
|
# not need to pass this option.**
|
@@ -1285,9 +1465,9 @@ module Aws::ComprehendMedical
|
|
1285
1465
|
#
|
1286
1466
|
# @option params [required, String] :data_access_role_arn
|
1287
1467
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1288
|
-
# Management (IAM) role that grants
|
1289
|
-
#
|
1290
|
-
#
|
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].
|
1291
1471
|
#
|
1292
1472
|
#
|
1293
1473
|
#
|
@@ -1298,7 +1478,7 @@ module Aws::ComprehendMedical
|
|
1298
1478
|
#
|
1299
1479
|
# @option params [String] :client_request_token
|
1300
1480
|
# A unique identifier for the request. If you don't set the client
|
1301
|
-
# request token,
|
1481
|
+
# request token, Comprehend Medical; generates one.
|
1302
1482
|
#
|
1303
1483
|
# **A suitable default value is auto-generated.** You should normally
|
1304
1484
|
# not need to pass this option.**
|
@@ -1358,9 +1538,9 @@ module Aws::ComprehendMedical
|
|
1358
1538
|
#
|
1359
1539
|
# @option params [required, String] :data_access_role_arn
|
1360
1540
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1361
|
-
# Management (IAM) role that grants
|
1362
|
-
#
|
1363
|
-
#
|
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].
|
1364
1544
|
#
|
1365
1545
|
#
|
1366
1546
|
#
|
@@ -1371,7 +1551,7 @@ module Aws::ComprehendMedical
|
|
1371
1551
|
#
|
1372
1552
|
# @option params [String] :client_request_token
|
1373
1553
|
# A unique identifier for the request. If you don't set the client
|
1374
|
-
# request token,
|
1554
|
+
# request token, Comprehend Medical; generates one.
|
1375
1555
|
#
|
1376
1556
|
# **A suitable default value is auto-generated.** You should normally
|
1377
1557
|
# not need to pass this option.**
|
@@ -1419,6 +1599,75 @@ module Aws::ComprehendMedical
|
|
1419
1599
|
req.send_request(options)
|
1420
1600
|
end
|
1421
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
|
+
|
1422
1671
|
# Stops a medical entities detection job in progress.
|
1423
1672
|
#
|
1424
1673
|
# @option params [required, String] :job_id
|
@@ -1531,6 +1780,34 @@ module Aws::ComprehendMedical
|
|
1531
1780
|
req.send_request(options)
|
1532
1781
|
end
|
1533
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
|
+
|
1534
1811
|
# @!endgroup
|
1535
1812
|
|
1536
1813
|
# @param params ({})
|
@@ -1544,7 +1821,7 @@ module Aws::ComprehendMedical
|
|
1544
1821
|
params: params,
|
1545
1822
|
config: config)
|
1546
1823
|
context[:gem_name] = 'aws-sdk-comprehendmedical'
|
1547
|
-
context[:gem_version] = '1.
|
1824
|
+
context[:gem_version] = '1.33.0'
|
1548
1825
|
Seahorse::Client::Request.new(handlers, context)
|
1549
1826
|
end
|
1550
1827
|
|