aws-sdk-comprehendmedical 1.12.0 → 1.17.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 +5 -5
- data/lib/aws-sdk-comprehendmedical.rb +7 -4
- data/lib/aws-sdk-comprehendmedical/client.rb +517 -32
- data/lib/aws-sdk-comprehendmedical/client_api.rb +179 -0
- data/lib/aws-sdk-comprehendmedical/errors.rb +30 -8
- data/lib/aws-sdk-comprehendmedical/resource.rb +1 -0
- data/lib/aws-sdk-comprehendmedical/types.rb +416 -1
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: b11b05d3f186f13fa09cca19271f6edd2c250d96a49b1111f1f9aac044f65dc0
|
4
|
+
data.tar.gz: 050b4955cc8df51b2fef6fe1f6513810702f1fc8dd67963cec412f93f032f6b1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 740b0cf5b7687a1c2ecb50d288455872d578e9f7bded4138dbd998f611555f9b19abf9346e83ea6b8f3f340a70b8cb278552bd76b55a22c8fa07056e5297d2a9
|
7
|
+
data.tar.gz: 1a219aa44ec6c811a6933bdf90ca485efc4f2d49adccc4ce6bac695bcb924b129dc0cd3676f30b07f1d28b11256ebe241088e3106358e1abba4506a94f245940
|
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-comprehendmedical/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# comprehend_medical = Aws::ComprehendMedical::Client.new
|
28
|
+
# resp = comprehend_medical.describe_entities_detection_v2_job(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from AWS Comprehend Medical
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from AWS Comprehend Medical are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::ComprehendMedical::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all AWS Comprehend Medical API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-comprehendmedical/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::ComprehendMedical
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.17.0'
|
46
49
|
|
47
50
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:comprehendmedical)
|
31
31
|
|
32
32
|
module Aws::ComprehendMedical
|
33
|
+
# An API client for ComprehendMedical. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::ComprehendMedical::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::ComprehendMedical
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::ComprehendMedical
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::ComprehendMedical
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::ComprehendMedical
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::ComprehendMedical
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::ComprehendMedical
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::ComprehendMedical
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -219,16 +274,15 @@ module Aws::ComprehendMedical
|
|
219
274
|
# requests through. Formatted like 'http://proxy.com:123'.
|
220
275
|
#
|
221
276
|
# @option options [Float] :http_open_timeout (15) The number of
|
222
|
-
# seconds to wait when opening a HTTP session before
|
277
|
+
# seconds to wait when opening a HTTP session before raising a
|
223
278
|
# `Timeout::Error`.
|
224
279
|
#
|
225
280
|
# @option options [Integer] :http_read_timeout (60) The default
|
226
281
|
# number of seconds to wait for response data. This value can
|
227
|
-
# safely be set
|
228
|
-
# per-request on the session yeidled by {#session_for}.
|
282
|
+
# safely be set per-request on the session.
|
229
283
|
#
|
230
284
|
# @option options [Float] :http_idle_timeout (5) The number of
|
231
|
-
# seconds a connection is allowed to sit
|
285
|
+
# seconds a connection is allowed to sit idle before it is
|
232
286
|
# considered stale. Stale connections are closed and removed
|
233
287
|
# from the pool before making a request.
|
234
288
|
#
|
@@ -237,7 +291,7 @@ module Aws::ComprehendMedical
|
|
237
291
|
# request body. This option has no effect unless the request has
|
238
292
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
239
293
|
# disables this behaviour. This value can safely be set per
|
240
|
-
# request on the session
|
294
|
+
# request on the session.
|
241
295
|
#
|
242
296
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
243
297
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -310,6 +364,52 @@ module Aws::ComprehendMedical
|
|
310
364
|
req.send_request(options)
|
311
365
|
end
|
312
366
|
|
367
|
+
# Gets the properties associated with an InferICD10CM job. Use this
|
368
|
+
# operation to get the status of an inference job.
|
369
|
+
#
|
370
|
+
# @option params [required, String] :job_id
|
371
|
+
# The identifier that Amazon Comprehend Medical generated for the job.
|
372
|
+
# `The StartICD10CMInferenceJob` operation returns this identifier in
|
373
|
+
# its response.
|
374
|
+
#
|
375
|
+
# @return [Types::DescribeICD10CMInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
376
|
+
#
|
377
|
+
# * {Types::DescribeICD10CMInferenceJobResponse#comprehend_medical_async_job_properties #comprehend_medical_async_job_properties} => Types::ComprehendMedicalAsyncJobProperties
|
378
|
+
#
|
379
|
+
# @example Request syntax with placeholder values
|
380
|
+
#
|
381
|
+
# resp = client.describe_icd10cm_inference_job({
|
382
|
+
# job_id: "JobId", # required
|
383
|
+
# })
|
384
|
+
#
|
385
|
+
# @example Response structure
|
386
|
+
#
|
387
|
+
# resp.comprehend_medical_async_job_properties.job_id #=> String
|
388
|
+
# resp.comprehend_medical_async_job_properties.job_name #=> String
|
389
|
+
# resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
|
390
|
+
# resp.comprehend_medical_async_job_properties.message #=> String
|
391
|
+
# resp.comprehend_medical_async_job_properties.submit_time #=> Time
|
392
|
+
# resp.comprehend_medical_async_job_properties.end_time #=> Time
|
393
|
+
# resp.comprehend_medical_async_job_properties.expiration_time #=> Time
|
394
|
+
# resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
|
395
|
+
# resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
|
396
|
+
# resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
|
397
|
+
# resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
|
398
|
+
# resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
|
399
|
+
# resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
|
400
|
+
# resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
|
401
|
+
# resp.comprehend_medical_async_job_properties.kms_key #=> String
|
402
|
+
# resp.comprehend_medical_async_job_properties.model_version #=> String
|
403
|
+
#
|
404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeICD10CMInferenceJob AWS API Documentation
|
405
|
+
#
|
406
|
+
# @overload describe_icd10cm_inference_job(params = {})
|
407
|
+
# @param [Hash] params ({})
|
408
|
+
def describe_icd10cm_inference_job(params = {}, options = {})
|
409
|
+
req = build_request(:describe_icd10cm_inference_job, params)
|
410
|
+
req.send_request(options)
|
411
|
+
end
|
412
|
+
|
313
413
|
# Gets the properties associated with a protected health information
|
314
414
|
# (PHI) detection job. Use this operation to get the status of a
|
315
415
|
# detection job.
|
@@ -357,6 +457,52 @@ module Aws::ComprehendMedical
|
|
357
457
|
req.send_request(options)
|
358
458
|
end
|
359
459
|
|
460
|
+
# Gets the properties associated with an InferRxNorm job. Use this
|
461
|
+
# operation to get the status of an inference job.
|
462
|
+
#
|
463
|
+
# @option params [required, String] :job_id
|
464
|
+
# The identifier that Amazon Comprehend Medical generated for the job.
|
465
|
+
# The StartRxNormInferenceJob operation returns this identifier in its
|
466
|
+
# response.
|
467
|
+
#
|
468
|
+
# @return [Types::DescribeRxNormInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
469
|
+
#
|
470
|
+
# * {Types::DescribeRxNormInferenceJobResponse#comprehend_medical_async_job_properties #comprehend_medical_async_job_properties} => Types::ComprehendMedicalAsyncJobProperties
|
471
|
+
#
|
472
|
+
# @example Request syntax with placeholder values
|
473
|
+
#
|
474
|
+
# resp = client.describe_rx_norm_inference_job({
|
475
|
+
# job_id: "JobId", # required
|
476
|
+
# })
|
477
|
+
#
|
478
|
+
# @example Response structure
|
479
|
+
#
|
480
|
+
# resp.comprehend_medical_async_job_properties.job_id #=> String
|
481
|
+
# resp.comprehend_medical_async_job_properties.job_name #=> String
|
482
|
+
# resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
|
483
|
+
# resp.comprehend_medical_async_job_properties.message #=> String
|
484
|
+
# resp.comprehend_medical_async_job_properties.submit_time #=> Time
|
485
|
+
# resp.comprehend_medical_async_job_properties.end_time #=> Time
|
486
|
+
# resp.comprehend_medical_async_job_properties.expiration_time #=> Time
|
487
|
+
# resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
|
488
|
+
# resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
|
489
|
+
# resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
|
490
|
+
# resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
|
491
|
+
# resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
|
492
|
+
# resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
|
493
|
+
# resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
|
494
|
+
# resp.comprehend_medical_async_job_properties.kms_key #=> String
|
495
|
+
# resp.comprehend_medical_async_job_properties.model_version #=> String
|
496
|
+
#
|
497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeRxNormInferenceJob AWS API Documentation
|
498
|
+
#
|
499
|
+
# @overload describe_rx_norm_inference_job(params = {})
|
500
|
+
# @param [Hash] params ({})
|
501
|
+
def describe_rx_norm_inference_job(params = {}, options = {})
|
502
|
+
req = build_request(:describe_rx_norm_inference_job, params)
|
503
|
+
req.send_request(options)
|
504
|
+
end
|
505
|
+
|
360
506
|
# The `DetectEntities` operation is deprecated. You should use the
|
361
507
|
# DetectEntitiesV2 operation instead.
|
362
508
|
#
|
@@ -390,31 +536,35 @@ module Aws::ComprehendMedical
|
|
390
536
|
# resp.entities[0].end_offset #=> Integer
|
391
537
|
# resp.entities[0].score #=> Float
|
392
538
|
# resp.entities[0].text #=> String
|
393
|
-
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY"
|
394
|
-
# 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"
|
539
|
+
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
540
|
+
# 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"
|
395
541
|
# resp.entities[0].traits #=> Array
|
396
542
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
397
543
|
# resp.entities[0].traits[0].score #=> Float
|
398
544
|
# resp.entities[0].attributes #=> Array
|
399
|
-
# 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"
|
545
|
+
# 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"
|
400
546
|
# resp.entities[0].attributes[0].score #=> Float
|
401
547
|
# resp.entities[0].attributes[0].relationship_score #=> Float
|
548
|
+
# 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"
|
402
549
|
# resp.entities[0].attributes[0].id #=> Integer
|
403
550
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
404
551
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
405
552
|
# resp.entities[0].attributes[0].text #=> String
|
553
|
+
# resp.entities[0].attributes[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
406
554
|
# resp.entities[0].attributes[0].traits #=> Array
|
407
555
|
# resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
408
556
|
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
409
557
|
# resp.unmapped_attributes #=> Array
|
410
|
-
# resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY"
|
411
|
-
# 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"
|
558
|
+
# resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
559
|
+
# 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"
|
412
560
|
# resp.unmapped_attributes[0].attribute.score #=> Float
|
413
561
|
# resp.unmapped_attributes[0].attribute.relationship_score #=> Float
|
562
|
+
# 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"
|
414
563
|
# resp.unmapped_attributes[0].attribute.id #=> Integer
|
415
564
|
# resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
|
416
565
|
# resp.unmapped_attributes[0].attribute.end_offset #=> Integer
|
417
566
|
# resp.unmapped_attributes[0].attribute.text #=> String
|
567
|
+
# resp.unmapped_attributes[0].attribute.category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
418
568
|
# resp.unmapped_attributes[0].attribute.traits #=> Array
|
419
569
|
# resp.unmapped_attributes[0].attribute.traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
420
570
|
# resp.unmapped_attributes[0].attribute.traits[0].score #=> Float
|
@@ -432,7 +582,8 @@ module Aws::ComprehendMedical
|
|
432
582
|
|
433
583
|
# Inspects the clinical text for a variety of medical entities and
|
434
584
|
# returns specific information about them such as entity category,
|
435
|
-
# location, and confidence score on that information.
|
585
|
+
# location, and confidence score on that information. Amazon Comprehend
|
586
|
+
# Medical only detects medical entities in English language texts.
|
436
587
|
#
|
437
588
|
# The `DetectEntitiesV2` operation replaces the DetectEntities
|
438
589
|
# operation. This new action uses a different model for determining the
|
@@ -469,31 +620,35 @@ module Aws::ComprehendMedical
|
|
469
620
|
# resp.entities[0].end_offset #=> Integer
|
470
621
|
# resp.entities[0].score #=> Float
|
471
622
|
# resp.entities[0].text #=> String
|
472
|
-
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY"
|
473
|
-
# 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"
|
623
|
+
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
624
|
+
# 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"
|
474
625
|
# resp.entities[0].traits #=> Array
|
475
626
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
476
627
|
# resp.entities[0].traits[0].score #=> Float
|
477
628
|
# resp.entities[0].attributes #=> Array
|
478
|
-
# 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"
|
629
|
+
# 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"
|
479
630
|
# resp.entities[0].attributes[0].score #=> Float
|
480
631
|
# resp.entities[0].attributes[0].relationship_score #=> Float
|
632
|
+
# 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"
|
481
633
|
# resp.entities[0].attributes[0].id #=> Integer
|
482
634
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
483
635
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
484
636
|
# resp.entities[0].attributes[0].text #=> String
|
637
|
+
# resp.entities[0].attributes[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
485
638
|
# resp.entities[0].attributes[0].traits #=> Array
|
486
639
|
# resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
487
640
|
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
488
641
|
# resp.unmapped_attributes #=> Array
|
489
|
-
# resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY"
|
490
|
-
# 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"
|
642
|
+
# resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
643
|
+
# 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"
|
491
644
|
# resp.unmapped_attributes[0].attribute.score #=> Float
|
492
645
|
# resp.unmapped_attributes[0].attribute.relationship_score #=> Float
|
646
|
+
# 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"
|
493
647
|
# resp.unmapped_attributes[0].attribute.id #=> Integer
|
494
648
|
# resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
|
495
649
|
# resp.unmapped_attributes[0].attribute.end_offset #=> Integer
|
496
650
|
# resp.unmapped_attributes[0].attribute.text #=> String
|
651
|
+
# resp.unmapped_attributes[0].attribute.category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
497
652
|
# resp.unmapped_attributes[0].attribute.traits #=> Array
|
498
653
|
# resp.unmapped_attributes[0].attribute.traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
499
654
|
# resp.unmapped_attributes[0].attribute.traits[0].score #=> Float
|
@@ -510,8 +665,9 @@ module Aws::ComprehendMedical
|
|
510
665
|
end
|
511
666
|
|
512
667
|
# Inspects the clinical text for protected health information (PHI)
|
513
|
-
# entities and entity category, location, and confidence
|
514
|
-
#
|
668
|
+
# entities and returns the entity category, location, and confidence
|
669
|
+
# score for each entity. Amazon Comprehend Medical only detects entities
|
670
|
+
# in English language texts.
|
515
671
|
#
|
516
672
|
# @option params [required, String] :text
|
517
673
|
# A UTF-8 text string containing the clinical content being examined for
|
@@ -538,19 +694,21 @@ module Aws::ComprehendMedical
|
|
538
694
|
# resp.entities[0].end_offset #=> Integer
|
539
695
|
# resp.entities[0].score #=> Float
|
540
696
|
# resp.entities[0].text #=> String
|
541
|
-
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY"
|
542
|
-
# 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"
|
697
|
+
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
698
|
+
# 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"
|
543
699
|
# resp.entities[0].traits #=> Array
|
544
700
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
545
701
|
# resp.entities[0].traits[0].score #=> Float
|
546
702
|
# resp.entities[0].attributes #=> Array
|
547
|
-
# 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"
|
703
|
+
# 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"
|
548
704
|
# resp.entities[0].attributes[0].score #=> Float
|
549
705
|
# resp.entities[0].attributes[0].relationship_score #=> Float
|
706
|
+
# 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"
|
550
707
|
# resp.entities[0].attributes[0].id #=> Integer
|
551
708
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
552
709
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
553
710
|
# resp.entities[0].attributes[0].text #=> String
|
711
|
+
# resp.entities[0].attributes[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
554
712
|
# resp.entities[0].attributes[0].traits #=> Array
|
555
713
|
# resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
556
714
|
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
@@ -569,7 +727,8 @@ module Aws::ComprehendMedical
|
|
569
727
|
# InferICD10CM detects medical conditions as entities listed in a
|
570
728
|
# patient record and links those entities to normalized concept
|
571
729
|
# identifiers in the ICD-10-CM knowledge base from the Centers for
|
572
|
-
# Disease Control.
|
730
|
+
# Disease Control. Amazon Comprehend Medical only detects medical
|
731
|
+
# entities in English language texts.
|
573
732
|
#
|
574
733
|
# @option params [required, String] :text
|
575
734
|
# The input text used for analysis. The input for InferICD10CM is a
|
@@ -629,7 +788,8 @@ module Aws::ComprehendMedical
|
|
629
788
|
|
630
789
|
# InferRxNorm detects medications as entities listed in a patient record
|
631
790
|
# and links to the normalized concept identifiers in the RxNorm database
|
632
|
-
# from the National Library of Medicine.
|
791
|
+
# from the National Library of Medicine. Amazon Comprehend Medical only
|
792
|
+
# detects medical entities in English language texts.
|
633
793
|
#
|
634
794
|
# @option params [required, String] :text
|
635
795
|
# The input text used for analysis. The input for InferRxNorm is a
|
@@ -749,6 +909,68 @@ module Aws::ComprehendMedical
|
|
749
909
|
req.send_request(options)
|
750
910
|
end
|
751
911
|
|
912
|
+
# Gets a list of InferICD10CM jobs that you have submitted.
|
913
|
+
#
|
914
|
+
# @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
|
915
|
+
# Filters the jobs that are returned. You can filter jobs based on their
|
916
|
+
# names, status, or the date and time that they were submitted. You can
|
917
|
+
# only set one filter at a time.
|
918
|
+
#
|
919
|
+
# @option params [String] :next_token
|
920
|
+
# Identifies the next page of results to return.
|
921
|
+
#
|
922
|
+
# @option params [Integer] :max_results
|
923
|
+
# The maximum number of results to return in each page. The default is
|
924
|
+
# 100.
|
925
|
+
#
|
926
|
+
# @return [Types::ListICD10CMInferenceJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
927
|
+
#
|
928
|
+
# * {Types::ListICD10CMInferenceJobsResponse#comprehend_medical_async_job_properties_list #comprehend_medical_async_job_properties_list} => Array<Types::ComprehendMedicalAsyncJobProperties>
|
929
|
+
# * {Types::ListICD10CMInferenceJobsResponse#next_token #next_token} => String
|
930
|
+
#
|
931
|
+
# @example Request syntax with placeholder values
|
932
|
+
#
|
933
|
+
# resp = client.list_icd10cm_inference_jobs({
|
934
|
+
# filter: {
|
935
|
+
# job_name: "JobName",
|
936
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
|
937
|
+
# submit_time_before: Time.now,
|
938
|
+
# submit_time_after: Time.now,
|
939
|
+
# },
|
940
|
+
# next_token: "String",
|
941
|
+
# max_results: 1,
|
942
|
+
# })
|
943
|
+
#
|
944
|
+
# @example Response structure
|
945
|
+
#
|
946
|
+
# resp.comprehend_medical_async_job_properties_list #=> Array
|
947
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
|
948
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
|
949
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
|
950
|
+
# resp.comprehend_medical_async_job_properties_list[0].message #=> String
|
951
|
+
# resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
|
952
|
+
# resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
|
953
|
+
# resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
|
954
|
+
# resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
|
955
|
+
# resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
|
956
|
+
# resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
|
957
|
+
# resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
|
958
|
+
# resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
|
959
|
+
# resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
|
960
|
+
# resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
|
961
|
+
# resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
|
962
|
+
# resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
|
963
|
+
# resp.next_token #=> String
|
964
|
+
#
|
965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListICD10CMInferenceJobs AWS API Documentation
|
966
|
+
#
|
967
|
+
# @overload list_icd10cm_inference_jobs(params = {})
|
968
|
+
# @param [Hash] params ({})
|
969
|
+
def list_icd10cm_inference_jobs(params = {}, options = {})
|
970
|
+
req = build_request(:list_icd10cm_inference_jobs, params)
|
971
|
+
req.send_request(options)
|
972
|
+
end
|
973
|
+
|
752
974
|
# Gets a list of protected health information (PHI) detection jobs that
|
753
975
|
# you have submitted.
|
754
976
|
#
|
@@ -812,6 +1034,67 @@ module Aws::ComprehendMedical
|
|
812
1034
|
req.send_request(options)
|
813
1035
|
end
|
814
1036
|
|
1037
|
+
# Gets a list of InferRxNorm jobs that you have submitted.
|
1038
|
+
#
|
1039
|
+
# @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
|
1040
|
+
# Filters the jobs that are returned. You can filter jobs based on their
|
1041
|
+
# names, status, or the date and time that they were submitted. You can
|
1042
|
+
# only set one filter at a time.
|
1043
|
+
#
|
1044
|
+
# @option params [String] :next_token
|
1045
|
+
# Identifies the next page of results to return.
|
1046
|
+
#
|
1047
|
+
# @option params [Integer] :max_results
|
1048
|
+
# Identifies the next page of results to return.
|
1049
|
+
#
|
1050
|
+
# @return [Types::ListRxNormInferenceJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1051
|
+
#
|
1052
|
+
# * {Types::ListRxNormInferenceJobsResponse#comprehend_medical_async_job_properties_list #comprehend_medical_async_job_properties_list} => Array<Types::ComprehendMedicalAsyncJobProperties>
|
1053
|
+
# * {Types::ListRxNormInferenceJobsResponse#next_token #next_token} => String
|
1054
|
+
#
|
1055
|
+
# @example Request syntax with placeholder values
|
1056
|
+
#
|
1057
|
+
# resp = client.list_rx_norm_inference_jobs({
|
1058
|
+
# filter: {
|
1059
|
+
# job_name: "JobName",
|
1060
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
|
1061
|
+
# submit_time_before: Time.now,
|
1062
|
+
# submit_time_after: Time.now,
|
1063
|
+
# },
|
1064
|
+
# next_token: "String",
|
1065
|
+
# max_results: 1,
|
1066
|
+
# })
|
1067
|
+
#
|
1068
|
+
# @example Response structure
|
1069
|
+
#
|
1070
|
+
# resp.comprehend_medical_async_job_properties_list #=> Array
|
1071
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
|
1072
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
|
1073
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1074
|
+
# resp.comprehend_medical_async_job_properties_list[0].message #=> String
|
1075
|
+
# resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
|
1076
|
+
# resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
|
1077
|
+
# resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
|
1078
|
+
# resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
|
1079
|
+
# resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
|
1080
|
+
# resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
|
1081
|
+
# resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
|
1082
|
+
# resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
|
1083
|
+
# resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
|
1084
|
+
# resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
|
1085
|
+
# resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
|
1086
|
+
# resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
|
1087
|
+
# resp.next_token #=> String
|
1088
|
+
#
|
1089
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListRxNormInferenceJobs AWS API Documentation
|
1090
|
+
#
|
1091
|
+
# @overload list_rx_norm_inference_jobs(params = {})
|
1092
|
+
# @param [Hash] params ({})
|
1093
|
+
def list_rx_norm_inference_jobs(params = {}, options = {})
|
1094
|
+
req = build_request(:list_rx_norm_inference_jobs, params)
|
1095
|
+
req.send_request(options)
|
1096
|
+
end
|
1097
|
+
|
815
1098
|
# Starts an asynchronous medical entity detection job for a collection
|
816
1099
|
# of documents. Use the `DescribeEntitiesDetectionV2Job` operation to
|
817
1100
|
# track the status of a job.
|
@@ -885,6 +1168,79 @@ module Aws::ComprehendMedical
|
|
885
1168
|
req.send_request(options)
|
886
1169
|
end
|
887
1170
|
|
1171
|
+
# Starts an asynchronous job to detect medical conditions and link them
|
1172
|
+
# to the ICD-10-CM ontology. Use the `DescribeICD10CMInferenceJob`
|
1173
|
+
# operation to track the status of a job.
|
1174
|
+
#
|
1175
|
+
# @option params [required, Types::InputDataConfig] :input_data_config
|
1176
|
+
# Specifies the format and location of the input data for the job.
|
1177
|
+
#
|
1178
|
+
# @option params [required, Types::OutputDataConfig] :output_data_config
|
1179
|
+
# Specifies where to send the output files.
|
1180
|
+
#
|
1181
|
+
# @option params [required, String] :data_access_role_arn
|
1182
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1183
|
+
# Management (IAM) role that grants Amazon Comprehend Medical read
|
1184
|
+
# access to your input data. For more information, see [ Role-Based
|
1185
|
+
# Permissions Required for Asynchronous Operations][1].
|
1186
|
+
#
|
1187
|
+
#
|
1188
|
+
#
|
1189
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med
|
1190
|
+
#
|
1191
|
+
# @option params [String] :job_name
|
1192
|
+
# The identifier of the job.
|
1193
|
+
#
|
1194
|
+
# @option params [String] :client_request_token
|
1195
|
+
# A unique identifier for the request. If you don't set the client
|
1196
|
+
# request token, Amazon Comprehend Medical generates one.
|
1197
|
+
#
|
1198
|
+
# **A suitable default value is auto-generated.** You should normally
|
1199
|
+
# not need to pass this option.**
|
1200
|
+
#
|
1201
|
+
# @option params [String] :kms_key
|
1202
|
+
# An AWS Key Management Service key to encrypt your output files. If you
|
1203
|
+
# do not specify a key, the files are written in plain text.
|
1204
|
+
#
|
1205
|
+
# @option params [required, String] :language_code
|
1206
|
+
# The language of the input documents. All documents must be in the same
|
1207
|
+
# language.
|
1208
|
+
#
|
1209
|
+
# @return [Types::StartICD10CMInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1210
|
+
#
|
1211
|
+
# * {Types::StartICD10CMInferenceJobResponse#job_id #job_id} => String
|
1212
|
+
#
|
1213
|
+
# @example Request syntax with placeholder values
|
1214
|
+
#
|
1215
|
+
# resp = client.start_icd10cm_inference_job({
|
1216
|
+
# input_data_config: { # required
|
1217
|
+
# s3_bucket: "S3Bucket", # required
|
1218
|
+
# s3_key: "S3Key",
|
1219
|
+
# },
|
1220
|
+
# output_data_config: { # required
|
1221
|
+
# s3_bucket: "S3Bucket", # required
|
1222
|
+
# s3_key: "S3Key",
|
1223
|
+
# },
|
1224
|
+
# data_access_role_arn: "IamRoleArn", # required
|
1225
|
+
# job_name: "JobName",
|
1226
|
+
# client_request_token: "ClientRequestTokenString",
|
1227
|
+
# kms_key: "KMSKey",
|
1228
|
+
# language_code: "en", # required, accepts en
|
1229
|
+
# })
|
1230
|
+
#
|
1231
|
+
# @example Response structure
|
1232
|
+
#
|
1233
|
+
# resp.job_id #=> String
|
1234
|
+
#
|
1235
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartICD10CMInferenceJob AWS API Documentation
|
1236
|
+
#
|
1237
|
+
# @overload start_icd10cm_inference_job(params = {})
|
1238
|
+
# @param [Hash] params ({})
|
1239
|
+
def start_icd10cm_inference_job(params = {}, options = {})
|
1240
|
+
req = build_request(:start_icd10cm_inference_job, params)
|
1241
|
+
req.send_request(options)
|
1242
|
+
end
|
1243
|
+
|
888
1244
|
# Starts an asynchronous job to detect protected health information
|
889
1245
|
# (PHI). Use the `DescribePHIDetectionJob` operation to track the status
|
890
1246
|
# of a job.
|
@@ -958,6 +1314,79 @@ module Aws::ComprehendMedical
|
|
958
1314
|
req.send_request(options)
|
959
1315
|
end
|
960
1316
|
|
1317
|
+
# Starts an asynchronous job to detect medication entities and link them
|
1318
|
+
# to the RxNorm ontology. Use the `DescribeRxNormInferenceJob` operation
|
1319
|
+
# to track the status of a job.
|
1320
|
+
#
|
1321
|
+
# @option params [required, Types::InputDataConfig] :input_data_config
|
1322
|
+
# Specifies the format and location of the input data for the job.
|
1323
|
+
#
|
1324
|
+
# @option params [required, Types::OutputDataConfig] :output_data_config
|
1325
|
+
# Specifies where to send the output files.
|
1326
|
+
#
|
1327
|
+
# @option params [required, String] :data_access_role_arn
|
1328
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1329
|
+
# Management (IAM) role that grants Amazon Comprehend Medical read
|
1330
|
+
# access to your input data. For more information, see [ Role-Based
|
1331
|
+
# Permissions Required for Asynchronous Operations][1].
|
1332
|
+
#
|
1333
|
+
#
|
1334
|
+
#
|
1335
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med
|
1336
|
+
#
|
1337
|
+
# @option params [String] :job_name
|
1338
|
+
# The identifier of the job.
|
1339
|
+
#
|
1340
|
+
# @option params [String] :client_request_token
|
1341
|
+
# A unique identifier for the request. If you don't set the client
|
1342
|
+
# request token, Amazon Comprehend Medical generates one.
|
1343
|
+
#
|
1344
|
+
# **A suitable default value is auto-generated.** You should normally
|
1345
|
+
# not need to pass this option.**
|
1346
|
+
#
|
1347
|
+
# @option params [String] :kms_key
|
1348
|
+
# An AWS Key Management Service key to encrypt your output files. If you
|
1349
|
+
# do not specify a key, the files are written in plain text.
|
1350
|
+
#
|
1351
|
+
# @option params [required, String] :language_code
|
1352
|
+
# The language of the input documents. All documents must be in the same
|
1353
|
+
# language.
|
1354
|
+
#
|
1355
|
+
# @return [Types::StartRxNormInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1356
|
+
#
|
1357
|
+
# * {Types::StartRxNormInferenceJobResponse#job_id #job_id} => String
|
1358
|
+
#
|
1359
|
+
# @example Request syntax with placeholder values
|
1360
|
+
#
|
1361
|
+
# resp = client.start_rx_norm_inference_job({
|
1362
|
+
# input_data_config: { # required
|
1363
|
+
# s3_bucket: "S3Bucket", # required
|
1364
|
+
# s3_key: "S3Key",
|
1365
|
+
# },
|
1366
|
+
# output_data_config: { # required
|
1367
|
+
# s3_bucket: "S3Bucket", # required
|
1368
|
+
# s3_key: "S3Key",
|
1369
|
+
# },
|
1370
|
+
# data_access_role_arn: "IamRoleArn", # required
|
1371
|
+
# job_name: "JobName",
|
1372
|
+
# client_request_token: "ClientRequestTokenString",
|
1373
|
+
# kms_key: "KMSKey",
|
1374
|
+
# language_code: "en", # required, accepts en
|
1375
|
+
# })
|
1376
|
+
#
|
1377
|
+
# @example Response structure
|
1378
|
+
#
|
1379
|
+
# resp.job_id #=> String
|
1380
|
+
#
|
1381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartRxNormInferenceJob AWS API Documentation
|
1382
|
+
#
|
1383
|
+
# @overload start_rx_norm_inference_job(params = {})
|
1384
|
+
# @param [Hash] params ({})
|
1385
|
+
def start_rx_norm_inference_job(params = {}, options = {})
|
1386
|
+
req = build_request(:start_rx_norm_inference_job, params)
|
1387
|
+
req.send_request(options)
|
1388
|
+
end
|
1389
|
+
|
961
1390
|
# Stops a medical entities detection job in progress.
|
962
1391
|
#
|
963
1392
|
# @option params [required, String] :job_id
|
@@ -986,6 +1415,34 @@ module Aws::ComprehendMedical
|
|
986
1415
|
req.send_request(options)
|
987
1416
|
end
|
988
1417
|
|
1418
|
+
# Stops an InferICD10CM inference job in progress.
|
1419
|
+
#
|
1420
|
+
# @option params [required, String] :job_id
|
1421
|
+
# The identifier of the job.
|
1422
|
+
#
|
1423
|
+
# @return [Types::StopICD10CMInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1424
|
+
#
|
1425
|
+
# * {Types::StopICD10CMInferenceJobResponse#job_id #job_id} => String
|
1426
|
+
#
|
1427
|
+
# @example Request syntax with placeholder values
|
1428
|
+
#
|
1429
|
+
# resp = client.stop_icd10cm_inference_job({
|
1430
|
+
# job_id: "JobId", # required
|
1431
|
+
# })
|
1432
|
+
#
|
1433
|
+
# @example Response structure
|
1434
|
+
#
|
1435
|
+
# resp.job_id #=> String
|
1436
|
+
#
|
1437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopICD10CMInferenceJob AWS API Documentation
|
1438
|
+
#
|
1439
|
+
# @overload stop_icd10cm_inference_job(params = {})
|
1440
|
+
# @param [Hash] params ({})
|
1441
|
+
def stop_icd10cm_inference_job(params = {}, options = {})
|
1442
|
+
req = build_request(:stop_icd10cm_inference_job, params)
|
1443
|
+
req.send_request(options)
|
1444
|
+
end
|
1445
|
+
|
989
1446
|
# Stops a protected health information (PHI) detection job in progress.
|
990
1447
|
#
|
991
1448
|
# @option params [required, String] :job_id
|
@@ -1014,6 +1471,34 @@ module Aws::ComprehendMedical
|
|
1014
1471
|
req.send_request(options)
|
1015
1472
|
end
|
1016
1473
|
|
1474
|
+
# Stops an InferRxNorm inference job in progress.
|
1475
|
+
#
|
1476
|
+
# @option params [required, String] :job_id
|
1477
|
+
# The identifier of the job.
|
1478
|
+
#
|
1479
|
+
# @return [Types::StopRxNormInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1480
|
+
#
|
1481
|
+
# * {Types::StopRxNormInferenceJobResponse#job_id #job_id} => String
|
1482
|
+
#
|
1483
|
+
# @example Request syntax with placeholder values
|
1484
|
+
#
|
1485
|
+
# resp = client.stop_rx_norm_inference_job({
|
1486
|
+
# job_id: "JobId", # required
|
1487
|
+
# })
|
1488
|
+
#
|
1489
|
+
# @example Response structure
|
1490
|
+
#
|
1491
|
+
# resp.job_id #=> String
|
1492
|
+
#
|
1493
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopRxNormInferenceJob AWS API Documentation
|
1494
|
+
#
|
1495
|
+
# @overload stop_rx_norm_inference_job(params = {})
|
1496
|
+
# @param [Hash] params ({})
|
1497
|
+
def stop_rx_norm_inference_job(params = {}, options = {})
|
1498
|
+
req = build_request(:stop_rx_norm_inference_job, params)
|
1499
|
+
req.send_request(options)
|
1500
|
+
end
|
1501
|
+
|
1017
1502
|
# @!endgroup
|
1018
1503
|
|
1019
1504
|
# @param params ({})
|
@@ -1027,7 +1512,7 @@ module Aws::ComprehendMedical
|
|
1027
1512
|
params: params,
|
1028
1513
|
config: config)
|
1029
1514
|
context[:gem_name] = 'aws-sdk-comprehendmedical'
|
1030
|
-
context[:gem_version] = '1.
|
1515
|
+
context[:gem_version] = '1.17.0'
|
1031
1516
|
Seahorse::Client::Request.new(handlers, context)
|
1032
1517
|
end
|
1033
1518
|
|