UNPKG

14.1 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2018-10-30",
5 "endpointPrefix": "comprehendmedical",
6 "jsonVersion": "1.1",
7 "protocol": "json",
8 "serviceAbbreviation": "ComprehendMedical",
9 "serviceFullName": "AWS Comprehend Medical",
10 "serviceId": "ComprehendMedical",
11 "signatureVersion": "v4",
12 "signingName": "comprehendmedical",
13 "targetPrefix": "ComprehendMedical_20181030",
14 "uid": "comprehendmedical-2018-10-30"
15 },
16 "operations": {
17 "DescribeEntitiesDetectionV2Job": {
18 "input": {
19 "type": "structure",
20 "required": [
21 "JobId"
22 ],
23 "members": {
24 "JobId": {}
25 }
26 },
27 "output": {
28 "type": "structure",
29 "members": {
30 "ComprehendMedicalAsyncJobProperties": {
31 "shape": "S4"
32 }
33 }
34 }
35 },
36 "DescribePHIDetectionJob": {
37 "input": {
38 "type": "structure",
39 "required": [
40 "JobId"
41 ],
42 "members": {
43 "JobId": {}
44 }
45 },
46 "output": {
47 "type": "structure",
48 "members": {
49 "ComprehendMedicalAsyncJobProperties": {
50 "shape": "S4"
51 }
52 }
53 }
54 },
55 "DetectEntities": {
56 "input": {
57 "type": "structure",
58 "required": [
59 "Text"
60 ],
61 "members": {
62 "Text": {}
63 }
64 },
65 "output": {
66 "type": "structure",
67 "required": [
68 "Entities",
69 "ModelVersion"
70 ],
71 "members": {
72 "Entities": {
73 "shape": "Sn"
74 },
75 "UnmappedAttributes": {
76 "shape": "S10"
77 },
78 "PaginationToken": {},
79 "ModelVersion": {}
80 }
81 },
82 "deprecated": true,
83 "deprecatedMessage": "This operation is deprecated, use DetectEntitiesV2 instead."
84 },
85 "DetectEntitiesV2": {
86 "input": {
87 "type": "structure",
88 "required": [
89 "Text"
90 ],
91 "members": {
92 "Text": {}
93 }
94 },
95 "output": {
96 "type": "structure",
97 "required": [
98 "Entities",
99 "ModelVersion"
100 ],
101 "members": {
102 "Entities": {
103 "shape": "Sn"
104 },
105 "UnmappedAttributes": {
106 "shape": "S10"
107 },
108 "PaginationToken": {},
109 "ModelVersion": {}
110 }
111 }
112 },
113 "DetectPHI": {
114 "input": {
115 "type": "structure",
116 "required": [
117 "Text"
118 ],
119 "members": {
120 "Text": {}
121 }
122 },
123 "output": {
124 "type": "structure",
125 "required": [
126 "Entities",
127 "ModelVersion"
128 ],
129 "members": {
130 "Entities": {
131 "shape": "Sn"
132 },
133 "PaginationToken": {},
134 "ModelVersion": {}
135 }
136 }
137 },
138 "InferICD10CM": {
139 "input": {
140 "type": "structure",
141 "required": [
142 "Text"
143 ],
144 "members": {
145 "Text": {}
146 }
147 },
148 "output": {
149 "type": "structure",
150 "required": [
151 "Entities"
152 ],
153 "members": {
154 "Entities": {
155 "type": "list",
156 "member": {
157 "type": "structure",
158 "members": {
159 "Id": {
160 "type": "integer"
161 },
162 "Text": {},
163 "Category": {},
164 "Type": {},
165 "Score": {
166 "type": "float"
167 },
168 "BeginOffset": {
169 "type": "integer"
170 },
171 "EndOffset": {
172 "type": "integer"
173 },
174 "Attributes": {
175 "type": "list",
176 "member": {
177 "type": "structure",
178 "members": {
179 "Type": {},
180 "Score": {
181 "type": "float"
182 },
183 "RelationshipScore": {
184 "type": "float"
185 },
186 "Id": {
187 "type": "integer"
188 },
189 "BeginOffset": {
190 "type": "integer"
191 },
192 "EndOffset": {
193 "type": "integer"
194 },
195 "Text": {},
196 "Traits": {
197 "shape": "S1g"
198 }
199 }
200 }
201 },
202 "Traits": {
203 "shape": "S1g"
204 },
205 "ICD10CMConcepts": {
206 "type": "list",
207 "member": {
208 "type": "structure",
209 "members": {
210 "Description": {},
211 "Code": {},
212 "Score": {
213 "type": "float"
214 }
215 }
216 }
217 }
218 }
219 }
220 },
221 "PaginationToken": {},
222 "ModelVersion": {}
223 }
224 }
225 },
226 "InferRxNorm": {
227 "input": {
228 "type": "structure",
229 "required": [
230 "Text"
231 ],
232 "members": {
233 "Text": {}
234 }
235 },
236 "output": {
237 "type": "structure",
238 "required": [
239 "Entities"
240 ],
241 "members": {
242 "Entities": {
243 "type": "list",
244 "member": {
245 "type": "structure",
246 "members": {
247 "Id": {
248 "type": "integer"
249 },
250 "Text": {},
251 "Category": {},
252 "Type": {},
253 "Score": {
254 "type": "float"
255 },
256 "BeginOffset": {
257 "type": "integer"
258 },
259 "EndOffset": {
260 "type": "integer"
261 },
262 "Attributes": {
263 "type": "list",
264 "member": {
265 "type": "structure",
266 "members": {
267 "Type": {},
268 "Score": {
269 "type": "float"
270 },
271 "RelationshipScore": {
272 "type": "float"
273 },
274 "Id": {
275 "type": "integer"
276 },
277 "BeginOffset": {
278 "type": "integer"
279 },
280 "EndOffset": {
281 "type": "integer"
282 },
283 "Text": {},
284 "Traits": {
285 "shape": "S1u"
286 }
287 }
288 }
289 },
290 "Traits": {
291 "shape": "S1u"
292 },
293 "RxNormConcepts": {
294 "type": "list",
295 "member": {
296 "type": "structure",
297 "members": {
298 "Description": {},
299 "Code": {},
300 "Score": {
301 "type": "float"
302 }
303 }
304 }
305 }
306 }
307 }
308 },
309 "PaginationToken": {},
310 "ModelVersion": {}
311 }
312 }
313 },
314 "ListEntitiesDetectionV2Jobs": {
315 "input": {
316 "type": "structure",
317 "members": {
318 "Filter": {
319 "shape": "S20"
320 },
321 "NextToken": {},
322 "MaxResults": {
323 "type": "integer"
324 }
325 }
326 },
327 "output": {
328 "type": "structure",
329 "members": {
330 "ComprehendMedicalAsyncJobPropertiesList": {
331 "shape": "S23"
332 },
333 "NextToken": {}
334 }
335 }
336 },
337 "ListPHIDetectionJobs": {
338 "input": {
339 "type": "structure",
340 "members": {
341 "Filter": {
342 "shape": "S20"
343 },
344 "NextToken": {},
345 "MaxResults": {
346 "type": "integer"
347 }
348 }
349 },
350 "output": {
351 "type": "structure",
352 "members": {
353 "ComprehendMedicalAsyncJobPropertiesList": {
354 "shape": "S23"
355 },
356 "NextToken": {}
357 }
358 }
359 },
360 "StartEntitiesDetectionV2Job": {
361 "input": {
362 "type": "structure",
363 "required": [
364 "InputDataConfig",
365 "OutputDataConfig",
366 "DataAccessRoleArn",
367 "LanguageCode"
368 ],
369 "members": {
370 "InputDataConfig": {
371 "shape": "S9"
372 },
373 "OutputDataConfig": {
374 "shape": "Sc"
375 },
376 "DataAccessRoleArn": {},
377 "JobName": {},
378 "ClientRequestToken": {
379 "idempotencyToken": true
380 },
381 "KMSKey": {},
382 "LanguageCode": {}
383 }
384 },
385 "output": {
386 "type": "structure",
387 "members": {
388 "JobId": {}
389 }
390 }
391 },
392 "StartPHIDetectionJob": {
393 "input": {
394 "type": "structure",
395 "required": [
396 "InputDataConfig",
397 "OutputDataConfig",
398 "DataAccessRoleArn",
399 "LanguageCode"
400 ],
401 "members": {
402 "InputDataConfig": {
403 "shape": "S9"
404 },
405 "OutputDataConfig": {
406 "shape": "Sc"
407 },
408 "DataAccessRoleArn": {},
409 "JobName": {},
410 "ClientRequestToken": {
411 "idempotencyToken": true
412 },
413 "KMSKey": {},
414 "LanguageCode": {}
415 }
416 },
417 "output": {
418 "type": "structure",
419 "members": {
420 "JobId": {}
421 }
422 }
423 },
424 "StopEntitiesDetectionV2Job": {
425 "input": {
426 "type": "structure",
427 "required": [
428 "JobId"
429 ],
430 "members": {
431 "JobId": {}
432 }
433 },
434 "output": {
435 "type": "structure",
436 "members": {
437 "JobId": {}
438 }
439 }
440 },
441 "StopPHIDetectionJob": {
442 "input": {
443 "type": "structure",
444 "required": [
445 "JobId"
446 ],
447 "members": {
448 "JobId": {}
449 }
450 },
451 "output": {
452 "type": "structure",
453 "members": {
454 "JobId": {}
455 }
456 }
457 }
458 },
459 "shapes": {
460 "S4": {
461 "type": "structure",
462 "members": {
463 "JobId": {},
464 "JobName": {},
465 "JobStatus": {},
466 "Message": {},
467 "SubmitTime": {
468 "type": "timestamp"
469 },
470 "EndTime": {
471 "type": "timestamp"
472 },
473 "ExpirationTime": {
474 "type": "timestamp"
475 },
476 "InputDataConfig": {
477 "shape": "S9"
478 },
479 "OutputDataConfig": {
480 "shape": "Sc"
481 },
482 "LanguageCode": {},
483 "DataAccessRoleArn": {},
484 "ManifestFilePath": {},
485 "KMSKey": {},
486 "ModelVersion": {}
487 }
488 },
489 "S9": {
490 "type": "structure",
491 "required": [
492 "S3Bucket"
493 ],
494 "members": {
495 "S3Bucket": {},
496 "S3Key": {}
497 }
498 },
499 "Sc": {
500 "type": "structure",
501 "required": [
502 "S3Bucket"
503 ],
504 "members": {
505 "S3Bucket": {},
506 "S3Key": {}
507 }
508 },
509 "Sn": {
510 "type": "list",
511 "member": {
512 "type": "structure",
513 "members": {
514 "Id": {
515 "type": "integer"
516 },
517 "BeginOffset": {
518 "type": "integer"
519 },
520 "EndOffset": {
521 "type": "integer"
522 },
523 "Score": {
524 "type": "float"
525 },
526 "Text": {},
527 "Category": {},
528 "Type": {},
529 "Traits": {
530 "shape": "Su"
531 },
532 "Attributes": {
533 "type": "list",
534 "member": {
535 "shape": "Sy"
536 }
537 }
538 }
539 }
540 },
541 "Su": {
542 "type": "list",
543 "member": {
544 "type": "structure",
545 "members": {
546 "Name": {},
547 "Score": {
548 "type": "float"
549 }
550 }
551 }
552 },
553 "Sy": {
554 "type": "structure",
555 "members": {
556 "Type": {},
557 "Score": {
558 "type": "float"
559 },
560 "RelationshipScore": {
561 "type": "float"
562 },
563 "RelationshipType": {},
564 "Id": {
565 "type": "integer"
566 },
567 "BeginOffset": {
568 "type": "integer"
569 },
570 "EndOffset": {
571 "type": "integer"
572 },
573 "Text": {},
574 "Category": {},
575 "Traits": {
576 "shape": "Su"
577 }
578 }
579 },
580 "S10": {
581 "type": "list",
582 "member": {
583 "type": "structure",
584 "members": {
585 "Type": {},
586 "Attribute": {
587 "shape": "Sy"
588 }
589 }
590 }
591 },
592 "S1g": {
593 "type": "list",
594 "member": {
595 "type": "structure",
596 "members": {
597 "Name": {},
598 "Score": {
599 "type": "float"
600 }
601 }
602 }
603 },
604 "S1u": {
605 "type": "list",
606 "member": {
607 "type": "structure",
608 "members": {
609 "Name": {},
610 "Score": {
611 "type": "float"
612 }
613 }
614 }
615 },
616 "S20": {
617 "type": "structure",
618 "members": {
619 "JobName": {},
620 "JobStatus": {},
621 "SubmitTimeBefore": {
622 "type": "timestamp"
623 },
624 "SubmitTimeAfter": {
625 "type": "timestamp"
626 }
627 }
628 },
629 "S23": {
630 "type": "list",
631 "member": {
632 "shape": "S4"
633 }
634 }
635 }
636}
\No newline at end of file