-
Notifications
You must be signed in to change notification settings - Fork 549
Expand file tree
/
Copy pathAmazonTextractAsync.java
More file actions
2512 lines (2458 loc) · 118 KB
/
Copy pathAmazonTextractAsync.java
File metadata and controls
2512 lines (2458 loc) · 118 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.textract;
import java.util.concurrent.Future;
import com.amazonaws.AmazonClientException;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.handlers.AsyncHandler;
import com.amazonaws.services.textract.model.*;
/**
* Interface for accessing Amazon Textract asynchronously.
* <p>
* Amazon Textract detects and analyzes text in documents and converts it into
* machine-readable text. This is the API reference documentation for Amazon
* Textract.
* </p>
**/
public interface AmazonTextractAsync extends AmazonTextract {
/**
* <p>
* Analyzes an input document for relationships between detected items.
* </p>
* <p>
* The types of information returned are as follows:
* </p>
* <ul>
* <li>
* <p>
* Form data (key-value pairs). The related information is returned in two
* <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY
* <code>Block</code> object and a VALUE <code>Block</code> object. For
* example, <i>Name: Ana Silva Carolina</i> contains a key and value.
* <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is the value.
* </p>
* </li>
* <li>
* <p>
* Table and table cell data. A TABLE <code>Block</code> object contains
* information about a detected table. A CELL <code>Block</code> object is
* returned for each cell in a table.
* </p>
* </li>
* <li>
* <p>
* Lines and words of text. A LINE <code>Block</code> object contains one or
* more WORD <code>Block</code> objects. All lines and words that are
* detected in the document are returned (including text that doesn't have a
* relationship with the value of <code>FeatureTypes</code>).
* </p>
* </li>
* <li>
* <p>
* Signatures. A SIGNATURE <code>Block</code> object contains the location
* information of a signature in a document. If used in conjunction with
* forms or tables, a signature can be given a Key-Value pairing or be
* detected in the cell of a table.
* </p>
* </li>
* <li>
* <p>
* Query. A QUERY Block object contains the query text, alias and link to
* the associated Query results block object.
* </p>
* </li>
* <li>
* <p>
* Query Result. A QUERY_RESULT Block object contains the answer to the
* query and an ID that connects it to the query asked. This Block also
* contains a confidence score.
* </p>
* </li>
* </ul>
* <p>
* Selection elements such as check boxes and option buttons (radio buttons)
* can be detected in form data and in tables. A SELECTION_ELEMENT
* <code>Block</code> object contains information about a selection element,
* including the selection status.
* </p>
* <p>
* You can choose which type of analysis to perform by specifying the
* <code>FeatureTypes</code> list.
* </p>
* <p>
* The output is returned in a list of <code>Block</code> objects.
* </p>
* <p>
* <code>AnalyzeDocument</code> is a synchronous operation. To analyze
* documents asynchronously, use <a>StartDocumentAnalysis</a>.
* </p>
* <p>
* For more information, see <a href=
* "https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html"
* >Document Text Analysis</a>.
* </p>
*
* @param analyzeDocumentRequest
* @return A Java Future object containing the response from the
* AnalyzeDocument service method, as returned by Amazon Textract.
* @throws InvalidParameterException
* @throws InvalidS3ObjectException
* @throws UnsupportedDocumentException
* @throws DocumentTooLargeException
* @throws BadDocumentException
* @throws AccessDeniedException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws HumanLoopQuotaExceededException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<AnalyzeDocumentResult> analyzeDocumentAsync(AnalyzeDocumentRequest analyzeDocumentRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Analyzes an input document for relationships between detected items.
* </p>
* <p>
* The types of information returned are as follows:
* </p>
* <ul>
* <li>
* <p>
* Form data (key-value pairs). The related information is returned in two
* <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY
* <code>Block</code> object and a VALUE <code>Block</code> object. For
* example, <i>Name: Ana Silva Carolina</i> contains a key and value.
* <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is the value.
* </p>
* </li>
* <li>
* <p>
* Table and table cell data. A TABLE <code>Block</code> object contains
* information about a detected table. A CELL <code>Block</code> object is
* returned for each cell in a table.
* </p>
* </li>
* <li>
* <p>
* Lines and words of text. A LINE <code>Block</code> object contains one or
* more WORD <code>Block</code> objects. All lines and words that are
* detected in the document are returned (including text that doesn't have a
* relationship with the value of <code>FeatureTypes</code>).
* </p>
* </li>
* <li>
* <p>
* Signatures. A SIGNATURE <code>Block</code> object contains the location
* information of a signature in a document. If used in conjunction with
* forms or tables, a signature can be given a Key-Value pairing or be
* detected in the cell of a table.
* </p>
* </li>
* <li>
* <p>
* Query. A QUERY Block object contains the query text, alias and link to
* the associated Query results block object.
* </p>
* </li>
* <li>
* <p>
* Query Result. A QUERY_RESULT Block object contains the answer to the
* query and an ID that connects it to the query asked. This Block also
* contains a confidence score.
* </p>
* </li>
* </ul>
* <p>
* Selection elements such as check boxes and option buttons (radio buttons)
* can be detected in form data and in tables. A SELECTION_ELEMENT
* <code>Block</code> object contains information about a selection element,
* including the selection status.
* </p>
* <p>
* You can choose which type of analysis to perform by specifying the
* <code>FeatureTypes</code> list.
* </p>
* <p>
* The output is returned in a list of <code>Block</code> objects.
* </p>
* <p>
* <code>AnalyzeDocument</code> is a synchronous operation. To analyze
* documents asynchronously, use <a>StartDocumentAnalysis</a>.
* </p>
* <p>
* For more information, see <a href=
* "https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html"
* >Document Text Analysis</a>.
* </p>
*
* @param analyzeDocumentRequest
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the
* implementation of the four callback methods in this interface
* to process the operation result or handle the exception.
* @return A Java Future object containing the response from the
* AnalyzeDocument service method, as returned by Amazon Textract.
* @throws InvalidParameterException
* @throws InvalidS3ObjectException
* @throws UnsupportedDocumentException
* @throws DocumentTooLargeException
* @throws BadDocumentException
* @throws AccessDeniedException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws HumanLoopQuotaExceededException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<AnalyzeDocumentResult> analyzeDocumentAsync(
AnalyzeDocumentRequest analyzeDocumentRequest,
AsyncHandler<AnalyzeDocumentRequest, AnalyzeDocumentResult> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* <code>AnalyzeExpense</code> synchronously analyzes an input document for
* financially related relationships between text.
* </p>
* <p>
* Information is returned as <code>ExpenseDocuments</code> and seperated as
* follows:
* </p>
* <ul>
* <li>
* <p>
* <code>LineItemGroups</code>- A data set containing <code>LineItems</code>
* which store information about the lines of text, such as an item
* purchased and its price on a receipt.
* </p>
* </li>
* <li>
* <p>
* <code>SummaryFields</code>- Contains all other information a receipt,
* such as header information or the vendors name.
* </p>
* </li>
* </ul>
*
* @param analyzeExpenseRequest
* @return A Java Future object containing the response from the
* AnalyzeExpense service method, as returned by Amazon Textract.
* @throws InvalidParameterException
* @throws InvalidS3ObjectException
* @throws UnsupportedDocumentException
* @throws DocumentTooLargeException
* @throws BadDocumentException
* @throws AccessDeniedException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<AnalyzeExpenseResult> analyzeExpenseAsync(AnalyzeExpenseRequest analyzeExpenseRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* <code>AnalyzeExpense</code> synchronously analyzes an input document for
* financially related relationships between text.
* </p>
* <p>
* Information is returned as <code>ExpenseDocuments</code> and seperated as
* follows:
* </p>
* <ul>
* <li>
* <p>
* <code>LineItemGroups</code>- A data set containing <code>LineItems</code>
* which store information about the lines of text, such as an item
* purchased and its price on a receipt.
* </p>
* </li>
* <li>
* <p>
* <code>SummaryFields</code>- Contains all other information a receipt,
* such as header information or the vendors name.
* </p>
* </li>
* </ul>
*
* @param analyzeExpenseRequest
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the
* implementation of the four callback methods in this interface
* to process the operation result or handle the exception.
* @return A Java Future object containing the response from the
* AnalyzeExpense service method, as returned by Amazon Textract.
* @throws InvalidParameterException
* @throws InvalidS3ObjectException
* @throws UnsupportedDocumentException
* @throws DocumentTooLargeException
* @throws BadDocumentException
* @throws AccessDeniedException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<AnalyzeExpenseResult> analyzeExpenseAsync(AnalyzeExpenseRequest analyzeExpenseRequest,
AsyncHandler<AnalyzeExpenseRequest, AnalyzeExpenseResult> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Analyzes identity documents for relevant information. This information is
* extracted and returned as <code>IdentityDocumentFields</code>, which
* records both the normalized field and value of the extracted text. Unlike
* other Amazon Textract operations, <code>AnalyzeID</code> doesn't return
* any Geometry data.
* </p>
*
* @param analyzeIDRequest
* @return A Java Future object containing the response from the AnalyzeID
* service method, as returned by Amazon Textract.
* @throws InvalidParameterException
* @throws InvalidS3ObjectException
* @throws UnsupportedDocumentException
* @throws DocumentTooLargeException
* @throws BadDocumentException
* @throws AccessDeniedException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<AnalyzeIDResult> analyzeIDAsync(AnalyzeIDRequest analyzeIDRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Analyzes identity documents for relevant information. This information is
* extracted and returned as <code>IdentityDocumentFields</code>, which
* records both the normalized field and value of the extracted text. Unlike
* other Amazon Textract operations, <code>AnalyzeID</code> doesn't return
* any Geometry data.
* </p>
*
* @param analyzeIDRequest
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the
* implementation of the four callback methods in this interface
* to process the operation result or handle the exception.
* @return A Java Future object containing the response from the AnalyzeID
* service method, as returned by Amazon Textract.
* @throws InvalidParameterException
* @throws InvalidS3ObjectException
* @throws UnsupportedDocumentException
* @throws DocumentTooLargeException
* @throws BadDocumentException
* @throws AccessDeniedException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<AnalyzeIDResult> analyzeIDAsync(AnalyzeIDRequest analyzeIDRequest,
AsyncHandler<AnalyzeIDRequest, AnalyzeIDResult> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Creates an adapter, which can be fine-tuned for enhanced performance on
* user provided documents. Takes an AdapterName and FeatureType. Currently
* the only supported feature type is <code>QUERIES</code>. You can also
* provide a Description, Tags, and a ClientRequestToken. You can choose
* whether or not the adapter should be AutoUpdated with the AutoUpdate
* argument. By default, AutoUpdate is set to DISABLED.
* </p>
*
* @param createAdapterRequest
* @return A Java Future object containing the response from the
* CreateAdapter service method, as returned by Amazon Textract.
* @throws InvalidParameterException
* @throws AccessDeniedException
* @throws ConflictException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws IdempotentParameterMismatchException
* @throws ThrottlingException
* @throws LimitExceededException
* @throws ValidationException
* @throws ServiceQuotaExceededException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<CreateAdapterResult> createAdapterAsync(CreateAdapterRequest createAdapterRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Creates an adapter, which can be fine-tuned for enhanced performance on
* user provided documents. Takes an AdapterName and FeatureType. Currently
* the only supported feature type is <code>QUERIES</code>. You can also
* provide a Description, Tags, and a ClientRequestToken. You can choose
* whether or not the adapter should be AutoUpdated with the AutoUpdate
* argument. By default, AutoUpdate is set to DISABLED.
* </p>
*
* @param createAdapterRequest
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the
* implementation of the four callback methods in this interface
* to process the operation result or handle the exception.
* @return A Java Future object containing the response from the
* CreateAdapter service method, as returned by Amazon Textract.
* @throws InvalidParameterException
* @throws AccessDeniedException
* @throws ConflictException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws IdempotentParameterMismatchException
* @throws ThrottlingException
* @throws LimitExceededException
* @throws ValidationException
* @throws ServiceQuotaExceededException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<CreateAdapterResult> createAdapterAsync(CreateAdapterRequest createAdapterRequest,
AsyncHandler<CreateAdapterRequest, CreateAdapterResult> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Creates a new version of an adapter. Operates on a provided AdapterId and
* a specified dataset provided via the DatasetConfig argument. Requires
* that you specify an Amazon S3 bucket with the OutputConfig argument. You
* can provide an optional KMSKeyId, an optional ClientRequestToken, and
* optional tags.
* </p>
*
* @param createAdapterVersionRequest
* @return A Java Future object containing the response from the
* CreateAdapterVersion service method, as returned by Amazon
* Textract.
* @throws InvalidParameterException
* @throws InvalidS3ObjectException
* @throws InvalidKMSKeyException
* @throws AccessDeniedException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws IdempotentParameterMismatchException
* @throws ThrottlingException
* @throws LimitExceededException
* @throws ValidationException
* @throws ServiceQuotaExceededException
* @throws ResourceNotFoundException
* @throws ConflictException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<CreateAdapterVersionResult> createAdapterVersionAsync(
CreateAdapterVersionRequest createAdapterVersionRequest) throws AmazonServiceException,
AmazonClientException;
/**
* <p>
* Creates a new version of an adapter. Operates on a provided AdapterId and
* a specified dataset provided via the DatasetConfig argument. Requires
* that you specify an Amazon S3 bucket with the OutputConfig argument. You
* can provide an optional KMSKeyId, an optional ClientRequestToken, and
* optional tags.
* </p>
*
* @param createAdapterVersionRequest
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the
* implementation of the four callback methods in this interface
* to process the operation result or handle the exception.
* @return A Java Future object containing the response from the
* CreateAdapterVersion service method, as returned by Amazon
* Textract.
* @throws InvalidParameterException
* @throws InvalidS3ObjectException
* @throws InvalidKMSKeyException
* @throws AccessDeniedException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws IdempotentParameterMismatchException
* @throws ThrottlingException
* @throws LimitExceededException
* @throws ValidationException
* @throws ServiceQuotaExceededException
* @throws ResourceNotFoundException
* @throws ConflictException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<CreateAdapterVersionResult> createAdapterVersionAsync(
CreateAdapterVersionRequest createAdapterVersionRequest,
AsyncHandler<CreateAdapterVersionRequest, CreateAdapterVersionResult> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the
* adapter specified by the ID.
* </p>
*
* @param deleteAdapterRequest
* @return A Java Future object containing the response from the
* DeleteAdapter service method, as returned by Amazon Textract.
* @throws InvalidParameterException
* @throws AccessDeniedException
* @throws ConflictException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws ValidationException
* @throws ResourceNotFoundException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<DeleteAdapterResult> deleteAdapterAsync(DeleteAdapterRequest deleteAdapterRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the
* adapter specified by the ID.
* </p>
*
* @param deleteAdapterRequest
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the
* implementation of the four callback methods in this interface
* to process the operation result or handle the exception.
* @return A Java Future object containing the response from the
* DeleteAdapter service method, as returned by Amazon Textract.
* @throws InvalidParameterException
* @throws AccessDeniedException
* @throws ConflictException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws ValidationException
* @throws ResourceNotFoundException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<DeleteAdapterResult> deleteAdapterAsync(DeleteAdapterRequest deleteAdapterRequest,
AsyncHandler<DeleteAdapterRequest, DeleteAdapterResult> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Deletes an Amazon Textract adapter version. Requires that you specify
* both an AdapterId and a AdapterVersion. Deletes the adapter version
* specified by the AdapterId and the AdapterVersion.
* </p>
*
* @param deleteAdapterVersionRequest
* @return A Java Future object containing the response from the
* DeleteAdapterVersion service method, as returned by Amazon
* Textract.
* @throws InvalidParameterException
* @throws AccessDeniedException
* @throws ConflictException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws ValidationException
* @throws ResourceNotFoundException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<DeleteAdapterVersionResult> deleteAdapterVersionAsync(
DeleteAdapterVersionRequest deleteAdapterVersionRequest) throws AmazonServiceException,
AmazonClientException;
/**
* <p>
* Deletes an Amazon Textract adapter version. Requires that you specify
* both an AdapterId and a AdapterVersion. Deletes the adapter version
* specified by the AdapterId and the AdapterVersion.
* </p>
*
* @param deleteAdapterVersionRequest
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the
* implementation of the four callback methods in this interface
* to process the operation result or handle the exception.
* @return A Java Future object containing the response from the
* DeleteAdapterVersion service method, as returned by Amazon
* Textract.
* @throws InvalidParameterException
* @throws AccessDeniedException
* @throws ConflictException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws ValidationException
* @throws ResourceNotFoundException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<DeleteAdapterVersionResult> deleteAdapterVersionAsync(
DeleteAdapterVersionRequest deleteAdapterVersionRequest,
AsyncHandler<DeleteAdapterVersionRequest, DeleteAdapterVersionResult> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Detects text in the input document. Amazon Textract can detect lines of
* text and the words that make up a line of text. The input document must
* be in one of the following image formats: JPEG, PNG, PDF, or TIFF.
* <code>DetectDocumentText</code> returns the detected text in an array of
* <a>Block</a> objects.
* </p>
* <p>
* Each document page has as an associated <code>Block</code> of type PAGE.
* Each PAGE <code>Block</code> object is the parent of LINE
* <code>Block</code> objects that represent the lines of detected text on a
* page. A LINE <code>Block</code> object is a parent for each word that
* makes up the line. Words are represented by <code>Block</code> objects of
* type WORD.
* </p>
* <p>
* <code>DetectDocumentText</code> is a synchronous operation. To analyze
* documents asynchronously, use <a>StartDocumentTextDetection</a>.
* </p>
* <p>
* For more information, see <a href=
* "https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html"
* >Document Text Detection</a>.
* </p>
*
* @param detectDocumentTextRequest
* @return A Java Future object containing the response from the
* DetectDocumentText service method, as returned by Amazon
* Textract.
* @throws InvalidParameterException
* @throws InvalidS3ObjectException
* @throws UnsupportedDocumentException
* @throws DocumentTooLargeException
* @throws BadDocumentException
* @throws AccessDeniedException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<DetectDocumentTextResult> detectDocumentTextAsync(
DetectDocumentTextRequest detectDocumentTextRequest) throws AmazonServiceException,
AmazonClientException;
/**
* <p>
* Detects text in the input document. Amazon Textract can detect lines of
* text and the words that make up a line of text. The input document must
* be in one of the following image formats: JPEG, PNG, PDF, or TIFF.
* <code>DetectDocumentText</code> returns the detected text in an array of
* <a>Block</a> objects.
* </p>
* <p>
* Each document page has as an associated <code>Block</code> of type PAGE.
* Each PAGE <code>Block</code> object is the parent of LINE
* <code>Block</code> objects that represent the lines of detected text on a
* page. A LINE <code>Block</code> object is a parent for each word that
* makes up the line. Words are represented by <code>Block</code> objects of
* type WORD.
* </p>
* <p>
* <code>DetectDocumentText</code> is a synchronous operation. To analyze
* documents asynchronously, use <a>StartDocumentTextDetection</a>.
* </p>
* <p>
* For more information, see <a href=
* "https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html"
* >Document Text Detection</a>.
* </p>
*
* @param detectDocumentTextRequest
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the
* implementation of the four callback methods in this interface
* to process the operation result or handle the exception.
* @return A Java Future object containing the response from the
* DetectDocumentText service method, as returned by Amazon
* Textract.
* @throws InvalidParameterException
* @throws InvalidS3ObjectException
* @throws UnsupportedDocumentException
* @throws DocumentTooLargeException
* @throws BadDocumentException
* @throws AccessDeniedException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<DetectDocumentTextResult> detectDocumentTextAsync(
DetectDocumentTextRequest detectDocumentTextRequest,
AsyncHandler<DetectDocumentTextRequest, DetectDocumentTextResult> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Gets configuration information for an adapter specified by an AdapterId,
* returning information on AdapterName, Description, CreationTime,
* AutoUpdate status, and FeatureTypes.
* </p>
*
* @param getAdapterRequest
* @return A Java Future object containing the response from the GetAdapter
* service method, as returned by Amazon Textract.
* @throws InvalidParameterException
* @throws AccessDeniedException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws ValidationException
* @throws ResourceNotFoundException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<GetAdapterResult> getAdapterAsync(GetAdapterRequest getAdapterRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Gets configuration information for an adapter specified by an AdapterId,
* returning information on AdapterName, Description, CreationTime,
* AutoUpdate status, and FeatureTypes.
* </p>
*
* @param getAdapterRequest
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the
* implementation of the four callback methods in this interface
* to process the operation result or handle the exception.
* @return A Java Future object containing the response from the GetAdapter
* service method, as returned by Amazon Textract.
* @throws InvalidParameterException
* @throws AccessDeniedException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws ValidationException
* @throws ResourceNotFoundException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<GetAdapterResult> getAdapterAsync(GetAdapterRequest getAdapterRequest,
AsyncHandler<GetAdapterRequest, GetAdapterResult> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Gets configuration information for the specified adapter version,
* including: AdapterId, AdapterVersion, FeatureTypes, Status,
* StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and
* EvaluationMetrics.
* </p>
*
* @param getAdapterVersionRequest
* @return A Java Future object containing the response from the
* GetAdapterVersion service method, as returned by Amazon Textract.
* @throws InvalidParameterException
* @throws AccessDeniedException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws ValidationException
* @throws ResourceNotFoundException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<GetAdapterVersionResult> getAdapterVersionAsync(
GetAdapterVersionRequest getAdapterVersionRequest) throws AmazonServiceException,
AmazonClientException;
/**
* <p>
* Gets configuration information for the specified adapter version,
* including: AdapterId, AdapterVersion, FeatureTypes, Status,
* StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and
* EvaluationMetrics.
* </p>
*
* @param getAdapterVersionRequest
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the
* implementation of the four callback methods in this interface
* to process the operation result or handle the exception.
* @return A Java Future object containing the response from the
* GetAdapterVersion service method, as returned by Amazon Textract.
* @throws InvalidParameterException
* @throws AccessDeniedException
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws ValidationException
* @throws ResourceNotFoundException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Textract indicating either a problem with the data in the
* request, or a server side issue.
*/
Future<GetAdapterVersionResult> getAdapterVersionAsync(
GetAdapterVersionRequest getAdapterVersionRequest,
AsyncHandler<GetAdapterVersionRequest, GetAdapterVersionResult> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <p>
* Gets the results for an Amazon Textract asynchronous operation that
* analyzes text in a document.
* </p>
* <p>
* You start asynchronous text analysis by calling
* <a>StartDocumentAnalysis</a>, which returns a job identifier (
* <code>JobId</code>). When the text analysis operation finishes, Amazon
* Textract publishes a completion status to the Amazon Simple Notification
* Service (Amazon SNS) topic that's registered in the initial call to
* <code>StartDocumentAnalysis</code>. To get the results of the
* text-detection operation, first check that the status value published to
* the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call
* <code>GetDocumentAnalysis</code>, and pass the job identifier (
* <code>JobId</code>) from the initial call to
* <code>StartDocumentAnalysis</code>.
* </p>
* <p>
* <code>GetDocumentAnalysis</code> returns an array of <a>Block</a>
* objects. The following types of information are returned:
* </p>
* <ul>
* <li>
* <p>
* Form data (key-value pairs). The related information is returned in two
* <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY
* <code>Block</code> object and a VALUE <code>Block</code> object. For
* example, <i>Name: Ana Silva Carolina</i> contains a key and value.
* <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is the value.
* </p>
* </li>
* <li>
* <p>
* Table and table cell data. A TABLE <code>Block</code> object contains
* information about a detected table. A CELL <code>Block</code> object is
* returned for each cell in a table.
* </p>
* </li>
* <li>
* <p>
* Lines and words of text. A LINE <code>Block</code> object contains one or
* more WORD <code>Block</code> objects. All lines and words that are
* detected in the document are returned (including text that doesn't have a
* relationship with the value of the <code>StartDocumentAnalysis</code>
* <code>FeatureTypes</code> input parameter).
* </p>
* </li>
* <li>
* <p>
* Query. A QUERY Block object contains the query text, alias and link to
* the associated Query results block object.
* </p>
* </li>
* <li>
* <p>
* Query Results. A QUERY_RESULT Block object contains the answer to the
* query and an ID that connects it to the query asked. This Block also
* contains a confidence score.
* </p>
* </li>
* </ul>
* <note>
* <p>
* While processing a document with queries, look out for
* <code>INVALID_REQUEST_PARAMETERS</code> output. This indicates that
* either the per page query limit has been exceeded or that the operation
* is trying to query a page in the document which doesn’t exist.
* </p>
* </note>
* <p>
* Selection elements such as check boxes and option buttons (radio buttons)
* can be detected in form data and in tables. A SELECTION_ELEMENT
* <code>Block</code> object contains information about a selection element,