@aws-sdk/client-comprehendmedical 3.363.0 → 3.369.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/README.md +1 -2
- package/dist-types/ComprehendMedical.d.ts +1 -2
- package/dist-types/ComprehendMedicalClient.d.ts +1 -2
- package/dist-types/commands/DetectEntitiesCommand.d.ts +3 -3
- package/dist-types/commands/DetectEntitiesV2Command.d.ts +2 -1
- package/dist-types/commands/DetectPHICommand.d.ts +2 -2
- package/dist-types/commands/InferICD10CMCommand.d.ts +1 -1
- package/dist-types/commands/InferRxNormCommand.d.ts +1 -1
- package/dist-types/commands/InferSNOMEDCTCommand.d.ts +1 -1
- package/dist-types/commands/ListPHIDetectionJobsCommand.d.ts +1 -1
- package/dist-types/index.d.ts +1 -2
- package/dist-types/models/models_0.d.ts +45 -55
- package/package.json +13 -13
package/README.md
CHANGED
|
@@ -6,8 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript ComprehendMedical Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<p> Comprehend Medical
|
|
10
|
-
to gain insight in your documents. </p>
|
|
9
|
+
<p>Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see <a href="https://docs.aws.amazon.com/comprehend-medical/latest/dev/comprehendmedical-quotas.html">Guidelines and quotas</a> in the <i>Amazon Comprehend Medical Developer Guide</i>.</p>
|
|
11
10
|
|
|
12
11
|
## Installing
|
|
13
12
|
|
|
@@ -186,8 +186,7 @@ export interface ComprehendMedical {
|
|
|
186
186
|
}
|
|
187
187
|
/**
|
|
188
188
|
* @public
|
|
189
|
-
* <p> Comprehend Medical
|
|
190
|
-
* to gain insight in your documents. </p>
|
|
189
|
+
* <p>Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see <a href="https://docs.aws.amazon.com/comprehend-medical/latest/dev/comprehendmedical-quotas.html">Guidelines and quotas</a> in the <i>Amazon Comprehend Medical Developer Guide</i>.</p>
|
|
191
190
|
*/
|
|
192
191
|
export declare class ComprehendMedical extends ComprehendMedicalClient implements ComprehendMedical {
|
|
193
192
|
}
|
|
@@ -171,8 +171,7 @@ export interface ComprehendMedicalClientResolvedConfig extends ComprehendMedical
|
|
|
171
171
|
}
|
|
172
172
|
/**
|
|
173
173
|
* @public
|
|
174
|
-
* <p> Comprehend Medical
|
|
175
|
-
* to gain insight in your documents. </p>
|
|
174
|
+
* <p>Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see <a href="https://docs.aws.amazon.com/comprehend-medical/latest/dev/comprehendmedical-quotas.html">Guidelines and quotas</a> in the <i>Amazon Comprehend Medical Developer Guide</i>.</p>
|
|
176
175
|
*/
|
|
177
176
|
export declare class ComprehendMedicalClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ComprehendMedicalClientResolvedConfig> {
|
|
178
177
|
/**
|
|
@@ -26,9 +26,9 @@ export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __M
|
|
|
26
26
|
* @deprecated
|
|
27
27
|
*
|
|
28
28
|
* <p>The <code>DetectEntities</code> operation is deprecated. You should use the <a>DetectEntitiesV2</a> operation instead.</p>
|
|
29
|
-
* <p>
|
|
29
|
+
* <p>Inspects the clinical text for a variety of medical entities and returns specific
|
|
30
30
|
* information about them such as entity category, location, and confidence score on that
|
|
31
|
-
* information
|
|
31
|
+
* information.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -118,7 +118,7 @@ export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __M
|
|
|
118
118
|
* and then retry the request.</p>
|
|
119
119
|
*
|
|
120
120
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
121
|
-
* <p> The Comprehend Medical
|
|
121
|
+
* <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
|
|
122
122
|
* </p>
|
|
123
123
|
*
|
|
124
124
|
* @throws {@link TextSizeLimitExceededException} (client fault)
|
|
@@ -31,6 +31,7 @@ export interface DetectEntitiesV2CommandOutput extends DetectEntitiesV2Response,
|
|
|
31
31
|
* operation. This new action uses a different model for determining the entities in your medical
|
|
32
32
|
* text and changes the way that some entities are returned in the output. You should use the
|
|
33
33
|
* <code>DetectEntitiesV2</code> operation in all new applications.</p>
|
|
34
|
+
*
|
|
34
35
|
* <p>The <code>DetectEntitiesV2</code> operation returns the <code>Acuity</code> and
|
|
35
36
|
* <code>Direction</code> entities as attributes instead of types. </p>
|
|
36
37
|
* @example
|
|
@@ -122,7 +123,7 @@ export interface DetectEntitiesV2CommandOutput extends DetectEntitiesV2Response,
|
|
|
122
123
|
* and then retry the request.</p>
|
|
123
124
|
*
|
|
124
125
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
125
|
-
* <p> The Comprehend Medical
|
|
126
|
+
* <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
|
|
126
127
|
* </p>
|
|
127
128
|
*
|
|
128
129
|
* @throws {@link TextSizeLimitExceededException} (client fault)
|
|
@@ -23,7 +23,7 @@ export interface DetectPHICommandOutput extends DetectPHIResponse, __MetadataBea
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>
|
|
26
|
+
* <p>Inspects the clinical text for protected health information (PHI) entities and returns
|
|
27
27
|
* the entity category, location, and confidence score for each entity. Amazon Comprehend Medical
|
|
28
28
|
* only detects entities in English language texts.</p>
|
|
29
29
|
* @example
|
|
@@ -98,7 +98,7 @@ export interface DetectPHICommandOutput extends DetectPHIResponse, __MetadataBea
|
|
|
98
98
|
* and then retry the request.</p>
|
|
99
99
|
*
|
|
100
100
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
101
|
-
* <p> The Comprehend Medical
|
|
101
|
+
* <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
|
|
102
102
|
* </p>
|
|
103
103
|
*
|
|
104
104
|
* @throws {@link TextSizeLimitExceededException} (client fault)
|
|
@@ -106,7 +106,7 @@ export interface InferICD10CMCommandOutput extends InferICD10CMResponse, __Metad
|
|
|
106
106
|
* and then retry the request.</p>
|
|
107
107
|
*
|
|
108
108
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
109
|
-
* <p> The Comprehend Medical
|
|
109
|
+
* <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
|
|
110
110
|
* </p>
|
|
111
111
|
*
|
|
112
112
|
* @throws {@link TextSizeLimitExceededException} (client fault)
|
|
@@ -103,7 +103,7 @@ export interface InferRxNormCommandOutput extends InferRxNormResponse, __Metadat
|
|
|
103
103
|
* and then retry the request.</p>
|
|
104
104
|
*
|
|
105
105
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
106
|
-
* <p> The Comprehend Medical
|
|
106
|
+
* <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
|
|
107
107
|
* </p>
|
|
108
108
|
*
|
|
109
109
|
* @throws {@link TextSizeLimitExceededException} (client fault)
|
|
@@ -119,7 +119,7 @@ export interface InferSNOMEDCTCommandOutput extends InferSNOMEDCTResponse, __Met
|
|
|
119
119
|
* and then retry the request.</p>
|
|
120
120
|
*
|
|
121
121
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
122
|
-
* <p> The Comprehend Medical
|
|
122
|
+
* <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
|
|
123
123
|
* </p>
|
|
124
124
|
*
|
|
125
125
|
* @throws {@link TextSizeLimitExceededException} (client fault)
|
|
@@ -23,7 +23,7 @@ export interface ListPHIDetectionJobsCommandOutput extends ListPHIDetectionJobsR
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Gets a list of protected health information (PHI) detection jobs
|
|
26
|
+
* <p>Gets a list of protected health information (PHI) detection jobs you have
|
|
27
27
|
* submitted.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p> Comprehend Medical
|
|
3
|
-
* to gain insight in your documents. </p>
|
|
2
|
+
* <p>Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see <a href="https://docs.aws.amazon.com/comprehend-medical/latest/dev/comprehendmedical-quotas.html">Guidelines and quotas</a> in the <i>Amazon Comprehend Medical Developer Guide</i>.</p>
|
|
4
3
|
*
|
|
5
4
|
* @packageDocumentation
|
|
6
5
|
*/
|
|
@@ -78,7 +78,7 @@ export interface Trait {
|
|
|
78
78
|
*/
|
|
79
79
|
Name?: AttributeName | string;
|
|
80
80
|
/**
|
|
81
|
-
* <p> The level of confidence that Comprehend Medical
|
|
81
|
+
* <p> The level of confidence that Amazon Comprehend Medical has in the accuracy of this trait.</p>
|
|
82
82
|
*/
|
|
83
83
|
Score?: number;
|
|
84
84
|
}
|
|
@@ -150,12 +150,12 @@ export interface Attribute {
|
|
|
150
150
|
*/
|
|
151
151
|
Type?: EntitySubType | string;
|
|
152
152
|
/**
|
|
153
|
-
* <p> The level of confidence that Comprehend Medical
|
|
153
|
+
* <p> The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized
|
|
154
154
|
* as an attribute. </p>
|
|
155
155
|
*/
|
|
156
156
|
Score?: number;
|
|
157
157
|
/**
|
|
158
|
-
* <p> The level of confidence that Comprehend Medical
|
|
158
|
+
* <p> The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this
|
|
159
159
|
* entity. </p>
|
|
160
160
|
*/
|
|
161
161
|
RelationshipScore?: number;
|
|
@@ -202,7 +202,7 @@ export interface Attribute {
|
|
|
202
202
|
export interface Characters {
|
|
203
203
|
/**
|
|
204
204
|
* <p>
|
|
205
|
-
* The number of characters present in the input text document as processed by Comprehend Medical.
|
|
205
|
+
* The number of characters present in the input text document as processed by Amazon Comprehend Medical.
|
|
206
206
|
* </p>
|
|
207
207
|
*/
|
|
208
208
|
OriginalTextCharacters?: number;
|
|
@@ -212,7 +212,7 @@ export interface Characters {
|
|
|
212
212
|
*/
|
|
213
213
|
export interface DescribeEntitiesDetectionV2JobRequest {
|
|
214
214
|
/**
|
|
215
|
-
* <p>The identifier that Comprehend Medical
|
|
215
|
+
* <p>The identifier that Amazon Comprehend Medical generated for the job. The
|
|
216
216
|
* <code>StartEntitiesDetectionV2Job</code> operation returns this identifier in its
|
|
217
217
|
* response.</p>
|
|
218
218
|
*/
|
|
@@ -227,8 +227,6 @@ export interface InputDataConfig {
|
|
|
227
227
|
/**
|
|
228
228
|
* <p>The URI of the S3 bucket that contains the input data. The bucket must be in the same
|
|
229
229
|
* region as the API endpoint that you are calling.</p>
|
|
230
|
-
* <p>Each file in the document collection must be less than 40 KB. You can store a maximum of
|
|
231
|
-
* 30 GB in the bucket.</p>
|
|
232
230
|
*/
|
|
233
231
|
S3Bucket: string | undefined;
|
|
234
232
|
/**
|
|
@@ -277,7 +275,7 @@ export interface OutputDataConfig {
|
|
|
277
275
|
*/
|
|
278
276
|
S3Bucket: string | undefined;
|
|
279
277
|
/**
|
|
280
|
-
* <p>The path to the output data files in the S3 bucket. Comprehend Medical
|
|
278
|
+
* <p>The path to the output data files in the S3 bucket. Amazon Comprehend Medical creates an output directory
|
|
281
279
|
* using the job ID so that the output from one job does not overwrite the output of
|
|
282
280
|
* another.</p>
|
|
283
281
|
*/
|
|
@@ -333,7 +331,7 @@ export interface ComprehendMedicalAsyncJobProperties {
|
|
|
333
331
|
*/
|
|
334
332
|
LanguageCode?: LanguageCode | string;
|
|
335
333
|
/**
|
|
336
|
-
* <p>The Amazon Resource Name (ARN) that gives Comprehend Medical
|
|
334
|
+
* <p>The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.</p>
|
|
337
335
|
*/
|
|
338
336
|
DataAccessRoleArn?: string;
|
|
339
337
|
/**
|
|
@@ -440,7 +438,7 @@ export interface DescribeICD10CMInferenceJobResponse {
|
|
|
440
438
|
*/
|
|
441
439
|
export interface DescribePHIDetectionJobRequest {
|
|
442
440
|
/**
|
|
443
|
-
* <p>The identifier that Comprehend Medical
|
|
441
|
+
* <p>The identifier that Amazon Comprehend Medical generated for the job. The <code>StartPHIDetectionJob</code>
|
|
444
442
|
* operation returns this identifier in its response.</p>
|
|
445
443
|
*/
|
|
446
444
|
JobId: string | undefined;
|
|
@@ -498,8 +496,7 @@ export interface DescribeSNOMEDCTInferenceJobResponse {
|
|
|
498
496
|
*/
|
|
499
497
|
export interface DetectEntitiesRequest {
|
|
500
498
|
/**
|
|
501
|
-
* <p> A UTF-8 text string containing the clinical content being examined for entities
|
|
502
|
-
* string must contain fewer than 20,000 bytes of characters.</p>
|
|
499
|
+
* <p> A UTF-8 text string containing the clinical content being examined for entities.</p>
|
|
503
500
|
*/
|
|
504
501
|
Text: string | undefined;
|
|
505
502
|
}
|
|
@@ -524,7 +521,7 @@ export interface Entity {
|
|
|
524
521
|
*/
|
|
525
522
|
EndOffset?: number;
|
|
526
523
|
/**
|
|
527
|
-
* <p>The level of confidence that Comprehend Medical
|
|
524
|
+
* <p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.</p>
|
|
528
525
|
*/
|
|
529
526
|
Score?: number;
|
|
530
527
|
/**
|
|
@@ -550,7 +547,7 @@ export interface Entity {
|
|
|
550
547
|
}
|
|
551
548
|
/**
|
|
552
549
|
* @public
|
|
553
|
-
* <p>
|
|
550
|
+
* <p>An attribute that was extracted, but Amazon Comprehend Medical was unable to relate to an entity. </p>
|
|
554
551
|
*/
|
|
555
552
|
export interface UnmappedAttribute {
|
|
556
553
|
/**
|
|
@@ -569,19 +566,19 @@ export interface UnmappedAttribute {
|
|
|
569
566
|
*/
|
|
570
567
|
export interface DetectEntitiesResponse {
|
|
571
568
|
/**
|
|
572
|
-
* <p>
|
|
569
|
+
* <p>The collection of medical entities extracted from the input text and their associated
|
|
573
570
|
* information. For each entity, the response provides the entity text, the entity category,
|
|
574
|
-
* where the entity text begins and ends, and the level of confidence that Comprehend Medical
|
|
571
|
+
* where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the
|
|
575
572
|
* detection and analysis. Attributes and traits of the entity are also returned.</p>
|
|
576
573
|
*/
|
|
577
574
|
Entities: Entity[] | undefined;
|
|
578
575
|
/**
|
|
579
|
-
* <p>
|
|
576
|
+
* <p>Attributes extracted from the input text that we were unable to relate to an
|
|
580
577
|
* entity.</p>
|
|
581
578
|
*/
|
|
582
579
|
UnmappedAttributes?: UnmappedAttribute[];
|
|
583
580
|
/**
|
|
584
|
-
* <p>
|
|
581
|
+
* <p>If the result of the previous request to <code>DetectEntities</code> was truncated,
|
|
585
582
|
* include the <code>PaginationToken</code> to fetch the next page of entities.</p>
|
|
586
583
|
*/
|
|
587
584
|
PaginationToken?: string;
|
|
@@ -608,7 +605,7 @@ export declare class InvalidEncodingException extends __BaseException {
|
|
|
608
605
|
}
|
|
609
606
|
/**
|
|
610
607
|
* @public
|
|
611
|
-
* <p> The Comprehend Medical
|
|
608
|
+
* <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
|
|
612
609
|
* </p>
|
|
613
610
|
*/
|
|
614
611
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
@@ -639,8 +636,7 @@ export declare class TextSizeLimitExceededException extends __BaseException {
|
|
|
639
636
|
*/
|
|
640
637
|
export interface DetectEntitiesV2Request {
|
|
641
638
|
/**
|
|
642
|
-
* <p>A UTF-8 string containing the clinical content being examined for entities
|
|
643
|
-
* must contain fewer than 20,000 bytes of characters.</p>
|
|
639
|
+
* <p>A UTF-8 string containing the clinical content being examined for entities.</p>
|
|
644
640
|
*/
|
|
645
641
|
Text: string | undefined;
|
|
646
642
|
}
|
|
@@ -676,8 +672,7 @@ export interface DetectEntitiesV2Response {
|
|
|
676
672
|
*/
|
|
677
673
|
export interface DetectPHIRequest {
|
|
678
674
|
/**
|
|
679
|
-
* <p>
|
|
680
|
-
* string must contain fewer than 20,000 bytes of characters.</p>
|
|
675
|
+
* <p>A UTF-8 text string containing the clinical content being examined for PHI entities.</p>
|
|
681
676
|
*/
|
|
682
677
|
Text: string | undefined;
|
|
683
678
|
}
|
|
@@ -686,14 +681,14 @@ export interface DetectPHIRequest {
|
|
|
686
681
|
*/
|
|
687
682
|
export interface DetectPHIResponse {
|
|
688
683
|
/**
|
|
689
|
-
* <p>
|
|
684
|
+
* <p>The collection of PHI entities extracted from the input text and their associated
|
|
690
685
|
* information. For each entity, the response provides the entity text, the entity category,
|
|
691
|
-
* where the entity text begins and ends, and the level of confidence that Comprehend Medical
|
|
692
|
-
* detection
|
|
686
|
+
* where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its
|
|
687
|
+
* detection.</p>
|
|
693
688
|
*/
|
|
694
689
|
Entities: Entity[] | undefined;
|
|
695
690
|
/**
|
|
696
|
-
* <p>
|
|
691
|
+
* <p>If the result of the previous request to <code>DetectPHI</code> was truncated, include
|
|
697
692
|
* the <code>PaginationToken</code> to fetch the next page of PHI entities. </p>
|
|
698
693
|
*/
|
|
699
694
|
PaginationToken?: string;
|
|
@@ -709,8 +704,7 @@ export interface DetectPHIResponse {
|
|
|
709
704
|
*/
|
|
710
705
|
export interface InferICD10CMRequest {
|
|
711
706
|
/**
|
|
712
|
-
* <p>The input text used for analysis
|
|
713
|
-
* characters.</p>
|
|
707
|
+
* <p>The input text used for analysis.</p>
|
|
714
708
|
*/
|
|
715
709
|
Text: string | undefined;
|
|
716
710
|
}
|
|
@@ -768,7 +762,7 @@ export interface ICD10CMTrait {
|
|
|
768
762
|
*/
|
|
769
763
|
Name?: ICD10CMTraitName | string;
|
|
770
764
|
/**
|
|
771
|
-
* <p>The level of confidence that Comprehend Medical
|
|
765
|
+
* <p>The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized
|
|
772
766
|
* as a trait.</p>
|
|
773
767
|
*/
|
|
774
768
|
Score?: number;
|
|
@@ -969,8 +963,7 @@ export interface InferICD10CMResponse {
|
|
|
969
963
|
*/
|
|
970
964
|
export interface InferRxNormRequest {
|
|
971
965
|
/**
|
|
972
|
-
* <p>The input text used for analysis
|
|
973
|
-
* characters.</p>
|
|
966
|
+
* <p>The input text used for analysis.</p>
|
|
974
967
|
*/
|
|
975
968
|
Text: string | undefined;
|
|
976
969
|
}
|
|
@@ -1033,7 +1026,7 @@ export interface RxNormAttribute {
|
|
|
1033
1026
|
*/
|
|
1034
1027
|
Type?: RxNormAttributeType | string;
|
|
1035
1028
|
/**
|
|
1036
|
-
* <p>The level of confidence that Comprehend Medical has that the segment of text is correctly
|
|
1029
|
+
* <p>The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly
|
|
1037
1030
|
* recognized as an attribute.</p>
|
|
1038
1031
|
*/
|
|
1039
1032
|
Score?: number;
|
|
@@ -1162,11 +1155,11 @@ export interface RxNormEntity {
|
|
|
1162
1155
|
*/
|
|
1163
1156
|
Attributes?: RxNormAttribute[];
|
|
1164
1157
|
/**
|
|
1165
|
-
* <p>
|
|
1158
|
+
* <p>Contextual information for the entity.</p>
|
|
1166
1159
|
*/
|
|
1167
1160
|
Traits?: RxNormTrait[];
|
|
1168
1161
|
/**
|
|
1169
|
-
* <p>
|
|
1162
|
+
* <p>The RxNorm concepts that the entity could refer to, along with a score indicating the
|
|
1170
1163
|
* likelihood of the match.</p>
|
|
1171
1164
|
*/
|
|
1172
1165
|
RxNormConcepts?: RxNormConcept[];
|
|
@@ -1198,9 +1191,7 @@ export interface InferRxNormResponse {
|
|
|
1198
1191
|
*/
|
|
1199
1192
|
export interface InferSNOMEDCTRequest {
|
|
1200
1193
|
/**
|
|
1201
|
-
* <p>
|
|
1202
|
-
* The input text to be analyzed using InferSNOMEDCT. The text should be a string with 1 to 10000 characters.
|
|
1203
|
-
* </p>
|
|
1194
|
+
* <p>The input text to be analyzed using InferSNOMEDCT.</p>
|
|
1204
1195
|
*/
|
|
1205
1196
|
Text: string | undefined;
|
|
1206
1197
|
}
|
|
@@ -1255,7 +1246,7 @@ export interface SNOMEDCTConcept {
|
|
|
1255
1246
|
Code?: string;
|
|
1256
1247
|
/**
|
|
1257
1248
|
* <p>
|
|
1258
|
-
* The level of confidence Comprehend Medical has that the entity should be linked to the identified SNOMED-CT concept.
|
|
1249
|
+
* The level of confidence Amazon Comprehend Medical has that the entity should be linked to the identified SNOMED-CT concept.
|
|
1259
1250
|
* </p>
|
|
1260
1251
|
*/
|
|
1261
1252
|
Score?: number;
|
|
@@ -1294,7 +1285,7 @@ export interface SNOMEDCTTrait {
|
|
|
1294
1285
|
Name?: SNOMEDCTTraitName | string;
|
|
1295
1286
|
/**
|
|
1296
1287
|
* <p>
|
|
1297
|
-
* The level of confidence that Comprehend Medical has in the accuracy of a detected trait.
|
|
1288
|
+
* The level of confidence that Amazon Comprehend Medical has in the accuracy of a detected trait.
|
|
1298
1289
|
* </p>
|
|
1299
1290
|
*/
|
|
1300
1291
|
Score?: number;
|
|
@@ -1336,13 +1327,13 @@ export interface SNOMEDCTAttribute {
|
|
|
1336
1327
|
Type?: SNOMEDCTAttributeType | string;
|
|
1337
1328
|
/**
|
|
1338
1329
|
* <p>
|
|
1339
|
-
* The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
|
|
1330
|
+
* The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
|
|
1340
1331
|
* </p>
|
|
1341
1332
|
*/
|
|
1342
1333
|
Score?: number;
|
|
1343
1334
|
/**
|
|
1344
1335
|
* <p>
|
|
1345
|
-
* The level of confidence that Comprehend Medical has that this attribute is correctly related to this entity.
|
|
1336
|
+
* The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
|
|
1346
1337
|
* </p>
|
|
1347
1338
|
*/
|
|
1348
1339
|
RelationshipScore?: number;
|
|
@@ -1406,7 +1397,7 @@ export type SNOMEDCTEntityType = (typeof SNOMEDCTEntityType)[keyof typeof SNOMED
|
|
|
1406
1397
|
/**
|
|
1407
1398
|
* @public
|
|
1408
1399
|
* <p>
|
|
1409
|
-
* 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 Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
|
|
1400
|
+
* 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.
|
|
1410
1401
|
* </p>
|
|
1411
1402
|
*/
|
|
1412
1403
|
export interface SNOMEDCTEntity {
|
|
@@ -1436,7 +1427,7 @@ export interface SNOMEDCTEntity {
|
|
|
1436
1427
|
Type?: SNOMEDCTEntityType | string;
|
|
1437
1428
|
/**
|
|
1438
1429
|
* <p>
|
|
1439
|
-
* The level of confidence that Comprehend Medical has in the accuracy of the detected entity.
|
|
1430
|
+
* The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
|
|
1440
1431
|
* </p>
|
|
1441
1432
|
*/
|
|
1442
1433
|
Score?: number;
|
|
@@ -1503,7 +1494,7 @@ export interface SNOMEDCTDetails {
|
|
|
1503
1494
|
export interface InferSNOMEDCTResponse {
|
|
1504
1495
|
/**
|
|
1505
1496
|
* <p>
|
|
1506
|
-
* 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 Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
|
|
1497
|
+
* 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.
|
|
1507
1498
|
* </p>
|
|
1508
1499
|
*/
|
|
1509
1500
|
Entities: SNOMEDCTEntity[] | undefined;
|
|
@@ -1749,7 +1740,7 @@ export interface StartEntitiesDetectionV2JobRequest {
|
|
|
1749
1740
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
1750
1741
|
/**
|
|
1751
1742
|
* <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that
|
|
1752
|
-
* grants Comprehend Medical
|
|
1743
|
+
* 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>
|
|
1753
1744
|
*/
|
|
1754
1745
|
DataAccessRoleArn: string | undefined;
|
|
1755
1746
|
/**
|
|
@@ -1757,7 +1748,7 @@ export interface StartEntitiesDetectionV2JobRequest {
|
|
|
1757
1748
|
*/
|
|
1758
1749
|
JobName?: string;
|
|
1759
1750
|
/**
|
|
1760
|
-
* <p>A unique identifier for the request. If you don't set the client request token, Comprehend Medical
|
|
1751
|
+
* <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical
|
|
1761
1752
|
* generates one for you.</p>
|
|
1762
1753
|
*/
|
|
1763
1754
|
ClientRequestToken?: string;
|
|
@@ -1767,7 +1758,7 @@ export interface StartEntitiesDetectionV2JobRequest {
|
|
|
1767
1758
|
*/
|
|
1768
1759
|
KMSKey?: string;
|
|
1769
1760
|
/**
|
|
1770
|
-
* <p>The language of the input documents. All documents must be in the same language. Comprehend Medical
|
|
1761
|
+
* <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>
|
|
1771
1762
|
*/
|
|
1772
1763
|
LanguageCode: LanguageCode | string | undefined;
|
|
1773
1764
|
}
|
|
@@ -1795,7 +1786,7 @@ export interface StartICD10CMInferenceJobRequest {
|
|
|
1795
1786
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
1796
1787
|
/**
|
|
1797
1788
|
* <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that
|
|
1798
|
-
* grants Comprehend Medical
|
|
1789
|
+
* 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>
|
|
1799
1790
|
*/
|
|
1800
1791
|
DataAccessRoleArn: string | undefined;
|
|
1801
1792
|
/**
|
|
@@ -1803,8 +1794,7 @@ export interface StartICD10CMInferenceJobRequest {
|
|
|
1803
1794
|
*/
|
|
1804
1795
|
JobName?: string;
|
|
1805
1796
|
/**
|
|
1806
|
-
* <p>A unique identifier for the request. If you don't set the client request token, Comprehend Medical
|
|
1807
|
-
* generates one.</p>
|
|
1797
|
+
* <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.</p>
|
|
1808
1798
|
*/
|
|
1809
1799
|
ClientRequestToken?: string;
|
|
1810
1800
|
/**
|
|
@@ -1841,7 +1831,7 @@ export interface StartPHIDetectionJobRequest {
|
|
|
1841
1831
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
1842
1832
|
/**
|
|
1843
1833
|
* <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that
|
|
1844
|
-
* grants Comprehend Medical
|
|
1834
|
+
* 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>
|
|
1845
1835
|
*/
|
|
1846
1836
|
DataAccessRoleArn: string | undefined;
|
|
1847
1837
|
/**
|
|
@@ -1849,7 +1839,7 @@ export interface StartPHIDetectionJobRequest {
|
|
|
1849
1839
|
*/
|
|
1850
1840
|
JobName?: string;
|
|
1851
1841
|
/**
|
|
1852
|
-
* <p>A unique identifier for the request. If you don't set the client request token, Comprehend Medical
|
|
1842
|
+
* <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical
|
|
1853
1843
|
* generates one.</p>
|
|
1854
1844
|
*/
|
|
1855
1845
|
ClientRequestToken?: string;
|
|
@@ -1887,7 +1877,7 @@ export interface StartRxNormInferenceJobRequest {
|
|
|
1887
1877
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
1888
1878
|
/**
|
|
1889
1879
|
* <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that
|
|
1890
|
-
* grants Comprehend Medical
|
|
1880
|
+
* 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>
|
|
1891
1881
|
*/
|
|
1892
1882
|
DataAccessRoleArn: string | undefined;
|
|
1893
1883
|
/**
|
|
@@ -1895,7 +1885,7 @@ export interface StartRxNormInferenceJobRequest {
|
|
|
1895
1885
|
*/
|
|
1896
1886
|
JobName?: string;
|
|
1897
1887
|
/**
|
|
1898
|
-
* <p>A unique identifier for the request. If you don't set the client request token, Comprehend Medical
|
|
1888
|
+
* <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical
|
|
1899
1889
|
* generates one.</p>
|
|
1900
1890
|
*/
|
|
1901
1891
|
ClientRequestToken?: string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-comprehendmedical",
|
|
3
3
|
"description": "AWS SDK for JavaScript Comprehendmedical Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.369.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,17 +21,17 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
27
|
-
"@aws-sdk/middleware-logger": "3.
|
|
28
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
29
|
-
"@aws-sdk/middleware-signing": "3.
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
31
|
-
"@aws-sdk/types": "3.
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
33
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
34
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.369.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.369.0",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "3.369.0",
|
|
27
|
+
"@aws-sdk/middleware-logger": "3.369.0",
|
|
28
|
+
"@aws-sdk/middleware-recursion-detection": "3.369.0",
|
|
29
|
+
"@aws-sdk/middleware-signing": "3.369.0",
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.369.0",
|
|
31
|
+
"@aws-sdk/types": "3.369.0",
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.369.0",
|
|
33
|
+
"@aws-sdk/util-user-agent-browser": "3.369.0",
|
|
34
|
+
"@aws-sdk/util-user-agent-node": "3.369.0",
|
|
35
35
|
"@smithy/config-resolver": "^1.0.1",
|
|
36
36
|
"@smithy/fetch-http-handler": "^1.0.1",
|
|
37
37
|
"@smithy/hash-node": "^1.0.1",
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
"@smithy/node-http-handler": "^1.0.2",
|
|
46
46
|
"@smithy/protocol-http": "^1.0.1",
|
|
47
47
|
"@smithy/smithy-client": "^1.0.3",
|
|
48
|
-
"@smithy/types": "^1.
|
|
48
|
+
"@smithy/types": "^1.1.0",
|
|
49
49
|
"@smithy/url-parser": "^1.0.1",
|
|
50
50
|
"@smithy/util-base64": "^1.0.1",
|
|
51
51
|
"@smithy/util-body-length-browser": "^1.0.1",
|