@aws-sdk/client-comprehendmedical 3.533.0 → 3.536.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.
- package/dist-types/ComprehendMedical.d.ts +6 -1
- package/dist-types/ComprehendMedicalClient.d.ts +1 -1
- package/dist-types/commands/DescribeEntitiesDetectionV2JobCommand.d.ts +2 -1
- package/dist-types/commands/DescribeICD10CMInferenceJobCommand.d.ts +2 -1
- package/dist-types/commands/DescribePHIDetectionJobCommand.d.ts +2 -1
- package/dist-types/commands/DescribeRxNormInferenceJobCommand.d.ts +2 -1
- package/dist-types/commands/DescribeSNOMEDCTInferenceJobCommand.d.ts +2 -1
- package/dist-types/commands/DetectEntitiesCommand.d.ts +4 -3
- package/dist-types/commands/DetectEntitiesV2Command.d.ts +2 -1
- package/dist-types/commands/DetectPHICommand.d.ts +2 -1
- package/dist-types/commands/InferICD10CMCommand.d.ts +2 -1
- package/dist-types/commands/InferRxNormCommand.d.ts +2 -1
- package/dist-types/commands/InferSNOMEDCTCommand.d.ts +2 -1
- package/dist-types/commands/ListEntitiesDetectionV2JobsCommand.d.ts +2 -1
- package/dist-types/commands/ListICD10CMInferenceJobsCommand.d.ts +2 -1
- package/dist-types/commands/ListPHIDetectionJobsCommand.d.ts +2 -1
- package/dist-types/commands/ListRxNormInferenceJobsCommand.d.ts +2 -1
- package/dist-types/commands/ListSNOMEDCTInferenceJobsCommand.d.ts +2 -1
- package/dist-types/commands/StartEntitiesDetectionV2JobCommand.d.ts +2 -1
- package/dist-types/commands/StartICD10CMInferenceJobCommand.d.ts +2 -1
- package/dist-types/commands/StartPHIDetectionJobCommand.d.ts +2 -1
- package/dist-types/commands/StartRxNormInferenceJobCommand.d.ts +2 -1
- package/dist-types/commands/StartSNOMEDCTInferenceJobCommand.d.ts +2 -1
- package/dist-types/commands/StopEntitiesDetectionV2JobCommand.d.ts +2 -1
- package/dist-types/commands/StopICD10CMInferenceJobCommand.d.ts +2 -1
- package/dist-types/commands/StopPHIDetectionJobCommand.d.ts +2 -1
- package/dist-types/commands/StopRxNormInferenceJobCommand.d.ts +2 -1
- package/dist-types/commands/StopSNOMEDCTInferenceJobCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +266 -266
- package/dist-types/ts3.4/ComprehendMedical.d.ts +5 -0
- package/dist-types/ts3.4/commands/DescribeEntitiesDetectionV2JobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeICD10CMInferenceJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribePHIDetectionJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeRxNormInferenceJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeSNOMEDCTInferenceJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DetectEntitiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DetectEntitiesV2Command.d.ts +9 -0
- package/dist-types/ts3.4/commands/DetectPHICommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/InferICD10CMCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/InferRxNormCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/InferSNOMEDCTCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListEntitiesDetectionV2JobsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListICD10CMInferenceJobsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPHIDetectionJobsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListRxNormInferenceJobsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSNOMEDCTInferenceJobsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartEntitiesDetectionV2JobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartICD10CMInferenceJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartPHIDetectionJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartRxNormInferenceJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartSNOMEDCTInferenceJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopEntitiesDetectionV2JobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopICD10CMInferenceJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopPHIDetectionJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopRxNormInferenceJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopSNOMEDCTInferenceJobCommand.d.ts +9 -0
- package/package.json +40 -40
|
@@ -69,18 +69,18 @@ export declare const AttributeName: {
|
|
|
69
69
|
*/
|
|
70
70
|
export type AttributeName = (typeof AttributeName)[keyof typeof AttributeName];
|
|
71
71
|
/**
|
|
72
|
-
* @public
|
|
73
72
|
* <p> Provides contextual information about the extracted entity. </p>
|
|
73
|
+
* @public
|
|
74
74
|
*/
|
|
75
75
|
export interface Trait {
|
|
76
76
|
/**
|
|
77
|
-
* @public
|
|
78
77
|
* <p> Provides a name or contextual description about the trait. </p>
|
|
78
|
+
* @public
|
|
79
79
|
*/
|
|
80
80
|
Name?: AttributeName;
|
|
81
81
|
/**
|
|
82
|
-
* @public
|
|
83
82
|
* <p> The level of confidence that Amazon Comprehend Medical has in the accuracy of this trait.</p>
|
|
83
|
+
* @public
|
|
84
84
|
*/
|
|
85
85
|
Score?: number;
|
|
86
86
|
}
|
|
@@ -140,83 +140,83 @@ export declare const EntitySubType: {
|
|
|
140
140
|
*/
|
|
141
141
|
export type EntitySubType = (typeof EntitySubType)[keyof typeof EntitySubType];
|
|
142
142
|
/**
|
|
143
|
-
* @public
|
|
144
143
|
* <p> An extracted segment of the text that is an attribute of an entity, or otherwise related
|
|
145
144
|
* to an entity, such as the dosage of a medication taken. It contains information about the
|
|
146
145
|
* attribute such as id, begin and end offset within the input text, and the segment of the input
|
|
147
146
|
* text. </p>
|
|
147
|
+
* @public
|
|
148
148
|
*/
|
|
149
149
|
export interface Attribute {
|
|
150
150
|
/**
|
|
151
|
-
* @public
|
|
152
151
|
* <p> The type of attribute. </p>
|
|
152
|
+
* @public
|
|
153
153
|
*/
|
|
154
154
|
Type?: EntitySubType;
|
|
155
155
|
/**
|
|
156
|
-
* @public
|
|
157
156
|
* <p> The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized
|
|
158
157
|
* as an attribute. </p>
|
|
158
|
+
* @public
|
|
159
159
|
*/
|
|
160
160
|
Score?: number;
|
|
161
161
|
/**
|
|
162
|
-
* @public
|
|
163
162
|
* <p> The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this
|
|
164
163
|
* entity. </p>
|
|
164
|
+
* @public
|
|
165
165
|
*/
|
|
166
166
|
RelationshipScore?: number;
|
|
167
167
|
/**
|
|
168
|
-
* @public
|
|
169
168
|
* <p>The type of relationship between the entity and attribute. Type for the relationship is
|
|
170
169
|
* <code>OVERLAP</code>, indicating that the entity occurred at the same time as the
|
|
171
170
|
* <code>Date_Expression</code>. </p>
|
|
171
|
+
* @public
|
|
172
172
|
*/
|
|
173
173
|
RelationshipType?: RelationshipType;
|
|
174
174
|
/**
|
|
175
|
-
* @public
|
|
176
175
|
* <p> The numeric identifier for this attribute. This is a monotonically increasing id unique
|
|
177
176
|
* within this response rather than a global unique identifier. </p>
|
|
177
|
+
* @public
|
|
178
178
|
*/
|
|
179
179
|
Id?: number;
|
|
180
180
|
/**
|
|
181
|
-
* @public
|
|
182
181
|
* <p> The 0-based character offset in the input text that shows where the attribute begins. The
|
|
183
182
|
* offset returns the UTF-8 code point in the string. </p>
|
|
183
|
+
* @public
|
|
184
184
|
*/
|
|
185
185
|
BeginOffset?: number;
|
|
186
186
|
/**
|
|
187
|
-
* @public
|
|
188
187
|
* <p> The 0-based character offset in the input text that shows where the attribute ends. The
|
|
189
188
|
* offset returns the UTF-8 code point in the string.</p>
|
|
189
|
+
* @public
|
|
190
190
|
*/
|
|
191
191
|
EndOffset?: number;
|
|
192
192
|
/**
|
|
193
|
-
* @public
|
|
194
193
|
* <p> The segment of input text extracted as this attribute.</p>
|
|
194
|
+
* @public
|
|
195
195
|
*/
|
|
196
196
|
Text?: string;
|
|
197
197
|
/**
|
|
198
|
-
* @public
|
|
199
198
|
* <p> The category of attribute. </p>
|
|
199
|
+
* @public
|
|
200
200
|
*/
|
|
201
201
|
Category?: EntityType;
|
|
202
202
|
/**
|
|
203
|
-
* @public
|
|
204
203
|
* <p> Contextual information for this attribute. </p>
|
|
204
|
+
* @public
|
|
205
205
|
*/
|
|
206
206
|
Traits?: Trait[];
|
|
207
207
|
}
|
|
208
208
|
/**
|
|
209
|
-
* @public
|
|
210
209
|
* <p>
|
|
211
210
|
* The number of characters in the input text to be analyzed.
|
|
212
211
|
* </p>
|
|
212
|
+
* @public
|
|
213
213
|
*/
|
|
214
214
|
export interface Characters {
|
|
215
215
|
/**
|
|
216
|
-
* @public
|
|
217
216
|
* <p>
|
|
218
217
|
* The number of characters present in the input text document as processed by Amazon Comprehend Medical.
|
|
219
218
|
* </p>
|
|
219
|
+
* @public
|
|
220
220
|
*/
|
|
221
221
|
OriginalTextCharacters?: number;
|
|
222
222
|
}
|
|
@@ -225,28 +225,28 @@ export interface Characters {
|
|
|
225
225
|
*/
|
|
226
226
|
export interface DescribeEntitiesDetectionV2JobRequest {
|
|
227
227
|
/**
|
|
228
|
-
* @public
|
|
229
228
|
* <p>The identifier that Amazon Comprehend Medical generated for the job. The
|
|
230
229
|
* <code>StartEntitiesDetectionV2Job</code> operation returns this identifier in its
|
|
231
230
|
* response.</p>
|
|
231
|
+
* @public
|
|
232
232
|
*/
|
|
233
233
|
JobId: string | undefined;
|
|
234
234
|
}
|
|
235
235
|
/**
|
|
236
|
-
* @public
|
|
237
236
|
* <p>The input properties for an entities detection job. This includes the name of the S3
|
|
238
237
|
* bucket and the path to the files to be analyzed. </p>
|
|
238
|
+
* @public
|
|
239
239
|
*/
|
|
240
240
|
export interface InputDataConfig {
|
|
241
241
|
/**
|
|
242
|
-
* @public
|
|
243
242
|
* <p>The URI of the S3 bucket that contains the input data. The bucket must be in the same
|
|
244
243
|
* region as the API endpoint that you are calling.</p>
|
|
244
|
+
* @public
|
|
245
245
|
*/
|
|
246
246
|
S3Bucket: string | undefined;
|
|
247
247
|
/**
|
|
248
|
-
* @public
|
|
249
248
|
* <p>The path to the input data files in the S3 bucket.</p>
|
|
249
|
+
* @public
|
|
250
250
|
*/
|
|
251
251
|
S3Key?: string;
|
|
252
252
|
}
|
|
@@ -279,105 +279,105 @@ export declare const LanguageCode: {
|
|
|
279
279
|
*/
|
|
280
280
|
export type LanguageCode = (typeof LanguageCode)[keyof typeof LanguageCode];
|
|
281
281
|
/**
|
|
282
|
-
* @public
|
|
283
282
|
* <p>The output properties for a detection job.</p>
|
|
283
|
+
* @public
|
|
284
284
|
*/
|
|
285
285
|
export interface OutputDataConfig {
|
|
286
286
|
/**
|
|
287
|
-
* @public
|
|
288
287
|
* <p>When you use the <code>OutputDataConfig</code> object with asynchronous operations, you
|
|
289
288
|
* specify the Amazon S3 location where you want to write the output data. The URI must be in the
|
|
290
289
|
* same region as the API endpoint that you are calling. The location is used as the prefix for
|
|
291
290
|
* the actual location of the output.</p>
|
|
291
|
+
* @public
|
|
292
292
|
*/
|
|
293
293
|
S3Bucket: string | undefined;
|
|
294
294
|
/**
|
|
295
|
-
* @public
|
|
296
295
|
* <p>The path to the output data files in the S3 bucket. Amazon Comprehend Medical creates an output directory
|
|
297
296
|
* using the job ID so that the output from one job does not overwrite the output of
|
|
298
297
|
* another.</p>
|
|
298
|
+
* @public
|
|
299
299
|
*/
|
|
300
300
|
S3Key?: string;
|
|
301
301
|
}
|
|
302
302
|
/**
|
|
303
|
-
* @public
|
|
304
303
|
* <p>Provides information about a detection job.</p>
|
|
304
|
+
* @public
|
|
305
305
|
*/
|
|
306
306
|
export interface ComprehendMedicalAsyncJobProperties {
|
|
307
307
|
/**
|
|
308
|
-
* @public
|
|
309
308
|
* <p>The identifier assigned to the detection job.</p>
|
|
309
|
+
* @public
|
|
310
310
|
*/
|
|
311
311
|
JobId?: string;
|
|
312
312
|
/**
|
|
313
|
-
* @public
|
|
314
313
|
* <p>The name that you assigned to the detection job.</p>
|
|
314
|
+
* @public
|
|
315
315
|
*/
|
|
316
316
|
JobName?: string;
|
|
317
317
|
/**
|
|
318
|
-
* @public
|
|
319
318
|
* <p>The current status of the detection job. If the status is <code>FAILED</code>, the
|
|
320
319
|
* <code>Message</code> field shows the reason for the failure.</p>
|
|
320
|
+
* @public
|
|
321
321
|
*/
|
|
322
322
|
JobStatus?: JobStatus;
|
|
323
323
|
/**
|
|
324
|
-
* @public
|
|
325
324
|
* <p>A description of the status of a job.</p>
|
|
325
|
+
* @public
|
|
326
326
|
*/
|
|
327
327
|
Message?: string;
|
|
328
328
|
/**
|
|
329
|
-
* @public
|
|
330
329
|
* <p>The time that the detection job was submitted for processing.</p>
|
|
330
|
+
* @public
|
|
331
331
|
*/
|
|
332
332
|
SubmitTime?: Date;
|
|
333
333
|
/**
|
|
334
|
-
* @public
|
|
335
334
|
* <p>The time that the detection job completed.</p>
|
|
335
|
+
* @public
|
|
336
336
|
*/
|
|
337
337
|
EndTime?: Date;
|
|
338
338
|
/**
|
|
339
|
-
* @public
|
|
340
339
|
* <p>The date and time that job metadata is deleted from the server. Output files in your S3
|
|
341
340
|
* bucket will not be deleted. After the metadata is deleted, the job will no longer appear in
|
|
342
341
|
* the results of the <code>ListEntitiesDetectionV2Job</code> or the
|
|
343
342
|
* <code>ListPHIDetectionJobs</code> operation.</p>
|
|
343
|
+
* @public
|
|
344
344
|
*/
|
|
345
345
|
ExpirationTime?: Date;
|
|
346
346
|
/**
|
|
347
|
-
* @public
|
|
348
347
|
* <p>The input data configuration that you supplied when you created the detection job.</p>
|
|
348
|
+
* @public
|
|
349
349
|
*/
|
|
350
350
|
InputDataConfig?: InputDataConfig;
|
|
351
351
|
/**
|
|
352
|
-
* @public
|
|
353
352
|
* <p>The output data configuration that you supplied when you created the detection job.</p>
|
|
353
|
+
* @public
|
|
354
354
|
*/
|
|
355
355
|
OutputDataConfig?: OutputDataConfig;
|
|
356
356
|
/**
|
|
357
|
-
* @public
|
|
358
357
|
* <p>The language code of the input documents.</p>
|
|
358
|
+
* @public
|
|
359
359
|
*/
|
|
360
360
|
LanguageCode?: LanguageCode;
|
|
361
361
|
/**
|
|
362
|
-
* @public
|
|
363
362
|
* <p>The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.</p>
|
|
363
|
+
* @public
|
|
364
364
|
*/
|
|
365
365
|
DataAccessRoleArn?: string;
|
|
366
366
|
/**
|
|
367
|
-
* @public
|
|
368
367
|
* <p>The path to the file that describes the results of a batch job.</p>
|
|
368
|
+
* @public
|
|
369
369
|
*/
|
|
370
370
|
ManifestFilePath?: string;
|
|
371
371
|
/**
|
|
372
|
-
* @public
|
|
373
372
|
* <p>The AWS Key Management Service key, if any, used to encrypt the output files. </p>
|
|
373
|
+
* @public
|
|
374
374
|
*/
|
|
375
375
|
KMSKey?: string;
|
|
376
376
|
/**
|
|
377
|
-
* @public
|
|
378
377
|
* <p>The version of the model used to analyze the documents. The version number looks like
|
|
379
378
|
* X.X.X. You can use this information to track the model used for a particular batch of
|
|
380
379
|
* documents.</p>
|
|
380
|
+
* @public
|
|
381
381
|
*/
|
|
382
382
|
ModelVersion?: string;
|
|
383
383
|
}
|
|
@@ -386,14 +386,14 @@ export interface ComprehendMedicalAsyncJobProperties {
|
|
|
386
386
|
*/
|
|
387
387
|
export interface DescribeEntitiesDetectionV2JobResponse {
|
|
388
388
|
/**
|
|
389
|
-
* @public
|
|
390
389
|
* <p>An object that contains the properties associated with a detection job.</p>
|
|
390
|
+
* @public
|
|
391
391
|
*/
|
|
392
392
|
ComprehendMedicalAsyncJobProperties?: ComprehendMedicalAsyncJobProperties;
|
|
393
393
|
}
|
|
394
394
|
/**
|
|
395
|
-
* @public
|
|
396
395
|
* <p> An internal server error occurred. Retry your request. </p>
|
|
396
|
+
* @public
|
|
397
397
|
*/
|
|
398
398
|
export declare class InternalServerException extends __BaseException {
|
|
399
399
|
readonly name: "InternalServerException";
|
|
@@ -405,9 +405,9 @@ export declare class InternalServerException extends __BaseException {
|
|
|
405
405
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
406
406
|
}
|
|
407
407
|
/**
|
|
408
|
-
* @public
|
|
409
408
|
* <p> The request that you made is invalid. Check your request to determine why it's invalid
|
|
410
409
|
* and then retry the request.</p>
|
|
410
|
+
* @public
|
|
411
411
|
*/
|
|
412
412
|
export declare class InvalidRequestException extends __BaseException {
|
|
413
413
|
readonly name: "InvalidRequestException";
|
|
@@ -419,9 +419,9 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
419
419
|
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
420
420
|
}
|
|
421
421
|
/**
|
|
422
|
-
* @public
|
|
423
422
|
* <p>The resource identified by the specified Amazon Resource Name (ARN) was not found. Check
|
|
424
423
|
* the ARN and try your request again.</p>
|
|
424
|
+
* @public
|
|
425
425
|
*/
|
|
426
426
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
427
427
|
readonly name: "ResourceNotFoundException";
|
|
@@ -433,10 +433,10 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
433
433
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
434
434
|
}
|
|
435
435
|
/**
|
|
436
|
-
* @public
|
|
437
436
|
* <p> You have made too many requests within a short period of time. Wait for a short time and
|
|
438
437
|
* then try your request again. Contact customer support for more information about a service
|
|
439
438
|
* limit increase. </p>
|
|
439
|
+
* @public
|
|
440
440
|
*/
|
|
441
441
|
export declare class TooManyRequestsException extends __BaseException {
|
|
442
442
|
readonly name: "TooManyRequestsException";
|
|
@@ -452,9 +452,9 @@ export declare class TooManyRequestsException extends __BaseException {
|
|
|
452
452
|
*/
|
|
453
453
|
export interface DescribeICD10CMInferenceJobRequest {
|
|
454
454
|
/**
|
|
455
|
-
* @public
|
|
456
455
|
* <p>The identifier that Amazon Comprehend Medical generated for the job. <code>The
|
|
457
456
|
* StartICD10CMInferenceJob</code> operation returns this identifier in its response.</p>
|
|
457
|
+
* @public
|
|
458
458
|
*/
|
|
459
459
|
JobId: string | undefined;
|
|
460
460
|
}
|
|
@@ -463,8 +463,8 @@ export interface DescribeICD10CMInferenceJobRequest {
|
|
|
463
463
|
*/
|
|
464
464
|
export interface DescribeICD10CMInferenceJobResponse {
|
|
465
465
|
/**
|
|
466
|
-
* @public
|
|
467
466
|
* <p>An object that contains the properties associated with a detection job.</p>
|
|
467
|
+
* @public
|
|
468
468
|
*/
|
|
469
469
|
ComprehendMedicalAsyncJobProperties?: ComprehendMedicalAsyncJobProperties;
|
|
470
470
|
}
|
|
@@ -473,9 +473,9 @@ export interface DescribeICD10CMInferenceJobResponse {
|
|
|
473
473
|
*/
|
|
474
474
|
export interface DescribePHIDetectionJobRequest {
|
|
475
475
|
/**
|
|
476
|
-
* @public
|
|
477
476
|
* <p>The identifier that Amazon Comprehend Medical generated for the job. The <code>StartPHIDetectionJob</code>
|
|
478
477
|
* operation returns this identifier in its response.</p>
|
|
478
|
+
* @public
|
|
479
479
|
*/
|
|
480
480
|
JobId: string | undefined;
|
|
481
481
|
}
|
|
@@ -484,8 +484,8 @@ export interface DescribePHIDetectionJobRequest {
|
|
|
484
484
|
*/
|
|
485
485
|
export interface DescribePHIDetectionJobResponse {
|
|
486
486
|
/**
|
|
487
|
-
* @public
|
|
488
487
|
* <p>An object that contains the properties associated with a detection job.</p>
|
|
488
|
+
* @public
|
|
489
489
|
*/
|
|
490
490
|
ComprehendMedicalAsyncJobProperties?: ComprehendMedicalAsyncJobProperties;
|
|
491
491
|
}
|
|
@@ -494,9 +494,9 @@ export interface DescribePHIDetectionJobResponse {
|
|
|
494
494
|
*/
|
|
495
495
|
export interface DescribeRxNormInferenceJobRequest {
|
|
496
496
|
/**
|
|
497
|
-
* @public
|
|
498
497
|
* <p>The identifier that Amazon Comprehend Medical generated for the job. The
|
|
499
498
|
* StartRxNormInferenceJob operation returns this identifier in its response.</p>
|
|
499
|
+
* @public
|
|
500
500
|
*/
|
|
501
501
|
JobId: string | undefined;
|
|
502
502
|
}
|
|
@@ -505,8 +505,8 @@ export interface DescribeRxNormInferenceJobRequest {
|
|
|
505
505
|
*/
|
|
506
506
|
export interface DescribeRxNormInferenceJobResponse {
|
|
507
507
|
/**
|
|
508
|
-
* @public
|
|
509
508
|
* <p>An object that contains the properties associated with a detection job.</p>
|
|
509
|
+
* @public
|
|
510
510
|
*/
|
|
511
511
|
ComprehendMedicalAsyncJobProperties?: ComprehendMedicalAsyncJobProperties;
|
|
512
512
|
}
|
|
@@ -515,10 +515,10 @@ export interface DescribeRxNormInferenceJobResponse {
|
|
|
515
515
|
*/
|
|
516
516
|
export interface DescribeSNOMEDCTInferenceJobRequest {
|
|
517
517
|
/**
|
|
518
|
-
* @public
|
|
519
518
|
* <p>
|
|
520
519
|
* The identifier that Amazon Comprehend Medical generated for the job. The StartSNOMEDCTInferenceJob operation returns this identifier in its response.
|
|
521
520
|
* </p>
|
|
521
|
+
* @public
|
|
522
522
|
*/
|
|
523
523
|
JobId: string | undefined;
|
|
524
524
|
}
|
|
@@ -527,8 +527,8 @@ export interface DescribeSNOMEDCTInferenceJobRequest {
|
|
|
527
527
|
*/
|
|
528
528
|
export interface DescribeSNOMEDCTInferenceJobResponse {
|
|
529
529
|
/**
|
|
530
|
-
* @public
|
|
531
530
|
* <p>Provides information about a detection job.</p>
|
|
531
|
+
* @public
|
|
532
532
|
*/
|
|
533
533
|
ComprehendMedicalAsyncJobProperties?: ComprehendMedicalAsyncJobProperties;
|
|
534
534
|
}
|
|
@@ -537,80 +537,80 @@ export interface DescribeSNOMEDCTInferenceJobResponse {
|
|
|
537
537
|
*/
|
|
538
538
|
export interface DetectEntitiesRequest {
|
|
539
539
|
/**
|
|
540
|
-
* @public
|
|
541
540
|
* <p> A UTF-8 text string containing the clinical content being examined for entities.</p>
|
|
541
|
+
* @public
|
|
542
542
|
*/
|
|
543
543
|
Text: string | undefined;
|
|
544
544
|
}
|
|
545
545
|
/**
|
|
546
|
-
* @public
|
|
547
546
|
* <p> Provides information about an extracted medical entity.</p>
|
|
547
|
+
* @public
|
|
548
548
|
*/
|
|
549
549
|
export interface Entity {
|
|
550
550
|
/**
|
|
551
|
-
* @public
|
|
552
551
|
* <p> The numeric identifier for the entity. This is a monotonically increasing id unique
|
|
553
552
|
* within this response rather than a global unique identifier. </p>
|
|
553
|
+
* @public
|
|
554
554
|
*/
|
|
555
555
|
Id?: number;
|
|
556
556
|
/**
|
|
557
|
-
* @public
|
|
558
557
|
* <p> The 0-based character offset in the input text that shows where the entity begins. The
|
|
559
558
|
* offset returns the UTF-8 code point in the string. </p>
|
|
559
|
+
* @public
|
|
560
560
|
*/
|
|
561
561
|
BeginOffset?: number;
|
|
562
562
|
/**
|
|
563
|
-
* @public
|
|
564
563
|
* <p> The 0-based character offset in the input text that shows where the entity ends. The
|
|
565
564
|
* offset returns the UTF-8 code point in the string. </p>
|
|
565
|
+
* @public
|
|
566
566
|
*/
|
|
567
567
|
EndOffset?: number;
|
|
568
568
|
/**
|
|
569
|
-
* @public
|
|
570
569
|
* <p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.</p>
|
|
570
|
+
* @public
|
|
571
571
|
*/
|
|
572
572
|
Score?: number;
|
|
573
573
|
/**
|
|
574
|
-
* @public
|
|
575
574
|
* <p> The segment of input text extracted as this entity.</p>
|
|
575
|
+
* @public
|
|
576
576
|
*/
|
|
577
577
|
Text?: string;
|
|
578
578
|
/**
|
|
579
|
-
* @public
|
|
580
579
|
* <p> The category of the entity.</p>
|
|
580
|
+
* @public
|
|
581
581
|
*/
|
|
582
582
|
Category?: EntityType;
|
|
583
583
|
/**
|
|
584
|
-
* @public
|
|
585
584
|
* <p> Describes the specific type of entity with category of entities.</p>
|
|
585
|
+
* @public
|
|
586
586
|
*/
|
|
587
587
|
Type?: EntitySubType;
|
|
588
588
|
/**
|
|
589
|
-
* @public
|
|
590
589
|
* <p>Contextual information for the entity.</p>
|
|
590
|
+
* @public
|
|
591
591
|
*/
|
|
592
592
|
Traits?: Trait[];
|
|
593
593
|
/**
|
|
594
|
-
* @public
|
|
595
594
|
* <p> The extracted attributes that relate to this entity.</p>
|
|
595
|
+
* @public
|
|
596
596
|
*/
|
|
597
597
|
Attributes?: Attribute[];
|
|
598
598
|
}
|
|
599
599
|
/**
|
|
600
|
-
* @public
|
|
601
600
|
* <p>An attribute that was extracted, but Amazon Comprehend Medical was unable to relate to an entity. </p>
|
|
601
|
+
* @public
|
|
602
602
|
*/
|
|
603
603
|
export interface UnmappedAttribute {
|
|
604
604
|
/**
|
|
605
|
-
* @public
|
|
606
605
|
* <p> The type of the unmapped attribute, could be one of the following values: "MEDICATION",
|
|
607
606
|
* "MEDICAL_CONDITION", "ANATOMY", "TEST_AND_TREATMENT_PROCEDURE" or
|
|
608
607
|
* "PROTECTED_HEALTH_INFORMATION". </p>
|
|
608
|
+
* @public
|
|
609
609
|
*/
|
|
610
610
|
Type?: EntityType;
|
|
611
611
|
/**
|
|
612
|
-
* @public
|
|
613
612
|
* <p> The specific attribute that has been extracted but not mapped to an entity. </p>
|
|
613
|
+
* @public
|
|
614
614
|
*/
|
|
615
615
|
Attribute?: Attribute;
|
|
616
616
|
}
|
|
@@ -619,37 +619,37 @@ export interface UnmappedAttribute {
|
|
|
619
619
|
*/
|
|
620
620
|
export interface DetectEntitiesResponse {
|
|
621
621
|
/**
|
|
622
|
-
* @public
|
|
623
622
|
* <p>The collection of medical entities extracted from the input text and their associated
|
|
624
623
|
* information. For each entity, the response provides the entity text, the entity category,
|
|
625
624
|
* where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the
|
|
626
625
|
* detection and analysis. Attributes and traits of the entity are also returned.</p>
|
|
626
|
+
* @public
|
|
627
627
|
*/
|
|
628
628
|
Entities: Entity[] | undefined;
|
|
629
629
|
/**
|
|
630
|
-
* @public
|
|
631
630
|
* <p>Attributes extracted from the input text that we were unable to relate to an
|
|
632
631
|
* entity.</p>
|
|
632
|
+
* @public
|
|
633
633
|
*/
|
|
634
634
|
UnmappedAttributes?: UnmappedAttribute[];
|
|
635
635
|
/**
|
|
636
|
-
* @public
|
|
637
636
|
* <p>If the result of the previous request to <code>DetectEntities</code> was truncated,
|
|
638
637
|
* include the <code>PaginationToken</code> to fetch the next page of entities.</p>
|
|
638
|
+
* @public
|
|
639
639
|
*/
|
|
640
640
|
PaginationToken?: string;
|
|
641
641
|
/**
|
|
642
|
-
* @public
|
|
643
642
|
* <p>The version of the model used to analyze the documents. The version number looks like
|
|
644
643
|
* X.X.X. You can use this information to track the model used for a particular batch of
|
|
645
644
|
* documents.</p>
|
|
645
|
+
* @public
|
|
646
646
|
*/
|
|
647
647
|
ModelVersion: string | undefined;
|
|
648
648
|
}
|
|
649
649
|
/**
|
|
650
|
-
* @public
|
|
651
650
|
* <p> The input text was not in valid UTF-8 character encoding. Check your text then retry your
|
|
652
651
|
* request.</p>
|
|
652
|
+
* @public
|
|
653
653
|
*/
|
|
654
654
|
export declare class InvalidEncodingException extends __BaseException {
|
|
655
655
|
readonly name: "InvalidEncodingException";
|
|
@@ -661,9 +661,9 @@ export declare class InvalidEncodingException extends __BaseException {
|
|
|
661
661
|
constructor(opts: __ExceptionOptionType<InvalidEncodingException, __BaseException>);
|
|
662
662
|
}
|
|
663
663
|
/**
|
|
664
|
-
* @public
|
|
665
664
|
* <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
|
|
666
665
|
* </p>
|
|
666
|
+
* @public
|
|
667
667
|
*/
|
|
668
668
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
669
669
|
readonly name: "ServiceUnavailableException";
|
|
@@ -675,9 +675,9 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
675
675
|
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
676
676
|
}
|
|
677
677
|
/**
|
|
678
|
-
* @public
|
|
679
678
|
* <p> The size of the text you submitted exceeds the size limit. Reduce the size of the text or
|
|
680
679
|
* use a smaller document and then retry your request. </p>
|
|
680
|
+
* @public
|
|
681
681
|
*/
|
|
682
682
|
export declare class TextSizeLimitExceededException extends __BaseException {
|
|
683
683
|
readonly name: "TextSizeLimitExceededException";
|
|
@@ -693,8 +693,8 @@ export declare class TextSizeLimitExceededException extends __BaseException {
|
|
|
693
693
|
*/
|
|
694
694
|
export interface DetectEntitiesV2Request {
|
|
695
695
|
/**
|
|
696
|
-
* @public
|
|
697
696
|
* <p>A UTF-8 string containing the clinical content being examined for entities.</p>
|
|
697
|
+
* @public
|
|
698
698
|
*/
|
|
699
699
|
Text: string | undefined;
|
|
700
700
|
}
|
|
@@ -703,29 +703,29 @@ export interface DetectEntitiesV2Request {
|
|
|
703
703
|
*/
|
|
704
704
|
export interface DetectEntitiesV2Response {
|
|
705
705
|
/**
|
|
706
|
-
* @public
|
|
707
706
|
* <p>The collection of medical entities extracted from the input text and their associated
|
|
708
707
|
* information. For each entity, the response provides the entity text, the entity category,
|
|
709
708
|
* where the entity text begins and ends, and the level of confidence in the detection and
|
|
710
709
|
* analysis. Attributes and traits of the entity are also returned.</p>
|
|
710
|
+
* @public
|
|
711
711
|
*/
|
|
712
712
|
Entities: Entity[] | undefined;
|
|
713
713
|
/**
|
|
714
|
-
* @public
|
|
715
714
|
* <p>Attributes extracted from the input text that couldn't be related to an entity.</p>
|
|
715
|
+
* @public
|
|
716
716
|
*/
|
|
717
717
|
UnmappedAttributes?: UnmappedAttribute[];
|
|
718
718
|
/**
|
|
719
|
-
* @public
|
|
720
719
|
* <p>If the result to the <code>DetectEntitiesV2</code> operation was truncated, include the
|
|
721
720
|
* <code>PaginationToken</code> to fetch the next page of entities.</p>
|
|
721
|
+
* @public
|
|
722
722
|
*/
|
|
723
723
|
PaginationToken?: string;
|
|
724
724
|
/**
|
|
725
|
-
* @public
|
|
726
725
|
* <p>The version of the model used to analyze the documents. The version number looks like
|
|
727
726
|
* X.X.X. You can use this information to track the model used for a particular batch of
|
|
728
727
|
* documents.</p>
|
|
728
|
+
* @public
|
|
729
729
|
*/
|
|
730
730
|
ModelVersion: string | undefined;
|
|
731
731
|
}
|
|
@@ -734,8 +734,8 @@ export interface DetectEntitiesV2Response {
|
|
|
734
734
|
*/
|
|
735
735
|
export interface DetectPHIRequest {
|
|
736
736
|
/**
|
|
737
|
-
* @public
|
|
738
737
|
* <p>A UTF-8 text string containing the clinical content being examined for PHI entities.</p>
|
|
738
|
+
* @public
|
|
739
739
|
*/
|
|
740
740
|
Text: string | undefined;
|
|
741
741
|
}
|
|
@@ -744,24 +744,24 @@ export interface DetectPHIRequest {
|
|
|
744
744
|
*/
|
|
745
745
|
export interface DetectPHIResponse {
|
|
746
746
|
/**
|
|
747
|
-
* @public
|
|
748
747
|
* <p>The collection of PHI entities extracted from the input text and their associated
|
|
749
748
|
* information. For each entity, the response provides the entity text, the entity category,
|
|
750
749
|
* where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its
|
|
751
750
|
* detection.</p>
|
|
751
|
+
* @public
|
|
752
752
|
*/
|
|
753
753
|
Entities: Entity[] | undefined;
|
|
754
754
|
/**
|
|
755
|
-
* @public
|
|
756
755
|
* <p>If the result of the previous request to <code>DetectPHI</code> was truncated, include
|
|
757
756
|
* the <code>PaginationToken</code> to fetch the next page of PHI entities. </p>
|
|
757
|
+
* @public
|
|
758
758
|
*/
|
|
759
759
|
PaginationToken?: string;
|
|
760
760
|
/**
|
|
761
|
-
* @public
|
|
762
761
|
* <p>The version of the model used to analyze the documents. The version number looks like
|
|
763
762
|
* X.X.X. You can use this information to track the model used for a particular batch of
|
|
764
763
|
* documents.</p>
|
|
764
|
+
* @public
|
|
765
765
|
*/
|
|
766
766
|
ModelVersion: string | undefined;
|
|
767
767
|
}
|
|
@@ -770,8 +770,8 @@ export interface DetectPHIResponse {
|
|
|
770
770
|
*/
|
|
771
771
|
export interface InferICD10CMRequest {
|
|
772
772
|
/**
|
|
773
|
-
* @public
|
|
774
773
|
* <p>The input text used for analysis.</p>
|
|
774
|
+
* @public
|
|
775
775
|
*/
|
|
776
776
|
Text: string | undefined;
|
|
777
777
|
}
|
|
@@ -818,21 +818,21 @@ export declare const ICD10CMTraitName: {
|
|
|
818
818
|
*/
|
|
819
819
|
export type ICD10CMTraitName = (typeof ICD10CMTraitName)[keyof typeof ICD10CMTraitName];
|
|
820
820
|
/**
|
|
821
|
-
* @public
|
|
822
821
|
* <p>Contextual information for the entity. The traits recognized by InferICD10CM are
|
|
823
822
|
* <code>DIAGNOSIS</code>, <code>SIGN</code>, <code>SYMPTOM</code>, and
|
|
824
823
|
* <code>NEGATION</code>.</p>
|
|
824
|
+
* @public
|
|
825
825
|
*/
|
|
826
826
|
export interface ICD10CMTrait {
|
|
827
827
|
/**
|
|
828
|
-
* @public
|
|
829
828
|
* <p>Provides a name or contextual description about the trait.</p>
|
|
829
|
+
* @public
|
|
830
830
|
*/
|
|
831
831
|
Name?: ICD10CMTraitName;
|
|
832
832
|
/**
|
|
833
|
-
* @public
|
|
834
833
|
* <p>The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized
|
|
835
834
|
* as a trait.</p>
|
|
835
|
+
* @public
|
|
836
836
|
*/
|
|
837
837
|
Score?: number;
|
|
838
838
|
}
|
|
@@ -854,70 +854,70 @@ export declare const ICD10CMAttributeType: {
|
|
|
854
854
|
*/
|
|
855
855
|
export type ICD10CMAttributeType = (typeof ICD10CMAttributeType)[keyof typeof ICD10CMAttributeType];
|
|
856
856
|
/**
|
|
857
|
-
* @public
|
|
858
857
|
* <p>The detected attributes that relate to an entity. This includes an extracted segment of
|
|
859
858
|
* the text that is an attribute of an entity, or otherwise related to an entity. InferICD10CM
|
|
860
859
|
* detects the following attributes: <code>Direction</code>, <code>System, Organ or Site</code>,
|
|
861
860
|
* and <code>Acuity</code>.</p>
|
|
861
|
+
* @public
|
|
862
862
|
*/
|
|
863
863
|
export interface ICD10CMAttribute {
|
|
864
864
|
/**
|
|
865
|
-
* @public
|
|
866
865
|
* <p>The type of attribute. InferICD10CM detects entities of the type <code>DX_NAME</code>.
|
|
867
866
|
* </p>
|
|
867
|
+
* @public
|
|
868
868
|
*/
|
|
869
869
|
Type?: ICD10CMAttributeType;
|
|
870
870
|
/**
|
|
871
|
-
* @public
|
|
872
871
|
* <p>The level of confidence that Amazon Comprehend Medical has that the segment of text is
|
|
873
872
|
* correctly recognized as an attribute.</p>
|
|
873
|
+
* @public
|
|
874
874
|
*/
|
|
875
875
|
Score?: number;
|
|
876
876
|
/**
|
|
877
|
-
* @public
|
|
878
877
|
* <p>The level of confidence that Amazon Comprehend Medical has that this attribute is
|
|
879
878
|
* correctly related to this entity.</p>
|
|
879
|
+
* @public
|
|
880
880
|
*/
|
|
881
881
|
RelationshipScore?: number;
|
|
882
882
|
/**
|
|
883
|
-
* @public
|
|
884
883
|
* <p>The numeric identifier for this attribute. This is a monotonically increasing id unique
|
|
885
884
|
* within this response rather than a global unique identifier.</p>
|
|
885
|
+
* @public
|
|
886
886
|
*/
|
|
887
887
|
Id?: number;
|
|
888
888
|
/**
|
|
889
|
-
* @public
|
|
890
889
|
* <p>The 0-based character offset in the input text that shows where the attribute begins. The
|
|
891
890
|
* offset returns the UTF-8 code point in the string.</p>
|
|
891
|
+
* @public
|
|
892
892
|
*/
|
|
893
893
|
BeginOffset?: number;
|
|
894
894
|
/**
|
|
895
|
-
* @public
|
|
896
895
|
* <p>The 0-based character offset in the input text that shows where the attribute ends. The
|
|
897
896
|
* offset returns the UTF-8 code point in the string.</p>
|
|
897
|
+
* @public
|
|
898
898
|
*/
|
|
899
899
|
EndOffset?: number;
|
|
900
900
|
/**
|
|
901
|
-
* @public
|
|
902
901
|
* <p>The segment of input text which contains the detected attribute.</p>
|
|
902
|
+
* @public
|
|
903
903
|
*/
|
|
904
904
|
Text?: string;
|
|
905
905
|
/**
|
|
906
|
-
* @public
|
|
907
906
|
* <p>The contextual information for the attribute. The traits recognized by InferICD10CM are
|
|
908
907
|
* <code>DIAGNOSIS</code>, <code>SIGN</code>, <code>SYMPTOM</code>, and
|
|
909
908
|
* <code>NEGATION</code>.</p>
|
|
909
|
+
* @public
|
|
910
910
|
*/
|
|
911
911
|
Traits?: ICD10CMTrait[];
|
|
912
912
|
/**
|
|
913
|
-
* @public
|
|
914
913
|
* <p>The category of attribute. Can be either of <code>DX_NAME</code> or <code>TIME_EXPRESSION</code>.</p>
|
|
914
|
+
* @public
|
|
915
915
|
*/
|
|
916
916
|
Category?: ICD10CMEntityType;
|
|
917
917
|
/**
|
|
918
|
-
* @public
|
|
919
918
|
* <p>The type of relationship between the entity and attribute. Type for the relationship can
|
|
920
919
|
* be either of <code>OVERLAP</code> or <code>SYSTEM_ORGAN_SITE</code>.</p>
|
|
920
|
+
* @public
|
|
921
921
|
*/
|
|
922
922
|
RelationshipType?: ICD10CMRelationshipType;
|
|
923
923
|
}
|
|
@@ -933,98 +933,98 @@ export declare const ICD10CMEntityCategory: {
|
|
|
933
933
|
*/
|
|
934
934
|
export type ICD10CMEntityCategory = (typeof ICD10CMEntityCategory)[keyof typeof ICD10CMEntityCategory];
|
|
935
935
|
/**
|
|
936
|
-
* @public
|
|
937
936
|
* <p> The ICD-10-CM concepts that the entity could refer to, along with a score indicating the
|
|
938
937
|
* likelihood of the match.</p>
|
|
938
|
+
* @public
|
|
939
939
|
*/
|
|
940
940
|
export interface ICD10CMConcept {
|
|
941
941
|
/**
|
|
942
|
-
* @public
|
|
943
942
|
* <p>The long description of the ICD-10-CM code in the ontology.</p>
|
|
943
|
+
* @public
|
|
944
944
|
*/
|
|
945
945
|
Description?: string;
|
|
946
946
|
/**
|
|
947
|
-
* @public
|
|
948
947
|
* <p>The ICD-10-CM code that identifies the concept found in the knowledge base from the
|
|
949
948
|
* Centers for Disease Control.</p>
|
|
949
|
+
* @public
|
|
950
950
|
*/
|
|
951
951
|
Code?: string;
|
|
952
952
|
/**
|
|
953
|
-
* @public
|
|
954
953
|
* <p>The level of confidence that Amazon Comprehend Medical has that the entity is accurately
|
|
955
954
|
* linked to an ICD-10-CM concept.</p>
|
|
955
|
+
* @public
|
|
956
956
|
*/
|
|
957
957
|
Score?: number;
|
|
958
958
|
}
|
|
959
959
|
/**
|
|
960
|
-
* @public
|
|
961
960
|
* <p>The collection of medical entities extracted from the input text and their associated
|
|
962
961
|
* information. For each entity, the response provides the entity text, the entity category,
|
|
963
962
|
* where the entity text begins and ends, and the level of confidence that Amazon Comprehend
|
|
964
963
|
* Medical has in the detection and analysis. Attributes and traits of the entity are also
|
|
965
964
|
* returned. </p>
|
|
965
|
+
* @public
|
|
966
966
|
*/
|
|
967
967
|
export interface ICD10CMEntity {
|
|
968
968
|
/**
|
|
969
|
-
* @public
|
|
970
969
|
* <p>The numeric identifier for the entity. This is a monotonically increasing id unique within
|
|
971
970
|
* this response rather than a global unique identifier.</p>
|
|
971
|
+
* @public
|
|
972
972
|
*/
|
|
973
973
|
Id?: number;
|
|
974
974
|
/**
|
|
975
|
-
* @public
|
|
976
975
|
* <p>The segment of input text that is matched to the detected entity.</p>
|
|
976
|
+
* @public
|
|
977
977
|
*/
|
|
978
978
|
Text?: string;
|
|
979
979
|
/**
|
|
980
|
-
* @public
|
|
981
980
|
* <p> The category of the entity. InferICD10CM detects entities in the
|
|
982
981
|
* <code>MEDICAL_CONDITION</code> category. </p>
|
|
982
|
+
* @public
|
|
983
983
|
*/
|
|
984
984
|
Category?: ICD10CMEntityCategory;
|
|
985
985
|
/**
|
|
986
|
-
* @public
|
|
987
986
|
* <p>Describes the specific type of entity with category of entities. InferICD10CM detects
|
|
988
987
|
* entities of the type <code>DX_NAME</code> and <code>TIME_EXPRESSION</code>.</p>
|
|
988
|
+
* @public
|
|
989
989
|
*/
|
|
990
990
|
Type?: ICD10CMEntityType;
|
|
991
991
|
/**
|
|
992
|
-
* @public
|
|
993
992
|
* <p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the
|
|
994
993
|
* detection.</p>
|
|
994
|
+
* @public
|
|
995
995
|
*/
|
|
996
996
|
Score?: number;
|
|
997
997
|
/**
|
|
998
|
-
* @public
|
|
999
998
|
* <p>The 0-based character offset in the input text that shows where the entity begins. The
|
|
1000
999
|
* offset returns the UTF-8 code point in the string.</p>
|
|
1000
|
+
* @public
|
|
1001
1001
|
*/
|
|
1002
1002
|
BeginOffset?: number;
|
|
1003
1003
|
/**
|
|
1004
|
-
* @public
|
|
1005
1004
|
* <p>The 0-based character offset in the input text that shows where the entity ends. The
|
|
1006
1005
|
* offset returns the UTF-8 code point in the string.</p>
|
|
1006
|
+
* @public
|
|
1007
1007
|
*/
|
|
1008
1008
|
EndOffset?: number;
|
|
1009
1009
|
/**
|
|
1010
|
-
* @public
|
|
1011
1010
|
* <p>The detected attributes that relate to the entity. An extracted segment of the text that
|
|
1012
1011
|
* is an attribute of an entity, or otherwise related to an entity, such as the nature of a
|
|
1013
1012
|
* medical condition.</p>
|
|
1013
|
+
* @public
|
|
1014
1014
|
*/
|
|
1015
1015
|
Attributes?: ICD10CMAttribute[];
|
|
1016
1016
|
/**
|
|
1017
|
-
* @public
|
|
1018
1017
|
* <p>Provides Contextual information for the entity. The traits recognized by InferICD10CM are
|
|
1019
1018
|
* <code>DIAGNOSIS</code>, <code>SIGN</code>, <code>SYMPTOM</code>, and
|
|
1020
1019
|
* <code>NEGATION.</code>
|
|
1021
1020
|
* </p>
|
|
1021
|
+
* @public
|
|
1022
1022
|
*/
|
|
1023
1023
|
Traits?: ICD10CMTrait[];
|
|
1024
1024
|
/**
|
|
1025
|
-
* @public
|
|
1026
1025
|
* <p>The ICD-10-CM concepts that the entity could refer to, along with a score indicating the
|
|
1027
1026
|
* likelihood of the match.</p>
|
|
1027
|
+
* @public
|
|
1028
1028
|
*/
|
|
1029
1029
|
ICD10CMConcepts?: ICD10CMConcept[];
|
|
1030
1030
|
}
|
|
@@ -1033,23 +1033,23 @@ export interface ICD10CMEntity {
|
|
|
1033
1033
|
*/
|
|
1034
1034
|
export interface InferICD10CMResponse {
|
|
1035
1035
|
/**
|
|
1036
|
-
* @public
|
|
1037
1036
|
* <p>The medical conditions detected in the text linked to ICD-10-CM concepts. If the action is
|
|
1038
1037
|
* successful, the service sends back an HTTP 200 response, as well as the entities
|
|
1039
1038
|
* detected.</p>
|
|
1039
|
+
* @public
|
|
1040
1040
|
*/
|
|
1041
1041
|
Entities: ICD10CMEntity[] | undefined;
|
|
1042
1042
|
/**
|
|
1043
|
-
* @public
|
|
1044
1043
|
* <p>If the result of the previous request to <code>InferICD10CM</code> was truncated, include
|
|
1045
1044
|
* the <code>PaginationToken</code> to fetch the next page of medical condition entities. </p>
|
|
1045
|
+
* @public
|
|
1046
1046
|
*/
|
|
1047
1047
|
PaginationToken?: string;
|
|
1048
1048
|
/**
|
|
1049
|
-
* @public
|
|
1050
1049
|
* <p>The version of the model used to analyze the documents, in the format
|
|
1051
1050
|
* <i>n</i>.<i>n</i>.<i>n</i> You can use this
|
|
1052
1051
|
* information to track the model used for a particular batch of documents.</p>
|
|
1052
|
+
* @public
|
|
1053
1053
|
*/
|
|
1054
1054
|
ModelVersion?: string;
|
|
1055
1055
|
}
|
|
@@ -1058,8 +1058,8 @@ export interface InferICD10CMResponse {
|
|
|
1058
1058
|
*/
|
|
1059
1059
|
export interface InferRxNormRequest {
|
|
1060
1060
|
/**
|
|
1061
|
-
* @public
|
|
1062
1061
|
* <p>The input text used for analysis.</p>
|
|
1062
|
+
* @public
|
|
1063
1063
|
*/
|
|
1064
1064
|
Text: string | undefined;
|
|
1065
1065
|
}
|
|
@@ -1076,21 +1076,21 @@ export declare const RxNormTraitName: {
|
|
|
1076
1076
|
*/
|
|
1077
1077
|
export type RxNormTraitName = (typeof RxNormTraitName)[keyof typeof RxNormTraitName];
|
|
1078
1078
|
/**
|
|
1079
|
-
* @public
|
|
1080
1079
|
* <p>The contextual information for the entity. InferRxNorm recognizes the trait
|
|
1081
1080
|
* <code>NEGATION</code>, which is any indication that the patient is not taking a medication.
|
|
1082
1081
|
* </p>
|
|
1082
|
+
* @public
|
|
1083
1083
|
*/
|
|
1084
1084
|
export interface RxNormTrait {
|
|
1085
1085
|
/**
|
|
1086
|
-
* @public
|
|
1087
1086
|
* <p>Provides a name or contextual description about the trait.</p>
|
|
1087
|
+
* @public
|
|
1088
1088
|
*/
|
|
1089
1089
|
Name?: RxNormTraitName;
|
|
1090
1090
|
/**
|
|
1091
|
-
* @public
|
|
1092
1091
|
* <p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected
|
|
1093
1092
|
* trait.</p>
|
|
1093
|
+
* @public
|
|
1094
1094
|
*/
|
|
1095
1095
|
Score?: number;
|
|
1096
1096
|
}
|
|
@@ -1112,58 +1112,58 @@ export declare const RxNormAttributeType: {
|
|
|
1112
1112
|
*/
|
|
1113
1113
|
export type RxNormAttributeType = (typeof RxNormAttributeType)[keyof typeof RxNormAttributeType];
|
|
1114
1114
|
/**
|
|
1115
|
-
* @public
|
|
1116
1115
|
* <p>The extracted attributes that relate to this entity. The attributes recognized by
|
|
1117
1116
|
* InferRxNorm are <code>DOSAGE</code>, <code>DURATION</code>, <code>FORM</code>,
|
|
1118
1117
|
* <code>FREQUENCY</code>, <code>RATE</code>, <code>ROUTE_OR_MODE</code>.</p>
|
|
1118
|
+
* @public
|
|
1119
1119
|
*/
|
|
1120
1120
|
export interface RxNormAttribute {
|
|
1121
1121
|
/**
|
|
1122
|
-
* @public
|
|
1123
1122
|
* <p>The type of attribute. The types of attributes recognized by InferRxNorm are
|
|
1124
1123
|
* <code>BRAND_NAME</code> and <code>GENERIC_NAME</code>.</p>
|
|
1124
|
+
* @public
|
|
1125
1125
|
*/
|
|
1126
1126
|
Type?: RxNormAttributeType;
|
|
1127
1127
|
/**
|
|
1128
|
-
* @public
|
|
1129
1128
|
* <p>The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly
|
|
1130
1129
|
* recognized as an attribute.</p>
|
|
1130
|
+
* @public
|
|
1131
1131
|
*/
|
|
1132
1132
|
Score?: number;
|
|
1133
1133
|
/**
|
|
1134
|
-
* @public
|
|
1135
1134
|
* <p>The level of confidence that Amazon Comprehend Medical has that the attribute is
|
|
1136
1135
|
* accurately linked to an entity.</p>
|
|
1136
|
+
* @public
|
|
1137
1137
|
*/
|
|
1138
1138
|
RelationshipScore?: number;
|
|
1139
1139
|
/**
|
|
1140
|
-
* @public
|
|
1141
1140
|
* <p>The numeric identifier for this attribute. This is a monotonically increasing id unique
|
|
1142
1141
|
* within this response rather than a global unique identifier.</p>
|
|
1142
|
+
* @public
|
|
1143
1143
|
*/
|
|
1144
1144
|
Id?: number;
|
|
1145
1145
|
/**
|
|
1146
|
-
* @public
|
|
1147
1146
|
* <p>The 0-based character offset in the input text that shows where the attribute begins. The
|
|
1148
1147
|
* offset returns the UTF-8 code point in the string.</p>
|
|
1148
|
+
* @public
|
|
1149
1149
|
*/
|
|
1150
1150
|
BeginOffset?: number;
|
|
1151
1151
|
/**
|
|
1152
|
-
* @public
|
|
1153
1152
|
* <p>The 0-based character offset in the input text that shows where the attribute ends. The
|
|
1154
1153
|
* offset returns the UTF-8 code point in the string.</p>
|
|
1154
|
+
* @public
|
|
1155
1155
|
*/
|
|
1156
1156
|
EndOffset?: number;
|
|
1157
1157
|
/**
|
|
1158
|
-
* @public
|
|
1159
1158
|
* <p>The segment of input text which corresponds to the detected attribute.</p>
|
|
1159
|
+
* @public
|
|
1160
1160
|
*/
|
|
1161
1161
|
Text?: string;
|
|
1162
1162
|
/**
|
|
1163
|
-
* @public
|
|
1164
1163
|
* <p>Contextual information for the attribute. InferRxNorm recognizes the trait
|
|
1165
1164
|
* <code>NEGATION</code> for attributes, i.e. that the patient is not taking a specific dose or
|
|
1166
1165
|
* form of a medication.</p>
|
|
1166
|
+
* @public
|
|
1167
1167
|
*/
|
|
1168
1168
|
Traits?: RxNormTrait[];
|
|
1169
1169
|
}
|
|
@@ -1179,25 +1179,25 @@ export declare const RxNormEntityCategory: {
|
|
|
1179
1179
|
*/
|
|
1180
1180
|
export type RxNormEntityCategory = (typeof RxNormEntityCategory)[keyof typeof RxNormEntityCategory];
|
|
1181
1181
|
/**
|
|
1182
|
-
* @public
|
|
1183
1182
|
* <p>The RxNorm concept that the entity could refer to, along with a score indicating the
|
|
1184
1183
|
* likelihood of the match.</p>
|
|
1184
|
+
* @public
|
|
1185
1185
|
*/
|
|
1186
1186
|
export interface RxNormConcept {
|
|
1187
1187
|
/**
|
|
1188
|
-
* @public
|
|
1189
1188
|
* <p>The description of the RxNorm concept.</p>
|
|
1189
|
+
* @public
|
|
1190
1190
|
*/
|
|
1191
1191
|
Description?: string;
|
|
1192
1192
|
/**
|
|
1193
|
-
* @public
|
|
1194
1193
|
* <p>RxNorm concept ID, also known as the RxCUI.</p>
|
|
1194
|
+
* @public
|
|
1195
1195
|
*/
|
|
1196
1196
|
Code?: string;
|
|
1197
1197
|
/**
|
|
1198
|
-
* @public
|
|
1199
1198
|
* <p>The level of confidence that Amazon Comprehend Medical has that the entity is accurately
|
|
1200
1199
|
* linked to the reported RxNorm concept.</p>
|
|
1200
|
+
* @public
|
|
1201
1201
|
*/
|
|
1202
1202
|
Score?: number;
|
|
1203
1203
|
}
|
|
@@ -1214,72 +1214,72 @@ export declare const RxNormEntityType: {
|
|
|
1214
1214
|
*/
|
|
1215
1215
|
export type RxNormEntityType = (typeof RxNormEntityType)[keyof typeof RxNormEntityType];
|
|
1216
1216
|
/**
|
|
1217
|
-
* @public
|
|
1218
1217
|
* <p>The collection of medical entities extracted from the input text and their associated
|
|
1219
1218
|
* information. For each entity, the response provides the entity text, the entity category,
|
|
1220
1219
|
* where the entity text begins and ends, and the level of confidence that Amazon Comprehend
|
|
1221
1220
|
* Medical has in the detection and analysis. Attributes and traits of the entity are also
|
|
1222
1221
|
* returned. </p>
|
|
1222
|
+
* @public
|
|
1223
1223
|
*/
|
|
1224
1224
|
export interface RxNormEntity {
|
|
1225
1225
|
/**
|
|
1226
|
-
* @public
|
|
1227
1226
|
* <p>The numeric identifier for the entity. This is a monotonically increasing id unique within
|
|
1228
1227
|
* this response rather than a global unique identifier.</p>
|
|
1228
|
+
* @public
|
|
1229
1229
|
*/
|
|
1230
1230
|
Id?: number;
|
|
1231
1231
|
/**
|
|
1232
|
-
* @public
|
|
1233
1232
|
* <p>The segment of input text extracted from which the entity was detected.</p>
|
|
1233
|
+
* @public
|
|
1234
1234
|
*/
|
|
1235
1235
|
Text?: string;
|
|
1236
1236
|
/**
|
|
1237
|
-
* @public
|
|
1238
1237
|
* <p>The category of the entity. The recognized categories are <code>GENERIC</code> or
|
|
1239
1238
|
* <code>BRAND_NAME</code>.</p>
|
|
1239
|
+
* @public
|
|
1240
1240
|
*/
|
|
1241
1241
|
Category?: RxNormEntityCategory;
|
|
1242
1242
|
/**
|
|
1243
|
-
* @public
|
|
1244
1243
|
* <p> Describes the specific type of entity. For InferRxNorm, the recognized entity type is
|
|
1245
1244
|
* <code>MEDICATION</code>.</p>
|
|
1245
|
+
* @public
|
|
1246
1246
|
*/
|
|
1247
1247
|
Type?: RxNormEntityType;
|
|
1248
1248
|
/**
|
|
1249
|
-
* @public
|
|
1250
1249
|
* <p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected
|
|
1251
1250
|
* entity.</p>
|
|
1251
|
+
* @public
|
|
1252
1252
|
*/
|
|
1253
1253
|
Score?: number;
|
|
1254
1254
|
/**
|
|
1255
|
-
* @public
|
|
1256
1255
|
* <p>The 0-based character offset in the input text that shows where the entity begins. The
|
|
1257
1256
|
* offset returns the UTF-8 code point in the string.</p>
|
|
1257
|
+
* @public
|
|
1258
1258
|
*/
|
|
1259
1259
|
BeginOffset?: number;
|
|
1260
1260
|
/**
|
|
1261
|
-
* @public
|
|
1262
1261
|
* <p>The 0-based character offset in the input text that shows where the entity ends. The
|
|
1263
1262
|
* offset returns the UTF-8 code point in the string.</p>
|
|
1263
|
+
* @public
|
|
1264
1264
|
*/
|
|
1265
1265
|
EndOffset?: number;
|
|
1266
1266
|
/**
|
|
1267
|
-
* @public
|
|
1268
1267
|
* <p>The extracted attributes that relate to the entity. The attributes recognized by
|
|
1269
1268
|
* InferRxNorm are <code>DOSAGE</code>, <code>DURATION</code>, <code>FORM</code>,
|
|
1270
1269
|
* <code>FREQUENCY</code>, <code>RATE</code>, <code>ROUTE_OR_MODE</code>, and
|
|
1271
1270
|
* <code>STRENGTH</code>.</p>
|
|
1271
|
+
* @public
|
|
1272
1272
|
*/
|
|
1273
1273
|
Attributes?: RxNormAttribute[];
|
|
1274
1274
|
/**
|
|
1275
|
-
* @public
|
|
1276
1275
|
* <p>Contextual information for the entity.</p>
|
|
1276
|
+
* @public
|
|
1277
1277
|
*/
|
|
1278
1278
|
Traits?: RxNormTrait[];
|
|
1279
1279
|
/**
|
|
1280
|
-
* @public
|
|
1281
1280
|
* <p>The RxNorm concepts that the entity could refer to, along with a score indicating the
|
|
1282
1281
|
* likelihood of the match.</p>
|
|
1282
|
+
* @public
|
|
1283
1283
|
*/
|
|
1284
1284
|
RxNormConcepts?: RxNormConcept[];
|
|
1285
1285
|
}
|
|
@@ -1288,23 +1288,23 @@ export interface RxNormEntity {
|
|
|
1288
1288
|
*/
|
|
1289
1289
|
export interface InferRxNormResponse {
|
|
1290
1290
|
/**
|
|
1291
|
-
* @public
|
|
1292
1291
|
* <p>The medication entities detected in the text linked to RxNorm concepts. If the action is
|
|
1293
1292
|
* successful, the service sends back an HTTP 200 response, as well as the entities
|
|
1294
1293
|
* detected.</p>
|
|
1294
|
+
* @public
|
|
1295
1295
|
*/
|
|
1296
1296
|
Entities: RxNormEntity[] | undefined;
|
|
1297
1297
|
/**
|
|
1298
|
-
* @public
|
|
1299
1298
|
* <p>If the result of the previous request to <code>InferRxNorm</code> was truncated, include
|
|
1300
1299
|
* the <code>PaginationToken</code> to fetch the next page of medication entities.</p>
|
|
1300
|
+
* @public
|
|
1301
1301
|
*/
|
|
1302
1302
|
PaginationToken?: string;
|
|
1303
1303
|
/**
|
|
1304
|
-
* @public
|
|
1305
1304
|
* <p>The version of the model used to analyze the documents, in the format
|
|
1306
1305
|
* <i>n</i>.<i>n</i>.<i>n</i> You can use this
|
|
1307
1306
|
* information to track the model used for a particular batch of documents.</p>
|
|
1307
|
+
* @public
|
|
1308
1308
|
*/
|
|
1309
1309
|
ModelVersion?: string;
|
|
1310
1310
|
}
|
|
@@ -1313,8 +1313,8 @@ export interface InferRxNormResponse {
|
|
|
1313
1313
|
*/
|
|
1314
1314
|
export interface InferSNOMEDCTRequest {
|
|
1315
1315
|
/**
|
|
1316
|
-
* @public
|
|
1317
1316
|
* <p>The input text to be analyzed using InferSNOMEDCT.</p>
|
|
1317
|
+
* @public
|
|
1318
1318
|
*/
|
|
1319
1319
|
Text: string | undefined;
|
|
1320
1320
|
}
|
|
@@ -1349,31 +1349,31 @@ export declare const SNOMEDCTRelationshipType: {
|
|
|
1349
1349
|
*/
|
|
1350
1350
|
export type SNOMEDCTRelationshipType = (typeof SNOMEDCTRelationshipType)[keyof typeof SNOMEDCTRelationshipType];
|
|
1351
1351
|
/**
|
|
1352
|
-
* @public
|
|
1353
1352
|
* <p>
|
|
1354
1353
|
* The SNOMED-CT concepts that the entity could refer to, along with a score indicating the likelihood of the match.
|
|
1355
1354
|
* </p>
|
|
1355
|
+
* @public
|
|
1356
1356
|
*/
|
|
1357
1357
|
export interface SNOMEDCTConcept {
|
|
1358
1358
|
/**
|
|
1359
|
-
* @public
|
|
1360
1359
|
* <p>
|
|
1361
1360
|
* The description of the SNOMED-CT concept.
|
|
1362
1361
|
* </p>
|
|
1362
|
+
* @public
|
|
1363
1363
|
*/
|
|
1364
1364
|
Description?: string;
|
|
1365
1365
|
/**
|
|
1366
|
-
* @public
|
|
1367
1366
|
* <p>
|
|
1368
1367
|
* The numeric ID for the SNOMED-CT concept.
|
|
1369
1368
|
* </p>
|
|
1369
|
+
* @public
|
|
1370
1370
|
*/
|
|
1371
1371
|
Code?: string;
|
|
1372
1372
|
/**
|
|
1373
|
-
* @public
|
|
1374
1373
|
* <p>
|
|
1375
1374
|
* The level of confidence Amazon Comprehend Medical has that the entity should be linked to the identified SNOMED-CT concept.
|
|
1376
1375
|
* </p>
|
|
1376
|
+
* @public
|
|
1377
1377
|
*/
|
|
1378
1378
|
Score?: number;
|
|
1379
1379
|
}
|
|
@@ -1397,24 +1397,24 @@ export declare const SNOMEDCTTraitName: {
|
|
|
1397
1397
|
*/
|
|
1398
1398
|
export type SNOMEDCTTraitName = (typeof SNOMEDCTTraitName)[keyof typeof SNOMEDCTTraitName];
|
|
1399
1399
|
/**
|
|
1400
|
-
* @public
|
|
1401
1400
|
* <p>
|
|
1402
1401
|
* Contextual information for an entity.
|
|
1403
1402
|
* </p>
|
|
1403
|
+
* @public
|
|
1404
1404
|
*/
|
|
1405
1405
|
export interface SNOMEDCTTrait {
|
|
1406
1406
|
/**
|
|
1407
|
-
* @public
|
|
1408
1407
|
* <p>
|
|
1409
1408
|
* The name or contextual description of a detected trait.
|
|
1410
1409
|
* </p>
|
|
1410
|
+
* @public
|
|
1411
1411
|
*/
|
|
1412
1412
|
Name?: SNOMEDCTTraitName;
|
|
1413
1413
|
/**
|
|
1414
|
-
* @public
|
|
1415
1414
|
* <p>
|
|
1416
1415
|
* The level of confidence that Amazon Comprehend Medical has in the accuracy of a detected trait.
|
|
1417
1416
|
* </p>
|
|
1417
|
+
* @public
|
|
1418
1418
|
*/
|
|
1419
1419
|
Score?: number;
|
|
1420
1420
|
}
|
|
@@ -1435,87 +1435,87 @@ export declare const SNOMEDCTAttributeType: {
|
|
|
1435
1435
|
*/
|
|
1436
1436
|
export type SNOMEDCTAttributeType = (typeof SNOMEDCTAttributeType)[keyof typeof SNOMEDCTAttributeType];
|
|
1437
1437
|
/**
|
|
1438
|
-
* @public
|
|
1439
1438
|
* <p>
|
|
1440
1439
|
* The extracted attributes that relate to an entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken.
|
|
1441
1440
|
* </p>
|
|
1441
|
+
* @public
|
|
1442
1442
|
*/
|
|
1443
1443
|
export interface SNOMEDCTAttribute {
|
|
1444
1444
|
/**
|
|
1445
|
-
* @public
|
|
1446
1445
|
* <p>
|
|
1447
1446
|
* The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.
|
|
1448
1447
|
* </p>
|
|
1448
|
+
* @public
|
|
1449
1449
|
*/
|
|
1450
1450
|
Category?: SNOMEDCTEntityCategory;
|
|
1451
1451
|
/**
|
|
1452
|
-
* @public
|
|
1453
1452
|
* <p>
|
|
1454
1453
|
* The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.
|
|
1455
1454
|
* </p>
|
|
1455
|
+
* @public
|
|
1456
1456
|
*/
|
|
1457
1457
|
Type?: SNOMEDCTAttributeType;
|
|
1458
1458
|
/**
|
|
1459
|
-
* @public
|
|
1460
1459
|
* <p>
|
|
1461
1460
|
* The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
|
|
1462
1461
|
* </p>
|
|
1462
|
+
* @public
|
|
1463
1463
|
*/
|
|
1464
1464
|
Score?: number;
|
|
1465
1465
|
/**
|
|
1466
|
-
* @public
|
|
1467
1466
|
* <p>
|
|
1468
1467
|
* The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
|
|
1469
1468
|
* </p>
|
|
1469
|
+
* @public
|
|
1470
1470
|
*/
|
|
1471
1471
|
RelationshipScore?: number;
|
|
1472
1472
|
/**
|
|
1473
|
-
* @public
|
|
1474
1473
|
* <p>
|
|
1475
1474
|
* The type of relationship that exists between the entity and the related attribute.
|
|
1476
1475
|
* </p>
|
|
1476
|
+
* @public
|
|
1477
1477
|
*/
|
|
1478
1478
|
RelationshipType?: SNOMEDCTRelationshipType;
|
|
1479
1479
|
/**
|
|
1480
|
-
* @public
|
|
1481
1480
|
* <p>
|
|
1482
1481
|
* The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
|
|
1483
1482
|
* </p>
|
|
1483
|
+
* @public
|
|
1484
1484
|
*/
|
|
1485
1485
|
Id?: number;
|
|
1486
1486
|
/**
|
|
1487
|
-
* @public
|
|
1488
1487
|
* <p>
|
|
1489
1488
|
* The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.
|
|
1490
1489
|
* </p>
|
|
1490
|
+
* @public
|
|
1491
1491
|
*/
|
|
1492
1492
|
BeginOffset?: number;
|
|
1493
1493
|
/**
|
|
1494
|
-
* @public
|
|
1495
1494
|
* <p>
|
|
1496
1495
|
* The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.
|
|
1497
1496
|
* </p>
|
|
1497
|
+
* @public
|
|
1498
1498
|
*/
|
|
1499
1499
|
EndOffset?: number;
|
|
1500
1500
|
/**
|
|
1501
|
-
* @public
|
|
1502
1501
|
* <p>
|
|
1503
1502
|
* The segment of input text extracted as this attribute.
|
|
1504
1503
|
* </p>
|
|
1504
|
+
* @public
|
|
1505
1505
|
*/
|
|
1506
1506
|
Text?: string;
|
|
1507
1507
|
/**
|
|
1508
|
-
* @public
|
|
1509
1508
|
* <p>
|
|
1510
1509
|
* Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.
|
|
1511
1510
|
* </p>
|
|
1511
|
+
* @public
|
|
1512
1512
|
*/
|
|
1513
1513
|
Traits?: SNOMEDCTTrait[];
|
|
1514
1514
|
/**
|
|
1515
|
-
* @public
|
|
1516
1515
|
* <p>
|
|
1517
1516
|
* The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.
|
|
1518
1517
|
* </p>
|
|
1518
|
+
* @public
|
|
1519
1519
|
*/
|
|
1520
1520
|
SNOMEDCTConcepts?: SNOMEDCTConcept[];
|
|
1521
1521
|
}
|
|
@@ -1534,109 +1534,109 @@ export declare const SNOMEDCTEntityType: {
|
|
|
1534
1534
|
*/
|
|
1535
1535
|
export type SNOMEDCTEntityType = (typeof SNOMEDCTEntityType)[keyof typeof SNOMEDCTEntityType];
|
|
1536
1536
|
/**
|
|
1537
|
-
* @public
|
|
1538
1537
|
* <p>
|
|
1539
1538
|
* The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
|
|
1540
1539
|
* </p>
|
|
1540
|
+
* @public
|
|
1541
1541
|
*/
|
|
1542
1542
|
export interface SNOMEDCTEntity {
|
|
1543
1543
|
/**
|
|
1544
|
-
* @public
|
|
1545
1544
|
* <p>
|
|
1546
1545
|
* The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
|
|
1547
1546
|
* </p>
|
|
1547
|
+
* @public
|
|
1548
1548
|
*/
|
|
1549
1549
|
Id?: number;
|
|
1550
1550
|
/**
|
|
1551
|
-
* @public
|
|
1552
1551
|
* <p>
|
|
1553
1552
|
* The segment of input text extracted as this entity.
|
|
1554
1553
|
* </p>
|
|
1554
|
+
* @public
|
|
1555
1555
|
*/
|
|
1556
1556
|
Text?: string;
|
|
1557
1557
|
/**
|
|
1558
|
-
* @public
|
|
1559
1558
|
* <p>
|
|
1560
1559
|
* The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
|
|
1561
1560
|
* </p>
|
|
1561
|
+
* @public
|
|
1562
1562
|
*/
|
|
1563
1563
|
Category?: SNOMEDCTEntityCategory;
|
|
1564
1564
|
/**
|
|
1565
|
-
* @public
|
|
1566
1565
|
* <p>
|
|
1567
1566
|
* Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
|
|
1568
1567
|
* </p>
|
|
1568
|
+
* @public
|
|
1569
1569
|
*/
|
|
1570
1570
|
Type?: SNOMEDCTEntityType;
|
|
1571
1571
|
/**
|
|
1572
|
-
* @public
|
|
1573
1572
|
* <p>
|
|
1574
1573
|
* The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
|
|
1575
1574
|
* </p>
|
|
1575
|
+
* @public
|
|
1576
1576
|
*/
|
|
1577
1577
|
Score?: number;
|
|
1578
1578
|
/**
|
|
1579
|
-
* @public
|
|
1580
1579
|
* <p>
|
|
1581
1580
|
* The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.
|
|
1582
1581
|
* </p>
|
|
1582
|
+
* @public
|
|
1583
1583
|
*/
|
|
1584
1584
|
BeginOffset?: number;
|
|
1585
1585
|
/**
|
|
1586
|
-
* @public
|
|
1587
1586
|
* <p>
|
|
1588
1587
|
* The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.
|
|
1589
1588
|
* </p>
|
|
1589
|
+
* @public
|
|
1590
1590
|
*/
|
|
1591
1591
|
EndOffset?: number;
|
|
1592
1592
|
/**
|
|
1593
|
-
* @public
|
|
1594
1593
|
* <p>
|
|
1595
1594
|
* An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken.
|
|
1596
1595
|
* </p>
|
|
1596
|
+
* @public
|
|
1597
1597
|
*/
|
|
1598
1598
|
Attributes?: SNOMEDCTAttribute[];
|
|
1599
1599
|
/**
|
|
1600
|
-
* @public
|
|
1601
1600
|
* <p>
|
|
1602
1601
|
* Contextual information for the entity.
|
|
1603
1602
|
* </p>
|
|
1603
|
+
* @public
|
|
1604
1604
|
*/
|
|
1605
1605
|
Traits?: SNOMEDCTTrait[];
|
|
1606
1606
|
/**
|
|
1607
|
-
* @public
|
|
1608
1607
|
* <p>
|
|
1609
1608
|
* The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
|
|
1610
1609
|
* </p>
|
|
1610
|
+
* @public
|
|
1611
1611
|
*/
|
|
1612
1612
|
SNOMEDCTConcepts?: SNOMEDCTConcept[];
|
|
1613
1613
|
}
|
|
1614
1614
|
/**
|
|
1615
|
-
* @public
|
|
1616
1615
|
* <p>
|
|
1617
1616
|
* The information about the revision of the SNOMED-CT ontology in the response. Specifically, the details include the SNOMED-CT edition, language, and version date.
|
|
1618
1617
|
* </p>
|
|
1618
|
+
* @public
|
|
1619
1619
|
*/
|
|
1620
1620
|
export interface SNOMEDCTDetails {
|
|
1621
1621
|
/**
|
|
1622
|
-
* @public
|
|
1623
1622
|
* <p>
|
|
1624
1623
|
* The edition of SNOMED-CT used. The edition used for the InferSNOMEDCT editions is the US edition.
|
|
1625
1624
|
* </p>
|
|
1625
|
+
* @public
|
|
1626
1626
|
*/
|
|
1627
1627
|
Edition?: string;
|
|
1628
1628
|
/**
|
|
1629
|
-
* @public
|
|
1630
1629
|
* <p>
|
|
1631
1630
|
* The language used in the SNOMED-CT ontology. All Amazon Comprehend Medical operations are US English (en).
|
|
1632
1631
|
* </p>
|
|
1632
|
+
* @public
|
|
1633
1633
|
*/
|
|
1634
1634
|
Language?: string;
|
|
1635
1635
|
/**
|
|
1636
|
-
* @public
|
|
1637
1636
|
* <p>
|
|
1638
1637
|
* The version date of the SNOMED-CT ontology used.
|
|
1639
1638
|
* </p>
|
|
1639
|
+
* @public
|
|
1640
1640
|
*/
|
|
1641
1641
|
VersionDate?: string;
|
|
1642
1642
|
}
|
|
@@ -1645,69 +1645,69 @@ export interface SNOMEDCTDetails {
|
|
|
1645
1645
|
*/
|
|
1646
1646
|
export interface InferSNOMEDCTResponse {
|
|
1647
1647
|
/**
|
|
1648
|
-
* @public
|
|
1649
1648
|
* <p>
|
|
1650
1649
|
* The collection of medical concept entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
|
|
1651
1650
|
* </p>
|
|
1651
|
+
* @public
|
|
1652
1652
|
*/
|
|
1653
1653
|
Entities: SNOMEDCTEntity[] | undefined;
|
|
1654
1654
|
/**
|
|
1655
|
-
* @public
|
|
1656
1655
|
* <p>
|
|
1657
1656
|
* If the result of the request is truncated, the pagination token can be used to fetch the next page of entities.
|
|
1658
1657
|
* </p>
|
|
1658
|
+
* @public
|
|
1659
1659
|
*/
|
|
1660
1660
|
PaginationToken?: string;
|
|
1661
1661
|
/**
|
|
1662
|
-
* @public
|
|
1663
1662
|
* <p>
|
|
1664
1663
|
* The version of the model used to analyze the documents, in the format n.n.n You can use this information to track the model used for a particular batch of documents.
|
|
1665
1664
|
* </p>
|
|
1665
|
+
* @public
|
|
1666
1666
|
*/
|
|
1667
1667
|
ModelVersion?: string;
|
|
1668
1668
|
/**
|
|
1669
|
-
* @public
|
|
1670
1669
|
* <p>
|
|
1671
1670
|
* The details of the SNOMED-CT revision, including the edition, language, and version date.
|
|
1672
1671
|
* </p>
|
|
1672
|
+
* @public
|
|
1673
1673
|
*/
|
|
1674
1674
|
SNOMEDCTDetails?: SNOMEDCTDetails;
|
|
1675
1675
|
/**
|
|
1676
|
-
* @public
|
|
1677
1676
|
* <p>
|
|
1678
1677
|
* The number of characters in the input request documentation.
|
|
1679
1678
|
* </p>
|
|
1679
|
+
* @public
|
|
1680
1680
|
*/
|
|
1681
1681
|
Characters?: Characters;
|
|
1682
1682
|
}
|
|
1683
1683
|
/**
|
|
1684
|
-
* @public
|
|
1685
1684
|
* <p>Provides information for filtering a list of detection jobs.</p>
|
|
1685
|
+
* @public
|
|
1686
1686
|
*/
|
|
1687
1687
|
export interface ComprehendMedicalAsyncJobFilter {
|
|
1688
1688
|
/**
|
|
1689
|
-
* @public
|
|
1690
1689
|
* <p>Filters on the name of the job.</p>
|
|
1690
|
+
* @public
|
|
1691
1691
|
*/
|
|
1692
1692
|
JobName?: string;
|
|
1693
1693
|
/**
|
|
1694
|
-
* @public
|
|
1695
1694
|
* <p>Filters the list of jobs based on job status. Returns only jobs with the specified
|
|
1696
1695
|
* status.</p>
|
|
1696
|
+
* @public
|
|
1697
1697
|
*/
|
|
1698
1698
|
JobStatus?: JobStatus;
|
|
1699
1699
|
/**
|
|
1700
|
-
* @public
|
|
1701
1700
|
* <p>Filters the list of jobs based on the time that the job was submitted for processing.
|
|
1702
1701
|
* Returns only jobs submitted before the specified time. Jobs are returned in ascending order,
|
|
1703
1702
|
* oldest to newest.</p>
|
|
1703
|
+
* @public
|
|
1704
1704
|
*/
|
|
1705
1705
|
SubmitTimeBefore?: Date;
|
|
1706
1706
|
/**
|
|
1707
|
-
* @public
|
|
1708
1707
|
* <p>Filters the list of jobs based on the time that the job was submitted for processing.
|
|
1709
1708
|
* Returns only jobs submitted after the specified time. Jobs are returned in descending order,
|
|
1710
1709
|
* newest to oldest.</p>
|
|
1710
|
+
* @public
|
|
1711
1711
|
*/
|
|
1712
1712
|
SubmitTimeAfter?: Date;
|
|
1713
1713
|
}
|
|
@@ -1716,19 +1716,19 @@ export interface ComprehendMedicalAsyncJobFilter {
|
|
|
1716
1716
|
*/
|
|
1717
1717
|
export interface ListEntitiesDetectionV2JobsRequest {
|
|
1718
1718
|
/**
|
|
1719
|
-
* @public
|
|
1720
1719
|
* <p>Filters the jobs that are returned. You can filter jobs based on their names, status, or
|
|
1721
1720
|
* the date and time that they were submitted. You can only set one filter at a time.</p>
|
|
1721
|
+
* @public
|
|
1722
1722
|
*/
|
|
1723
1723
|
Filter?: ComprehendMedicalAsyncJobFilter;
|
|
1724
1724
|
/**
|
|
1725
|
-
* @public
|
|
1726
1725
|
* <p>Identifies the next page of results to return.</p>
|
|
1726
|
+
* @public
|
|
1727
1727
|
*/
|
|
1728
1728
|
NextToken?: string;
|
|
1729
1729
|
/**
|
|
1730
|
-
* @public
|
|
1731
1730
|
* <p>The maximum number of results to return in each page. The default is 100.</p>
|
|
1731
|
+
* @public
|
|
1732
1732
|
*/
|
|
1733
1733
|
MaxResults?: number;
|
|
1734
1734
|
}
|
|
@@ -1737,20 +1737,20 @@ export interface ListEntitiesDetectionV2JobsRequest {
|
|
|
1737
1737
|
*/
|
|
1738
1738
|
export interface ListEntitiesDetectionV2JobsResponse {
|
|
1739
1739
|
/**
|
|
1740
|
-
* @public
|
|
1741
1740
|
* <p>A list containing the properties of each job returned.</p>
|
|
1741
|
+
* @public
|
|
1742
1742
|
*/
|
|
1743
1743
|
ComprehendMedicalAsyncJobPropertiesList?: ComprehendMedicalAsyncJobProperties[];
|
|
1744
1744
|
/**
|
|
1745
|
-
* @public
|
|
1746
1745
|
* <p>Identifies the next page of results to return.</p>
|
|
1746
|
+
* @public
|
|
1747
1747
|
*/
|
|
1748
1748
|
NextToken?: string;
|
|
1749
1749
|
}
|
|
1750
1750
|
/**
|
|
1751
|
-
* @public
|
|
1752
1751
|
* <p>The filter that you specified for the operation is invalid. Check the filter values that
|
|
1753
1752
|
* you entered and try your request again.</p>
|
|
1753
|
+
* @public
|
|
1754
1754
|
*/
|
|
1755
1755
|
export declare class ValidationException extends __BaseException {
|
|
1756
1756
|
readonly name: "ValidationException";
|
|
@@ -1766,19 +1766,19 @@ export declare class ValidationException extends __BaseException {
|
|
|
1766
1766
|
*/
|
|
1767
1767
|
export interface ListICD10CMInferenceJobsRequest {
|
|
1768
1768
|
/**
|
|
1769
|
-
* @public
|
|
1770
1769
|
* <p>Filters the jobs that are returned. You can filter jobs based on their names, status, or
|
|
1771
1770
|
* the date and time that they were submitted. You can only set one filter at a time.</p>
|
|
1771
|
+
* @public
|
|
1772
1772
|
*/
|
|
1773
1773
|
Filter?: ComprehendMedicalAsyncJobFilter;
|
|
1774
1774
|
/**
|
|
1775
|
-
* @public
|
|
1776
1775
|
* <p>Identifies the next page of results to return.</p>
|
|
1776
|
+
* @public
|
|
1777
1777
|
*/
|
|
1778
1778
|
NextToken?: string;
|
|
1779
1779
|
/**
|
|
1780
|
-
* @public
|
|
1781
1780
|
* <p>The maximum number of results to return in each page. The default is 100.</p>
|
|
1781
|
+
* @public
|
|
1782
1782
|
*/
|
|
1783
1783
|
MaxResults?: number;
|
|
1784
1784
|
}
|
|
@@ -1787,13 +1787,13 @@ export interface ListICD10CMInferenceJobsRequest {
|
|
|
1787
1787
|
*/
|
|
1788
1788
|
export interface ListICD10CMInferenceJobsResponse {
|
|
1789
1789
|
/**
|
|
1790
|
-
* @public
|
|
1791
1790
|
* <p>A list containing the properties of each job that is returned.</p>
|
|
1791
|
+
* @public
|
|
1792
1792
|
*/
|
|
1793
1793
|
ComprehendMedicalAsyncJobPropertiesList?: ComprehendMedicalAsyncJobProperties[];
|
|
1794
1794
|
/**
|
|
1795
|
-
* @public
|
|
1796
1795
|
* <p>Identifies the next page of results to return.</p>
|
|
1796
|
+
* @public
|
|
1797
1797
|
*/
|
|
1798
1798
|
NextToken?: string;
|
|
1799
1799
|
}
|
|
@@ -1802,19 +1802,19 @@ export interface ListICD10CMInferenceJobsResponse {
|
|
|
1802
1802
|
*/
|
|
1803
1803
|
export interface ListPHIDetectionJobsRequest {
|
|
1804
1804
|
/**
|
|
1805
|
-
* @public
|
|
1806
1805
|
* <p>Filters the jobs that are returned. You can filter jobs based on their names, status, or
|
|
1807
1806
|
* the date and time that they were submitted. You can only set one filter at a time.</p>
|
|
1807
|
+
* @public
|
|
1808
1808
|
*/
|
|
1809
1809
|
Filter?: ComprehendMedicalAsyncJobFilter;
|
|
1810
1810
|
/**
|
|
1811
|
-
* @public
|
|
1812
1811
|
* <p>Identifies the next page of results to return.</p>
|
|
1812
|
+
* @public
|
|
1813
1813
|
*/
|
|
1814
1814
|
NextToken?: string;
|
|
1815
1815
|
/**
|
|
1816
|
-
* @public
|
|
1817
1816
|
* <p>The maximum number of results to return in each page. The default is 100.</p>
|
|
1817
|
+
* @public
|
|
1818
1818
|
*/
|
|
1819
1819
|
MaxResults?: number;
|
|
1820
1820
|
}
|
|
@@ -1823,13 +1823,13 @@ export interface ListPHIDetectionJobsRequest {
|
|
|
1823
1823
|
*/
|
|
1824
1824
|
export interface ListPHIDetectionJobsResponse {
|
|
1825
1825
|
/**
|
|
1826
|
-
* @public
|
|
1827
1826
|
* <p>A list containing the properties of each job returned.</p>
|
|
1827
|
+
* @public
|
|
1828
1828
|
*/
|
|
1829
1829
|
ComprehendMedicalAsyncJobPropertiesList?: ComprehendMedicalAsyncJobProperties[];
|
|
1830
1830
|
/**
|
|
1831
|
-
* @public
|
|
1832
1831
|
* <p>Identifies the next page of results to return.</p>
|
|
1832
|
+
* @public
|
|
1833
1833
|
*/
|
|
1834
1834
|
NextToken?: string;
|
|
1835
1835
|
}
|
|
@@ -1838,19 +1838,19 @@ export interface ListPHIDetectionJobsResponse {
|
|
|
1838
1838
|
*/
|
|
1839
1839
|
export interface ListRxNormInferenceJobsRequest {
|
|
1840
1840
|
/**
|
|
1841
|
-
* @public
|
|
1842
1841
|
* <p>Filters the jobs that are returned. You can filter jobs based on their names, status, or
|
|
1843
1842
|
* the date and time that they were submitted. You can only set one filter at a time.</p>
|
|
1843
|
+
* @public
|
|
1844
1844
|
*/
|
|
1845
1845
|
Filter?: ComprehendMedicalAsyncJobFilter;
|
|
1846
1846
|
/**
|
|
1847
|
-
* @public
|
|
1848
1847
|
* <p>Identifies the next page of results to return.</p>
|
|
1848
|
+
* @public
|
|
1849
1849
|
*/
|
|
1850
1850
|
NextToken?: string;
|
|
1851
1851
|
/**
|
|
1852
|
-
* @public
|
|
1853
1852
|
* <p>Identifies the next page of results to return.</p>
|
|
1853
|
+
* @public
|
|
1854
1854
|
*/
|
|
1855
1855
|
MaxResults?: number;
|
|
1856
1856
|
}
|
|
@@ -1859,13 +1859,13 @@ export interface ListRxNormInferenceJobsRequest {
|
|
|
1859
1859
|
*/
|
|
1860
1860
|
export interface ListRxNormInferenceJobsResponse {
|
|
1861
1861
|
/**
|
|
1862
|
-
* @public
|
|
1863
1862
|
* <p>The maximum number of results to return in each page. The default is 100.</p>
|
|
1863
|
+
* @public
|
|
1864
1864
|
*/
|
|
1865
1865
|
ComprehendMedicalAsyncJobPropertiesList?: ComprehendMedicalAsyncJobProperties[];
|
|
1866
1866
|
/**
|
|
1867
|
-
* @public
|
|
1868
1867
|
* <p>Identifies the next page of results to return.</p>
|
|
1868
|
+
* @public
|
|
1869
1869
|
*/
|
|
1870
1870
|
NextToken?: string;
|
|
1871
1871
|
}
|
|
@@ -1874,22 +1874,22 @@ export interface ListRxNormInferenceJobsResponse {
|
|
|
1874
1874
|
*/
|
|
1875
1875
|
export interface ListSNOMEDCTInferenceJobsRequest {
|
|
1876
1876
|
/**
|
|
1877
|
-
* @public
|
|
1878
1877
|
* <p>Provides information for filtering a list of detection jobs.</p>
|
|
1878
|
+
* @public
|
|
1879
1879
|
*/
|
|
1880
1880
|
Filter?: ComprehendMedicalAsyncJobFilter;
|
|
1881
1881
|
/**
|
|
1882
|
-
* @public
|
|
1883
1882
|
* <p>
|
|
1884
1883
|
* Identifies the next page of InferSNOMEDCT results to return.
|
|
1885
1884
|
* </p>
|
|
1885
|
+
* @public
|
|
1886
1886
|
*/
|
|
1887
1887
|
NextToken?: string;
|
|
1888
1888
|
/**
|
|
1889
|
-
* @public
|
|
1890
1889
|
* <p>
|
|
1891
1890
|
* The maximum number of results to return in each page. The default is 100.
|
|
1892
1891
|
* </p>
|
|
1892
|
+
* @public
|
|
1893
1893
|
*/
|
|
1894
1894
|
MaxResults?: number;
|
|
1895
1895
|
}
|
|
@@ -1898,17 +1898,17 @@ export interface ListSNOMEDCTInferenceJobsRequest {
|
|
|
1898
1898
|
*/
|
|
1899
1899
|
export interface ListSNOMEDCTInferenceJobsResponse {
|
|
1900
1900
|
/**
|
|
1901
|
-
* @public
|
|
1902
1901
|
* <p>
|
|
1903
1902
|
* A list containing the properties of each job that is returned.
|
|
1904
1903
|
* </p>
|
|
1904
|
+
* @public
|
|
1905
1905
|
*/
|
|
1906
1906
|
ComprehendMedicalAsyncJobPropertiesList?: ComprehendMedicalAsyncJobProperties[];
|
|
1907
1907
|
/**
|
|
1908
|
-
* @public
|
|
1909
1908
|
* <p>
|
|
1910
1909
|
* Identifies the next page of results to return.
|
|
1911
1910
|
* </p>
|
|
1911
|
+
* @public
|
|
1912
1912
|
*/
|
|
1913
1913
|
NextToken?: string;
|
|
1914
1914
|
}
|
|
@@ -1917,41 +1917,41 @@ export interface ListSNOMEDCTInferenceJobsResponse {
|
|
|
1917
1917
|
*/
|
|
1918
1918
|
export interface StartEntitiesDetectionV2JobRequest {
|
|
1919
1919
|
/**
|
|
1920
|
-
* @public
|
|
1921
1920
|
* <p>The input configuration that specifies the format and location of the input data for the job.</p>
|
|
1921
|
+
* @public
|
|
1922
1922
|
*/
|
|
1923
1923
|
InputDataConfig: InputDataConfig | undefined;
|
|
1924
1924
|
/**
|
|
1925
|
-
* @public
|
|
1926
1925
|
* <p>The output configuration that specifies where to send the output files.</p>
|
|
1926
|
+
* @public
|
|
1927
1927
|
*/
|
|
1928
1928
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
1929
1929
|
/**
|
|
1930
|
-
* @public
|
|
1931
1930
|
* <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that
|
|
1932
1931
|
* grants Amazon Comprehend Medical read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med">Role-Based Permissions Required for Asynchronous Operations</a>.</p>
|
|
1932
|
+
* @public
|
|
1933
1933
|
*/
|
|
1934
1934
|
DataAccessRoleArn: string | undefined;
|
|
1935
1935
|
/**
|
|
1936
|
-
* @public
|
|
1937
1936
|
* <p>The identifier of the job.</p>
|
|
1937
|
+
* @public
|
|
1938
1938
|
*/
|
|
1939
1939
|
JobName?: string;
|
|
1940
1940
|
/**
|
|
1941
|
-
* @public
|
|
1942
1941
|
* <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical
|
|
1943
1942
|
* generates one for you.</p>
|
|
1943
|
+
* @public
|
|
1944
1944
|
*/
|
|
1945
1945
|
ClientRequestToken?: string;
|
|
1946
1946
|
/**
|
|
1947
|
-
* @public
|
|
1948
1947
|
* <p>An AWS Key Management Service key to encrypt your output files. If you do not specify a
|
|
1949
1948
|
* key, the files are written in plain text.</p>
|
|
1949
|
+
* @public
|
|
1950
1950
|
*/
|
|
1951
1951
|
KMSKey?: string;
|
|
1952
1952
|
/**
|
|
1953
|
-
* @public
|
|
1954
1953
|
* <p>The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).</p>
|
|
1954
|
+
* @public
|
|
1955
1955
|
*/
|
|
1956
1956
|
LanguageCode: LanguageCode | undefined;
|
|
1957
1957
|
}
|
|
@@ -1960,9 +1960,9 @@ export interface StartEntitiesDetectionV2JobRequest {
|
|
|
1960
1960
|
*/
|
|
1961
1961
|
export interface StartEntitiesDetectionV2JobResponse {
|
|
1962
1962
|
/**
|
|
1963
|
-
* @public
|
|
1964
1963
|
* <p>The identifier generated for the job. To get the status of a job, use this identifier with
|
|
1965
1964
|
* the <code>DescribeEntitiesDetectionV2Job</code> operation.</p>
|
|
1965
|
+
* @public
|
|
1966
1966
|
*/
|
|
1967
1967
|
JobId?: string;
|
|
1968
1968
|
}
|
|
@@ -1971,40 +1971,40 @@ export interface StartEntitiesDetectionV2JobResponse {
|
|
|
1971
1971
|
*/
|
|
1972
1972
|
export interface StartICD10CMInferenceJobRequest {
|
|
1973
1973
|
/**
|
|
1974
|
-
* @public
|
|
1975
1974
|
* <p>Specifies the format and location of the input data for the job.</p>
|
|
1975
|
+
* @public
|
|
1976
1976
|
*/
|
|
1977
1977
|
InputDataConfig: InputDataConfig | undefined;
|
|
1978
1978
|
/**
|
|
1979
|
-
* @public
|
|
1980
1979
|
* <p>Specifies where to send the output files.</p>
|
|
1980
|
+
* @public
|
|
1981
1981
|
*/
|
|
1982
1982
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
1983
1983
|
/**
|
|
1984
|
-
* @public
|
|
1985
1984
|
* <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that
|
|
1986
1985
|
* grants Amazon Comprehend Medical read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med"> Role-Based Permissions Required for Asynchronous Operations</a>.</p>
|
|
1986
|
+
* @public
|
|
1987
1987
|
*/
|
|
1988
1988
|
DataAccessRoleArn: string | undefined;
|
|
1989
1989
|
/**
|
|
1990
|
-
* @public
|
|
1991
1990
|
* <p>The identifier of the job.</p>
|
|
1991
|
+
* @public
|
|
1992
1992
|
*/
|
|
1993
1993
|
JobName?: string;
|
|
1994
1994
|
/**
|
|
1995
|
-
* @public
|
|
1996
1995
|
* <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.</p>
|
|
1996
|
+
* @public
|
|
1997
1997
|
*/
|
|
1998
1998
|
ClientRequestToken?: string;
|
|
1999
1999
|
/**
|
|
2000
|
-
* @public
|
|
2001
2000
|
* <p>An AWS Key Management Service key to encrypt your output files. If you do not specify a
|
|
2002
2001
|
* key, the files are written in plain text.</p>
|
|
2002
|
+
* @public
|
|
2003
2003
|
*/
|
|
2004
2004
|
KMSKey?: string;
|
|
2005
2005
|
/**
|
|
2006
|
-
* @public
|
|
2007
2006
|
* <p>The language of the input documents. All documents must be in the same language.</p>
|
|
2007
|
+
* @public
|
|
2008
2008
|
*/
|
|
2009
2009
|
LanguageCode: LanguageCode | undefined;
|
|
2010
2010
|
}
|
|
@@ -2013,9 +2013,9 @@ export interface StartICD10CMInferenceJobRequest {
|
|
|
2013
2013
|
*/
|
|
2014
2014
|
export interface StartICD10CMInferenceJobResponse {
|
|
2015
2015
|
/**
|
|
2016
|
-
* @public
|
|
2017
2016
|
* <p>The identifier generated for the job. To get the status of a job, use this identifier with
|
|
2018
2017
|
* the <code>StartICD10CMInferenceJob</code> operation.</p>
|
|
2018
|
+
* @public
|
|
2019
2019
|
*/
|
|
2020
2020
|
JobId?: string;
|
|
2021
2021
|
}
|
|
@@ -2024,41 +2024,41 @@ export interface StartICD10CMInferenceJobResponse {
|
|
|
2024
2024
|
*/
|
|
2025
2025
|
export interface StartPHIDetectionJobRequest {
|
|
2026
2026
|
/**
|
|
2027
|
-
* @public
|
|
2028
2027
|
* <p>Specifies the format and location of the input data for the job.</p>
|
|
2028
|
+
* @public
|
|
2029
2029
|
*/
|
|
2030
2030
|
InputDataConfig: InputDataConfig | undefined;
|
|
2031
2031
|
/**
|
|
2032
|
-
* @public
|
|
2033
2032
|
* <p>Specifies where to send the output files.</p>
|
|
2033
|
+
* @public
|
|
2034
2034
|
*/
|
|
2035
2035
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
2036
2036
|
/**
|
|
2037
|
-
* @public
|
|
2038
2037
|
* <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that
|
|
2039
2038
|
* grants Amazon Comprehend Medical read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med"> Role-Based Permissions Required for Asynchronous Operations</a>.</p>
|
|
2039
|
+
* @public
|
|
2040
2040
|
*/
|
|
2041
2041
|
DataAccessRoleArn: string | undefined;
|
|
2042
2042
|
/**
|
|
2043
|
-
* @public
|
|
2044
2043
|
* <p>The identifier of the job.</p>
|
|
2044
|
+
* @public
|
|
2045
2045
|
*/
|
|
2046
2046
|
JobName?: string;
|
|
2047
2047
|
/**
|
|
2048
|
-
* @public
|
|
2049
2048
|
* <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical
|
|
2050
2049
|
* generates one.</p>
|
|
2050
|
+
* @public
|
|
2051
2051
|
*/
|
|
2052
2052
|
ClientRequestToken?: string;
|
|
2053
2053
|
/**
|
|
2054
|
-
* @public
|
|
2055
2054
|
* <p>An AWS Key Management Service key to encrypt your output files. If you do not specify a
|
|
2056
2055
|
* key, the files are written in plain text.</p>
|
|
2056
|
+
* @public
|
|
2057
2057
|
*/
|
|
2058
2058
|
KMSKey?: string;
|
|
2059
2059
|
/**
|
|
2060
|
-
* @public
|
|
2061
2060
|
* <p>The language of the input documents. All documents must be in the same language.</p>
|
|
2061
|
+
* @public
|
|
2062
2062
|
*/
|
|
2063
2063
|
LanguageCode: LanguageCode | undefined;
|
|
2064
2064
|
}
|
|
@@ -2067,9 +2067,9 @@ export interface StartPHIDetectionJobRequest {
|
|
|
2067
2067
|
*/
|
|
2068
2068
|
export interface StartPHIDetectionJobResponse {
|
|
2069
2069
|
/**
|
|
2070
|
-
* @public
|
|
2071
2070
|
* <p>The identifier generated for the job. To get the status of a job, use this identifier with
|
|
2072
2071
|
* the <code>DescribePHIDetectionJob</code> operation.</p>
|
|
2072
|
+
* @public
|
|
2073
2073
|
*/
|
|
2074
2074
|
JobId?: string;
|
|
2075
2075
|
}
|
|
@@ -2078,41 +2078,41 @@ export interface StartPHIDetectionJobResponse {
|
|
|
2078
2078
|
*/
|
|
2079
2079
|
export interface StartRxNormInferenceJobRequest {
|
|
2080
2080
|
/**
|
|
2081
|
-
* @public
|
|
2082
2081
|
* <p>Specifies the format and location of the input data for the job.</p>
|
|
2082
|
+
* @public
|
|
2083
2083
|
*/
|
|
2084
2084
|
InputDataConfig: InputDataConfig | undefined;
|
|
2085
2085
|
/**
|
|
2086
|
-
* @public
|
|
2087
2086
|
* <p>Specifies where to send the output files.</p>
|
|
2087
|
+
* @public
|
|
2088
2088
|
*/
|
|
2089
2089
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
2090
2090
|
/**
|
|
2091
|
-
* @public
|
|
2092
2091
|
* <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that
|
|
2093
2092
|
* grants Amazon Comprehend Medical read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med"> Role-Based Permissions Required for Asynchronous Operations</a>.</p>
|
|
2093
|
+
* @public
|
|
2094
2094
|
*/
|
|
2095
2095
|
DataAccessRoleArn: string | undefined;
|
|
2096
2096
|
/**
|
|
2097
|
-
* @public
|
|
2098
2097
|
* <p>The identifier of the job.</p>
|
|
2098
|
+
* @public
|
|
2099
2099
|
*/
|
|
2100
2100
|
JobName?: string;
|
|
2101
2101
|
/**
|
|
2102
|
-
* @public
|
|
2103
2102
|
* <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical
|
|
2104
2103
|
* generates one.</p>
|
|
2104
|
+
* @public
|
|
2105
2105
|
*/
|
|
2106
2106
|
ClientRequestToken?: string;
|
|
2107
2107
|
/**
|
|
2108
|
-
* @public
|
|
2109
2108
|
* <p>An AWS Key Management Service key to encrypt your output files. If you do not specify a
|
|
2110
2109
|
* key, the files are written in plain text.</p>
|
|
2110
|
+
* @public
|
|
2111
2111
|
*/
|
|
2112
2112
|
KMSKey?: string;
|
|
2113
2113
|
/**
|
|
2114
|
-
* @public
|
|
2115
2114
|
* <p>The language of the input documents. All documents must be in the same language.</p>
|
|
2115
|
+
* @public
|
|
2116
2116
|
*/
|
|
2117
2117
|
LanguageCode: LanguageCode | undefined;
|
|
2118
2118
|
}
|
|
@@ -2121,8 +2121,8 @@ export interface StartRxNormInferenceJobRequest {
|
|
|
2121
2121
|
*/
|
|
2122
2122
|
export interface StartRxNormInferenceJobResponse {
|
|
2123
2123
|
/**
|
|
2124
|
-
* @public
|
|
2125
2124
|
* <p>The identifier of the job.</p>
|
|
2125
|
+
* @public
|
|
2126
2126
|
*/
|
|
2127
2127
|
JobId?: string;
|
|
2128
2128
|
}
|
|
@@ -2131,49 +2131,49 @@ export interface StartRxNormInferenceJobResponse {
|
|
|
2131
2131
|
*/
|
|
2132
2132
|
export interface StartSNOMEDCTInferenceJobRequest {
|
|
2133
2133
|
/**
|
|
2134
|
-
* @public
|
|
2135
2134
|
* <p>The input properties for an entities detection job. This includes the name of the S3
|
|
2136
2135
|
* bucket and the path to the files to be analyzed. </p>
|
|
2136
|
+
* @public
|
|
2137
2137
|
*/
|
|
2138
2138
|
InputDataConfig: InputDataConfig | undefined;
|
|
2139
2139
|
/**
|
|
2140
|
-
* @public
|
|
2141
2140
|
* <p>The output properties for a detection job.</p>
|
|
2141
|
+
* @public
|
|
2142
2142
|
*/
|
|
2143
2143
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
2144
2144
|
/**
|
|
2145
|
-
* @public
|
|
2146
2145
|
* <p>
|
|
2147
2146
|
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.
|
|
2148
2147
|
* </p>
|
|
2148
|
+
* @public
|
|
2149
2149
|
*/
|
|
2150
2150
|
DataAccessRoleArn: string | undefined;
|
|
2151
2151
|
/**
|
|
2152
|
-
* @public
|
|
2153
2152
|
* <p>
|
|
2154
2153
|
* The user generated name the asynchronous InferSNOMEDCT job.
|
|
2155
2154
|
* </p>
|
|
2155
|
+
* @public
|
|
2156
2156
|
*/
|
|
2157
2157
|
JobName?: string;
|
|
2158
2158
|
/**
|
|
2159
|
-
* @public
|
|
2160
2159
|
* <p>
|
|
2161
2160
|
* A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.
|
|
2162
2161
|
* </p>
|
|
2162
|
+
* @public
|
|
2163
2163
|
*/
|
|
2164
2164
|
ClientRequestToken?: string;
|
|
2165
2165
|
/**
|
|
2166
|
-
* @public
|
|
2167
2166
|
* <p>
|
|
2168
2167
|
* An AWS Key Management Service key used to encrypt your output files. If you do not specify a key, the files are written in plain text.
|
|
2169
2168
|
* </p>
|
|
2169
|
+
* @public
|
|
2170
2170
|
*/
|
|
2171
2171
|
KMSKey?: string;
|
|
2172
2172
|
/**
|
|
2173
|
-
* @public
|
|
2174
2173
|
* <p>
|
|
2175
2174
|
* The language of the input documents. All documents must be in the same language.
|
|
2176
2175
|
* </p>
|
|
2176
|
+
* @public
|
|
2177
2177
|
*/
|
|
2178
2178
|
LanguageCode: LanguageCode | undefined;
|
|
2179
2179
|
}
|
|
@@ -2182,10 +2182,10 @@ export interface StartSNOMEDCTInferenceJobRequest {
|
|
|
2182
2182
|
*/
|
|
2183
2183
|
export interface StartSNOMEDCTInferenceJobResponse {
|
|
2184
2184
|
/**
|
|
2185
|
-
* @public
|
|
2186
2185
|
* <p>
|
|
2187
2186
|
* The identifier generated for the job. To get the status of a job, use this identifier with the StartSNOMEDCTInferenceJob operation.
|
|
2188
2187
|
* </p>
|
|
2188
|
+
* @public
|
|
2189
2189
|
*/
|
|
2190
2190
|
JobId?: string;
|
|
2191
2191
|
}
|
|
@@ -2194,8 +2194,8 @@ export interface StartSNOMEDCTInferenceJobResponse {
|
|
|
2194
2194
|
*/
|
|
2195
2195
|
export interface StopEntitiesDetectionV2JobRequest {
|
|
2196
2196
|
/**
|
|
2197
|
-
* @public
|
|
2198
2197
|
* <p>The identifier of the medical entities job to stop.</p>
|
|
2198
|
+
* @public
|
|
2199
2199
|
*/
|
|
2200
2200
|
JobId: string | undefined;
|
|
2201
2201
|
}
|
|
@@ -2204,8 +2204,8 @@ export interface StopEntitiesDetectionV2JobRequest {
|
|
|
2204
2204
|
*/
|
|
2205
2205
|
export interface StopEntitiesDetectionV2JobResponse {
|
|
2206
2206
|
/**
|
|
2207
|
-
* @public
|
|
2208
2207
|
* <p>The identifier of the medical entities detection job that was stopped.</p>
|
|
2208
|
+
* @public
|
|
2209
2209
|
*/
|
|
2210
2210
|
JobId?: string;
|
|
2211
2211
|
}
|
|
@@ -2214,8 +2214,8 @@ export interface StopEntitiesDetectionV2JobResponse {
|
|
|
2214
2214
|
*/
|
|
2215
2215
|
export interface StopICD10CMInferenceJobRequest {
|
|
2216
2216
|
/**
|
|
2217
|
-
* @public
|
|
2218
2217
|
* <p>The identifier of the job.</p>
|
|
2218
|
+
* @public
|
|
2219
2219
|
*/
|
|
2220
2220
|
JobId: string | undefined;
|
|
2221
2221
|
}
|
|
@@ -2224,9 +2224,9 @@ export interface StopICD10CMInferenceJobRequest {
|
|
|
2224
2224
|
*/
|
|
2225
2225
|
export interface StopICD10CMInferenceJobResponse {
|
|
2226
2226
|
/**
|
|
2227
|
-
* @public
|
|
2228
2227
|
* <p>The identifier generated for the job. To get the status of job, use this identifier with
|
|
2229
2228
|
* the <code>DescribeICD10CMInferenceJob</code> operation.</p>
|
|
2229
|
+
* @public
|
|
2230
2230
|
*/
|
|
2231
2231
|
JobId?: string;
|
|
2232
2232
|
}
|
|
@@ -2235,8 +2235,8 @@ export interface StopICD10CMInferenceJobResponse {
|
|
|
2235
2235
|
*/
|
|
2236
2236
|
export interface StopPHIDetectionJobRequest {
|
|
2237
2237
|
/**
|
|
2238
|
-
* @public
|
|
2239
2238
|
* <p>The identifier of the PHI detection job to stop.</p>
|
|
2239
|
+
* @public
|
|
2240
2240
|
*/
|
|
2241
2241
|
JobId: string | undefined;
|
|
2242
2242
|
}
|
|
@@ -2245,8 +2245,8 @@ export interface StopPHIDetectionJobRequest {
|
|
|
2245
2245
|
*/
|
|
2246
2246
|
export interface StopPHIDetectionJobResponse {
|
|
2247
2247
|
/**
|
|
2248
|
-
* @public
|
|
2249
2248
|
* <p>The identifier of the PHI detection job that was stopped.</p>
|
|
2249
|
+
* @public
|
|
2250
2250
|
*/
|
|
2251
2251
|
JobId?: string;
|
|
2252
2252
|
}
|
|
@@ -2255,8 +2255,8 @@ export interface StopPHIDetectionJobResponse {
|
|
|
2255
2255
|
*/
|
|
2256
2256
|
export interface StopRxNormInferenceJobRequest {
|
|
2257
2257
|
/**
|
|
2258
|
-
* @public
|
|
2259
2258
|
* <p>The identifier of the job.</p>
|
|
2259
|
+
* @public
|
|
2260
2260
|
*/
|
|
2261
2261
|
JobId: string | undefined;
|
|
2262
2262
|
}
|
|
@@ -2265,9 +2265,9 @@ export interface StopRxNormInferenceJobRequest {
|
|
|
2265
2265
|
*/
|
|
2266
2266
|
export interface StopRxNormInferenceJobResponse {
|
|
2267
2267
|
/**
|
|
2268
|
-
* @public
|
|
2269
2268
|
* <p>The identifier generated for the job. To get the status of job, use this identifier with
|
|
2270
2269
|
* the <code>DescribeRxNormInferenceJob</code> operation.</p>
|
|
2270
|
+
* @public
|
|
2271
2271
|
*/
|
|
2272
2272
|
JobId?: string;
|
|
2273
2273
|
}
|
|
@@ -2276,10 +2276,10 @@ export interface StopRxNormInferenceJobResponse {
|
|
|
2276
2276
|
*/
|
|
2277
2277
|
export interface StopSNOMEDCTInferenceJobRequest {
|
|
2278
2278
|
/**
|
|
2279
|
-
* @public
|
|
2280
2279
|
* <p>
|
|
2281
2280
|
* The job id of the asynchronous InferSNOMEDCT job to be stopped.
|
|
2282
2281
|
* </p>
|
|
2282
|
+
* @public
|
|
2283
2283
|
*/
|
|
2284
2284
|
JobId: string | undefined;
|
|
2285
2285
|
}
|
|
@@ -2288,10 +2288,10 @@ export interface StopSNOMEDCTInferenceJobRequest {
|
|
|
2288
2288
|
*/
|
|
2289
2289
|
export interface StopSNOMEDCTInferenceJobResponse {
|
|
2290
2290
|
/**
|
|
2291
|
-
* @public
|
|
2292
2291
|
* <p>
|
|
2293
2292
|
* The identifier generated for the job. To get the status of job, use this identifier with the DescribeSNOMEDCTInferenceJob operation.
|
|
2294
2293
|
* </p>
|
|
2294
|
+
* @public
|
|
2295
2295
|
*/
|
|
2296
2296
|
JobId?: string;
|
|
2297
2297
|
}
|