@aws-sdk/client-textract 3.295.0 → 3.297.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.
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
2
2
  import { TextractServiceException as __BaseException } from "./TextractServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>You aren't authorized to perform the action. Use the Amazon Resource Name (ARN)
5
6
  * of an authorized user or IAM role to perform the operation.</p>
6
7
  */
@@ -15,6 +16,7 @@ export declare class AccessDeniedException extends __BaseException {
15
16
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
16
17
  }
17
18
  /**
19
+ * @public
18
20
  * <p>The S3 bucket name and file name that identifies the document.</p>
19
21
  * <p>The AWS Region for the S3 bucket that contains the document must match the Region that
20
22
  * you use for Amazon Textract operations.</p>
@@ -41,6 +43,7 @@ export interface S3Object {
41
43
  Version?: string;
42
44
  }
43
45
  /**
46
+ * @public
44
47
  * <p>The input document, either as bytes or as an S3 object.</p>
45
48
  * <p>You pass image bytes to an Amazon Textract API operation by using the <code>Bytes</code>
46
49
  * property. For example, you would use the <code>Bytes</code> property to pass a document
@@ -73,17 +76,24 @@ export interface Document {
73
76
  */
74
77
  S3Object?: S3Object;
75
78
  }
79
+ /**
80
+ * @public
81
+ */
76
82
  export declare enum FeatureType {
77
83
  FORMS = "FORMS",
78
84
  QUERIES = "QUERIES",
79
85
  SIGNATURES = "SIGNATURES",
80
86
  TABLES = "TABLES"
81
87
  }
88
+ /**
89
+ * @public
90
+ */
82
91
  export declare enum ContentClassifier {
83
92
  FREE_OF_ADULT_CONTENT = "FreeOfAdultContent",
84
93
  FREE_OF_PERSONALLY_IDENTIFIABLE_INFORMATION = "FreeOfPersonallyIdentifiableInformation"
85
94
  }
86
95
  /**
96
+ * @public
87
97
  * <p>Allows you to set attributes of the image. Currently, you can declare an image as free
88
98
  * of personally identifiable information and adult content. </p>
89
99
  */
@@ -95,6 +105,7 @@ export interface HumanLoopDataAttributes {
95
105
  ContentClassifiers?: (ContentClassifier | string)[];
96
106
  }
97
107
  /**
108
+ * @public
98
109
  * <p>Sets up the human review workflow the document will be sent to if one of the conditions
99
110
  * is met. You can also set certain attributes of the image before review. </p>
100
111
  */
@@ -114,6 +125,7 @@ export interface HumanLoopConfig {
114
125
  DataAttributes?: HumanLoopDataAttributes;
115
126
  }
116
127
  /**
128
+ * @public
117
129
  * <p>Each query contains the question you want to ask in the Text and the alias you want to associate.</p>
118
130
  */
119
131
  export interface Query {
@@ -151,6 +163,7 @@ export interface Query {
151
163
  Pages?: string[];
152
164
  }
153
165
  /**
166
+ * @public
154
167
  * <p></p>
155
168
  */
156
169
  export interface QueriesConfig {
@@ -159,6 +172,9 @@ export interface QueriesConfig {
159
172
  */
160
173
  Queries: Query[] | undefined;
161
174
  }
175
+ /**
176
+ * @public
177
+ */
162
178
  export interface AnalyzeDocumentRequest {
163
179
  /**
164
180
  * <p>The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS
@@ -188,6 +204,9 @@ export interface AnalyzeDocumentRequest {
188
204
  */
189
205
  QueriesConfig?: QueriesConfig;
190
206
  }
207
+ /**
208
+ * @public
209
+ */
191
210
  export declare enum BlockType {
192
211
  CELL = "CELL",
193
212
  KEY_VALUE_SET = "KEY_VALUE_SET",
@@ -202,12 +221,16 @@ export declare enum BlockType {
202
221
  TITLE = "TITLE",
203
222
  WORD = "WORD"
204
223
  }
224
+ /**
225
+ * @public
226
+ */
205
227
  export declare enum EntityType {
206
228
  COLUMN_HEADER = "COLUMN_HEADER",
207
229
  KEY = "KEY",
208
230
  VALUE = "VALUE"
209
231
  }
210
232
  /**
233
+ * @public
211
234
  * <p>The bounding box around the detected page, text, key-value pair, table, table cell, or
212
235
  * selection element on a document page. The <code>left</code> (x-coordinate) and
213
236
  * <code>top</code> (y-coordinate) are coordinates that represent the top and left sides of
@@ -244,6 +267,7 @@ export interface BoundingBox {
244
267
  Top?: number;
245
268
  }
246
269
  /**
270
+ * @public
247
271
  * <p>The X and Y coordinates of a point on a document page. The X and Y
248
272
  * values that are returned are ratios of the overall document page size. For example, if the
249
273
  * input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is
@@ -265,6 +289,7 @@ export interface Point {
265
289
  Y?: number;
266
290
  }
267
291
  /**
292
+ * @public
268
293
  * <p>Information about where the following items are located on a document page: detected
269
294
  * page, text, key-value pairs, tables, table cells, and selection elements.</p>
270
295
  */
@@ -279,6 +304,9 @@ export interface Geometry {
279
304
  */
280
305
  Polygon?: Point[];
281
306
  }
307
+ /**
308
+ * @public
309
+ */
282
310
  export declare enum RelationshipType {
283
311
  ANSWER = "ANSWER",
284
312
  CHILD = "CHILD",
@@ -288,6 +316,7 @@ export declare enum RelationshipType {
288
316
  VALUE = "VALUE"
289
317
  }
290
318
  /**
319
+ * @public
291
320
  * <p>Information about how blocks are related to each other. A <code>Block</code> object
292
321
  * contains 0 or more <code>Relation</code> objects in a list, <code>Relationships</code>. For
293
322
  * more information, see <a>Block</a>.</p>
@@ -311,15 +340,22 @@ export interface Relationship {
311
340
  */
312
341
  Ids?: string[];
313
342
  }
343
+ /**
344
+ * @public
345
+ */
314
346
  export declare enum SelectionStatus {
315
347
  NOT_SELECTED = "NOT_SELECTED",
316
348
  SELECTED = "SELECTED"
317
349
  }
350
+ /**
351
+ * @public
352
+ */
318
353
  export declare enum TextType {
319
354
  HANDWRITING = "HANDWRITING",
320
355
  PRINTED = "PRINTED"
321
356
  }
322
357
  /**
358
+ * @public
323
359
  * <p>A <code>Block</code> represents items that are recognized in a document within a group
324
360
  * of pixels close to each other. The information returned in a <code>Block</code> object
325
361
  * depends on the type of operation. In text detection for documents (for example <a>DetectDocumentText</a>), you get information about the detected words and lines
@@ -517,6 +553,7 @@ export interface Block {
517
553
  Query?: Query;
518
554
  }
519
555
  /**
556
+ * @public
520
557
  * <p>Information about the input document.</p>
521
558
  */
522
559
  export interface DocumentMetadata {
@@ -526,6 +563,7 @@ export interface DocumentMetadata {
526
563
  Pages?: number;
527
564
  }
528
565
  /**
566
+ * @public
529
567
  * <p>Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the
530
568
  * input did not trigger human review.</p>
531
569
  */
@@ -544,6 +582,9 @@ export interface HumanLoopActivationOutput {
544
582
  */
545
583
  HumanLoopActivationConditionsEvaluationResults?: __LazyJsonString | string;
546
584
  }
585
+ /**
586
+ * @public
587
+ */
547
588
  export interface AnalyzeDocumentResponse {
548
589
  /**
549
590
  * <p>Metadata about the analyzed document. An example is the number of pages.</p>
@@ -563,6 +604,7 @@ export interface AnalyzeDocumentResponse {
563
604
  AnalyzeDocumentModelVersion?: string;
564
605
  }
565
606
  /**
607
+ * @public
566
608
  * <p>Amazon Textract isn't able to read the document. For more information on the document
567
609
  * limits in Amazon Textract, see <a>limits</a>.</p>
568
610
  */
@@ -577,6 +619,7 @@ export declare class BadDocumentException extends __BaseException {
577
619
  constructor(opts: __ExceptionOptionType<BadDocumentException, __BaseException>);
578
620
  }
579
621
  /**
622
+ * @public
580
623
  * <p>The document can't be processed because it's too large. The maximum document size for
581
624
  * synchronous operations 10 MB. The maximum document size for asynchronous operations is 500
582
625
  * MB for PDF files.</p>
@@ -592,6 +635,7 @@ export declare class DocumentTooLargeException extends __BaseException {
592
635
  constructor(opts: __ExceptionOptionType<DocumentTooLargeException, __BaseException>);
593
636
  }
594
637
  /**
638
+ * @public
595
639
  * <p>Indicates you have exceeded the maximum number of active human in the loop workflows available</p>
596
640
  */
597
641
  export declare class HumanLoopQuotaExceededException extends __BaseException {
@@ -617,6 +661,7 @@ export declare class HumanLoopQuotaExceededException extends __BaseException {
617
661
  constructor(opts: __ExceptionOptionType<HumanLoopQuotaExceededException, __BaseException>);
618
662
  }
619
663
  /**
664
+ * @public
620
665
  * <p>Amazon Textract experienced a service issue. Try your call again.</p>
621
666
  */
622
667
  export declare class InternalServerError extends __BaseException {
@@ -630,6 +675,7 @@ export declare class InternalServerError extends __BaseException {
630
675
  constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
631
676
  }
632
677
  /**
678
+ * @public
633
679
  * <p>An input parameter violated a constraint. For example, in synchronous operations,
634
680
  * an <code>InvalidParameterException</code> exception occurs
635
681
  * when neither of the <code>S3Object</code> or <code>Bytes</code> values are supplied in the <code>Document</code>
@@ -647,6 +693,7 @@ export declare class InvalidParameterException extends __BaseException {
647
693
  constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
648
694
  }
649
695
  /**
696
+ * @public
650
697
  * <p>Amazon Textract is unable to access the S3 object that's specified in the request.
651
698
  * for more information, <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html">Configure Access to Amazon S3</a>
652
699
  * For troubleshooting information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html">Troubleshooting Amazon S3</a>
@@ -663,6 +710,7 @@ export declare class InvalidS3ObjectException extends __BaseException {
663
710
  constructor(opts: __ExceptionOptionType<InvalidS3ObjectException, __BaseException>);
664
711
  }
665
712
  /**
713
+ * @public
666
714
  * <p>The number of requests exceeded your throughput limit. If you want to increase this limit,
667
715
  * contact Amazon Textract.</p>
668
716
  */
@@ -677,6 +725,7 @@ export declare class ProvisionedThroughputExceededException extends __BaseExcept
677
725
  constructor(opts: __ExceptionOptionType<ProvisionedThroughputExceededException, __BaseException>);
678
726
  }
679
727
  /**
728
+ * @public
680
729
  * <p>Amazon Textract is temporarily unable to process the request. Try your call again.</p>
681
730
  */
682
731
  export declare class ThrottlingException extends __BaseException {
@@ -690,6 +739,7 @@ export declare class ThrottlingException extends __BaseException {
690
739
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
691
740
  }
692
741
  /**
742
+ * @public
693
743
  * <p>The format of the input document isn't supported. Documents for operations can be in
694
744
  * PNG, JPEG, PDF, or TIFF format.</p>
695
745
  */
@@ -703,6 +753,9 @@ export declare class UnsupportedDocumentException extends __BaseException {
703
753
  */
704
754
  constructor(opts: __ExceptionOptionType<UnsupportedDocumentException, __BaseException>);
705
755
  }
756
+ /**
757
+ * @public
758
+ */
706
759
  export interface AnalyzeExpenseRequest {
707
760
  /**
708
761
  * <p>The input document, either as bytes or as an S3 object.</p>
@@ -726,6 +779,7 @@ export interface AnalyzeExpenseRequest {
726
779
  Document: Document | undefined;
727
780
  }
728
781
  /**
782
+ * @public
729
783
  * <p>Returns the kind of currency detected.</p>
730
784
  */
731
785
  export interface ExpenseCurrency {
@@ -777,6 +831,7 @@ export interface ExpenseCurrency {
777
831
  Confidence?: number;
778
832
  }
779
833
  /**
834
+ * @public
780
835
  * <p>Shows the group that a certain key belongs to. This helps differentiate between
781
836
  * names and addresses for different organizations, that can be hard to determine
782
837
  * via JSON response.</p>
@@ -792,6 +847,7 @@ export interface ExpenseGroupProperty {
792
847
  Id?: string;
793
848
  }
794
849
  /**
850
+ * @public
795
851
  * <p>An object used to store information about the Value or Label detected by Amazon Textract.</p>
796
852
  */
797
853
  export interface ExpenseDetection {
@@ -810,6 +866,7 @@ export interface ExpenseDetection {
810
866
  Confidence?: number;
811
867
  }
812
868
  /**
869
+ * @public
813
870
  * <p>An object used to store information about the Type detected by Amazon Textract.</p>
814
871
  */
815
872
  export interface ExpenseType {
@@ -823,6 +880,7 @@ export interface ExpenseType {
823
880
  Confidence?: number;
824
881
  }
825
882
  /**
883
+ * @public
826
884
  * <p>Breakdown of detected information, seperated into
827
885
  * the catagories Type, LabelDetection, and ValueDetection</p>
828
886
  */
@@ -855,6 +913,7 @@ export interface ExpenseField {
855
913
  GroupProperties?: ExpenseGroupProperty[];
856
914
  }
857
915
  /**
916
+ * @public
858
917
  * <p>A structure that holds information about the different lines found in a document's tables.</p>
859
918
  */
860
919
  export interface LineItemFields {
@@ -864,6 +923,7 @@ export interface LineItemFields {
864
923
  LineItemExpenseFields?: ExpenseField[];
865
924
  }
866
925
  /**
926
+ * @public
867
927
  * <p>A grouping of tables which contain LineItems, with each table identified by the table's <code>LineItemGroupIndex</code>.</p>
868
928
  */
869
929
  export interface LineItemGroup {
@@ -877,6 +937,7 @@ export interface LineItemGroup {
877
937
  LineItems?: LineItemFields[];
878
938
  }
879
939
  /**
940
+ * @public
880
941
  * <p>The structure holding all the information returned by AnalyzeExpense</p>
881
942
  */
882
943
  export interface ExpenseDocument {
@@ -899,6 +960,9 @@ export interface ExpenseDocument {
899
960
  */
900
961
  Blocks?: Block[];
901
962
  }
963
+ /**
964
+ * @public
965
+ */
902
966
  export interface AnalyzeExpenseResponse {
903
967
  /**
904
968
  * <p>Information about the input document.</p>
@@ -909,16 +973,23 @@ export interface AnalyzeExpenseResponse {
909
973
  */
910
974
  ExpenseDocuments?: ExpenseDocument[];
911
975
  }
976
+ /**
977
+ * @public
978
+ */
912
979
  export interface AnalyzeIDRequest {
913
980
  /**
914
981
  * <p>The document being passed to AnalyzeID.</p>
915
982
  */
916
983
  DocumentPages: Document[] | undefined;
917
984
  }
985
+ /**
986
+ * @public
987
+ */
918
988
  export declare enum ValueType {
919
989
  DATE = "DATE"
920
990
  }
921
991
  /**
992
+ * @public
922
993
  * <p>Contains information relating to dates in a document, including the type
923
994
  * of value, and the value.</p>
924
995
  */
@@ -933,6 +1004,7 @@ export interface NormalizedValue {
933
1004
  ValueType?: ValueType | string;
934
1005
  }
935
1006
  /**
1007
+ * @public
936
1008
  * <p>Used to contain the information detected by an AnalyzeID operation.</p>
937
1009
  */
938
1010
  export interface AnalyzeIDDetections {
@@ -951,6 +1023,7 @@ export interface AnalyzeIDDetections {
951
1023
  Confidence?: number;
952
1024
  }
953
1025
  /**
1026
+ * @public
954
1027
  * <p>Structure containing both the normalized type of the extracted information
955
1028
  * and the text associated with it. These are extracted as Type and Value respectively.</p>
956
1029
  */
@@ -965,6 +1038,7 @@ export interface IdentityDocumentField {
965
1038
  ValueDetection?: AnalyzeIDDetections;
966
1039
  }
967
1040
  /**
1041
+ * @public
968
1042
  * <p>The structure that lists each document processed in an AnalyzeID operation.</p>
969
1043
  */
970
1044
  export interface IdentityDocument {
@@ -983,6 +1057,9 @@ export interface IdentityDocument {
983
1057
  */
984
1058
  Blocks?: Block[];
985
1059
  }
1060
+ /**
1061
+ * @public
1062
+ */
986
1063
  export interface AnalyzeIDResponse {
987
1064
  /**
988
1065
  * <p>The list of documents processed by AnalyzeID. Includes a number denoting their place in
@@ -998,6 +1075,9 @@ export interface AnalyzeIDResponse {
998
1075
  */
999
1076
  AnalyzeIDModelVersion?: string;
1000
1077
  }
1078
+ /**
1079
+ * @public
1080
+ */
1001
1081
  export interface DetectDocumentTextRequest {
1002
1082
  /**
1003
1083
  * <p>The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI
@@ -1008,6 +1088,9 @@ export interface DetectDocumentTextRequest {
1008
1088
  */
1009
1089
  Document: Document | undefined;
1010
1090
  }
1091
+ /**
1092
+ * @public
1093
+ */
1011
1094
  export interface DetectDocumentTextResponse {
1012
1095
  /**
1013
1096
  * <p>Metadata about the document. It contains the number of pages that are detected in the
@@ -1025,6 +1108,7 @@ export interface DetectDocumentTextResponse {
1025
1108
  DetectDocumentTextModelVersion?: string;
1026
1109
  }
1027
1110
  /**
1111
+ * @public
1028
1112
  * <p>A structure that holds information regarding a detected signature on a page.</p>
1029
1113
  */
1030
1114
  export interface DetectedSignature {
@@ -1034,6 +1118,7 @@ export interface DetectedSignature {
1034
1118
  Page?: number;
1035
1119
  }
1036
1120
  /**
1121
+ * @public
1037
1122
  * <p>Contains information about the pages of a document, defined by logical boundary.</p>
1038
1123
  */
1039
1124
  export interface SplitDocument {
@@ -1047,6 +1132,7 @@ export interface SplitDocument {
1047
1132
  Pages?: number[];
1048
1133
  }
1049
1134
  /**
1135
+ * @public
1050
1136
  * <p>A structure containing information about an undetected signature on a page where it was expected but not found.</p>
1051
1137
  */
1052
1138
  export interface UndetectedSignature {
@@ -1056,6 +1142,7 @@ export interface UndetectedSignature {
1056
1142
  Page?: number;
1057
1143
  }
1058
1144
  /**
1145
+ * @public
1059
1146
  * <p>Summary information about documents grouped by the same document type.</p>
1060
1147
  */
1061
1148
  export interface DocumentGroup {
@@ -1077,6 +1164,7 @@ export interface DocumentGroup {
1077
1164
  UndetectedSignatures?: UndetectedSignature[];
1078
1165
  }
1079
1166
  /**
1167
+ * @public
1080
1168
  * <p>The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous
1081
1169
  * operations.</p>
1082
1170
  * <p>The input document can be an image file in JPEG or PNG format. It can also be a file in
@@ -1089,6 +1177,7 @@ export interface DocumentLocation {
1089
1177
  S3Object?: S3Object;
1090
1178
  }
1091
1179
  /**
1180
+ * @public
1092
1181
  * <p>The results extracted for a lending document.</p>
1093
1182
  */
1094
1183
  export interface LendingDetection {
@@ -1111,6 +1200,7 @@ export interface LendingDetection {
1111
1200
  Confidence?: number;
1112
1201
  }
1113
1202
  /**
1203
+ * @public
1114
1204
  * <p>Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and geometry.</p>
1115
1205
  */
1116
1206
  export interface LendingField {
@@ -1128,6 +1218,7 @@ export interface LendingField {
1128
1218
  ValueDetections?: LendingDetection[];
1129
1219
  }
1130
1220
  /**
1221
+ * @public
1131
1222
  * <p>Information regarding a detected signature on a page.</p>
1132
1223
  */
1133
1224
  export interface SignatureDetection {
@@ -1142,6 +1233,7 @@ export interface SignatureDetection {
1142
1233
  Geometry?: Geometry;
1143
1234
  }
1144
1235
  /**
1236
+ * @public
1145
1237
  * <p>Holds the structured data returned by AnalyzeDocument for lending documents.</p>
1146
1238
  */
1147
1239
  export interface LendingDocument {
@@ -1155,6 +1247,7 @@ export interface LendingDocument {
1155
1247
  SignatureDetections?: SignatureDetection[];
1156
1248
  }
1157
1249
  /**
1250
+ * @public
1158
1251
  * <p>Contains information extracted by an analysis operation after using StartLendingAnalysis.</p>
1159
1252
  */
1160
1253
  export interface Extraction {
@@ -1171,6 +1264,9 @@ export interface Extraction {
1171
1264
  */
1172
1265
  IdentityDocument?: IdentityDocument;
1173
1266
  }
1267
+ /**
1268
+ * @public
1269
+ */
1174
1270
  export interface GetDocumentAnalysisRequest {
1175
1271
  /**
1176
1272
  * <p>A unique identifier for the text-detection job. The <code>JobId</code> is returned from
@@ -1191,6 +1287,9 @@ export interface GetDocumentAnalysisRequest {
1191
1287
  */
1192
1288
  NextToken?: string;
1193
1289
  }
1290
+ /**
1291
+ * @public
1292
+ */
1194
1293
  export declare enum JobStatus {
1195
1294
  FAILED = "FAILED",
1196
1295
  IN_PROGRESS = "IN_PROGRESS",
@@ -1198,6 +1297,7 @@ export declare enum JobStatus {
1198
1297
  SUCCEEDED = "SUCCEEDED"
1199
1298
  }
1200
1299
  /**
1300
+ * @public
1201
1301
  * <p>A warning about an issue that occurred during asynchronous text analysis (<a>StartDocumentAnalysis</a>) or asynchronous document text detection (<a>StartDocumentTextDetection</a>). </p>
1202
1302
  */
1203
1303
  export interface Warning {
@@ -1210,6 +1310,9 @@ export interface Warning {
1210
1310
  */
1211
1311
  Pages?: number[];
1212
1312
  }
1313
+ /**
1314
+ * @public
1315
+ */
1213
1316
  export interface GetDocumentAnalysisResponse {
1214
1317
  /**
1215
1318
  * <p>Information about a document that Amazon Textract processed.
@@ -1245,6 +1348,7 @@ export interface GetDocumentAnalysisResponse {
1245
1348
  AnalyzeDocumentModelVersion?: string;
1246
1349
  }
1247
1350
  /**
1351
+ * @public
1248
1352
  * <p>An invalid job identifier was passed to an asynchronous analysis operation.</p>
1249
1353
  */
1250
1354
  export declare class InvalidJobIdException extends __BaseException {
@@ -1258,6 +1362,7 @@ export declare class InvalidJobIdException extends __BaseException {
1258
1362
  constructor(opts: __ExceptionOptionType<InvalidJobIdException, __BaseException>);
1259
1363
  }
1260
1364
  /**
1365
+ * @public
1261
1366
  * <p> Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key
1262
1367
  * was entered incorrectly. </p>
1263
1368
  */
@@ -1271,6 +1376,9 @@ export declare class InvalidKMSKeyException extends __BaseException {
1271
1376
  */
1272
1377
  constructor(opts: __ExceptionOptionType<InvalidKMSKeyException, __BaseException>);
1273
1378
  }
1379
+ /**
1380
+ * @public
1381
+ */
1274
1382
  export interface GetDocumentTextDetectionRequest {
1275
1383
  /**
1276
1384
  * <p>A unique identifier for the text detection job. The <code>JobId</code> is returned from
@@ -1289,6 +1397,9 @@ export interface GetDocumentTextDetectionRequest {
1289
1397
  */
1290
1398
  NextToken?: string;
1291
1399
  }
1400
+ /**
1401
+ * @public
1402
+ */
1292
1403
  export interface GetDocumentTextDetectionResponse {
1293
1404
  /**
1294
1405
  * <p>Information about a document that Amazon Textract processed. <code>DocumentMetadata</code> is
@@ -1322,6 +1433,9 @@ export interface GetDocumentTextDetectionResponse {
1322
1433
  */
1323
1434
  DetectDocumentTextModelVersion?: string;
1324
1435
  }
1436
+ /**
1437
+ * @public
1438
+ */
1325
1439
  export interface GetExpenseAnalysisRequest {
1326
1440
  /**
1327
1441
  * <p>A unique identifier for the text detection job. The <code>JobId</code> is returned from
@@ -1340,6 +1454,9 @@ export interface GetExpenseAnalysisRequest {
1340
1454
  */
1341
1455
  NextToken?: string;
1342
1456
  }
1457
+ /**
1458
+ * @public
1459
+ */
1343
1460
  export interface GetExpenseAnalysisResponse {
1344
1461
  /**
1345
1462
  * <p>Information about a document that Amazon Textract processed. <code>DocumentMetadata</code> is
@@ -1373,6 +1490,9 @@ export interface GetExpenseAnalysisResponse {
1373
1490
  */
1374
1491
  AnalyzeExpenseModelVersion?: string;
1375
1492
  }
1493
+ /**
1494
+ * @public
1495
+ */
1376
1496
  export interface GetLendingAnalysisRequest {
1377
1497
  /**
1378
1498
  * <p>A unique identifier for the lending or text-detection job. The <code>JobId</code> is
@@ -1394,6 +1514,7 @@ export interface GetLendingAnalysisRequest {
1394
1514
  NextToken?: string;
1395
1515
  }
1396
1516
  /**
1517
+ * @public
1397
1518
  * <p>Contains information regarding predicted values returned by Amazon Textract operations, including the
1398
1519
  * predicted value and the confidence in the predicted value.</p>
1399
1520
  */
@@ -1408,6 +1529,7 @@ export interface Prediction {
1408
1529
  Confidence?: number;
1409
1530
  }
1410
1531
  /**
1532
+ * @public
1411
1533
  * <p>The class assigned to a Page object detected in an input document.
1412
1534
  * Contains information regarding the predicted type/class of a document's page and the
1413
1535
  * page number that the Page object was detected on.</p>
@@ -1424,6 +1546,7 @@ export interface PageClassification {
1424
1546
  PageNumber: Prediction[] | undefined;
1425
1547
  }
1426
1548
  /**
1549
+ * @public
1427
1550
  * <p>Contains the detections for each page analyzed through the Analyze Lending API.</p>
1428
1551
  */
1429
1552
  export interface LendingResult {
@@ -1440,6 +1563,9 @@ export interface LendingResult {
1440
1563
  */
1441
1564
  Extractions?: Extraction[];
1442
1565
  }
1566
+ /**
1567
+ * @public
1568
+ */
1443
1569
  export interface GetLendingAnalysisResponse {
1444
1570
  /**
1445
1571
  * <p>Information about the input document.</p>
@@ -1473,6 +1599,9 @@ export interface GetLendingAnalysisResponse {
1473
1599
  */
1474
1600
  AnalyzeLendingModelVersion?: string;
1475
1601
  }
1602
+ /**
1603
+ * @public
1604
+ */
1476
1605
  export interface GetLendingAnalysisSummaryRequest {
1477
1606
  /**
1478
1607
  * <p> A unique identifier for the lending or text-detection job. The <code>JobId</code> is
@@ -1481,6 +1610,7 @@ export interface GetLendingAnalysisSummaryRequest {
1481
1610
  JobId: string | undefined;
1482
1611
  }
1483
1612
  /**
1613
+ * @public
1484
1614
  * <p>Contains information regarding DocumentGroups and UndetectedDocumentTypes.</p>
1485
1615
  */
1486
1616
  export interface LendingSummary {
@@ -1493,6 +1623,9 @@ export interface LendingSummary {
1493
1623
  */
1494
1624
  UndetectedDocumentTypes?: string[];
1495
1625
  }
1626
+ /**
1627
+ * @public
1628
+ */
1496
1629
  export interface GetLendingAnalysisSummaryResponse {
1497
1630
  /**
1498
1631
  * <p>Information about the input document.</p>
@@ -1521,6 +1654,7 @@ export interface GetLendingAnalysisSummaryResponse {
1521
1654
  AnalyzeLendingModelVersion?: string;
1522
1655
  }
1523
1656
  /**
1657
+ * @public
1524
1658
  * <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at
1525
1659
  * least one of the other input parameters is different from the previous call to the
1526
1660
  * operation. </p>
@@ -1536,6 +1670,7 @@ export declare class IdempotentParameterMismatchException extends __BaseExceptio
1536
1670
  constructor(opts: __ExceptionOptionType<IdempotentParameterMismatchException, __BaseException>);
1537
1671
  }
1538
1672
  /**
1673
+ * @public
1539
1674
  * <p>An Amazon Textract service limit was exceeded. For example, if you start too many
1540
1675
  * asynchronous jobs concurrently, calls to start operations
1541
1676
  * (<code>StartDocumentTextDetection</code>, for example) raise a LimitExceededException
@@ -1553,6 +1688,7 @@ export declare class LimitExceededException extends __BaseException {
1553
1688
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
1554
1689
  }
1555
1690
  /**
1691
+ * @public
1556
1692
  * <p>The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of
1557
1693
  * an asynchronous document operation. </p>
1558
1694
  */
@@ -1567,6 +1703,7 @@ export interface NotificationChannel {
1567
1703
  RoleArn: string | undefined;
1568
1704
  }
1569
1705
  /**
1706
+ * @public
1570
1707
  * <p>Sets whether or not your output will go to a user created bucket. Used to set the name
1571
1708
  * of the bucket, and the prefix on the output file.</p>
1572
1709
  * <p>
@@ -1596,6 +1733,9 @@ export interface OutputConfig {
1596
1733
  */
1597
1734
  S3Prefix?: string;
1598
1735
  }
1736
+ /**
1737
+ * @public
1738
+ */
1599
1739
  export interface StartDocumentAnalysisRequest {
1600
1740
  /**
1601
1741
  * <p>The location of the document to be processed.</p>
@@ -1648,6 +1788,9 @@ export interface StartDocumentAnalysisRequest {
1648
1788
  */
1649
1789
  QueriesConfig?: QueriesConfig;
1650
1790
  }
1791
+ /**
1792
+ * @public
1793
+ */
1651
1794
  export interface StartDocumentAnalysisResponse {
1652
1795
  /**
1653
1796
  * <p>The identifier for the document text detection job. Use <code>JobId</code> to identify
@@ -1656,6 +1799,9 @@ export interface StartDocumentAnalysisResponse {
1656
1799
  */
1657
1800
  JobId?: string;
1658
1801
  }
1802
+ /**
1803
+ * @public
1804
+ */
1659
1805
  export interface StartDocumentTextDetectionRequest {
1660
1806
  /**
1661
1807
  * <p>The location of the document to be processed.</p>
@@ -1695,6 +1841,9 @@ export interface StartDocumentTextDetectionRequest {
1695
1841
  */
1696
1842
  KMSKeyId?: string;
1697
1843
  }
1844
+ /**
1845
+ * @public
1846
+ */
1698
1847
  export interface StartDocumentTextDetectionResponse {
1699
1848
  /**
1700
1849
  * <p>The identifier of the text detection job for the document. Use <code>JobId</code> to
@@ -1703,6 +1852,9 @@ export interface StartDocumentTextDetectionResponse {
1703
1852
  */
1704
1853
  JobId?: string;
1705
1854
  }
1855
+ /**
1856
+ * @public
1857
+ */
1706
1858
  export interface StartExpenseAnalysisRequest {
1707
1859
  /**
1708
1860
  * <p>The location of the document to be processed.</p>
@@ -1742,6 +1894,9 @@ export interface StartExpenseAnalysisRequest {
1742
1894
  */
1743
1895
  KMSKeyId?: string;
1744
1896
  }
1897
+ /**
1898
+ * @public
1899
+ */
1745
1900
  export interface StartExpenseAnalysisResponse {
1746
1901
  /**
1747
1902
  * <p>A unique identifier for the text detection job. The <code>JobId</code> is returned from
@@ -1749,6 +1904,9 @@ export interface StartExpenseAnalysisResponse {
1749
1904
  */
1750
1905
  JobId?: string;
1751
1906
  }
1907
+ /**
1908
+ * @public
1909
+ */
1752
1910
  export interface StartLendingAnalysisRequest {
1753
1911
  /**
1754
1912
  * <p>The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous
@@ -1804,6 +1962,9 @@ export interface StartLendingAnalysisRequest {
1804
1962
  */
1805
1963
  KMSKeyId?: string;
1806
1964
  }
1965
+ /**
1966
+ * @public
1967
+ */
1807
1968
  export interface StartLendingAnalysisResponse {
1808
1969
  /**
1809
1970
  * <p>A unique identifier for the lending or text-detection job. The <code>JobId</code> is