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
@@ -21,12 +21,12 @@ module Aws::ComprehendMedical
|
|
21
21
|
# @return [String]
|
22
22
|
#
|
23
23
|
# @!attribute [rw] score
|
24
|
-
# The level of confidence that
|
24
|
+
# The level of confidence that Comprehend Medical; has that the
|
25
25
|
# segment of text is correctly recognized as an attribute.
|
26
26
|
# @return [Float]
|
27
27
|
#
|
28
28
|
# @!attribute [rw] relationship_score
|
29
|
-
# The level of confidence that
|
29
|
+
# The level of confidence that Comprehend Medical; has that this
|
30
30
|
# attribute is correctly related to this entity.
|
31
31
|
# @return [Float]
|
32
32
|
#
|
@@ -83,6 +83,21 @@ module Aws::ComprehendMedical
|
|
83
83
|
include Aws::Structure
|
84
84
|
end
|
85
85
|
|
86
|
+
# The number of characters in the input text to be analyzed.
|
87
|
+
#
|
88
|
+
# @!attribute [rw] original_text_characters
|
89
|
+
# The number of characters present in the input text document as
|
90
|
+
# processed by Comprehend Medical.
|
91
|
+
# @return [Integer]
|
92
|
+
#
|
93
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/Characters AWS API Documentation
|
94
|
+
#
|
95
|
+
class Characters < Struct.new(
|
96
|
+
:original_text_characters)
|
97
|
+
SENSITIVE = []
|
98
|
+
include Aws::Structure
|
99
|
+
end
|
100
|
+
|
86
101
|
# Provides information for filtering a list of detection jobs.
|
87
102
|
#
|
88
103
|
# @note When making an API call, you may pass ComprehendMedicalAsyncJobFilter
|
@@ -179,8 +194,8 @@ module Aws::ComprehendMedical
|
|
179
194
|
# @return [String]
|
180
195
|
#
|
181
196
|
# @!attribute [rw] data_access_role_arn
|
182
|
-
# The Amazon Resource Name (ARN) that gives
|
183
|
-
#
|
197
|
+
# The Amazon Resource Name (ARN) that gives Comprehend Medical; read
|
198
|
+
# access to your input data.
|
184
199
|
# @return [String]
|
185
200
|
#
|
186
201
|
# @!attribute [rw] manifest_file_path
|
@@ -227,9 +242,9 @@ module Aws::ComprehendMedical
|
|
227
242
|
# }
|
228
243
|
#
|
229
244
|
# @!attribute [rw] job_id
|
230
|
-
# The identifier that
|
231
|
-
#
|
232
|
-
#
|
245
|
+
# The identifier that Comprehend Medical; generated for the job. The
|
246
|
+
# `StartEntitiesDetectionV2Job` operation returns this identifier in
|
247
|
+
# its response.
|
233
248
|
# @return [String]
|
234
249
|
#
|
235
250
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeEntitiesDetectionV2JobRequest AWS API Documentation
|
@@ -295,8 +310,8 @@ module Aws::ComprehendMedical
|
|
295
310
|
# }
|
296
311
|
#
|
297
312
|
# @!attribute [rw] job_id
|
298
|
-
# The identifier that
|
299
|
-
#
|
313
|
+
# The identifier that Comprehend Medical; generated for the job. The
|
314
|
+
# `StartPHIDetectionJob` operation returns this identifier in its
|
300
315
|
# response.
|
301
316
|
# @return [String]
|
302
317
|
#
|
@@ -355,6 +370,39 @@ module Aws::ComprehendMedical
|
|
355
370
|
include Aws::Structure
|
356
371
|
end
|
357
372
|
|
373
|
+
# @note When making an API call, you may pass DescribeSNOMEDCTInferenceJobRequest
|
374
|
+
# data as a hash:
|
375
|
+
#
|
376
|
+
# {
|
377
|
+
# job_id: "JobId", # required
|
378
|
+
# }
|
379
|
+
#
|
380
|
+
# @!attribute [rw] job_id
|
381
|
+
# The identifier that Amazon Comprehend Medical generated for the job.
|
382
|
+
# The StartSNOMEDCTInferenceJob operation returns this identifier in
|
383
|
+
# its response.
|
384
|
+
# @return [String]
|
385
|
+
#
|
386
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeSNOMEDCTInferenceJobRequest AWS API Documentation
|
387
|
+
#
|
388
|
+
class DescribeSNOMEDCTInferenceJobRequest < Struct.new(
|
389
|
+
:job_id)
|
390
|
+
SENSITIVE = []
|
391
|
+
include Aws::Structure
|
392
|
+
end
|
393
|
+
|
394
|
+
# @!attribute [rw] comprehend_medical_async_job_properties
|
395
|
+
# Provides information about a detection job.
|
396
|
+
# @return [Types::ComprehendMedicalAsyncJobProperties]
|
397
|
+
#
|
398
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeSNOMEDCTInferenceJobResponse AWS API Documentation
|
399
|
+
#
|
400
|
+
class DescribeSNOMEDCTInferenceJobResponse < Struct.new(
|
401
|
+
:comprehend_medical_async_job_properties)
|
402
|
+
SENSITIVE = []
|
403
|
+
include Aws::Structure
|
404
|
+
end
|
405
|
+
|
358
406
|
# @note When making an API call, you may pass DetectEntitiesRequest
|
359
407
|
# data as a hash:
|
360
408
|
#
|
@@ -380,9 +428,9 @@ module Aws::ComprehendMedical
|
|
380
428
|
# The collection of medical entities extracted from the input text and
|
381
429
|
# their associated information. For each entity, the response provides
|
382
430
|
# the entity text, the entity category, where the entity text begins
|
383
|
-
# and ends, and the level of confidence that
|
384
|
-
#
|
385
|
-
#
|
431
|
+
# and ends, and the level of confidence that Comprehend Medical; has
|
432
|
+
# in the detection and analysis. Attributes and traits of the entity
|
433
|
+
# are also returned.
|
386
434
|
# @return [Array<Types::Entity>]
|
387
435
|
#
|
388
436
|
# @!attribute [rw] unmapped_attributes
|
@@ -494,8 +542,8 @@ module Aws::ComprehendMedical
|
|
494
542
|
# The collection of PHI entities extracted from the input text and
|
495
543
|
# their associated information. For each entity, the response provides
|
496
544
|
# the entity text, the entity category, where the entity text begins
|
497
|
-
# and ends, and the level of confidence that
|
498
|
-
#
|
545
|
+
# and ends, and the level of confidence that Comprehend Medical; has
|
546
|
+
# in its detection.
|
499
547
|
# @return [Array<Types::Entity>]
|
500
548
|
#
|
501
549
|
# @!attribute [rw] pagination_token
|
@@ -540,8 +588,8 @@ module Aws::ComprehendMedical
|
|
540
588
|
# @return [Integer]
|
541
589
|
#
|
542
590
|
# @!attribute [rw] score
|
543
|
-
# The level of confidence that
|
544
|
-
#
|
591
|
+
# The level of confidence that Comprehend Medical; has in the accuracy
|
592
|
+
# of the detection.
|
545
593
|
# @return [Float]
|
546
594
|
#
|
547
595
|
# @!attribute [rw] text
|
@@ -767,7 +815,7 @@ module Aws::ComprehendMedical
|
|
767
815
|
# @return [String]
|
768
816
|
#
|
769
817
|
# @!attribute [rw] score
|
770
|
-
# The level of confidence that
|
818
|
+
# The level of confidence that Comprehend Medical; has that the
|
771
819
|
# segment of text is correctly recognized as a trait.
|
772
820
|
# @return [Float]
|
773
821
|
#
|
@@ -876,6 +924,67 @@ module Aws::ComprehendMedical
|
|
876
924
|
include Aws::Structure
|
877
925
|
end
|
878
926
|
|
927
|
+
# @note When making an API call, you may pass InferSNOMEDCTRequest
|
928
|
+
# data as a hash:
|
929
|
+
#
|
930
|
+
# {
|
931
|
+
# text: "OntologyLinkingBoundedLengthString", # required
|
932
|
+
# }
|
933
|
+
#
|
934
|
+
# @!attribute [rw] text
|
935
|
+
# The input text to be analyzed using InferSNOMEDCT. The text should
|
936
|
+
# be a string with 1 to 10000 characters.
|
937
|
+
# @return [String]
|
938
|
+
#
|
939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferSNOMEDCTRequest AWS API Documentation
|
940
|
+
#
|
941
|
+
class InferSNOMEDCTRequest < Struct.new(
|
942
|
+
:text)
|
943
|
+
SENSITIVE = []
|
944
|
+
include Aws::Structure
|
945
|
+
end
|
946
|
+
|
947
|
+
# @!attribute [rw] entities
|
948
|
+
# The collection of medical concept entities extracted from the input
|
949
|
+
# text and their associated information. For each entity, the response
|
950
|
+
# provides the entity text, the entity category, where the entity text
|
951
|
+
# begins and ends, and the level of confidence that Comprehend Medical
|
952
|
+
# has in the detection and analysis. Attributes and traits of the
|
953
|
+
# entity are also returned.
|
954
|
+
# @return [Array<Types::SNOMEDCTEntity>]
|
955
|
+
#
|
956
|
+
# @!attribute [rw] pagination_token
|
957
|
+
# If the result of the request is truncated, the pagination token can
|
958
|
+
# be used to fetch the next page of entities.
|
959
|
+
# @return [String]
|
960
|
+
#
|
961
|
+
# @!attribute [rw] model_version
|
962
|
+
# The version of the model used to analyze the documents, in the
|
963
|
+
# format n.n.n You can use this information to track the model used
|
964
|
+
# for a particular batch of documents.
|
965
|
+
# @return [String]
|
966
|
+
#
|
967
|
+
# @!attribute [rw] snomedct_details
|
968
|
+
# The details of the SNOMED-CT revision, including the edition,
|
969
|
+
# language, and version date.
|
970
|
+
# @return [Types::SNOMEDCTDetails]
|
971
|
+
#
|
972
|
+
# @!attribute [rw] characters
|
973
|
+
# The number of characters in the input request documentation.
|
974
|
+
# @return [Types::Characters]
|
975
|
+
#
|
976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferSNOMEDCTResponse AWS API Documentation
|
977
|
+
#
|
978
|
+
class InferSNOMEDCTResponse < Struct.new(
|
979
|
+
:entities,
|
980
|
+
:pagination_token,
|
981
|
+
:model_version,
|
982
|
+
:snomedct_details,
|
983
|
+
:characters)
|
984
|
+
SENSITIVE = []
|
985
|
+
include Aws::Structure
|
986
|
+
end
|
987
|
+
|
879
988
|
# The input properties for an entities detection job. This includes the
|
880
989
|
# name of the S3 bucket and the path to the files to be analyzed.
|
881
990
|
#
|
@@ -1173,6 +1282,60 @@ module Aws::ComprehendMedical
|
|
1173
1282
|
include Aws::Structure
|
1174
1283
|
end
|
1175
1284
|
|
1285
|
+
# @note When making an API call, you may pass ListSNOMEDCTInferenceJobsRequest
|
1286
|
+
# data as a hash:
|
1287
|
+
#
|
1288
|
+
# {
|
1289
|
+
# filter: {
|
1290
|
+
# job_name: "JobName",
|
1291
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
|
1292
|
+
# submit_time_before: Time.now,
|
1293
|
+
# submit_time_after: Time.now,
|
1294
|
+
# },
|
1295
|
+
# next_token: "String",
|
1296
|
+
# max_results: 1,
|
1297
|
+
# }
|
1298
|
+
#
|
1299
|
+
# @!attribute [rw] filter
|
1300
|
+
# Provides information for filtering a list of detection jobs.
|
1301
|
+
# @return [Types::ComprehendMedicalAsyncJobFilter]
|
1302
|
+
#
|
1303
|
+
# @!attribute [rw] next_token
|
1304
|
+
# Identifies the next page of InferSNOMEDCT results to return.
|
1305
|
+
# @return [String]
|
1306
|
+
#
|
1307
|
+
# @!attribute [rw] max_results
|
1308
|
+
# The maximum number of results to return in each page. The default is
|
1309
|
+
# 100.
|
1310
|
+
# @return [Integer]
|
1311
|
+
#
|
1312
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListSNOMEDCTInferenceJobsRequest AWS API Documentation
|
1313
|
+
#
|
1314
|
+
class ListSNOMEDCTInferenceJobsRequest < Struct.new(
|
1315
|
+
:filter,
|
1316
|
+
:next_token,
|
1317
|
+
:max_results)
|
1318
|
+
SENSITIVE = []
|
1319
|
+
include Aws::Structure
|
1320
|
+
end
|
1321
|
+
|
1322
|
+
# @!attribute [rw] comprehend_medical_async_job_properties_list
|
1323
|
+
# A list containing the properties of each job that is returned.
|
1324
|
+
# @return [Array<Types::ComprehendMedicalAsyncJobProperties>]
|
1325
|
+
#
|
1326
|
+
# @!attribute [rw] next_token
|
1327
|
+
# Identifies the next page of results to return.
|
1328
|
+
# @return [String]
|
1329
|
+
#
|
1330
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListSNOMEDCTInferenceJobsResponse AWS API Documentation
|
1331
|
+
#
|
1332
|
+
class ListSNOMEDCTInferenceJobsResponse < Struct.new(
|
1333
|
+
:comprehend_medical_async_job_properties_list,
|
1334
|
+
:next_token)
|
1335
|
+
SENSITIVE = []
|
1336
|
+
include Aws::Structure
|
1337
|
+
end
|
1338
|
+
|
1176
1339
|
# The output properties for a detection job.
|
1177
1340
|
#
|
1178
1341
|
# @note When making an API call, you may pass OutputDataConfig
|
@@ -1192,10 +1355,9 @@ module Aws::ComprehendMedical
|
|
1192
1355
|
# @return [String]
|
1193
1356
|
#
|
1194
1357
|
# @!attribute [rw] s3_key
|
1195
|
-
# The path to the output data files in the S3 bucket.
|
1196
|
-
#
|
1197
|
-
#
|
1198
|
-
# another.
|
1358
|
+
# The path to the output data files in the S3 bucket. Comprehend
|
1359
|
+
# Medical; creates an output directory using the job ID so that the
|
1360
|
+
# output from one job does not overwrite the output of another.
|
1199
1361
|
# @return [String]
|
1200
1362
|
#
|
1201
1363
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/OutputDataConfig AWS API Documentation
|
@@ -1408,8 +1570,239 @@ module Aws::ComprehendMedical
|
|
1408
1570
|
include Aws::Structure
|
1409
1571
|
end
|
1410
1572
|
|
1411
|
-
# The
|
1412
|
-
#
|
1573
|
+
# The extracted attributes that relate to an entity. An extracted
|
1574
|
+
# segment of the text that is an attribute of an entity, or otherwise
|
1575
|
+
# related to an entity, such as the dosage of a medication taken.
|
1576
|
+
#
|
1577
|
+
# @!attribute [rw] category
|
1578
|
+
# The category of the detected attribute. Possible categories include
|
1579
|
+
# MEDICAL\_CONDITION, ANATOMY, and TEST\_TREATMENT\_PROCEDURE.
|
1580
|
+
# @return [String]
|
1581
|
+
#
|
1582
|
+
# @!attribute [rw] type
|
1583
|
+
# The type of attribute. Possible types include DX\_NAME, ACUITY,
|
1584
|
+
# DIRECTION, SYSTEM\_ORGAN\_SITE,TEST\_NAME, TEST\_VALUE, TEST\_UNIT,
|
1585
|
+
# PROCEDURE\_NAME, and TREATMENT\_NAME.
|
1586
|
+
# @return [String]
|
1587
|
+
#
|
1588
|
+
# @!attribute [rw] score
|
1589
|
+
# The level of confidence that Comprehend Medical has that the segment
|
1590
|
+
# of text is correctly recognized as an attribute.
|
1591
|
+
# @return [Float]
|
1592
|
+
#
|
1593
|
+
# @!attribute [rw] relationship_score
|
1594
|
+
# The level of confidence that Comprehend Medical has that this
|
1595
|
+
# attribute is correctly related to this entity.
|
1596
|
+
# @return [Float]
|
1597
|
+
#
|
1598
|
+
# @!attribute [rw] relationship_type
|
1599
|
+
# The type of relationship that exists between the entity and the
|
1600
|
+
# related attribute.
|
1601
|
+
# @return [String]
|
1602
|
+
#
|
1603
|
+
# @!attribute [rw] id
|
1604
|
+
# The numeric identifier for this attribute. This is a monotonically
|
1605
|
+
# increasing id unique within this response rather than a global
|
1606
|
+
# unique identifier.
|
1607
|
+
# @return [Integer]
|
1608
|
+
#
|
1609
|
+
# @!attribute [rw] begin_offset
|
1610
|
+
# The 0-based character offset in the input text that shows where the
|
1611
|
+
# attribute begins. The offset returns the UTF-8 code point in the
|
1612
|
+
# string.
|
1613
|
+
# @return [Integer]
|
1614
|
+
#
|
1615
|
+
# @!attribute [rw] end_offset
|
1616
|
+
# The 0-based character offset in the input text that shows where the
|
1617
|
+
# attribute ends. The offset returns the UTF-8 code point in the
|
1618
|
+
# string.
|
1619
|
+
# @return [Integer]
|
1620
|
+
#
|
1621
|
+
# @!attribute [rw] text
|
1622
|
+
# The segment of input text extracted as this attribute.
|
1623
|
+
# @return [String]
|
1624
|
+
#
|
1625
|
+
# @!attribute [rw] traits
|
1626
|
+
# Contextual information for an attribute. Examples include signs,
|
1627
|
+
# symptoms, diagnosis, and negation.
|
1628
|
+
# @return [Array<Types::SNOMEDCTTrait>]
|
1629
|
+
#
|
1630
|
+
# @!attribute [rw] snomedct_concepts
|
1631
|
+
# The SNOMED-CT concepts specific to an attribute, along with a score
|
1632
|
+
# indicating the likelihood of the match.
|
1633
|
+
# @return [Array<Types::SNOMEDCTConcept>]
|
1634
|
+
#
|
1635
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/SNOMEDCTAttribute AWS API Documentation
|
1636
|
+
#
|
1637
|
+
class SNOMEDCTAttribute < Struct.new(
|
1638
|
+
:category,
|
1639
|
+
:type,
|
1640
|
+
:score,
|
1641
|
+
:relationship_score,
|
1642
|
+
:relationship_type,
|
1643
|
+
:id,
|
1644
|
+
:begin_offset,
|
1645
|
+
:end_offset,
|
1646
|
+
:text,
|
1647
|
+
:traits,
|
1648
|
+
:snomedct_concepts)
|
1649
|
+
SENSITIVE = []
|
1650
|
+
include Aws::Structure
|
1651
|
+
end
|
1652
|
+
|
1653
|
+
# The SNOMED-CT concepts that the entity could refer to, along with a
|
1654
|
+
# score indicating the likelihood of the match.
|
1655
|
+
#
|
1656
|
+
# @!attribute [rw] description
|
1657
|
+
# The description of the SNOMED-CT concept.
|
1658
|
+
# @return [String]
|
1659
|
+
#
|
1660
|
+
# @!attribute [rw] code
|
1661
|
+
# The numeric ID for the SNOMED-CT concept.
|
1662
|
+
# @return [String]
|
1663
|
+
#
|
1664
|
+
# @!attribute [rw] score
|
1665
|
+
# The level of confidence Comprehend Medical has that the entity
|
1666
|
+
# should be linked to the identified SNOMED-CT concept.
|
1667
|
+
# @return [Float]
|
1668
|
+
#
|
1669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/SNOMEDCTConcept AWS API Documentation
|
1670
|
+
#
|
1671
|
+
class SNOMEDCTConcept < Struct.new(
|
1672
|
+
:description,
|
1673
|
+
:code,
|
1674
|
+
:score)
|
1675
|
+
SENSITIVE = []
|
1676
|
+
include Aws::Structure
|
1677
|
+
end
|
1678
|
+
|
1679
|
+
# The information about the revision of the SNOMED-CT ontology in the
|
1680
|
+
# response. Specifically, the details include the SNOMED-CT edition,
|
1681
|
+
# language, and version date.
|
1682
|
+
#
|
1683
|
+
# @!attribute [rw] edition
|
1684
|
+
# The edition of SNOMED-CT used. The edition used for the
|
1685
|
+
# InferSNOMEDCT editions is the US edition.
|
1686
|
+
# @return [String]
|
1687
|
+
#
|
1688
|
+
# @!attribute [rw] language
|
1689
|
+
# The language used in the SNOMED-CT ontology. All Amazon Comprehend
|
1690
|
+
# Medical operations are US English (en).
|
1691
|
+
# @return [String]
|
1692
|
+
#
|
1693
|
+
# @!attribute [rw] version_date
|
1694
|
+
# The version date of the SNOMED-CT ontology used.
|
1695
|
+
# @return [String]
|
1696
|
+
#
|
1697
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/SNOMEDCTDetails AWS API Documentation
|
1698
|
+
#
|
1699
|
+
class SNOMEDCTDetails < Struct.new(
|
1700
|
+
:edition,
|
1701
|
+
:language,
|
1702
|
+
:version_date)
|
1703
|
+
SENSITIVE = []
|
1704
|
+
include Aws::Structure
|
1705
|
+
end
|
1706
|
+
|
1707
|
+
# The collection of medical entities extracted from the input text and
|
1708
|
+
# their associated information. For each entity, the response provides
|
1709
|
+
# the entity text, the entity category, where the entity text begins and
|
1710
|
+
# ends, and the level of confidence that Comprehend Medical has in the
|
1711
|
+
# detection and analysis. Attributes and traits of the entity are also
|
1712
|
+
# returned.
|
1713
|
+
#
|
1714
|
+
# @!attribute [rw] id
|
1715
|
+
# The numeric identifier for the entity. This is a monotonically
|
1716
|
+
# increasing id unique within this response rather than a global
|
1717
|
+
# unique identifier.
|
1718
|
+
# @return [Integer]
|
1719
|
+
#
|
1720
|
+
# @!attribute [rw] text
|
1721
|
+
# The segment of input text extracted as this entity.
|
1722
|
+
# @return [String]
|
1723
|
+
#
|
1724
|
+
# @!attribute [rw] category
|
1725
|
+
# The category of the detected entity. Possible categories are
|
1726
|
+
# MEDICAL\_CONDITION, ANATOMY, or TEST\_TREATMENT\_PROCEDURE.
|
1727
|
+
# @return [String]
|
1728
|
+
#
|
1729
|
+
# @!attribute [rw] type
|
1730
|
+
# Describes the specific type of entity with category of entities.
|
1731
|
+
# Possible types include DX\_NAME, ACUITY, DIRECTION,
|
1732
|
+
# SYSTEM\_ORGAN\_SITE, TEST\_NAME, TEST\_VALUE, TEST\_UNIT,
|
1733
|
+
# PROCEDURE\_NAME, or TREATMENT\_NAME.
|
1734
|
+
# @return [String]
|
1735
|
+
#
|
1736
|
+
# @!attribute [rw] score
|
1737
|
+
# The level of confidence that Comprehend Medical has in the accuracy
|
1738
|
+
# of the detected entity.
|
1739
|
+
# @return [Float]
|
1740
|
+
#
|
1741
|
+
# @!attribute [rw] begin_offset
|
1742
|
+
# The 0-based character offset in the input text that shows where the
|
1743
|
+
# entity begins. The offset returns the UTF-8 code point in the
|
1744
|
+
# string.
|
1745
|
+
# @return [Integer]
|
1746
|
+
#
|
1747
|
+
# @!attribute [rw] end_offset
|
1748
|
+
# The 0-based character offset in the input text that shows where the
|
1749
|
+
# entity ends. The offset returns the UTF-8 code point in the string.
|
1750
|
+
# @return [Integer]
|
1751
|
+
#
|
1752
|
+
# @!attribute [rw] attributes
|
1753
|
+
# An extracted segment of the text that is an attribute of an entity,
|
1754
|
+
# or otherwise related to an entity, such as the dosage of a
|
1755
|
+
# medication taken.
|
1756
|
+
# @return [Array<Types::SNOMEDCTAttribute>]
|
1757
|
+
#
|
1758
|
+
# @!attribute [rw] traits
|
1759
|
+
# Contextual information for the entity.
|
1760
|
+
# @return [Array<Types::SNOMEDCTTrait>]
|
1761
|
+
#
|
1762
|
+
# @!attribute [rw] snomedct_concepts
|
1763
|
+
# The SNOMED concepts that the entity could refer to, along with a
|
1764
|
+
# score indicating the likelihood of the match.
|
1765
|
+
# @return [Array<Types::SNOMEDCTConcept>]
|
1766
|
+
#
|
1767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/SNOMEDCTEntity AWS API Documentation
|
1768
|
+
#
|
1769
|
+
class SNOMEDCTEntity < Struct.new(
|
1770
|
+
:id,
|
1771
|
+
:text,
|
1772
|
+
:category,
|
1773
|
+
:type,
|
1774
|
+
:score,
|
1775
|
+
:begin_offset,
|
1776
|
+
:end_offset,
|
1777
|
+
:attributes,
|
1778
|
+
:traits,
|
1779
|
+
:snomedct_concepts)
|
1780
|
+
SENSITIVE = []
|
1781
|
+
include Aws::Structure
|
1782
|
+
end
|
1783
|
+
|
1784
|
+
# Contextual information for an entity.
|
1785
|
+
#
|
1786
|
+
# @!attribute [rw] name
|
1787
|
+
# The name or contextual description of a detected trait.
|
1788
|
+
# @return [String]
|
1789
|
+
#
|
1790
|
+
# @!attribute [rw] score
|
1791
|
+
# The level of confidence that Comprehend Medical has in the accuracy
|
1792
|
+
# of a detected trait.
|
1793
|
+
# @return [Float]
|
1794
|
+
#
|
1795
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/SNOMEDCTTrait AWS API Documentation
|
1796
|
+
#
|
1797
|
+
class SNOMEDCTTrait < Struct.new(
|
1798
|
+
:name,
|
1799
|
+
:score)
|
1800
|
+
SENSITIVE = []
|
1801
|
+
include Aws::Structure
|
1802
|
+
end
|
1803
|
+
|
1804
|
+
# The Comprehend Medical; service is temporarily unavailable. Please
|
1805
|
+
# wait and then retry your request.
|
1413
1806
|
#
|
1414
1807
|
# @!attribute [rw] message
|
1415
1808
|
# @return [String]
|
@@ -1442,18 +1835,20 @@ module Aws::ComprehendMedical
|
|
1442
1835
|
# }
|
1443
1836
|
#
|
1444
1837
|
# @!attribute [rw] input_data_config
|
1445
|
-
#
|
1838
|
+
# The input configuration that specifies the format and location of
|
1839
|
+
# the input data for the job.
|
1446
1840
|
# @return [Types::InputDataConfig]
|
1447
1841
|
#
|
1448
1842
|
# @!attribute [rw] output_data_config
|
1449
|
-
#
|
1843
|
+
# The output configuration that specifies where to send the output
|
1844
|
+
# files.
|
1450
1845
|
# @return [Types::OutputDataConfig]
|
1451
1846
|
#
|
1452
1847
|
# @!attribute [rw] data_access_role_arn
|
1453
1848
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1454
|
-
# Management (IAM) role that grants
|
1455
|
-
#
|
1456
|
-
#
|
1849
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
1850
|
+
# your input data. For more information, see [ Role-Based Permissions
|
1851
|
+
# Required for Asynchronous Operations][1].
|
1457
1852
|
#
|
1458
1853
|
#
|
1459
1854
|
#
|
@@ -1466,7 +1861,7 @@ module Aws::ComprehendMedical
|
|
1466
1861
|
#
|
1467
1862
|
# @!attribute [rw] client_request_token
|
1468
1863
|
# A unique identifier for the request. If you don't set the client
|
1469
|
-
# request token,
|
1864
|
+
# request token, Comprehend Medical; generates one for you.
|
1470
1865
|
#
|
1471
1866
|
# **A suitable default value is auto-generated.** You should normally
|
1472
1867
|
# not need to pass this option.
|
@@ -1479,7 +1874,8 @@ module Aws::ComprehendMedical
|
|
1479
1874
|
#
|
1480
1875
|
# @!attribute [rw] language_code
|
1481
1876
|
# The language of the input documents. All documents must be in the
|
1482
|
-
# same language.
|
1877
|
+
# same language. Comprehend Medical; processes files in US English
|
1878
|
+
# (en).
|
1483
1879
|
# @return [String]
|
1484
1880
|
#
|
1485
1881
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartEntitiesDetectionV2JobRequest AWS API Documentation
|
@@ -1539,9 +1935,9 @@ module Aws::ComprehendMedical
|
|
1539
1935
|
#
|
1540
1936
|
# @!attribute [rw] data_access_role_arn
|
1541
1937
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1542
|
-
# Management (IAM) role that grants
|
1543
|
-
#
|
1544
|
-
#
|
1938
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
1939
|
+
# your input data. For more information, see [ Role-Based Permissions
|
1940
|
+
# Required for Asynchronous Operations][1].
|
1545
1941
|
#
|
1546
1942
|
#
|
1547
1943
|
#
|
@@ -1554,7 +1950,7 @@ module Aws::ComprehendMedical
|
|
1554
1950
|
#
|
1555
1951
|
# @!attribute [rw] client_request_token
|
1556
1952
|
# A unique identifier for the request. If you don't set the client
|
1557
|
-
# request token,
|
1953
|
+
# request token, Comprehend Medical; generates one.
|
1558
1954
|
#
|
1559
1955
|
# **A suitable default value is auto-generated.** You should normally
|
1560
1956
|
# not need to pass this option.
|
@@ -1626,9 +2022,9 @@ module Aws::ComprehendMedical
|
|
1626
2022
|
#
|
1627
2023
|
# @!attribute [rw] data_access_role_arn
|
1628
2024
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1629
|
-
# Management (IAM) role that grants
|
1630
|
-
#
|
1631
|
-
#
|
2025
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
2026
|
+
# your input data. For more information, see [ Role-Based Permissions
|
2027
|
+
# Required for Asynchronous Operations][1].
|
1632
2028
|
#
|
1633
2029
|
#
|
1634
2030
|
#
|
@@ -1641,7 +2037,7 @@ module Aws::ComprehendMedical
|
|
1641
2037
|
#
|
1642
2038
|
# @!attribute [rw] client_request_token
|
1643
2039
|
# A unique identifier for the request. If you don't set the client
|
1644
|
-
# request token,
|
2040
|
+
# request token, Comprehend Medical; generates one.
|
1645
2041
|
#
|
1646
2042
|
# **A suitable default value is auto-generated.** You should normally
|
1647
2043
|
# not need to pass this option.
|
@@ -1713,9 +2109,9 @@ module Aws::ComprehendMedical
|
|
1713
2109
|
#
|
1714
2110
|
# @!attribute [rw] data_access_role_arn
|
1715
2111
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1716
|
-
# Management (IAM) role that grants
|
1717
|
-
#
|
1718
|
-
#
|
2112
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
2113
|
+
# your input data. For more information, see [ Role-Based Permissions
|
2114
|
+
# Required for Asynchronous Operations][1].
|
1719
2115
|
#
|
1720
2116
|
#
|
1721
2117
|
#
|
@@ -1728,7 +2124,7 @@ module Aws::ComprehendMedical
|
|
1728
2124
|
#
|
1729
2125
|
# @!attribute [rw] client_request_token
|
1730
2126
|
# A unique identifier for the request. If you don't set the client
|
1731
|
-
# request token,
|
2127
|
+
# request token, Comprehend Medical; generates one.
|
1732
2128
|
#
|
1733
2129
|
# **A suitable default value is auto-generated.** You should normally
|
1734
2130
|
# not need to pass this option.
|
@@ -1770,6 +2166,89 @@ module Aws::ComprehendMedical
|
|
1770
2166
|
include Aws::Structure
|
1771
2167
|
end
|
1772
2168
|
|
2169
|
+
# @note When making an API call, you may pass StartSNOMEDCTInferenceJobRequest
|
2170
|
+
# data as a hash:
|
2171
|
+
#
|
2172
|
+
# {
|
2173
|
+
# input_data_config: { # required
|
2174
|
+
# s3_bucket: "S3Bucket", # required
|
2175
|
+
# s3_key: "S3Key",
|
2176
|
+
# },
|
2177
|
+
# output_data_config: { # required
|
2178
|
+
# s3_bucket: "S3Bucket", # required
|
2179
|
+
# s3_key: "S3Key",
|
2180
|
+
# },
|
2181
|
+
# data_access_role_arn: "IamRoleArn", # required
|
2182
|
+
# job_name: "JobName",
|
2183
|
+
# client_request_token: "ClientRequestTokenString",
|
2184
|
+
# kms_key: "KMSKey",
|
2185
|
+
# language_code: "en", # required, accepts en
|
2186
|
+
# }
|
2187
|
+
#
|
2188
|
+
# @!attribute [rw] input_data_config
|
2189
|
+
# The input properties for an entities detection job. This includes
|
2190
|
+
# the name of the S3 bucket and the path to the files to be analyzed.
|
2191
|
+
# @return [Types::InputDataConfig]
|
2192
|
+
#
|
2193
|
+
# @!attribute [rw] output_data_config
|
2194
|
+
# The output properties for a detection job.
|
2195
|
+
# @return [Types::OutputDataConfig]
|
2196
|
+
#
|
2197
|
+
# @!attribute [rw] data_access_role_arn
|
2198
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
2199
|
+
# Management (IAM) role that grants Amazon Comprehend Medical read
|
2200
|
+
# access to your input data.
|
2201
|
+
# @return [String]
|
2202
|
+
#
|
2203
|
+
# @!attribute [rw] job_name
|
2204
|
+
# The user generated name the asynchronous InferSNOMEDCT job.
|
2205
|
+
# @return [String]
|
2206
|
+
#
|
2207
|
+
# @!attribute [rw] client_request_token
|
2208
|
+
# A unique identifier for the request. If you don't set the client
|
2209
|
+
# request token, Amazon Comprehend Medical generates one.
|
2210
|
+
#
|
2211
|
+
# **A suitable default value is auto-generated.** You should normally
|
2212
|
+
# not need to pass this option.
|
2213
|
+
# @return [String]
|
2214
|
+
#
|
2215
|
+
# @!attribute [rw] kms_key
|
2216
|
+
# An AWS Key Management Service key used to encrypt your output files.
|
2217
|
+
# If you do not specify a key, the files are written in plain text.
|
2218
|
+
# @return [String]
|
2219
|
+
#
|
2220
|
+
# @!attribute [rw] language_code
|
2221
|
+
# The language of the input documents. All documents must be in the
|
2222
|
+
# same language.
|
2223
|
+
# @return [String]
|
2224
|
+
#
|
2225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartSNOMEDCTInferenceJobRequest AWS API Documentation
|
2226
|
+
#
|
2227
|
+
class StartSNOMEDCTInferenceJobRequest < Struct.new(
|
2228
|
+
:input_data_config,
|
2229
|
+
:output_data_config,
|
2230
|
+
:data_access_role_arn,
|
2231
|
+
:job_name,
|
2232
|
+
:client_request_token,
|
2233
|
+
:kms_key,
|
2234
|
+
:language_code)
|
2235
|
+
SENSITIVE = []
|
2236
|
+
include Aws::Structure
|
2237
|
+
end
|
2238
|
+
|
2239
|
+
# @!attribute [rw] job_id
|
2240
|
+
# The identifier generated for the job. To get the status of a job,
|
2241
|
+
# use this identifier with the StartSNOMEDCTInferenceJob operation.
|
2242
|
+
# @return [String]
|
2243
|
+
#
|
2244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartSNOMEDCTInferenceJobResponse AWS API Documentation
|
2245
|
+
#
|
2246
|
+
class StartSNOMEDCTInferenceJobResponse < Struct.new(
|
2247
|
+
:job_id)
|
2248
|
+
SENSITIVE = []
|
2249
|
+
include Aws::Structure
|
2250
|
+
end
|
2251
|
+
|
1773
2252
|
# @note When making an API call, you may pass StopEntitiesDetectionV2JobRequest
|
1774
2253
|
# data as a hash:
|
1775
2254
|
#
|
@@ -1897,6 +2376,38 @@ module Aws::ComprehendMedical
|
|
1897
2376
|
include Aws::Structure
|
1898
2377
|
end
|
1899
2378
|
|
2379
|
+
# @note When making an API call, you may pass StopSNOMEDCTInferenceJobRequest
|
2380
|
+
# data as a hash:
|
2381
|
+
#
|
2382
|
+
# {
|
2383
|
+
# job_id: "JobId", # required
|
2384
|
+
# }
|
2385
|
+
#
|
2386
|
+
# @!attribute [rw] job_id
|
2387
|
+
# The job id of the asynchronous InferSNOMEDCT job to be stopped.
|
2388
|
+
# @return [String]
|
2389
|
+
#
|
2390
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopSNOMEDCTInferenceJobRequest AWS API Documentation
|
2391
|
+
#
|
2392
|
+
class StopSNOMEDCTInferenceJobRequest < Struct.new(
|
2393
|
+
:job_id)
|
2394
|
+
SENSITIVE = []
|
2395
|
+
include Aws::Structure
|
2396
|
+
end
|
2397
|
+
|
2398
|
+
# @!attribute [rw] job_id
|
2399
|
+
# The identifier generated for the job. To get the status of job, use
|
2400
|
+
# this identifier with the DescribeSNOMEDCTInferenceJob operation.
|
2401
|
+
# @return [String]
|
2402
|
+
#
|
2403
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopSNOMEDCTInferenceJobResponse AWS API Documentation
|
2404
|
+
#
|
2405
|
+
class StopSNOMEDCTInferenceJobResponse < Struct.new(
|
2406
|
+
:job_id)
|
2407
|
+
SENSITIVE = []
|
2408
|
+
include Aws::Structure
|
2409
|
+
end
|
2410
|
+
|
1900
2411
|
# The size of the text you submitted exceeds the size limit. Reduce the
|
1901
2412
|
# size of the text or use a smaller document and then retry your
|
1902
2413
|
# request.
|
@@ -1934,8 +2445,8 @@ module Aws::ComprehendMedical
|
|
1934
2445
|
# @return [String]
|
1935
2446
|
#
|
1936
2447
|
# @!attribute [rw] score
|
1937
|
-
# The level of confidence that
|
1938
|
-
#
|
2448
|
+
# The level of confidence that Comprehend Medical; has in the accuracy
|
2449
|
+
# of this trait.
|
1939
2450
|
# @return [Float]
|
1940
2451
|
#
|
1941
2452
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/Trait AWS API Documentation
|
@@ -1947,12 +2458,12 @@ module Aws::ComprehendMedical
|
|
1947
2458
|
include Aws::Structure
|
1948
2459
|
end
|
1949
2460
|
|
1950
|
-
# An attribute that
|
1951
|
-
# entity.
|
2461
|
+
# An attribute that was extracted, but Comprehend Medical; was unable to
|
2462
|
+
# relate to an entity.
|
1952
2463
|
#
|
1953
2464
|
# @!attribute [rw] type
|
1954
|
-
# The type of the attribute, could be one of the following
|
1955
|
-
# "MEDICATION", "MEDICAL\_CONDITION", "ANATOMY",
|
2465
|
+
# The type of the unmapped attribute, could be one of the following
|
2466
|
+
# values: "MEDICATION", "MEDICAL\_CONDITION", "ANATOMY",
|
1956
2467
|
# "TEST\_AND\_TREATMENT\_PROCEDURE" or
|
1957
2468
|
# "PROTECTED\_HEALTH\_INFORMATION".
|
1958
2469
|
# @return [String]
|