1 | import {Request} from '../lib/request';
|
2 | import {Response} from '../lib/response';
|
3 | import {AWSError} from '../lib/error';
|
4 | import {Service} from '../lib/service';
|
5 | import {ServiceConfigurationOptions} from '../lib/service';
|
6 | import {ConfigBase as Config} from '../lib/config';
|
7 | interface Blob {}
|
8 | declare class ComprehendMedical extends Service {
|
9 | |
10 |
|
11 |
|
12 | constructor(options?: ComprehendMedical.Types.ClientConfiguration)
|
13 | config: Config & ComprehendMedical.Types.ClientConfiguration;
|
14 | /**
|
15 | * Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.
|
16 | */
|
17 | describeEntitiesDetectionV2Job(params: ComprehendMedical.Types.DescribeEntitiesDetectionV2JobRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.DescribeEntitiesDetectionV2JobResponse) => void): Request<ComprehendMedical.Types.DescribeEntitiesDetectionV2JobResponse, AWSError>;
|
18 | /**
|
19 | * Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.
|
20 | */
|
21 | describeEntitiesDetectionV2Job(callback?: (err: AWSError, data: ComprehendMedical.Types.DescribeEntitiesDetectionV2JobResponse) => void): Request<ComprehendMedical.Types.DescribeEntitiesDetectionV2JobResponse, AWSError>;
|
22 | /**
|
23 | * Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.
|
24 | */
|
25 | describePHIDetectionJob(params: ComprehendMedical.Types.DescribePHIDetectionJobRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.DescribePHIDetectionJobResponse) => void): Request<ComprehendMedical.Types.DescribePHIDetectionJobResponse, AWSError>;
|
26 | /**
|
27 | * Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.
|
28 | */
|
29 | describePHIDetectionJob(callback?: (err: AWSError, data: ComprehendMedical.Types.DescribePHIDetectionJobResponse) => void): Request<ComprehendMedical.Types.DescribePHIDetectionJobResponse, AWSError>;
|
30 | /**
|
31 | * The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead. Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .
|
32 | */
|
33 | detectEntities(params: ComprehendMedical.Types.DetectEntitiesRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.DetectEntitiesResponse) => void): Request<ComprehendMedical.Types.DetectEntitiesResponse, AWSError>;
|
34 | /**
|
35 | * The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead. Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .
|
36 | */
|
37 | detectEntities(callback?: (err: AWSError, data: ComprehendMedical.Types.DetectEntitiesResponse) => void): Request<ComprehendMedical.Types.DetectEntitiesResponse, AWSError>;
|
38 | /**
|
39 | * Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information. The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications. The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types. It does not return the Quality or Quantity entities.
|
40 | */
|
41 | detectEntitiesV2(params: ComprehendMedical.Types.DetectEntitiesV2Request, callback?: (err: AWSError, data: ComprehendMedical.Types.DetectEntitiesV2Response) => void): Request<ComprehendMedical.Types.DetectEntitiesV2Response, AWSError>;
|
42 | /**
|
43 | * Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information. The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications. The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types. It does not return the Quality or Quantity entities.
|
44 | */
|
45 | detectEntitiesV2(callback?: (err: AWSError, data: ComprehendMedical.Types.DetectEntitiesV2Response) => void): Request<ComprehendMedical.Types.DetectEntitiesV2Response, AWSError>;
|
46 | /**
|
47 | * Inspects the clinical text for protected health information (PHI) entities and entity category, location, and confidence score on that information.
|
48 | */
|
49 | detectPHI(params: ComprehendMedical.Types.DetectPHIRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.DetectPHIResponse) => void): Request<ComprehendMedical.Types.DetectPHIResponse, AWSError>;
|
50 | /**
|
51 | * Inspects the clinical text for protected health information (PHI) entities and entity category, location, and confidence score on that information.
|
52 | */
|
53 | detectPHI(callback?: (err: AWSError, data: ComprehendMedical.Types.DetectPHIResponse) => void): Request<ComprehendMedical.Types.DetectPHIResponse, AWSError>;
|
54 | /**
|
55 | * Gets a list of medical entity detection jobs that you have submitted.
|
56 | */
|
57 | listEntitiesDetectionV2Jobs(params: ComprehendMedical.Types.ListEntitiesDetectionV2JobsRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.ListEntitiesDetectionV2JobsResponse) => void): Request<ComprehendMedical.Types.ListEntitiesDetectionV2JobsResponse, AWSError>;
|
58 | /**
|
59 | * Gets a list of medical entity detection jobs that you have submitted.
|
60 | */
|
61 | listEntitiesDetectionV2Jobs(callback?: (err: AWSError, data: ComprehendMedical.Types.ListEntitiesDetectionV2JobsResponse) => void): Request<ComprehendMedical.Types.ListEntitiesDetectionV2JobsResponse, AWSError>;
|
62 | /**
|
63 | * Gets a list of protected health information (PHI) detection jobs that you have submitted.
|
64 | */
|
65 | listPHIDetectionJobs(params: ComprehendMedical.Types.ListPHIDetectionJobsRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.ListPHIDetectionJobsResponse) => void): Request<ComprehendMedical.Types.ListPHIDetectionJobsResponse, AWSError>;
|
66 | /**
|
67 | * Gets a list of protected health information (PHI) detection jobs that you have submitted.
|
68 | */
|
69 | listPHIDetectionJobs(callback?: (err: AWSError, data: ComprehendMedical.Types.ListPHIDetectionJobsResponse) => void): Request<ComprehendMedical.Types.ListPHIDetectionJobsResponse, AWSError>;
|
70 | /**
|
71 | * Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job.
|
72 | */
|
73 | startEntitiesDetectionV2Job(params: ComprehendMedical.Types.StartEntitiesDetectionV2JobRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.StartEntitiesDetectionV2JobResponse) => void): Request<ComprehendMedical.Types.StartEntitiesDetectionV2JobResponse, AWSError>;
|
74 | /**
|
75 | * Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job.
|
76 | */
|
77 | startEntitiesDetectionV2Job(callback?: (err: AWSError, data: ComprehendMedical.Types.StartEntitiesDetectionV2JobResponse) => void): Request<ComprehendMedical.Types.StartEntitiesDetectionV2JobResponse, AWSError>;
|
78 | /**
|
79 | * Starts an asynchronous job to detect protected health information (PHI). Use the DescribePHIDetectionJob operation to track the status of a job.
|
80 | */
|
81 | startPHIDetectionJob(params: ComprehendMedical.Types.StartPHIDetectionJobRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.StartPHIDetectionJobResponse) => void): Request<ComprehendMedical.Types.StartPHIDetectionJobResponse, AWSError>;
|
82 | /**
|
83 | * Starts an asynchronous job to detect protected health information (PHI). Use the DescribePHIDetectionJob operation to track the status of a job.
|
84 | */
|
85 | startPHIDetectionJob(callback?: (err: AWSError, data: ComprehendMedical.Types.StartPHIDetectionJobResponse) => void): Request<ComprehendMedical.Types.StartPHIDetectionJobResponse, AWSError>;
|
86 | /**
|
87 | * Stops a medical entities detection job in progress.
|
88 | */
|
89 | stopEntitiesDetectionV2Job(params: ComprehendMedical.Types.StopEntitiesDetectionV2JobRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.StopEntitiesDetectionV2JobResponse) => void): Request<ComprehendMedical.Types.StopEntitiesDetectionV2JobResponse, AWSError>;
|
90 | /**
|
91 | * Stops a medical entities detection job in progress.
|
92 | */
|
93 | stopEntitiesDetectionV2Job(callback?: (err: AWSError, data: ComprehendMedical.Types.StopEntitiesDetectionV2JobResponse) => void): Request<ComprehendMedical.Types.StopEntitiesDetectionV2JobResponse, AWSError>;
|
94 | /**
|
95 | * Stops a protected health information (PHI) detection job in progress.
|
96 | */
|
97 | stopPHIDetectionJob(params: ComprehendMedical.Types.StopPHIDetectionJobRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.StopPHIDetectionJobResponse) => void): Request<ComprehendMedical.Types.StopPHIDetectionJobResponse, AWSError>;
|
98 | /**
|
99 | * Stops a protected health information (PHI) detection job in progress.
|
100 | */
|
101 | stopPHIDetectionJob(callback?: (err: AWSError, data: ComprehendMedical.Types.StopPHIDetectionJobResponse) => void): Request<ComprehendMedical.Types.StopPHIDetectionJobResponse, AWSError>;
|
102 | }
|
103 | declare namespace ComprehendMedical {
|
104 | export type AnyLengthString = string;
|
105 | export interface Attribute {
|
106 | |
107 |
|
108 |
|
109 | Type?: EntitySubType;
|
110 | |
111 |
|
112 |
|
113 | Score?: Float;
|
114 | |
115 |
|
116 |
|
117 | RelationshipScore?: Float;
|
118 | |
119 |
|
120 |
|
121 | Id?: Integer;
|
122 | |
123 |
|
124 |
|
125 | BeginOffset?: Integer;
|
126 | |
127 |
|
128 |
|
129 | EndOffset?: Integer;
|
130 | |
131 |
|
132 |
|
133 | Text?: String;
|
134 | |
135 |
|
136 |
|
137 | Traits?: TraitList;
|
138 | }
|
139 | export type AttributeList = Attribute[];
|
140 | export type AttributeName = "SIGN"|"SYMPTOM"|"DIAGNOSIS"|"NEGATION"|string;
|
141 | export type BoundedLengthString = string;
|
142 | export type ClientRequestTokenString = string;
|
143 | export interface ComprehendMedicalAsyncJobFilter {
|
144 | |
145 |
|
146 |
|
147 | JobName?: JobName;
|
148 | |
149 |
|
150 |
|
151 | JobStatus?: JobStatus;
|
152 | |
153 |
|
154 |
|
155 | SubmitTimeBefore?: Timestamp;
|
156 | |
157 |
|
158 |
|
159 | SubmitTimeAfter?: Timestamp;
|
160 | }
|
161 | export interface ComprehendMedicalAsyncJobProperties {
|
162 | |
163 |
|
164 |
|
165 | JobId?: JobId;
|
166 | |
167 |
|
168 |
|
169 | JobName?: JobName;
|
170 | |
171 |
|
172 |
|
173 | JobStatus?: JobStatus;
|
174 | |
175 |
|
176 |
|
177 | Message?: AnyLengthString;
|
178 | |
179 |
|
180 |
|
181 | SubmitTime?: Timestamp;
|
182 | |
183 |
|
184 |
|
185 | EndTime?: Timestamp;
|
186 | |
187 |
|
188 |
|
189 | ExpirationTime?: Timestamp;
|
190 | |
191 |
|
192 |
|
193 | InputDataConfig?: InputDataConfig;
|
194 | |
195 |
|
196 |
|
197 | OutputDataConfig?: OutputDataConfig;
|
198 | |
199 |
|
200 |
|
201 | LanguageCode?: LanguageCode;
|
202 | |
203 |
|
204 |
|
205 | DataAccessRoleArn?: IamRoleArn;
|
206 | |
207 |
|
208 |
|
209 | ManifestFilePath?: ManifestFilePath;
|
210 | |
211 |
|
212 |
|
213 | KMSKey?: KMSKey;
|
214 | |
215 |
|
216 |
|
217 | ModelVersion?: ModelVersion;
|
218 | }
|
219 | export type ComprehendMedicalAsyncJobPropertiesList = ComprehendMedicalAsyncJobProperties[];
|
220 | export interface DescribeEntitiesDetectionV2JobRequest {
|
221 | |
222 |
|
223 |
|
224 | JobId: JobId;
|
225 | }
|
226 | export interface DescribeEntitiesDetectionV2JobResponse {
|
227 | |
228 |
|
229 |
|
230 | ComprehendMedicalAsyncJobProperties?: ComprehendMedicalAsyncJobProperties;
|
231 | }
|
232 | export interface DescribePHIDetectionJobRequest {
|
233 | |
234 |
|
235 |
|
236 | JobId: JobId;
|
237 | }
|
238 | export interface DescribePHIDetectionJobResponse {
|
239 | |
240 |
|
241 |
|
242 | ComprehendMedicalAsyncJobProperties?: ComprehendMedicalAsyncJobProperties;
|
243 | }
|
244 | export interface DetectEntitiesRequest {
|
245 | |
246 |
|
247 |
|
248 | Text: BoundedLengthString;
|
249 | }
|
250 | export interface DetectEntitiesResponse {
|
251 | |
252 |
|
253 |
|
254 | Entities: EntityList;
|
255 | |
256 |
|
257 |
|
258 | UnmappedAttributes?: UnmappedAttributeList;
|
259 | |
260 |
|
261 |
|
262 | PaginationToken?: String;
|
263 | |
264 |
|
265 |
|
266 | ModelVersion: String;
|
267 | }
|
268 | export interface DetectEntitiesV2Request {
|
269 | |
270 |
|
271 |
|
272 | Text: BoundedLengthString;
|
273 | }
|
274 | export interface DetectEntitiesV2Response {
|
275 | |
276 |
|
277 |
|
278 | Entities: EntityList;
|
279 | |
280 |
|
281 |
|
282 | UnmappedAttributes?: UnmappedAttributeList;
|
283 | |
284 |
|
285 |
|
286 | PaginationToken?: String;
|
287 | |
288 |
|
289 |
|
290 | ModelVersion: String;
|
291 | }
|
292 | export interface DetectPHIRequest {
|
293 | |
294 |
|
295 |
|
296 | Text: BoundedLengthString;
|
297 | }
|
298 | export interface DetectPHIResponse {
|
299 | |
300 |
|
301 |
|
302 | Entities: EntityList;
|
303 | |
304 |
|
305 |
|
306 | PaginationToken?: String;
|
307 | |
308 |
|
309 |
|
310 | ModelVersion: String;
|
311 | }
|
312 | export interface Entity {
|
313 | |
314 |
|
315 |
|
316 | Id?: Integer;
|
317 | |
318 |
|
319 |
|
320 | BeginOffset?: Integer;
|
321 | |
322 |
|
323 |
|
324 | EndOffset?: Integer;
|
325 | |
326 |
|
327 |
|
328 | Score?: Float;
|
329 | |
330 |
|
331 |
|
332 | Text?: String;
|
333 | |
334 |
|
335 |
|
336 | Category?: EntityType;
|
337 | |
338 |
|
339 |
|
340 | Type?: EntitySubType;
|
341 | |
342 |
|
343 |
|
344 | Traits?: TraitList;
|
345 | |
346 |
|
347 |
|
348 | Attributes?: AttributeList;
|
349 | }
|
350 | export type EntityList = Entity[];
|
351 | export type EntitySubType = "NAME"|"DOSAGE"|"ROUTE_OR_MODE"|"FORM"|"FREQUENCY"|"DURATION"|"GENERIC_NAME"|"BRAND_NAME"|"STRENGTH"|"RATE"|"ACUITY"|"TEST_NAME"|"TEST_VALUE"|"TEST_UNITS"|"PROCEDURE_NAME"|"TREATMENT_NAME"|"DATE"|"AGE"|"CONTACT_POINT"|"EMAIL"|"IDENTIFIER"|"URL"|"ADDRESS"|"PROFESSION"|"SYSTEM_ORGAN_SITE"|"DIRECTION"|"QUALITY"|"QUANTITY"|string;
|
352 | export type EntityType = "MEDICATION"|"MEDICAL_CONDITION"|"PROTECTED_HEALTH_INFORMATION"|"TEST_TREATMENT_PROCEDURE"|"ANATOMY"|string;
|
353 | export type Float = number;
|
354 | export type IamRoleArn = string;
|
355 | export interface InputDataConfig {
|
356 | |
357 |
|
358 |
|
359 | S3Bucket: S3Bucket;
|
360 | |
361 |
|
362 |
|
363 | S3Key?: S3Key;
|
364 | }
|
365 | export type Integer = number;
|
366 | export type JobId = string;
|
367 | export type JobName = string;
|
368 | export type JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"PARTIAL_SUCCESS"|"FAILED"|"STOP_REQUESTED"|"STOPPED"|string;
|
369 | export type KMSKey = string;
|
370 | export type LanguageCode = "en"|string;
|
371 | export interface ListEntitiesDetectionV2JobsRequest {
|
372 | |
373 |
|
374 |
|
375 | Filter?: ComprehendMedicalAsyncJobFilter;
|
376 | |
377 |
|
378 |
|
379 | NextToken?: String;
|
380 | |
381 |
|
382 |
|
383 | MaxResults?: MaxResultsInteger;
|
384 | }
|
385 | export interface ListEntitiesDetectionV2JobsResponse {
|
386 | |
387 |
|
388 |
|
389 | ComprehendMedicalAsyncJobPropertiesList?: ComprehendMedicalAsyncJobPropertiesList;
|
390 | |
391 |
|
392 |
|
393 | NextToken?: String;
|
394 | }
|
395 | export interface ListPHIDetectionJobsRequest {
|
396 | |
397 |
|
398 |
|
399 | Filter?: ComprehendMedicalAsyncJobFilter;
|
400 | |
401 |
|
402 |
|
403 | NextToken?: String;
|
404 | |
405 |
|
406 |
|
407 | MaxResults?: MaxResultsInteger;
|
408 | }
|
409 | export interface ListPHIDetectionJobsResponse {
|
410 | |
411 |
|
412 |
|
413 | ComprehendMedicalAsyncJobPropertiesList?: ComprehendMedicalAsyncJobPropertiesList;
|
414 | |
415 |
|
416 |
|
417 | NextToken?: String;
|
418 | }
|
419 | export type ManifestFilePath = string;
|
420 | export type MaxResultsInteger = number;
|
421 | export type ModelVersion = string;
|
422 | export interface OutputDataConfig {
|
423 | |
424 |
|
425 |
|
426 | S3Bucket: S3Bucket;
|
427 | |
428 |
|
429 |
|
430 | S3Key?: S3Key;
|
431 | }
|
432 | export type S3Bucket = string;
|
433 | export type S3Key = string;
|
434 | export interface StartEntitiesDetectionV2JobRequest {
|
435 | |
436 |
|
437 |
|
438 | InputDataConfig: InputDataConfig;
|
439 | |
440 |
|
441 |
|
442 | OutputDataConfig: OutputDataConfig;
|
443 | |
444 |
|
445 |
|
446 | DataAccessRoleArn: IamRoleArn;
|
447 | |
448 |
|
449 |
|
450 | JobName?: JobName;
|
451 | |
452 |
|
453 |
|
454 | ClientRequestToken?: ClientRequestTokenString;
|
455 | |
456 |
|
457 |
|
458 | KMSKey?: KMSKey;
|
459 | |
460 |
|
461 |
|
462 | LanguageCode: LanguageCode;
|
463 | }
|
464 | export interface StartEntitiesDetectionV2JobResponse {
|
465 | |
466 |
|
467 |
|
468 | JobId?: JobId;
|
469 | }
|
470 | export interface StartPHIDetectionJobRequest {
|
471 | |
472 |
|
473 |
|
474 | InputDataConfig: InputDataConfig;
|
475 | |
476 |
|
477 |
|
478 | OutputDataConfig: OutputDataConfig;
|
479 | |
480 |
|
481 |
|
482 | DataAccessRoleArn: IamRoleArn;
|
483 | |
484 |
|
485 |
|
486 | JobName?: JobName;
|
487 | |
488 |
|
489 |
|
490 | ClientRequestToken?: ClientRequestTokenString;
|
491 | |
492 |
|
493 |
|
494 | KMSKey?: KMSKey;
|
495 | |
496 |
|
497 |
|
498 | LanguageCode: LanguageCode;
|
499 | }
|
500 | export interface StartPHIDetectionJobResponse {
|
501 | |
502 |
|
503 |
|
504 | JobId?: JobId;
|
505 | }
|
506 | export interface StopEntitiesDetectionV2JobRequest {
|
507 | |
508 |
|
509 |
|
510 | JobId: JobId;
|
511 | }
|
512 | export interface StopEntitiesDetectionV2JobResponse {
|
513 | |
514 |
|
515 |
|
516 | JobId?: JobId;
|
517 | }
|
518 | export interface StopPHIDetectionJobRequest {
|
519 | |
520 |
|
521 |
|
522 | JobId: JobId;
|
523 | }
|
524 | export interface StopPHIDetectionJobResponse {
|
525 | |
526 |
|
527 |
|
528 | JobId?: JobId;
|
529 | }
|
530 | export type String = string;
|
531 | export type Timestamp = Date;
|
532 | export interface Trait {
|
533 | |
534 |
|
535 |
|
536 | Name?: AttributeName;
|
537 | |
538 |
|
539 |
|
540 | Score?: Float;
|
541 | }
|
542 | export type TraitList = Trait[];
|
543 | export interface UnmappedAttribute {
|
544 | |
545 |
|
546 |
|
547 | Type?: EntityType;
|
548 | |
549 |
|
550 |
|
551 | Attribute?: Attribute;
|
552 | }
|
553 | export type UnmappedAttributeList = UnmappedAttribute[];
|
554 | |
555 |
|
556 |
|
557 | export type apiVersion = "2018-10-30"|"latest"|string;
|
558 | export interface ClientApiVersions {
|
559 | |
560 |
|
561 |
|
562 | apiVersion?: apiVersion;
|
563 | }
|
564 | export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
|
565 | |
566 |
|
567 |
|
568 | export import Types = ComprehendMedical;
|
569 | }
|
570 | export = ComprehendMedical;
|