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