@aws-sdk/client-textract 3.533.0 → 3.535.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.
Files changed (55) hide show
  1. package/dist-types/Textract.d.ts +3 -1
  2. package/dist-types/TextractClient.d.ts +1 -1
  3. package/dist-types/commands/AnalyzeDocumentCommand.d.ts +2 -1
  4. package/dist-types/commands/AnalyzeExpenseCommand.d.ts +2 -1
  5. package/dist-types/commands/AnalyzeIDCommand.d.ts +2 -1
  6. package/dist-types/commands/CreateAdapterCommand.d.ts +2 -1
  7. package/dist-types/commands/CreateAdapterVersionCommand.d.ts +2 -1
  8. package/dist-types/commands/DeleteAdapterCommand.d.ts +2 -1
  9. package/dist-types/commands/DeleteAdapterVersionCommand.d.ts +2 -1
  10. package/dist-types/commands/DetectDocumentTextCommand.d.ts +2 -1
  11. package/dist-types/commands/GetAdapterCommand.d.ts +2 -1
  12. package/dist-types/commands/GetAdapterVersionCommand.d.ts +2 -1
  13. package/dist-types/commands/GetDocumentAnalysisCommand.d.ts +2 -1
  14. package/dist-types/commands/GetDocumentTextDetectionCommand.d.ts +2 -1
  15. package/dist-types/commands/GetExpenseAnalysisCommand.d.ts +2 -1
  16. package/dist-types/commands/GetLendingAnalysisCommand.d.ts +2 -1
  17. package/dist-types/commands/GetLendingAnalysisSummaryCommand.d.ts +2 -1
  18. package/dist-types/commands/ListAdapterVersionsCommand.d.ts +2 -1
  19. package/dist-types/commands/ListAdaptersCommand.d.ts +2 -1
  20. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  21. package/dist-types/commands/StartDocumentAnalysisCommand.d.ts +2 -1
  22. package/dist-types/commands/StartDocumentTextDetectionCommand.d.ts +2 -1
  23. package/dist-types/commands/StartExpenseAnalysisCommand.d.ts +2 -1
  24. package/dist-types/commands/StartLendingAnalysisCommand.d.ts +2 -1
  25. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  26. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  27. package/dist-types/commands/UpdateAdapterCommand.d.ts +2 -1
  28. package/dist-types/models/models_0.d.ts +369 -369
  29. package/dist-types/ts3.4/Textract.d.ts +2 -0
  30. package/dist-types/ts3.4/commands/AnalyzeDocumentCommand.d.ts +9 -0
  31. package/dist-types/ts3.4/commands/AnalyzeExpenseCommand.d.ts +9 -0
  32. package/dist-types/ts3.4/commands/AnalyzeIDCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/CreateAdapterCommand.d.ts +9 -0
  34. package/dist-types/ts3.4/commands/CreateAdapterVersionCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/commands/DeleteAdapterCommand.d.ts +9 -0
  36. package/dist-types/ts3.4/commands/DeleteAdapterVersionCommand.d.ts +9 -0
  37. package/dist-types/ts3.4/commands/DetectDocumentTextCommand.d.ts +9 -0
  38. package/dist-types/ts3.4/commands/GetAdapterCommand.d.ts +9 -0
  39. package/dist-types/ts3.4/commands/GetAdapterVersionCommand.d.ts +9 -0
  40. package/dist-types/ts3.4/commands/GetDocumentAnalysisCommand.d.ts +9 -0
  41. package/dist-types/ts3.4/commands/GetDocumentTextDetectionCommand.d.ts +9 -0
  42. package/dist-types/ts3.4/commands/GetExpenseAnalysisCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/GetLendingAnalysisCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/GetLendingAnalysisSummaryCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/ListAdapterVersionsCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/ListAdaptersCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/StartDocumentAnalysisCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/StartDocumentTextDetectionCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/StartExpenseAnalysisCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/StartLendingAnalysisCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/UpdateAdapterCommand.d.ts +9 -0
  55. package/package.json +40 -40
@@ -1,9 +1,9 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@smithy/smithy-client";
2
2
  import { TextractServiceException as __BaseException } from "./TextractServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>You aren't authorized to perform the action. Use the Amazon Resource Name (ARN)
6
5
  * of an authorized user or IAM role to perform the operation.</p>
6
+ * @public
7
7
  */
8
8
  export declare class AccessDeniedException extends __BaseException {
9
9
  readonly name: "AccessDeniedException";
@@ -16,18 +16,17 @@ export declare class AccessDeniedException extends __BaseException {
16
16
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
17
17
  }
18
18
  /**
19
- * @public
20
19
  * <p>An adapter selected for use when analyzing documents. Contains an adapter ID and a version number.
21
20
  * Contains information on pages selected for analysis when analyzing documents asychronously.</p>
21
+ * @public
22
22
  */
23
23
  export interface Adapter {
24
24
  /**
25
- * @public
26
25
  * <p>A unique identifier for the adapter resource.</p>
26
+ * @public
27
27
  */
28
28
  AdapterId: string | undefined;
29
29
  /**
30
- * @public
31
30
  * <p>Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a
32
31
  * list of rules for using this parameter.</p>
33
32
  * <ul>
@@ -49,11 +48,12 @@ export interface Adapter {
49
48
  * <p>Specified pages must be greater than 0 and less than or equal to the number of pages in the document.</p>
50
49
  * </li>
51
50
  * </ul>
51
+ * @public
52
52
  */
53
53
  Pages?: string[];
54
54
  /**
55
- * @public
56
55
  * <p>A string that identifies the version of the adapter.</p>
56
+ * @public
57
57
  */
58
58
  Version: string | undefined;
59
59
  }
@@ -73,45 +73,44 @@ export declare const FeatureType: {
73
73
  */
74
74
  export type FeatureType = (typeof FeatureType)[keyof typeof FeatureType];
75
75
  /**
76
- * @public
77
76
  * <p>Contains information on the adapter, including the adapter ID, Name, Creation time, and feature types.</p>
77
+ * @public
78
78
  */
79
79
  export interface AdapterOverview {
80
80
  /**
81
- * @public
82
81
  * <p>A unique identifier for the adapter resource.</p>
82
+ * @public
83
83
  */
84
84
  AdapterId?: string;
85
85
  /**
86
- * @public
87
86
  * <p>A string naming the adapter resource.</p>
87
+ * @public
88
88
  */
89
89
  AdapterName?: string;
90
90
  /**
91
- * @public
92
91
  * <p>The date and time that the adapter was created.</p>
92
+ * @public
93
93
  */
94
94
  CreationTime?: Date;
95
95
  /**
96
- * @public
97
96
  * <p>The feature types that the adapter is operating on.</p>
97
+ * @public
98
98
  */
99
99
  FeatureTypes?: FeatureType[];
100
100
  }
101
101
  /**
102
- * @public
103
102
  * <p>Contains information about adapters used when analyzing a document,
104
103
  * with each adapter specified using an AdapterId and version</p>
104
+ * @public
105
105
  */
106
106
  export interface AdaptersConfig {
107
107
  /**
108
- * @public
109
108
  * <p>A list of adapters to be used when analyzing the specified document.</p>
109
+ * @public
110
110
  */
111
111
  Adapters: Adapter[] | undefined;
112
112
  }
113
113
  /**
114
- * @public
115
114
  * <p>The S3 bucket name and file name that identifies the document.</p>
116
115
  * <p>The AWS Region for the S3 bucket that contains the document must match the Region that
117
116
  * you use for Amazon Textract operations.</p>
@@ -119,34 +118,34 @@ export interface AdaptersConfig {
119
118
  * permission to access the S3 bucket and file.
120
119
  *
121
120
  * </p>
121
+ * @public
122
122
  */
123
123
  export interface S3Object {
124
124
  /**
125
- * @public
126
125
  * <p>The name of the S3 bucket. Note that the # character is not valid in the file
127
126
  * name.</p>
127
+ * @public
128
128
  */
129
129
  Bucket?: string;
130
130
  /**
131
- * @public
132
131
  * <p>The file name of the input document. Synchronous operations can use image files that are
133
132
  * in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.</p>
133
+ * @public
134
134
  */
135
135
  Name?: string;
136
136
  /**
137
- * @public
138
137
  * <p>If the bucket has versioning enabled, you can specify the object version. </p>
138
+ * @public
139
139
  */
140
140
  Version?: string;
141
141
  }
142
142
  /**
143
- * @public
144
143
  * <p>The dataset configuration options for a given version of an adapter.
145
144
  * Can include an Amazon S3 bucket if specified.</p>
145
+ * @public
146
146
  */
147
147
  export interface AdapterVersionDatasetConfig {
148
148
  /**
149
- * @public
150
149
  * <p>The S3 bucket name and file name that identifies the document.</p>
151
150
  * <p>The AWS Region for the S3 bucket that contains the document must match the Region that
152
151
  * you use for Amazon Textract operations.</p>
@@ -154,49 +153,50 @@ export interface AdapterVersionDatasetConfig {
154
153
  * permission to access the S3 bucket and file.
155
154
  *
156
155
  * </p>
156
+ * @public
157
157
  */
158
158
  ManifestS3Object?: S3Object;
159
159
  }
160
160
  /**
161
- * @public
162
161
  * <p>The evaluation metrics (F1 score, Precision, and Recall) for an adapter version.</p>
162
+ * @public
163
163
  */
164
164
  export interface EvaluationMetric {
165
165
  /**
166
- * @public
167
166
  * <p>The F1 score for an adapter version.</p>
167
+ * @public
168
168
  */
169
169
  F1Score?: number;
170
170
  /**
171
- * @public
172
171
  * <p>The Precision score for an adapter version.</p>
172
+ * @public
173
173
  */
174
174
  Precision?: number;
175
175
  /**
176
- * @public
177
176
  * <p>The Recall score for an adapter version.</p>
177
+ * @public
178
178
  */
179
179
  Recall?: number;
180
180
  }
181
181
  /**
182
- * @public
183
182
  * <p>Contains information on the metrics used to evalute the peformance of a given adapter version. Includes data for
184
183
  * baseline model performance and individual adapter version perfromance.</p>
184
+ * @public
185
185
  */
186
186
  export interface AdapterVersionEvaluationMetric {
187
187
  /**
188
- * @public
189
188
  * <p>The F1 score, precision, and recall metrics for the baseline model.</p>
189
+ * @public
190
190
  */
191
191
  Baseline?: EvaluationMetric;
192
192
  /**
193
- * @public
194
193
  * <p>The F1 score, precision, and recall metrics for the baseline model.</p>
194
+ * @public
195
195
  */
196
196
  AdapterVersion?: EvaluationMetric;
197
197
  /**
198
- * @public
199
198
  * <p>Indicates the feature type being analyzed by a given adapter version.</p>
199
+ * @public
200
200
  */
201
201
  FeatureType?: FeatureType;
202
202
  }
@@ -216,43 +216,42 @@ export declare const AdapterVersionStatus: {
216
216
  */
217
217
  export type AdapterVersionStatus = (typeof AdapterVersionStatus)[keyof typeof AdapterVersionStatus];
218
218
  /**
219
- * @public
220
219
  * <p>Summary info for an adapter version. Contains information on the AdapterId, AdapterVersion, CreationTime, FeatureTypes, and Status.</p>
220
+ * @public
221
221
  */
222
222
  export interface AdapterVersionOverview {
223
223
  /**
224
- * @public
225
224
  * <p>A unique identifier for the adapter associated with a given adapter version.</p>
225
+ * @public
226
226
  */
227
227
  AdapterId?: string;
228
228
  /**
229
- * @public
230
229
  * <p>An identified for a given adapter version.</p>
230
+ * @public
231
231
  */
232
232
  AdapterVersion?: string;
233
233
  /**
234
- * @public
235
234
  * <p>The date and time that a given adapter version was created.</p>
235
+ * @public
236
236
  */
237
237
  CreationTime?: Date;
238
238
  /**
239
- * @public
240
239
  * <p>The feature types that the adapter version is operating on.</p>
240
+ * @public
241
241
  */
242
242
  FeatureTypes?: FeatureType[];
243
243
  /**
244
- * @public
245
244
  * <p>Contains information on the status of a given adapter version.</p>
245
+ * @public
246
246
  */
247
247
  Status?: AdapterVersionStatus;
248
248
  /**
249
- * @public
250
249
  * <p>A message explaining the status of a given adapter vesion.</p>
250
+ * @public
251
251
  */
252
252
  StatusMessage?: string;
253
253
  }
254
254
  /**
255
- * @public
256
255
  * <p>The input document, either as bytes or as an S3 object.</p>
257
256
  * <p>You pass image bytes to an Amazon Textract API operation by using the <code>Bytes</code>
258
257
  * property. For example, you would use the <code>Bytes</code> property to pass a document
@@ -269,20 +268,21 @@ export interface AdapterVersionOverview {
269
268
  * bucket, and then call the operation using the S3Object property.</p>
270
269
  * <p>For Amazon Textract to process an S3 object, the user must have permission
271
270
  * to access the S3 object. </p>
271
+ * @public
272
272
  */
273
273
  export interface Document {
274
274
  /**
275
- * @public
276
275
  * <p>A blob of base64-encoded document bytes. The maximum size of a document that's provided
277
276
  * in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.</p>
278
277
  * <p>If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode
279
278
  * image bytes passed using the <code>Bytes</code> field. </p>
279
+ * @public
280
280
  */
281
281
  Bytes?: Uint8Array;
282
282
  /**
283
- * @public
284
283
  * <p>Identifies an S3 object as the document source. The maximum size of a document that's
285
284
  * stored in an S3 bucket is 5 MB.</p>
285
+ * @public
286
286
  */
287
287
  S3Object?: S3Object;
288
288
  }
@@ -299,58 +299,57 @@ export declare const ContentClassifier: {
299
299
  */
300
300
  export type ContentClassifier = (typeof ContentClassifier)[keyof typeof ContentClassifier];
301
301
  /**
302
- * @public
303
302
  * <p>Allows you to set attributes of the image. Currently, you can declare an image as free
304
303
  * of personally identifiable information and adult content. </p>
304
+ * @public
305
305
  */
306
306
  export interface HumanLoopDataAttributes {
307
307
  /**
308
- * @public
309
308
  * <p>Sets whether the input image is free of personally identifiable information or adult
310
309
  * content.</p>
310
+ * @public
311
311
  */
312
312
  ContentClassifiers?: ContentClassifier[];
313
313
  }
314
314
  /**
315
- * @public
316
315
  * <p>Sets up the human review workflow the document will be sent to if one of the conditions
317
316
  * is met. You can also set certain attributes of the image before review. </p>
317
+ * @public
318
318
  */
319
319
  export interface HumanLoopConfig {
320
320
  /**
321
- * @public
322
321
  * <p>The name of the human workflow used for this image. This should be kept unique within a
323
322
  * region.</p>
323
+ * @public
324
324
  */
325
325
  HumanLoopName: string | undefined;
326
326
  /**
327
- * @public
328
327
  * <p>The Amazon Resource Name (ARN) of the flow definition.</p>
328
+ * @public
329
329
  */
330
330
  FlowDefinitionArn: string | undefined;
331
331
  /**
332
- * @public
333
332
  * <p>Sets attributes of the input data.</p>
333
+ * @public
334
334
  */
335
335
  DataAttributes?: HumanLoopDataAttributes;
336
336
  }
337
337
  /**
338
- * @public
339
338
  * <p>Each query contains the question you want to ask in the Text and the alias you want to associate.</p>
339
+ * @public
340
340
  */
341
341
  export interface Query {
342
342
  /**
343
- * @public
344
343
  * <p>Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"</p>
344
+ * @public
345
345
  */
346
346
  Text: string | undefined;
347
347
  /**
348
- * @public
349
348
  * <p>Alias attached to the query, for ease of location.</p>
349
+ * @public
350
350
  */
351
351
  Alias?: string;
352
352
  /**
353
- * @public
354
353
  * <p>Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a
355
354
  * list of rules for using this parameter.</p>
356
355
  * <ul>
@@ -372,17 +371,18 @@ export interface Query {
372
371
  * <p>Specified pages must be greater than 0 and less than or equal to the number of pages in the document.</p>
373
372
  * </li>
374
373
  * </ul>
374
+ * @public
375
375
  */
376
376
  Pages?: string[];
377
377
  }
378
378
  /**
379
- * @public
380
379
  * <p></p>
380
+ * @public
381
381
  */
382
382
  export interface QueriesConfig {
383
383
  /**
384
- * @public
385
384
  * <p></p>
385
+ * @public
386
386
  */
387
387
  Queries: Query[] | undefined;
388
388
  }
@@ -391,37 +391,37 @@ export interface QueriesConfig {
391
391
  */
392
392
  export interface AnalyzeDocumentRequest {
393
393
  /**
394
- * @public
395
394
  * <p>The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS
396
395
  * CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an
397
396
  * image in JPEG, PNG, PDF, or TIFF format.</p>
398
397
  * <p>If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode
399
398
  * image bytes that are passed using the <code>Bytes</code> field. </p>
399
+ * @public
400
400
  */
401
401
  Document: Document | undefined;
402
402
  /**
403
- * @public
404
403
  * <p>A list of the types of analysis to perform. Add TABLES to the list to return information
405
404
  * about the tables that are detected in the input document. Add FORMS to return detected form
406
405
  * data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list
407
406
  * to return information about the layout of the document. All lines and words detected in the document are included in the response (including
408
407
  * text that isn't related to the value of <code>FeatureTypes</code>). </p>
408
+ * @public
409
409
  */
410
410
  FeatureTypes: FeatureType[] | undefined;
411
411
  /**
412
- * @public
413
412
  * <p>Sets the configuration for the human in the loop workflow for analyzing
414
413
  * documents.</p>
414
+ * @public
415
415
  */
416
416
  HumanLoopConfig?: HumanLoopConfig;
417
417
  /**
418
- * @public
419
418
  * <p>Contains Queries and the alias for those Queries, as determined by the input. </p>
419
+ * @public
420
420
  */
421
421
  QueriesConfig?: QueriesConfig;
422
422
  /**
423
- * @public
424
423
  * <p>Specifies the adapter to be used when analyzing a document.</p>
424
+ * @public
425
425
  */
426
426
  AdaptersConfig?: AdaptersConfig;
427
427
  }
@@ -479,7 +479,6 @@ export declare const EntityType: {
479
479
  */
480
480
  export type EntityType = (typeof EntityType)[keyof typeof EntityType];
481
481
  /**
482
- * @public
483
482
  * <p>The bounding box around the detected page, text, key-value pair, table, table cell, or
484
483
  * selection element on a document page. The <code>left</code> (x-coordinate) and
485
484
  * <code>top</code> (y-coordinate) are coordinates that represent the top and left sides of
@@ -492,35 +491,35 @@ export type EntityType = (typeof EntityType)[keyof typeof EntityType];
492
491
  * bounding box as a ratio of the overall document page dimension. For example, if the
493
492
  * document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width
494
493
  * returned is 0.1. </p>
494
+ * @public
495
495
  */
496
496
  export interface BoundingBox {
497
497
  /**
498
- * @public
499
498
  * <p>The width of the bounding box as a ratio of the overall document page
500
499
  * width.</p>
500
+ * @public
501
501
  */
502
502
  Width?: number;
503
503
  /**
504
- * @public
505
504
  * <p>The height of the bounding box as a ratio of the overall document page
506
505
  * height.</p>
506
+ * @public
507
507
  */
508
508
  Height?: number;
509
509
  /**
510
- * @public
511
510
  * <p>The left coordinate of the bounding box as a ratio of overall document page
512
511
  * width.</p>
512
+ * @public
513
513
  */
514
514
  Left?: number;
515
515
  /**
516
- * @public
517
516
  * <p>The top coordinate of the bounding box as a ratio of overall document page
518
517
  * height.</p>
518
+ * @public
519
519
  */
520
520
  Top?: number;
521
521
  }
522
522
  /**
523
- * @public
524
523
  * <p>The X and Y coordinates of a point on a document page. The X and Y
525
524
  * values that are returned are ratios of the overall document page size. For example, if the
526
525
  * input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is
@@ -529,34 +528,35 @@ export interface BoundingBox {
529
528
  * by <a>DetectDocumentText</a>. <code>Polygon</code> represents a fine-grained
530
529
  * polygon around detected text. For more information, see Geometry in the Amazon Textract
531
530
  * Developer Guide. </p>
531
+ * @public
532
532
  */
533
533
  export interface Point {
534
534
  /**
535
- * @public
536
535
  * <p>The value of the X coordinate for a point on a <code>Polygon</code>.</p>
536
+ * @public
537
537
  */
538
538
  X?: number;
539
539
  /**
540
- * @public
541
540
  * <p>The value of the Y coordinate for a point on a <code>Polygon</code>.</p>
541
+ * @public
542
542
  */
543
543
  Y?: number;
544
544
  }
545
545
  /**
546
- * @public
547
546
  * <p>Information about where the following items are located on a document page: detected
548
547
  * page, text, key-value pairs, tables, table cells, and selection elements.</p>
548
+ * @public
549
549
  */
550
550
  export interface Geometry {
551
551
  /**
552
- * @public
553
552
  * <p>An axis-aligned coarse representation of the location of the recognized item on the
554
553
  * document page.</p>
554
+ * @public
555
555
  */
556
556
  BoundingBox?: BoundingBox;
557
557
  /**
558
- * @public
559
558
  * <p>Within the bounding box, a fine-grained polygon around the recognized item.</p>
559
+ * @public
560
560
  */
561
561
  Polygon?: Point[];
562
562
  }
@@ -580,16 +580,15 @@ export declare const RelationshipType: {
580
580
  */
581
581
  export type RelationshipType = (typeof RelationshipType)[keyof typeof RelationshipType];
582
582
  /**
583
- * @public
584
583
  * <p>Information about how blocks are related to each other. A <code>Block</code> object
585
584
  * contains 0 or more <code>Relation</code> objects in a list, <code>Relationships</code>. For
586
585
  * more information, see <a>Block</a>.</p>
587
586
  * <p>The <code>Type</code> element provides the type of the relationship for all blocks in
588
587
  * the <code>IDs</code> array. </p>
588
+ * @public
589
589
  */
590
590
  export interface Relationship {
591
591
  /**
592
- * @public
593
592
  * <p>The type of relationship between the blocks in the IDs array and the current block. The
594
593
  * following list describes the relationship types that can be returned. </p>
595
594
  * <ul>
@@ -630,13 +629,14 @@ export interface Relationship {
630
629
  * block types in a table. </p>
631
630
  * </li>
632
631
  * </ul>
632
+ * @public
633
633
  */
634
634
  Type?: RelationshipType;
635
635
  /**
636
- * @public
637
636
  * <p>An
638
637
  * array of IDs for related blocks. You can get the type of the relationship from the
639
638
  * <code>Type</code> element.</p>
639
+ * @public
640
640
  */
641
641
  Ids?: string[];
642
642
  }
@@ -665,7 +665,6 @@ export declare const TextType: {
665
665
  */
666
666
  export type TextType = (typeof TextType)[keyof typeof TextType];
667
667
  /**
668
- * @public
669
668
  * <p>A <code>Block</code> represents items that are recognized in a document within a group
670
669
  * of pixels close to each other. The information returned in a <code>Block</code> object
671
670
  * 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
@@ -678,10 +677,10 @@ export type TextType = (typeof TextType)[keyof typeof TextType];
678
677
  * operations, such as <a>GetDocumentAnalysis</a>, the array is returned over one
679
678
  * or more responses.</p>
680
679
  * <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works.html">How Amazon Textract Works</a>.</p>
680
+ * @public
681
681
  */
682
682
  export interface Block {
683
683
  /**
684
- * @public
685
684
  * <p>The type of text item that's recognized. In operations for text detection, the following
686
685
  * types are returned:</p>
687
686
  * <ul>
@@ -820,74 +819,74 @@ export interface Block {
820
819
  * <code>LAYOUT_TEXT</code> - Text that is present typically as a part of paragraphs in documents.</p>
821
820
  * </li>
822
821
  * </ul>
822
+ * @public
823
823
  */
824
824
  BlockType?: BlockType;
825
825
  /**
826
- * @public
827
826
  * <p>The confidence score that Amazon Textract has in the accuracy of the recognized text and
828
827
  * the accuracy of the geometry points around the recognized text.</p>
828
+ * @public
829
829
  */
830
830
  Confidence?: number;
831
831
  /**
832
- * @public
833
832
  * <p>The word or line of text that's recognized by Amazon Textract. </p>
833
+ * @public
834
834
  */
835
835
  Text?: string;
836
836
  /**
837
- * @public
838
837
  * <p>The kind of text that Amazon Textract has detected. Can check for handwritten text and
839
838
  * printed text.</p>
839
+ * @public
840
840
  */
841
841
  TextType?: TextType;
842
842
  /**
843
- * @public
844
843
  * <p>The row in which a table cell is located. The first row position is 1.
845
844
  * <code>RowIndex</code> isn't returned by <code>DetectDocumentText</code> and
846
845
  * <code>GetDocumentTextDetection</code>.</p>
846
+ * @public
847
847
  */
848
848
  RowIndex?: number;
849
849
  /**
850
- * @public
851
850
  * <p>The column in which a table cell appears. The first column position is 1.
852
851
  * <code>ColumnIndex</code> isn't returned by <code>DetectDocumentText</code> and
853
852
  * <code>GetDocumentTextDetection</code>.</p>
853
+ * @public
854
854
  */
855
855
  ColumnIndex?: number;
856
856
  /**
857
- * @public
858
857
  * <p>The number of rows that a table cell spans. <code>RowSpan</code> isn't returned by
859
858
  * <code>DetectDocumentText</code> and <code>GetDocumentTextDetection</code>.</p>
859
+ * @public
860
860
  */
861
861
  RowSpan?: number;
862
862
  /**
863
- * @public
864
863
  * <p>The number of columns that a table cell spans. <code>ColumnSpan</code> isn't returned by
865
864
  * <code>DetectDocumentText</code> and <code>GetDocumentTextDetection</code>. </p>
865
+ * @public
866
866
  */
867
867
  ColumnSpan?: number;
868
868
  /**
869
- * @public
870
869
  * <p>The location of the recognized text on the image. It includes an axis-aligned, coarse
871
870
  * bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial
872
871
  * information. </p>
872
+ * @public
873
873
  */
874
874
  Geometry?: Geometry;
875
875
  /**
876
- * @public
877
876
  * <p>The identifier for the recognized text. The identifier is only unique for a single
878
877
  * operation. </p>
878
+ * @public
879
879
  */
880
880
  Id?: string;
881
881
  /**
882
- * @public
883
882
  * <p>A list of relationship objects that describe how blocks are related to each other. For
884
883
  * example, a LINE block object contains a CHILD relationship type with the WORD blocks that
885
884
  * make up the line of text. There aren't Relationship objects in the list for relationships
886
885
  * that don't exist, such as when the current block has no child blocks.</p>
886
+ * @public
887
887
  */
888
888
  Relationships?: Relationship[];
889
889
  /**
890
- * @public
891
890
  * <p>The type of entity. </p>
892
891
  * <p>The following entity types can be returned by FORMS analysis:</p>
893
892
  * <ul>
@@ -940,61 +939,62 @@ export interface Block {
940
939
  * <p>
941
940
  * <code>EntityTypes</code> isn't returned by <code>DetectDocumentText</code> and
942
941
  * <code>GetDocumentTextDetection</code>.</p>
942
+ * @public
943
943
  */
944
944
  EntityTypes?: EntityType[];
945
945
  /**
946
- * @public
947
946
  * <p>The selection status of a selection element, such as an option button or check box.
948
947
  * </p>
948
+ * @public
949
949
  */
950
950
  SelectionStatus?: SelectionStatus;
951
951
  /**
952
- * @public
953
952
  * <p>The page on which a block was detected. <code>Page</code> is returned by synchronous and
954
953
  * asynchronous operations. Page values greater than 1 are only returned for multipage
955
954
  * documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an
956
955
  * asynchronous operation, even if it contains multiple document pages, is considered a
957
956
  * single-page document. This means that for scanned images the value of <code>Page</code> is
958
957
  * always 1. </p>
958
+ * @public
959
959
  */
960
960
  Page?: number;
961
961
  /**
962
- * @public
963
962
  * <p></p>
963
+ * @public
964
964
  */
965
965
  Query?: Query;
966
966
  }
967
967
  /**
968
- * @public
969
968
  * <p>Information about the input document.</p>
969
+ * @public
970
970
  */
971
971
  export interface DocumentMetadata {
972
972
  /**
973
- * @public
974
973
  * <p>The number of pages that are detected in the document.</p>
974
+ * @public
975
975
  */
976
976
  Pages?: number;
977
977
  }
978
978
  /**
979
- * @public
980
979
  * <p>Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the
981
980
  * input did not trigger human review.</p>
981
+ * @public
982
982
  */
983
983
  export interface HumanLoopActivationOutput {
984
984
  /**
985
- * @public
986
985
  * <p>The Amazon Resource Name (ARN) of the HumanLoop created.</p>
986
+ * @public
987
987
  */
988
988
  HumanLoopArn?: string;
989
989
  /**
990
- * @public
991
990
  * <p>Shows if and why human review was needed.</p>
991
+ * @public
992
992
  */
993
993
  HumanLoopActivationReasons?: string[];
994
994
  /**
995
- * @public
996
995
  * <p>Shows the result of condition evaluations, including those conditions which activated a
997
996
  * human review.</p>
997
+ * @public
998
998
  */
999
999
  HumanLoopActivationConditionsEvaluationResults?: __LazyJsonString | string;
1000
1000
  }
@@ -1003,30 +1003,30 @@ export interface HumanLoopActivationOutput {
1003
1003
  */
1004
1004
  export interface AnalyzeDocumentResponse {
1005
1005
  /**
1006
- * @public
1007
1006
  * <p>Metadata about the analyzed document. An example is the number of pages.</p>
1007
+ * @public
1008
1008
  */
1009
1009
  DocumentMetadata?: DocumentMetadata;
1010
1010
  /**
1011
- * @public
1012
1011
  * <p>The items that are detected and analyzed by <code>AnalyzeDocument</code>.</p>
1012
+ * @public
1013
1013
  */
1014
1014
  Blocks?: Block[];
1015
1015
  /**
1016
- * @public
1017
1016
  * <p>Shows the results of the human in the loop evaluation.</p>
1017
+ * @public
1018
1018
  */
1019
1019
  HumanLoopActivationOutput?: HumanLoopActivationOutput;
1020
1020
  /**
1021
- * @public
1022
1021
  * <p>The version of the model used to analyze the document.</p>
1022
+ * @public
1023
1023
  */
1024
1024
  AnalyzeDocumentModelVersion?: string;
1025
1025
  }
1026
1026
  /**
1027
- * @public
1028
1027
  * <p>Amazon Textract isn't able to read the document. For more information on the document
1029
1028
  * limits in Amazon Textract, see <a>limits</a>.</p>
1029
+ * @public
1030
1030
  */
1031
1031
  export declare class BadDocumentException extends __BaseException {
1032
1032
  readonly name: "BadDocumentException";
@@ -1039,10 +1039,10 @@ export declare class BadDocumentException extends __BaseException {
1039
1039
  constructor(opts: __ExceptionOptionType<BadDocumentException, __BaseException>);
1040
1040
  }
1041
1041
  /**
1042
- * @public
1043
1042
  * <p>The document can't be processed because it's too large. The maximum document size for
1044
1043
  * synchronous operations 10 MB. The maximum document size for asynchronous operations is 500
1045
1044
  * MB for PDF files.</p>
1045
+ * @public
1046
1046
  */
1047
1047
  export declare class DocumentTooLargeException extends __BaseException {
1048
1048
  readonly name: "DocumentTooLargeException";
@@ -1055,25 +1055,25 @@ export declare class DocumentTooLargeException extends __BaseException {
1055
1055
  constructor(opts: __ExceptionOptionType<DocumentTooLargeException, __BaseException>);
1056
1056
  }
1057
1057
  /**
1058
- * @public
1059
1058
  * <p>Indicates you have exceeded the maximum number of active human in the loop workflows available</p>
1059
+ * @public
1060
1060
  */
1061
1061
  export declare class HumanLoopQuotaExceededException extends __BaseException {
1062
1062
  readonly name: "HumanLoopQuotaExceededException";
1063
1063
  readonly $fault: "client";
1064
1064
  /**
1065
- * @public
1066
1065
  * <p>The resource type.</p>
1066
+ * @public
1067
1067
  */
1068
1068
  ResourceType?: string;
1069
1069
  /**
1070
- * @public
1071
1070
  * <p>The quota code.</p>
1071
+ * @public
1072
1072
  */
1073
1073
  QuotaCode?: string;
1074
1074
  /**
1075
- * @public
1076
1075
  * <p>The service code.</p>
1076
+ * @public
1077
1077
  */
1078
1078
  ServiceCode?: string;
1079
1079
  Message?: string;
@@ -1084,8 +1084,8 @@ export declare class HumanLoopQuotaExceededException extends __BaseException {
1084
1084
  constructor(opts: __ExceptionOptionType<HumanLoopQuotaExceededException, __BaseException>);
1085
1085
  }
1086
1086
  /**
1087
- * @public
1088
1087
  * <p>Amazon Textract experienced a service issue. Try your call again.</p>
1088
+ * @public
1089
1089
  */
1090
1090
  export declare class InternalServerError extends __BaseException {
1091
1091
  readonly name: "InternalServerError";
@@ -1098,12 +1098,12 @@ export declare class InternalServerError extends __BaseException {
1098
1098
  constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
1099
1099
  }
1100
1100
  /**
1101
- * @public
1102
1101
  * <p>An input parameter violated a constraint. For example, in synchronous operations,
1103
1102
  * an <code>InvalidParameterException</code> exception occurs
1104
1103
  * when neither of the <code>S3Object</code> or <code>Bytes</code> values are supplied in the <code>Document</code>
1105
1104
  * request parameter.
1106
1105
  * Validate your parameter before calling the API operation again.</p>
1106
+ * @public
1107
1107
  */
1108
1108
  export declare class InvalidParameterException extends __BaseException {
1109
1109
  readonly name: "InvalidParameterException";
@@ -1116,11 +1116,11 @@ export declare class InvalidParameterException extends __BaseException {
1116
1116
  constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
1117
1117
  }
1118
1118
  /**
1119
- * @public
1120
1119
  * <p>Amazon Textract is unable to access the S3 object that's specified in the request.
1121
1120
  * for more information, <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html">Configure Access to Amazon S3</a>
1122
1121
  * For troubleshooting information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html">Troubleshooting Amazon S3</a>
1123
1122
  * </p>
1123
+ * @public
1124
1124
  */
1125
1125
  export declare class InvalidS3ObjectException extends __BaseException {
1126
1126
  readonly name: "InvalidS3ObjectException";
@@ -1133,9 +1133,9 @@ export declare class InvalidS3ObjectException extends __BaseException {
1133
1133
  constructor(opts: __ExceptionOptionType<InvalidS3ObjectException, __BaseException>);
1134
1134
  }
1135
1135
  /**
1136
- * @public
1137
1136
  * <p>The number of requests exceeded your throughput limit. If you want to increase this limit,
1138
1137
  * contact Amazon Textract.</p>
1138
+ * @public
1139
1139
  */
1140
1140
  export declare class ProvisionedThroughputExceededException extends __BaseException {
1141
1141
  readonly name: "ProvisionedThroughputExceededException";
@@ -1148,8 +1148,8 @@ export declare class ProvisionedThroughputExceededException extends __BaseExcept
1148
1148
  constructor(opts: __ExceptionOptionType<ProvisionedThroughputExceededException, __BaseException>);
1149
1149
  }
1150
1150
  /**
1151
- * @public
1152
1151
  * <p>Amazon Textract is temporarily unable to process the request. Try your call again.</p>
1152
+ * @public
1153
1153
  */
1154
1154
  export declare class ThrottlingException extends __BaseException {
1155
1155
  readonly name: "ThrottlingException";
@@ -1162,9 +1162,9 @@ export declare class ThrottlingException extends __BaseException {
1162
1162
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
1163
1163
  }
1164
1164
  /**
1165
- * @public
1166
1165
  * <p>The format of the input document isn't supported. Documents for operations can be in
1167
1166
  * PNG, JPEG, PDF, or TIFF format.</p>
1167
+ * @public
1168
1168
  */
1169
1169
  export declare class UnsupportedDocumentException extends __BaseException {
1170
1170
  readonly name: "UnsupportedDocumentException";
@@ -1181,7 +1181,6 @@ export declare class UnsupportedDocumentException extends __BaseException {
1181
1181
  */
1182
1182
  export interface AnalyzeExpenseRequest {
1183
1183
  /**
1184
- * @public
1185
1184
  * <p>The input document, either as bytes or as an S3 object.</p>
1186
1185
  * <p>You pass image bytes to an Amazon Textract API operation by using the <code>Bytes</code>
1187
1186
  * property. For example, you would use the <code>Bytes</code> property to pass a document
@@ -1198,16 +1197,16 @@ export interface AnalyzeExpenseRequest {
1198
1197
  * bucket, and then call the operation using the S3Object property.</p>
1199
1198
  * <p>For Amazon Textract to process an S3 object, the user must have permission
1200
1199
  * to access the S3 object. </p>
1200
+ * @public
1201
1201
  */
1202
1202
  Document: Document | undefined;
1203
1203
  }
1204
1204
  /**
1205
- * @public
1206
1205
  * <p>Returns the kind of currency detected.</p>
1206
+ * @public
1207
1207
  */
1208
1208
  export interface ExpenseCurrency {
1209
1209
  /**
1210
- * @public
1211
1210
  * <p>Currency code for detected currency. the current supported codes are:</p>
1212
1211
  * <ul>
1213
1212
  * <li>
@@ -1247,161 +1246,162 @@ export interface ExpenseCurrency {
1247
1246
  * <p>HKD</p>
1248
1247
  * </li>
1249
1248
  * </ul>
1249
+ * @public
1250
1250
  */
1251
1251
  Code?: string;
1252
1252
  /**
1253
- * @public
1254
1253
  * <p>Percentage confideence in the detected currency.</p>
1254
+ * @public
1255
1255
  */
1256
1256
  Confidence?: number;
1257
1257
  }
1258
1258
  /**
1259
- * @public
1260
1259
  * <p>Shows the group that a certain key belongs to. This helps differentiate between
1261
1260
  * names and addresses for different organizations, that can be hard to determine
1262
1261
  * via JSON response.</p>
1262
+ * @public
1263
1263
  */
1264
1264
  export interface ExpenseGroupProperty {
1265
1265
  /**
1266
- * @public
1267
1266
  * <p>Informs you on whether the expense group is a name or an address.</p>
1267
+ * @public
1268
1268
  */
1269
1269
  Types?: string[];
1270
1270
  /**
1271
- * @public
1272
1271
  * <p>Provides a group Id number, which will be the same for each in the group.</p>
1272
+ * @public
1273
1273
  */
1274
1274
  Id?: string;
1275
1275
  }
1276
1276
  /**
1277
- * @public
1278
1277
  * <p>An object used to store information about the Value or Label detected by Amazon Textract.</p>
1278
+ * @public
1279
1279
  */
1280
1280
  export interface ExpenseDetection {
1281
1281
  /**
1282
- * @public
1283
1282
  * <p>The word or line of text recognized by Amazon Textract</p>
1283
+ * @public
1284
1284
  */
1285
1285
  Text?: string;
1286
1286
  /**
1287
- * @public
1288
1287
  * <p>Information about where the following items are located on a document page: detected
1289
1288
  * page, text, key-value pairs, tables, table cells, and selection elements.</p>
1289
+ * @public
1290
1290
  */
1291
1291
  Geometry?: Geometry;
1292
1292
  /**
1293
- * @public
1294
1293
  * <p>The confidence in detection, as a percentage</p>
1294
+ * @public
1295
1295
  */
1296
1296
  Confidence?: number;
1297
1297
  }
1298
1298
  /**
1299
- * @public
1300
1299
  * <p>An object used to store information about the Type detected by Amazon Textract.</p>
1300
+ * @public
1301
1301
  */
1302
1302
  export interface ExpenseType {
1303
1303
  /**
1304
- * @public
1305
1304
  * <p>The word or line of text detected by Amazon Textract.</p>
1305
+ * @public
1306
1306
  */
1307
1307
  Text?: string;
1308
1308
  /**
1309
- * @public
1310
1309
  * <p>The confidence of accuracy, as a percentage.</p>
1310
+ * @public
1311
1311
  */
1312
1312
  Confidence?: number;
1313
1313
  }
1314
1314
  /**
1315
- * @public
1316
1315
  * <p>Breakdown of detected information, seperated into
1317
1316
  * the catagories Type, LabelDetection, and ValueDetection</p>
1317
+ * @public
1318
1318
  */
1319
1319
  export interface ExpenseField {
1320
1320
  /**
1321
- * @public
1322
1321
  * <p>The implied label of a detected element. Present alongside LabelDetection for explicit elements.</p>
1322
+ * @public
1323
1323
  */
1324
1324
  Type?: ExpenseType;
1325
1325
  /**
1326
- * @public
1327
1326
  * <p>The explicitly stated label of a detected element.</p>
1327
+ * @public
1328
1328
  */
1329
1329
  LabelDetection?: ExpenseDetection;
1330
1330
  /**
1331
- * @public
1332
1331
  * <p>The value of a detected element. Present in explicit and implicit elements.</p>
1332
+ * @public
1333
1333
  */
1334
1334
  ValueDetection?: ExpenseDetection;
1335
1335
  /**
1336
- * @public
1337
1336
  * <p>The page number the value was detected on.</p>
1337
+ * @public
1338
1338
  */
1339
1339
  PageNumber?: number;
1340
1340
  /**
1341
- * @public
1342
1341
  * <p>Shows the kind of currency, both the code and confidence associated with any monatary value
1343
1342
  * detected.</p>
1343
+ * @public
1344
1344
  */
1345
1345
  Currency?: ExpenseCurrency;
1346
1346
  /**
1347
- * @public
1348
1347
  * <p>Shows which group a response object belongs to, such as whether an address line
1349
1348
  * belongs to the vendor's address or the recipent's address.</p>
1349
+ * @public
1350
1350
  */
1351
1351
  GroupProperties?: ExpenseGroupProperty[];
1352
1352
  }
1353
1353
  /**
1354
- * @public
1355
1354
  * <p>A structure that holds information about the different lines found in a document's tables.</p>
1355
+ * @public
1356
1356
  */
1357
1357
  export interface LineItemFields {
1358
1358
  /**
1359
- * @public
1360
1359
  * <p>ExpenseFields used to show information from detected lines on a table.</p>
1360
+ * @public
1361
1361
  */
1362
1362
  LineItemExpenseFields?: ExpenseField[];
1363
1363
  }
1364
1364
  /**
1365
- * @public
1366
1365
  * <p>A grouping of tables which contain LineItems, with each table identified by the table's <code>LineItemGroupIndex</code>.</p>
1366
+ * @public
1367
1367
  */
1368
1368
  export interface LineItemGroup {
1369
1369
  /**
1370
- * @public
1371
1370
  * <p>The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc.</p>
1371
+ * @public
1372
1372
  */
1373
1373
  LineItemGroupIndex?: number;
1374
1374
  /**
1375
- * @public
1376
1375
  * <p>The breakdown of information on a particular line of a table. </p>
1376
+ * @public
1377
1377
  */
1378
1378
  LineItems?: LineItemFields[];
1379
1379
  }
1380
1380
  /**
1381
- * @public
1382
1381
  * <p>The structure holding all the information returned by AnalyzeExpense</p>
1382
+ * @public
1383
1383
  */
1384
1384
  export interface ExpenseDocument {
1385
1385
  /**
1386
- * @public
1387
1386
  * <p>Denotes which invoice or receipt in the document the information is coming from.
1388
1387
  * First document will be 1, the second 2, and so on.</p>
1388
+ * @public
1389
1389
  */
1390
1390
  ExpenseIndex?: number;
1391
1391
  /**
1392
- * @public
1393
1392
  * <p>Any information found outside of a table by Amazon Textract.</p>
1393
+ * @public
1394
1394
  */
1395
1395
  SummaryFields?: ExpenseField[];
1396
1396
  /**
1397
- * @public
1398
1397
  * <p>Information detected on each table of a document, seperated into <code>LineItems</code>.</p>
1398
+ * @public
1399
1399
  */
1400
1400
  LineItemGroups?: LineItemGroup[];
1401
1401
  /**
1402
- * @public
1403
1402
  * <p>This is a block object, the same as reported when DetectDocumentText is run on a document.
1404
1403
  * It provides word level recognition of text.</p>
1404
+ * @public
1405
1405
  */
1406
1406
  Blocks?: Block[];
1407
1407
  }
@@ -1410,13 +1410,13 @@ export interface ExpenseDocument {
1410
1410
  */
1411
1411
  export interface AnalyzeExpenseResponse {
1412
1412
  /**
1413
- * @public
1414
1413
  * <p>Information about the input document.</p>
1414
+ * @public
1415
1415
  */
1416
1416
  DocumentMetadata?: DocumentMetadata;
1417
1417
  /**
1418
- * @public
1419
1418
  * <p>The expenses detected by Amazon Textract.</p>
1419
+ * @public
1420
1420
  */
1421
1421
  ExpenseDocuments?: ExpenseDocument[];
1422
1422
  }
@@ -1425,8 +1425,8 @@ export interface AnalyzeExpenseResponse {
1425
1425
  */
1426
1426
  export interface AnalyzeIDRequest {
1427
1427
  /**
1428
- * @public
1429
1428
  * <p>The document being passed to AnalyzeID.</p>
1429
+ * @public
1430
1430
  */
1431
1431
  DocumentPages: Document[] | undefined;
1432
1432
  }
@@ -1442,81 +1442,81 @@ export declare const ValueType: {
1442
1442
  */
1443
1443
  export type ValueType = (typeof ValueType)[keyof typeof ValueType];
1444
1444
  /**
1445
- * @public
1446
1445
  * <p>Contains information relating to dates in a document, including the type
1447
1446
  * of value, and the value.</p>
1447
+ * @public
1448
1448
  */
1449
1449
  export interface NormalizedValue {
1450
1450
  /**
1451
- * @public
1452
1451
  * <p>The value of the date, written as Year-Month-DayTHour:Minute:Second.</p>
1452
+ * @public
1453
1453
  */
1454
1454
  Value?: string;
1455
1455
  /**
1456
- * @public
1457
1456
  * <p>The normalized type of the value detected. In this case, DATE.</p>
1457
+ * @public
1458
1458
  */
1459
1459
  ValueType?: ValueType;
1460
1460
  }
1461
1461
  /**
1462
- * @public
1463
1462
  * <p>Used to contain the information detected by an AnalyzeID operation.</p>
1463
+ * @public
1464
1464
  */
1465
1465
  export interface AnalyzeIDDetections {
1466
1466
  /**
1467
- * @public
1468
1467
  * <p>Text of either the normalized field or value associated with it.</p>
1468
+ * @public
1469
1469
  */
1470
1470
  Text: string | undefined;
1471
1471
  /**
1472
- * @public
1473
1472
  * <p>Only returned for dates, returns the type of value detected and the date
1474
1473
  * written in a more machine readable way.</p>
1474
+ * @public
1475
1475
  */
1476
1476
  NormalizedValue?: NormalizedValue;
1477
1477
  /**
1478
- * @public
1479
1478
  * <p>The confidence score of the detected text.</p>
1479
+ * @public
1480
1480
  */
1481
1481
  Confidence?: number;
1482
1482
  }
1483
1483
  /**
1484
- * @public
1485
1484
  * <p>Structure containing both the normalized type of the extracted information
1486
1485
  * and the text associated with it. These are extracted as Type and Value respectively.</p>
1486
+ * @public
1487
1487
  */
1488
1488
  export interface IdentityDocumentField {
1489
1489
  /**
1490
- * @public
1491
1490
  * <p>Used to contain the information detected by an AnalyzeID operation.</p>
1491
+ * @public
1492
1492
  */
1493
1493
  Type?: AnalyzeIDDetections;
1494
1494
  /**
1495
- * @public
1496
1495
  * <p>Used to contain the information detected by an AnalyzeID operation.</p>
1496
+ * @public
1497
1497
  */
1498
1498
  ValueDetection?: AnalyzeIDDetections;
1499
1499
  }
1500
1500
  /**
1501
- * @public
1502
1501
  * <p>The structure that lists each document processed in an AnalyzeID operation.</p>
1502
+ * @public
1503
1503
  */
1504
1504
  export interface IdentityDocument {
1505
1505
  /**
1506
- * @public
1507
1506
  * <p>Denotes the placement of a document in the IdentityDocument list. The first document
1508
1507
  * is marked 1, the second 2 and so on.</p>
1508
+ * @public
1509
1509
  */
1510
1510
  DocumentIndex?: number;
1511
1511
  /**
1512
- * @public
1513
1512
  * <p>The structure used to record information extracted from identity documents.
1514
1513
  * Contains both normalized field and value of the extracted text.</p>
1514
+ * @public
1515
1515
  */
1516
1516
  IdentityDocumentFields?: IdentityDocumentField[];
1517
1517
  /**
1518
- * @public
1519
1518
  * <p>Individual word recognition, as returned by document detection.</p>
1519
+ * @public
1520
1520
  */
1521
1521
  Blocks?: Block[];
1522
1522
  }
@@ -1525,19 +1525,19 @@ export interface IdentityDocument {
1525
1525
  */
1526
1526
  export interface AnalyzeIDResponse {
1527
1527
  /**
1528
- * @public
1529
1528
  * <p>The list of documents processed by AnalyzeID. Includes a number denoting their place in
1530
1529
  * the list and the response structure for the document.</p>
1530
+ * @public
1531
1531
  */
1532
1532
  IdentityDocuments?: IdentityDocument[];
1533
1533
  /**
1534
- * @public
1535
1534
  * <p>Information about the input document.</p>
1535
+ * @public
1536
1536
  */
1537
1537
  DocumentMetadata?: DocumentMetadata;
1538
1538
  /**
1539
- * @public
1540
1539
  * <p>The version of the AnalyzeIdentity API being used to process documents.</p>
1540
+ * @public
1541
1541
  */
1542
1542
  AnalyzeIDModelVersion?: string;
1543
1543
  }
@@ -1554,8 +1554,8 @@ export declare const AutoUpdate: {
1554
1554
  */
1555
1555
  export type AutoUpdate = (typeof AutoUpdate)[keyof typeof AutoUpdate];
1556
1556
  /**
1557
- * @public
1558
1557
  * <p>Updating or deleting a resource can cause an inconsistent state.</p>
1558
+ * @public
1559
1559
  */
1560
1560
  export declare class ConflictException extends __BaseException {
1561
1561
  readonly name: "ConflictException";
@@ -1572,37 +1572,37 @@ export declare class ConflictException extends __BaseException {
1572
1572
  */
1573
1573
  export interface CreateAdapterRequest {
1574
1574
  /**
1575
- * @public
1576
1575
  * <p>The name to be assigned to the adapter being created.</p>
1576
+ * @public
1577
1577
  */
1578
1578
  AdapterName: string | undefined;
1579
1579
  /**
1580
- * @public
1581
1580
  * <p>Idempotent token is used to recognize the request. If the same token is used with multiple
1582
1581
  * CreateAdapter requests, the same session is returned.
1583
1582
  * This token is employed to avoid unintentionally creating the same session multiple times.</p>
1583
+ * @public
1584
1584
  */
1585
1585
  ClientRequestToken?: string;
1586
1586
  /**
1587
- * @public
1588
1587
  * <p>The description to be assigned to the adapter being created.</p>
1588
+ * @public
1589
1589
  */
1590
1590
  Description?: string;
1591
1591
  /**
1592
- * @public
1593
1592
  * <p>The type of feature that the adapter is being trained on. Currrenly, supported feature
1594
1593
  * types are: <code>QUERIES</code>
1595
1594
  * </p>
1595
+ * @public
1596
1596
  */
1597
1597
  FeatureTypes: FeatureType[] | undefined;
1598
1598
  /**
1599
- * @public
1600
1599
  * <p>Controls whether or not the adapter should automatically update.</p>
1600
+ * @public
1601
1601
  */
1602
1602
  AutoUpdate?: AutoUpdate;
1603
1603
  /**
1604
- * @public
1605
1604
  * <p>A list of tags to be added to the adapter.</p>
1605
+ * @public
1606
1606
  */
1607
1607
  Tags?: Record<string, string>;
1608
1608
  }
@@ -1611,16 +1611,16 @@ export interface CreateAdapterRequest {
1611
1611
  */
1612
1612
  export interface CreateAdapterResponse {
1613
1613
  /**
1614
- * @public
1615
1614
  * <p>A string containing the unique ID for the adapter that has been created.</p>
1615
+ * @public
1616
1616
  */
1617
1617
  AdapterId?: string;
1618
1618
  }
1619
1619
  /**
1620
- * @public
1621
1620
  * <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at
1622
1621
  * least one of the other input parameters is different from the previous call to the
1623
1622
  * operation. </p>
1623
+ * @public
1624
1624
  */
1625
1625
  export declare class IdempotentParameterMismatchException extends __BaseException {
1626
1626
  readonly name: "IdempotentParameterMismatchException";
@@ -1633,12 +1633,12 @@ export declare class IdempotentParameterMismatchException extends __BaseExceptio
1633
1633
  constructor(opts: __ExceptionOptionType<IdempotentParameterMismatchException, __BaseException>);
1634
1634
  }
1635
1635
  /**
1636
- * @public
1637
1636
  * <p>An Amazon Textract service limit was exceeded. For example, if you start too many
1638
1637
  * asynchronous jobs concurrently, calls to start operations
1639
1638
  * (<code>StartDocumentTextDetection</code>, for example) raise a LimitExceededException
1640
1639
  * exception (HTTP status code: 400) until the number of concurrently running jobs is below
1641
1640
  * the Amazon Textract service limit. </p>
1641
+ * @public
1642
1642
  */
1643
1643
  export declare class LimitExceededException extends __BaseException {
1644
1644
  readonly name: "LimitExceededException";
@@ -1651,8 +1651,8 @@ export declare class LimitExceededException extends __BaseException {
1651
1651
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
1652
1652
  }
1653
1653
  /**
1654
- * @public
1655
1654
  * <p>Returned when a request cannot be completed as it would exceed a maximum service quota.</p>
1655
+ * @public
1656
1656
  */
1657
1657
  export declare class ServiceQuotaExceededException extends __BaseException {
1658
1658
  readonly name: "ServiceQuotaExceededException";
@@ -1665,8 +1665,8 @@ export declare class ServiceQuotaExceededException extends __BaseException {
1665
1665
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
1666
1666
  }
1667
1667
  /**
1668
- * @public
1669
1668
  * <p> Indicates that a request was not valid. Check request for proper formatting. </p>
1669
+ * @public
1670
1670
  */
1671
1671
  export declare class ValidationException extends __BaseException {
1672
1672
  readonly name: "ValidationException";
@@ -1679,7 +1679,6 @@ export declare class ValidationException extends __BaseException {
1679
1679
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
1680
1680
  }
1681
1681
  /**
1682
- * @public
1683
1682
  * <p>Sets whether or not your output will go to a user created bucket. Used to set the name
1684
1683
  * of the bucket, and the prefix on the output file.</p>
1685
1684
  * <p>
@@ -1697,17 +1696,18 @@ export declare class ValidationException extends __BaseException {
1697
1696
  * <p>For more information on data privacy,
1698
1697
  * see the <a href="https://aws.amazon.com/compliance/data-privacy-faq/">Data Privacy
1699
1698
  * FAQ</a>.</p>
1699
+ * @public
1700
1700
  */
1701
1701
  export interface OutputConfig {
1702
1702
  /**
1703
- * @public
1704
1703
  * <p>The name of the bucket your output will go to.</p>
1704
+ * @public
1705
1705
  */
1706
1706
  S3Bucket: string | undefined;
1707
1707
  /**
1708
- * @public
1709
1708
  * <p>The prefix of the object key that the output will be saved to. When not enabled, the
1710
1709
  * prefix will be “textract_output".</p>
1710
+ * @public
1711
1711
  */
1712
1712
  S3Prefix?: string;
1713
1713
  }
@@ -1716,30 +1716,29 @@ export interface OutputConfig {
1716
1716
  */
1717
1717
  export interface CreateAdapterVersionRequest {
1718
1718
  /**
1719
- * @public
1720
1719
  * <p>A string containing a unique ID for the adapter that will receive a new version.</p>
1720
+ * @public
1721
1721
  */
1722
1722
  AdapterId: string | undefined;
1723
1723
  /**
1724
- * @public
1725
1724
  * <p>Idempotent token is used to recognize the request. If the same token is used with multiple
1726
1725
  * CreateAdapterVersion requests, the same session is returned.
1727
1726
  * This token is employed to avoid unintentionally creating the same session multiple times.</p>
1727
+ * @public
1728
1728
  */
1729
1729
  ClientRequestToken?: string;
1730
1730
  /**
1731
- * @public
1732
1731
  * <p>Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object as the
1733
1732
  * value.</p>
1733
+ * @public
1734
1734
  */
1735
1735
  DatasetConfig: AdapterVersionDatasetConfig | undefined;
1736
1736
  /**
1737
- * @public
1738
1737
  * <p>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.</p>
1738
+ * @public
1739
1739
  */
1740
1740
  KMSKeyId?: string;
1741
1741
  /**
1742
- * @public
1743
1742
  * <p>Sets whether or not your output will go to a user created bucket. Used to set the name
1744
1743
  * of the bucket, and the prefix on the output file.</p>
1745
1744
  * <p>
@@ -1757,11 +1756,12 @@ export interface CreateAdapterVersionRequest {
1757
1756
  * <p>For more information on data privacy,
1758
1757
  * see the <a href="https://aws.amazon.com/compliance/data-privacy-faq/">Data Privacy
1759
1758
  * FAQ</a>.</p>
1759
+ * @public
1760
1760
  */
1761
1761
  OutputConfig: OutputConfig | undefined;
1762
1762
  /**
1763
- * @public
1764
1763
  * <p>A set of tags (key-value pairs) that you want to attach to the adapter version. </p>
1764
+ * @public
1765
1765
  */
1766
1766
  Tags?: Record<string, string>;
1767
1767
  }
@@ -1770,20 +1770,20 @@ export interface CreateAdapterVersionRequest {
1770
1770
  */
1771
1771
  export interface CreateAdapterVersionResponse {
1772
1772
  /**
1773
- * @public
1774
1773
  * <p>A string containing the unique ID for the adapter that has received a new version.</p>
1774
+ * @public
1775
1775
  */
1776
1776
  AdapterId?: string;
1777
1777
  /**
1778
- * @public
1779
1778
  * <p>A string describing the new version of the adapter.</p>
1779
+ * @public
1780
1780
  */
1781
1781
  AdapterVersion?: string;
1782
1782
  }
1783
1783
  /**
1784
- * @public
1785
1784
  * <p> Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key
1786
1785
  * was entered incorrectly. </p>
1786
+ * @public
1787
1787
  */
1788
1788
  export declare class InvalidKMSKeyException extends __BaseException {
1789
1789
  readonly name: "InvalidKMSKeyException";
@@ -1796,8 +1796,8 @@ export declare class InvalidKMSKeyException extends __BaseException {
1796
1796
  constructor(opts: __ExceptionOptionType<InvalidKMSKeyException, __BaseException>);
1797
1797
  }
1798
1798
  /**
1799
- * @public
1800
1799
  * <p> Returned when an operation tried to access a nonexistent resource. </p>
1800
+ * @public
1801
1801
  */
1802
1802
  export declare class ResourceNotFoundException extends __BaseException {
1803
1803
  readonly name: "ResourceNotFoundException";
@@ -1814,8 +1814,8 @@ export declare class ResourceNotFoundException extends __BaseException {
1814
1814
  */
1815
1815
  export interface DeleteAdapterRequest {
1816
1816
  /**
1817
- * @public
1818
1817
  * <p>A string containing a unique ID for the adapter to be deleted.</p>
1818
+ * @public
1819
1819
  */
1820
1820
  AdapterId: string | undefined;
1821
1821
  }
@@ -1829,13 +1829,13 @@ export interface DeleteAdapterResponse {
1829
1829
  */
1830
1830
  export interface DeleteAdapterVersionRequest {
1831
1831
  /**
1832
- * @public
1833
1832
  * <p>A string containing a unique ID for the adapter version that will be deleted.</p>
1833
+ * @public
1834
1834
  */
1835
1835
  AdapterId: string | undefined;
1836
1836
  /**
1837
- * @public
1838
1837
  * <p>Specifies the adapter version to be deleted.</p>
1838
+ * @public
1839
1839
  */
1840
1840
  AdapterVersion: string | undefined;
1841
1841
  }
@@ -1849,12 +1849,12 @@ export interface DeleteAdapterVersionResponse {
1849
1849
  */
1850
1850
  export interface DetectDocumentTextRequest {
1851
1851
  /**
1852
- * @public
1853
1852
  * <p>The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI
1854
1853
  * to call Amazon Textract operations, you can't pass image bytes. The document must be an image
1855
1854
  * in JPEG or PNG format.</p>
1856
1855
  * <p>If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode
1857
1856
  * image bytes that are passed using the <code>Bytes</code> field. </p>
1857
+ * @public
1858
1858
  */
1859
1859
  Document: Document | undefined;
1860
1860
  }
@@ -1863,200 +1863,200 @@ export interface DetectDocumentTextRequest {
1863
1863
  */
1864
1864
  export interface DetectDocumentTextResponse {
1865
1865
  /**
1866
- * @public
1867
1866
  * <p>Metadata about the document. It contains the number of pages that are detected in the
1868
1867
  * document.</p>
1868
+ * @public
1869
1869
  */
1870
1870
  DocumentMetadata?: DocumentMetadata;
1871
1871
  /**
1872
- * @public
1873
1872
  * <p>An array of <code>Block</code> objects that contain the text that's detected in the
1874
1873
  * document.</p>
1874
+ * @public
1875
1875
  */
1876
1876
  Blocks?: Block[];
1877
1877
  /**
1878
- * @public
1879
1878
  * <p></p>
1879
+ * @public
1880
1880
  */
1881
1881
  DetectDocumentTextModelVersion?: string;
1882
1882
  }
1883
1883
  /**
1884
- * @public
1885
1884
  * <p>A structure that holds information regarding a detected signature on a page.</p>
1885
+ * @public
1886
1886
  */
1887
1887
  export interface DetectedSignature {
1888
1888
  /**
1889
- * @public
1890
1889
  * <p>The page a detected signature was found on.</p>
1890
+ * @public
1891
1891
  */
1892
1892
  Page?: number;
1893
1893
  }
1894
1894
  /**
1895
- * @public
1896
1895
  * <p>Contains information about the pages of a document, defined by logical boundary.</p>
1896
+ * @public
1897
1897
  */
1898
1898
  export interface SplitDocument {
1899
1899
  /**
1900
- * @public
1901
1900
  * <p>The index for a given document in a DocumentGroup of a specific Type.</p>
1901
+ * @public
1902
1902
  */
1903
1903
  Index?: number;
1904
1904
  /**
1905
- * @public
1906
1905
  * <p>An array of page numbers for a for a given document, ordered by logical boundary.</p>
1906
+ * @public
1907
1907
  */
1908
1908
  Pages?: number[];
1909
1909
  }
1910
1910
  /**
1911
- * @public
1912
1911
  * <p>A structure containing information about an undetected signature on a page where it was expected but not found.</p>
1912
+ * @public
1913
1913
  */
1914
1914
  export interface UndetectedSignature {
1915
1915
  /**
1916
- * @public
1917
1916
  * <p>The page where a signature was expected but not found.</p>
1917
+ * @public
1918
1918
  */
1919
1919
  Page?: number;
1920
1920
  }
1921
1921
  /**
1922
- * @public
1923
1922
  * <p>Summary information about documents grouped by the same document type.</p>
1923
+ * @public
1924
1924
  */
1925
1925
  export interface DocumentGroup {
1926
1926
  /**
1927
- * @public
1928
1927
  * <p>The type of document that Amazon Textract has detected. See <a href="https://docs.aws.amazon.com/textract/latest/dg/lending-response-objects.html">Analyze Lending Response Objects</a> for a list of all types returned by Textract.</p>
1928
+ * @public
1929
1929
  */
1930
1930
  Type?: string;
1931
1931
  /**
1932
- * @public
1933
1932
  * <p>An array that contains information about the pages of a document, defined by logical boundary.</p>
1933
+ * @public
1934
1934
  */
1935
1935
  SplitDocuments?: SplitDocument[];
1936
1936
  /**
1937
- * @public
1938
1937
  * <p>A list of the detected signatures found in a document group.</p>
1938
+ * @public
1939
1939
  */
1940
1940
  DetectedSignatures?: DetectedSignature[];
1941
1941
  /**
1942
- * @public
1943
1942
  * <p>A list of any expected signatures not found in a document group.</p>
1943
+ * @public
1944
1944
  */
1945
1945
  UndetectedSignatures?: UndetectedSignature[];
1946
1946
  }
1947
1947
  /**
1948
- * @public
1949
1948
  * <p>The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous
1950
1949
  * operations.</p>
1951
1950
  * <p>The input document can be an image file in JPEG or PNG format. It can also be a file in
1952
1951
  * PDF format.</p>
1952
+ * @public
1953
1953
  */
1954
1954
  export interface DocumentLocation {
1955
1955
  /**
1956
- * @public
1957
1956
  * <p>The Amazon S3 bucket that contains the input document.</p>
1957
+ * @public
1958
1958
  */
1959
1959
  S3Object?: S3Object;
1960
1960
  }
1961
1961
  /**
1962
- * @public
1963
1962
  * <p>The results extracted for a lending document.</p>
1963
+ * @public
1964
1964
  */
1965
1965
  export interface LendingDetection {
1966
1966
  /**
1967
- * @public
1968
1967
  * <p>The text extracted for a detected value in a lending document.</p>
1968
+ * @public
1969
1969
  */
1970
1970
  Text?: string;
1971
1971
  /**
1972
- * @public
1973
1972
  * <p>The selection status of a selection element, such as an option button or check box.</p>
1973
+ * @public
1974
1974
  */
1975
1975
  SelectionStatus?: SelectionStatus;
1976
1976
  /**
1977
- * @public
1978
1977
  * <p>Information about where the following items are located on a document page: detected
1979
1978
  * page, text, key-value pairs, tables, table cells, and selection elements.</p>
1979
+ * @public
1980
1980
  */
1981
1981
  Geometry?: Geometry;
1982
1982
  /**
1983
- * @public
1984
1983
  * <p>The confidence level for the text of a detected value in a lending document.</p>
1984
+ * @public
1985
1985
  */
1986
1986
  Confidence?: number;
1987
1987
  }
1988
1988
  /**
1989
- * @public
1990
1989
  * <p>Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and geometry.</p>
1990
+ * @public
1991
1991
  */
1992
1992
  export interface LendingField {
1993
1993
  /**
1994
- * @public
1995
1994
  * <p>The type of the lending document.</p>
1995
+ * @public
1996
1996
  */
1997
1997
  Type?: string;
1998
1998
  /**
1999
- * @public
2000
1999
  * <p>The results extracted for a lending document.</p>
2000
+ * @public
2001
2001
  */
2002
2002
  KeyDetection?: LendingDetection;
2003
2003
  /**
2004
- * @public
2005
2004
  * <p>An array of LendingDetection objects.</p>
2005
+ * @public
2006
2006
  */
2007
2007
  ValueDetections?: LendingDetection[];
2008
2008
  }
2009
2009
  /**
2010
- * @public
2011
2010
  * <p>Information regarding a detected signature on a page.</p>
2011
+ * @public
2012
2012
  */
2013
2013
  export interface SignatureDetection {
2014
2014
  /**
2015
- * @public
2016
2015
  * <p>The confidence, from 0 to 100, in the predicted values for a detected signature.</p>
2016
+ * @public
2017
2017
  */
2018
2018
  Confidence?: number;
2019
2019
  /**
2020
- * @public
2021
2020
  * <p>Information about where the following items are located on a document page: detected
2022
2021
  * page, text, key-value pairs, tables, table cells, and selection elements.</p>
2022
+ * @public
2023
2023
  */
2024
2024
  Geometry?: Geometry;
2025
2025
  }
2026
2026
  /**
2027
- * @public
2028
2027
  * <p>Holds the structured data returned by AnalyzeDocument for lending documents.</p>
2028
+ * @public
2029
2029
  */
2030
2030
  export interface LendingDocument {
2031
2031
  /**
2032
- * @public
2033
2032
  * <p>An array of LendingField objects.</p>
2033
+ * @public
2034
2034
  */
2035
2035
  LendingFields?: LendingField[];
2036
2036
  /**
2037
- * @public
2038
2037
  * <p>A list of signatures detected in a lending document.</p>
2038
+ * @public
2039
2039
  */
2040
2040
  SignatureDetections?: SignatureDetection[];
2041
2041
  }
2042
2042
  /**
2043
- * @public
2044
2043
  * <p>Contains information extracted by an analysis operation after using StartLendingAnalysis.</p>
2044
+ * @public
2045
2045
  */
2046
2046
  export interface Extraction {
2047
2047
  /**
2048
- * @public
2049
2048
  * <p>Holds the structured data returned by AnalyzeDocument for lending documents.</p>
2049
+ * @public
2050
2050
  */
2051
2051
  LendingDocument?: LendingDocument;
2052
2052
  /**
2053
- * @public
2054
2053
  * <p>The structure holding all the information returned by AnalyzeExpense</p>
2054
+ * @public
2055
2055
  */
2056
2056
  ExpenseDocument?: ExpenseDocument;
2057
2057
  /**
2058
- * @public
2059
2058
  * <p>The structure that lists each document processed in an AnalyzeID operation.</p>
2059
+ * @public
2060
2060
  */
2061
2061
  IdentityDocument?: IdentityDocument;
2062
2062
  }
@@ -2065,8 +2065,8 @@ export interface Extraction {
2065
2065
  */
2066
2066
  export interface GetAdapterRequest {
2067
2067
  /**
2068
- * @public
2069
2068
  * <p>A string containing a unique ID for the adapter.</p>
2069
+ * @public
2070
2070
  */
2071
2071
  AdapterId: string | undefined;
2072
2072
  }
@@ -2075,38 +2075,38 @@ export interface GetAdapterRequest {
2075
2075
  */
2076
2076
  export interface GetAdapterResponse {
2077
2077
  /**
2078
- * @public
2079
2078
  * <p>A string identifying the adapter that information has been retrieved for.</p>
2079
+ * @public
2080
2080
  */
2081
2081
  AdapterId?: string;
2082
2082
  /**
2083
- * @public
2084
2083
  * <p>The name of the requested adapter.</p>
2084
+ * @public
2085
2085
  */
2086
2086
  AdapterName?: string;
2087
2087
  /**
2088
- * @public
2089
2088
  * <p>The date and time the requested adapter was created at.</p>
2089
+ * @public
2090
2090
  */
2091
2091
  CreationTime?: Date;
2092
2092
  /**
2093
- * @public
2094
2093
  * <p>The description for the requested adapter.</p>
2094
+ * @public
2095
2095
  */
2096
2096
  Description?: string;
2097
2097
  /**
2098
- * @public
2099
2098
  * <p>List of the targeted feature types for the requested adapter.</p>
2099
+ * @public
2100
2100
  */
2101
2101
  FeatureTypes?: FeatureType[];
2102
2102
  /**
2103
- * @public
2104
2103
  * <p>Binary value indicating if the adapter is being automatically updated or not.</p>
2104
+ * @public
2105
2105
  */
2106
2106
  AutoUpdate?: AutoUpdate;
2107
2107
  /**
2108
- * @public
2109
2108
  * <p>A set of tags (key-value pairs) associated with the adapter that has been retrieved.</p>
2109
+ * @public
2110
2110
  */
2111
2111
  Tags?: Record<string, string>;
2112
2112
  }
@@ -2115,13 +2115,13 @@ export interface GetAdapterResponse {
2115
2115
  */
2116
2116
  export interface GetAdapterVersionRequest {
2117
2117
  /**
2118
- * @public
2119
2118
  * <p>A string specifying a unique ID for the adapter version you want to retrieve information for.</p>
2119
+ * @public
2120
2120
  */
2121
2121
  AdapterId: string | undefined;
2122
2122
  /**
2123
- * @public
2124
2123
  * <p>A string specifying the adapter version you want to retrieve information for.</p>
2124
+ * @public
2125
2125
  */
2126
2126
  AdapterVersion: string | undefined;
2127
2127
  }
@@ -2130,48 +2130,47 @@ export interface GetAdapterVersionRequest {
2130
2130
  */
2131
2131
  export interface GetAdapterVersionResponse {
2132
2132
  /**
2133
- * @public
2134
2133
  * <p>A string containing a unique ID for the adapter version being retrieved.</p>
2134
+ * @public
2135
2135
  */
2136
2136
  AdapterId?: string;
2137
2137
  /**
2138
- * @public
2139
2138
  * <p>A string containing the adapter version that has been retrieved.</p>
2139
+ * @public
2140
2140
  */
2141
2141
  AdapterVersion?: string;
2142
2142
  /**
2143
- * @public
2144
2143
  * <p>The time that the adapter version was created.</p>
2144
+ * @public
2145
2145
  */
2146
2146
  CreationTime?: Date;
2147
2147
  /**
2148
- * @public
2149
2148
  * <p>List of the targeted feature types for the requested adapter version.</p>
2149
+ * @public
2150
2150
  */
2151
2151
  FeatureTypes?: FeatureType[];
2152
2152
  /**
2153
- * @public
2154
2153
  * <p>The status of the adapter version that has been requested.</p>
2154
+ * @public
2155
2155
  */
2156
2156
  Status?: AdapterVersionStatus;
2157
2157
  /**
2158
- * @public
2159
2158
  * <p>A message that describes the status of the requested adapter version.</p>
2159
+ * @public
2160
2160
  */
2161
2161
  StatusMessage?: string;
2162
2162
  /**
2163
- * @public
2164
2163
  * <p>Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the
2165
2164
  * value.</p>
2165
+ * @public
2166
2166
  */
2167
2167
  DatasetConfig?: AdapterVersionDatasetConfig;
2168
2168
  /**
2169
- * @public
2170
2169
  * <p>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.</p>
2170
+ * @public
2171
2171
  */
2172
2172
  KMSKeyId?: string;
2173
2173
  /**
2174
- * @public
2175
2174
  * <p>Sets whether or not your output will go to a user created bucket. Used to set the name
2176
2175
  * of the bucket, and the prefix on the output file.</p>
2177
2176
  * <p>
@@ -2189,17 +2188,18 @@ export interface GetAdapterVersionResponse {
2189
2188
  * <p>For more information on data privacy,
2190
2189
  * see the <a href="https://aws.amazon.com/compliance/data-privacy-faq/">Data Privacy
2191
2190
  * FAQ</a>.</p>
2191
+ * @public
2192
2192
  */
2193
2193
  OutputConfig?: OutputConfig;
2194
2194
  /**
2195
- * @public
2196
2195
  * <p>The evaluation metrics (F1 score, Precision, and Recall) for the requested version,
2197
2196
  * grouped by baseline metrics and adapter version.</p>
2197
+ * @public
2198
2198
  */
2199
2199
  EvaluationMetrics?: AdapterVersionEvaluationMetric[];
2200
2200
  /**
2201
- * @public
2202
2201
  * <p>A set of tags (key-value pairs) that are associated with the adapter version.</p>
2202
+ * @public
2203
2203
  */
2204
2204
  Tags?: Record<string, string>;
2205
2205
  }
@@ -2208,24 +2208,24 @@ export interface GetAdapterVersionResponse {
2208
2208
  */
2209
2209
  export interface GetDocumentAnalysisRequest {
2210
2210
  /**
2211
- * @public
2212
2211
  * <p>A unique identifier for the text-detection job. The <code>JobId</code> is returned from
2213
2212
  * <code>StartDocumentAnalysis</code>. A <code>JobId</code> value is only valid for 7
2214
2213
  * days.</p>
2214
+ * @public
2215
2215
  */
2216
2216
  JobId: string | undefined;
2217
2217
  /**
2218
- * @public
2219
2218
  * <p>The maximum number of results to return per paginated call. The largest value that you
2220
2219
  * can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results
2221
2220
  * is returned. The default value is 1,000.</p>
2221
+ * @public
2222
2222
  */
2223
2223
  MaxResults?: number;
2224
2224
  /**
2225
- * @public
2226
2225
  * <p>If the previous response was incomplete (because there are more blocks to retrieve),
2227
2226
  * Amazon Textract returns a pagination token in the response. You can use this pagination
2228
2227
  * token to retrieve the next set of blocks.</p>
2228
+ * @public
2229
2229
  */
2230
2230
  NextToken?: string;
2231
2231
  }
@@ -2244,18 +2244,18 @@ export declare const JobStatus: {
2244
2244
  */
2245
2245
  export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
2246
2246
  /**
2247
- * @public
2248
2247
  * <p>A warning about an issue that occurred during asynchronous text analysis (<a>StartDocumentAnalysis</a>) or asynchronous document text detection (<a>StartDocumentTextDetection</a>). </p>
2248
+ * @public
2249
2249
  */
2250
2250
  export interface Warning {
2251
2251
  /**
2252
- * @public
2253
2252
  * <p>The error code for the warning.</p>
2253
+ * @public
2254
2254
  */
2255
2255
  ErrorCode?: string;
2256
2256
  /**
2257
- * @public
2258
2257
  * <p>A list of the pages that the warning applies to.</p>
2258
+ * @public
2259
2259
  */
2260
2260
  Pages?: number[];
2261
2261
  }
@@ -2264,48 +2264,48 @@ export interface Warning {
2264
2264
  */
2265
2265
  export interface GetDocumentAnalysisResponse {
2266
2266
  /**
2267
- * @public
2268
2267
  * <p>Information about a document that Amazon Textract processed.
2269
2268
  * <code>DocumentMetadata</code> is returned in every page of paginated responses from an
2270
2269
  * Amazon Textract video operation.</p>
2270
+ * @public
2271
2271
  */
2272
2272
  DocumentMetadata?: DocumentMetadata;
2273
2273
  /**
2274
- * @public
2275
2274
  * <p>The current status of the text detection job.</p>
2275
+ * @public
2276
2276
  */
2277
2277
  JobStatus?: JobStatus;
2278
2278
  /**
2279
- * @public
2280
2279
  * <p>If the response is truncated, Amazon Textract returns this token. You can use this token
2281
2280
  * in the subsequent request to retrieve the next set of text detection results.</p>
2281
+ * @public
2282
2282
  */
2283
2283
  NextToken?: string;
2284
2284
  /**
2285
- * @public
2286
2285
  * <p>The results of the text-analysis operation.</p>
2286
+ * @public
2287
2287
  */
2288
2288
  Blocks?: Block[];
2289
2289
  /**
2290
- * @public
2291
2290
  * <p>A list of warnings that occurred during the document-analysis operation.</p>
2291
+ * @public
2292
2292
  */
2293
2293
  Warnings?: Warning[];
2294
2294
  /**
2295
- * @public
2296
2295
  * <p>Returns if the detection job could not be completed. Contains explanation for what error
2297
2296
  * occured.</p>
2297
+ * @public
2298
2298
  */
2299
2299
  StatusMessage?: string;
2300
2300
  /**
2301
- * @public
2302
2301
  * <p></p>
2302
+ * @public
2303
2303
  */
2304
2304
  AnalyzeDocumentModelVersion?: string;
2305
2305
  }
2306
2306
  /**
2307
- * @public
2308
2307
  * <p>An invalid job identifier was passed to an asynchronous analysis operation.</p>
2308
+ * @public
2309
2309
  */
2310
2310
  export declare class InvalidJobIdException extends __BaseException {
2311
2311
  readonly name: "InvalidJobIdException";
@@ -2322,22 +2322,22 @@ export declare class InvalidJobIdException extends __BaseException {
2322
2322
  */
2323
2323
  export interface GetDocumentTextDetectionRequest {
2324
2324
  /**
2325
- * @public
2326
2325
  * <p>A unique identifier for the text detection job. The <code>JobId</code> is returned from
2327
2326
  * <code>StartDocumentTextDetection</code>. A <code>JobId</code> value is only valid for 7 days.</p>
2327
+ * @public
2328
2328
  */
2329
2329
  JobId: string | undefined;
2330
2330
  /**
2331
- * @public
2332
2331
  * <p>The maximum number of results to return per paginated call. The largest value you can
2333
2332
  * specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is
2334
2333
  * returned. The default value is 1,000.</p>
2334
+ * @public
2335
2335
  */
2336
2336
  MaxResults?: number;
2337
2337
  /**
2338
- * @public
2339
2338
  * <p>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination
2340
2339
  * token in the response. You can use this pagination token to retrieve the next set of blocks.</p>
2340
+ * @public
2341
2341
  */
2342
2342
  NextToken?: string;
2343
2343
  }
@@ -2346,41 +2346,41 @@ export interface GetDocumentTextDetectionRequest {
2346
2346
  */
2347
2347
  export interface GetDocumentTextDetectionResponse {
2348
2348
  /**
2349
- * @public
2350
2349
  * <p>Information about a document that Amazon Textract processed. <code>DocumentMetadata</code> is
2351
2350
  * returned in every page of paginated responses from an Amazon Textract video operation.</p>
2351
+ * @public
2352
2352
  */
2353
2353
  DocumentMetadata?: DocumentMetadata;
2354
2354
  /**
2355
- * @public
2356
2355
  * <p>The current status of the text detection job.</p>
2356
+ * @public
2357
2357
  */
2358
2358
  JobStatus?: JobStatus;
2359
2359
  /**
2360
- * @public
2361
2360
  * <p>If the response is truncated, Amazon Textract returns this token. You can use this token in
2362
2361
  * the subsequent request to retrieve the next set of text-detection results.</p>
2362
+ * @public
2363
2363
  */
2364
2364
  NextToken?: string;
2365
2365
  /**
2366
- * @public
2367
2366
  * <p>The results of the text-detection operation.</p>
2367
+ * @public
2368
2368
  */
2369
2369
  Blocks?: Block[];
2370
2370
  /**
2371
- * @public
2372
2371
  * <p>A list of warnings that occurred during the text-detection operation for the
2373
2372
  * document.</p>
2373
+ * @public
2374
2374
  */
2375
2375
  Warnings?: Warning[];
2376
2376
  /**
2377
- * @public
2378
2377
  * <p>Returns if the detection job could not be completed. Contains explanation for what error occured. </p>
2378
+ * @public
2379
2379
  */
2380
2380
  StatusMessage?: string;
2381
2381
  /**
2382
- * @public
2383
2382
  * <p></p>
2383
+ * @public
2384
2384
  */
2385
2385
  DetectDocumentTextModelVersion?: string;
2386
2386
  }
@@ -2389,22 +2389,22 @@ export interface GetDocumentTextDetectionResponse {
2389
2389
  */
2390
2390
  export interface GetExpenseAnalysisRequest {
2391
2391
  /**
2392
- * @public
2393
2392
  * <p>A unique identifier for the text detection job. The <code>JobId</code> is returned from
2394
2393
  * <code>StartExpenseAnalysis</code>. A <code>JobId</code> value is only valid for 7 days.</p>
2394
+ * @public
2395
2395
  */
2396
2396
  JobId: string | undefined;
2397
2397
  /**
2398
- * @public
2399
2398
  * <p>The maximum number of results to return per paginated call. The largest value you can
2400
2399
  * specify is 20. If you specify a value greater than 20, a maximum of 20 results is
2401
2400
  * returned. The default value is 20.</p>
2401
+ * @public
2402
2402
  */
2403
2403
  MaxResults?: number;
2404
2404
  /**
2405
- * @public
2406
2405
  * <p>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination
2407
2406
  * token in the response. You can use this pagination token to retrieve the next set of blocks.</p>
2407
+ * @public
2408
2408
  */
2409
2409
  NextToken?: string;
2410
2410
  }
@@ -2413,41 +2413,41 @@ export interface GetExpenseAnalysisRequest {
2413
2413
  */
2414
2414
  export interface GetExpenseAnalysisResponse {
2415
2415
  /**
2416
- * @public
2417
2416
  * <p>Information about a document that Amazon Textract processed. <code>DocumentMetadata</code> is
2418
2417
  * returned in every page of paginated responses from an Amazon Textract operation.</p>
2418
+ * @public
2419
2419
  */
2420
2420
  DocumentMetadata?: DocumentMetadata;
2421
2421
  /**
2422
- * @public
2423
2422
  * <p>The current status of the text detection job.</p>
2423
+ * @public
2424
2424
  */
2425
2425
  JobStatus?: JobStatus;
2426
2426
  /**
2427
- * @public
2428
2427
  * <p>If the response is truncated, Amazon Textract returns this token. You can use this token in
2429
2428
  * the subsequent request to retrieve the next set of text-detection results.</p>
2429
+ * @public
2430
2430
  */
2431
2431
  NextToken?: string;
2432
2432
  /**
2433
- * @public
2434
2433
  * <p>The expenses detected by Amazon Textract.</p>
2434
+ * @public
2435
2435
  */
2436
2436
  ExpenseDocuments?: ExpenseDocument[];
2437
2437
  /**
2438
- * @public
2439
2438
  * <p>A list of warnings that occurred during the text-detection operation for the
2440
2439
  * document.</p>
2440
+ * @public
2441
2441
  */
2442
2442
  Warnings?: Warning[];
2443
2443
  /**
2444
- * @public
2445
2444
  * <p>Returns if the detection job could not be completed. Contains explanation for what error occured. </p>
2445
+ * @public
2446
2446
  */
2447
2447
  StatusMessage?: string;
2448
2448
  /**
2449
- * @public
2450
2449
  * <p>The current model version of AnalyzeExpense.</p>
2450
+ * @public
2451
2451
  */
2452
2452
  AnalyzeExpenseModelVersion?: string;
2453
2453
  }
@@ -2456,81 +2456,81 @@ export interface GetExpenseAnalysisResponse {
2456
2456
  */
2457
2457
  export interface GetLendingAnalysisRequest {
2458
2458
  /**
2459
- * @public
2460
2459
  * <p>A unique identifier for the lending or text-detection job. The <code>JobId</code> is
2461
2460
  * returned from <code>StartLendingAnalysis</code>. A <code>JobId</code> value is only
2462
2461
  * valid for 7 days.</p>
2462
+ * @public
2463
2463
  */
2464
2464
  JobId: string | undefined;
2465
2465
  /**
2466
- * @public
2467
2466
  * <p>The maximum number of results to return per paginated call. The largest value that you
2468
2467
  * can specify is 30. If you specify a value greater than 30, a maximum of 30 results is
2469
2468
  * returned. The default value is 30.</p>
2469
+ * @public
2470
2470
  */
2471
2471
  MaxResults?: number;
2472
2472
  /**
2473
- * @public
2474
2473
  * <p>If the previous response was incomplete, Amazon Textract returns a pagination token in
2475
2474
  * the response. You can use this pagination token to retrieve the next set of lending
2476
2475
  * results.</p>
2476
+ * @public
2477
2477
  */
2478
2478
  NextToken?: string;
2479
2479
  }
2480
2480
  /**
2481
- * @public
2482
2481
  * <p>Contains information regarding predicted values returned by Amazon Textract operations, including the
2483
2482
  * predicted value and the confidence in the predicted value.</p>
2483
+ * @public
2484
2484
  */
2485
2485
  export interface Prediction {
2486
2486
  /**
2487
- * @public
2488
2487
  * <p>The predicted value of a detected object.</p>
2488
+ * @public
2489
2489
  */
2490
2490
  Value?: string;
2491
2491
  /**
2492
- * @public
2493
2492
  * <p>Amazon Textract's confidence in its predicted value.</p>
2493
+ * @public
2494
2494
  */
2495
2495
  Confidence?: number;
2496
2496
  }
2497
2497
  /**
2498
- * @public
2499
2498
  * <p>The class assigned to a Page object detected in an input document.
2500
2499
  * Contains information regarding the predicted type/class of a document's page and the
2501
2500
  * page number that the Page object was detected on.</p>
2501
+ * @public
2502
2502
  */
2503
2503
  export interface PageClassification {
2504
2504
  /**
2505
- * @public
2506
2505
  * <p>The class, or document type, assigned to a detected Page object. The class, or document type,
2507
2506
  * assigned to a detected Page object.</p>
2507
+ * @public
2508
2508
  */
2509
2509
  PageType: Prediction[] | undefined;
2510
2510
  /**
2511
- * @public
2512
2511
  * <p> The page number the value was detected on, relative to Amazon Textract's starting position.</p>
2512
+ * @public
2513
2513
  */
2514
2514
  PageNumber: Prediction[] | undefined;
2515
2515
  }
2516
2516
  /**
2517
- * @public
2518
2517
  * <p>Contains the detections for each page analyzed through the Analyze Lending API.</p>
2518
+ * @public
2519
2519
  */
2520
2520
  export interface LendingResult {
2521
2521
  /**
2522
- * @public
2523
2522
  * <p>The page number for a page, with regard to whole submission.</p>
2523
+ * @public
2524
2524
  */
2525
2525
  Page?: number;
2526
2526
  /**
2527
- * @public
2528
2527
  * <p>The classifier result for a given page.</p>
2528
+ * @public
2529
2529
  */
2530
2530
  PageClassification?: PageClassification;
2531
2531
  /**
2532
- * @public
2533
2532
  * <p>An array of Extraction to hold structured data. e.g. normalized key value pairs instead of raw OCR detections .</p>
2533
+ * @public
2534
2534
  */
2535
2535
  Extractions?: Extraction[];
2536
2536
  }
@@ -2539,41 +2539,41 @@ export interface LendingResult {
2539
2539
  */
2540
2540
  export interface GetLendingAnalysisResponse {
2541
2541
  /**
2542
- * @public
2543
2542
  * <p>Information about the input document.</p>
2543
+ * @public
2544
2544
  */
2545
2545
  DocumentMetadata?: DocumentMetadata;
2546
2546
  /**
2547
- * @public
2548
2547
  * <p> The current status of the lending analysis job.</p>
2548
+ * @public
2549
2549
  */
2550
2550
  JobStatus?: JobStatus;
2551
2551
  /**
2552
- * @public
2553
2552
  * <p>If the response is truncated, Amazon Textract returns this token.
2554
2553
  * You can use this token in the subsequent request to retrieve the next set of lending results.</p>
2554
+ * @public
2555
2555
  */
2556
2556
  NextToken?: string;
2557
2557
  /**
2558
- * @public
2559
2558
  * <p> Holds the information returned by one of AmazonTextract's document analysis
2560
2559
  * operations for the pinstripe.</p>
2560
+ * @public
2561
2561
  */
2562
2562
  Results?: LendingResult[];
2563
2563
  /**
2564
- * @public
2565
2564
  * <p> A list of warnings that occurred during the lending analysis operation. </p>
2565
+ * @public
2566
2566
  */
2567
2567
  Warnings?: Warning[];
2568
2568
  /**
2569
- * @public
2570
2569
  * <p> Returns if the lending analysis job could not be completed. Contains explanation for
2571
2570
  * what error occurred. </p>
2571
+ * @public
2572
2572
  */
2573
2573
  StatusMessage?: string;
2574
2574
  /**
2575
- * @public
2576
2575
  * <p> The current model version of the Analyze Lending API.</p>
2576
+ * @public
2577
2577
  */
2578
2578
  AnalyzeLendingModelVersion?: string;
2579
2579
  }
@@ -2582,25 +2582,25 @@ export interface GetLendingAnalysisResponse {
2582
2582
  */
2583
2583
  export interface GetLendingAnalysisSummaryRequest {
2584
2584
  /**
2585
- * @public
2586
2585
  * <p> A unique identifier for the lending or text-detection job. The <code>JobId</code> is
2587
2586
  * returned from StartLendingAnalysis. A <code>JobId</code> value is only valid for 7 days.</p>
2587
+ * @public
2588
2588
  */
2589
2589
  JobId: string | undefined;
2590
2590
  }
2591
2591
  /**
2592
- * @public
2593
2592
  * <p>Contains information regarding DocumentGroups and UndetectedDocumentTypes.</p>
2593
+ * @public
2594
2594
  */
2595
2595
  export interface LendingSummary {
2596
2596
  /**
2597
- * @public
2598
2597
  * <p>Contains an array of all DocumentGroup objects.</p>
2598
+ * @public
2599
2599
  */
2600
2600
  DocumentGroups?: DocumentGroup[];
2601
2601
  /**
2602
- * @public
2603
2602
  * <p>UndetectedDocumentTypes.</p>
2603
+ * @public
2604
2604
  */
2605
2605
  UndetectedDocumentTypes?: string[];
2606
2606
  }
@@ -2609,34 +2609,34 @@ export interface LendingSummary {
2609
2609
  */
2610
2610
  export interface GetLendingAnalysisSummaryResponse {
2611
2611
  /**
2612
- * @public
2613
2612
  * <p>Information about the input document.</p>
2613
+ * @public
2614
2614
  */
2615
2615
  DocumentMetadata?: DocumentMetadata;
2616
2616
  /**
2617
- * @public
2618
2617
  * <p> The current status of the lending analysis job. </p>
2618
+ * @public
2619
2619
  */
2620
2620
  JobStatus?: JobStatus;
2621
2621
  /**
2622
- * @public
2623
2622
  * <p> Contains summary information for documents grouped by type.</p>
2623
+ * @public
2624
2624
  */
2625
2625
  Summary?: LendingSummary;
2626
2626
  /**
2627
- * @public
2628
2627
  * <p>A list of warnings that occurred during the lending analysis operation.</p>
2628
+ * @public
2629
2629
  */
2630
2630
  Warnings?: Warning[];
2631
2631
  /**
2632
- * @public
2633
2632
  * <p>Returns if the lending analysis could not be completed. Contains explanation for what error
2634
2633
  * occurred.</p>
2634
+ * @public
2635
2635
  */
2636
2636
  StatusMessage?: string;
2637
2637
  /**
2638
- * @public
2639
2638
  * <p>The current model version of the Analyze Lending API.</p>
2639
+ * @public
2640
2640
  */
2641
2641
  AnalyzeLendingModelVersion?: string;
2642
2642
  }
@@ -2645,25 +2645,25 @@ export interface GetLendingAnalysisSummaryResponse {
2645
2645
  */
2646
2646
  export interface ListAdaptersRequest {
2647
2647
  /**
2648
- * @public
2649
2648
  * <p>Specifies the lower bound for the ListAdapters operation.
2650
2649
  * Ensures ListAdapters returns only adapters created after the specified creation time.</p>
2650
+ * @public
2651
2651
  */
2652
2652
  AfterCreationTime?: Date;
2653
2653
  /**
2654
- * @public
2655
2654
  * <p>Specifies the upper bound for the ListAdapters operation.
2656
2655
  * Ensures ListAdapters returns only adapters created before the specified creation time.</p>
2656
+ * @public
2657
2657
  */
2658
2658
  BeforeCreationTime?: Date;
2659
2659
  /**
2660
- * @public
2661
2660
  * <p>The maximum number of results to return when listing adapters.</p>
2661
+ * @public
2662
2662
  */
2663
2663
  MaxResults?: number;
2664
2664
  /**
2665
- * @public
2666
2665
  * <p>Identifies the next page of results to return when listing adapters.</p>
2666
+ * @public
2667
2667
  */
2668
2668
  NextToken?: string;
2669
2669
  }
@@ -2672,13 +2672,13 @@ export interface ListAdaptersRequest {
2672
2672
  */
2673
2673
  export interface ListAdaptersResponse {
2674
2674
  /**
2675
- * @public
2676
2675
  * <p>A list of adapters that matches the filtering criteria specified when calling ListAdapters.</p>
2676
+ * @public
2677
2677
  */
2678
2678
  Adapters?: AdapterOverview[];
2679
2679
  /**
2680
- * @public
2681
2680
  * <p>Identifies the next page of results to return when listing adapters.</p>
2681
+ * @public
2682
2682
  */
2683
2683
  NextToken?: string;
2684
2684
  }
@@ -2687,30 +2687,30 @@ export interface ListAdaptersResponse {
2687
2687
  */
2688
2688
  export interface ListAdapterVersionsRequest {
2689
2689
  /**
2690
- * @public
2691
2690
  * <p>A string containing a unique ID for the adapter to match for when listing adapter versions.</p>
2691
+ * @public
2692
2692
  */
2693
2693
  AdapterId?: string;
2694
2694
  /**
2695
- * @public
2696
2695
  * <p>Specifies the lower bound for the ListAdapterVersions operation.
2697
2696
  * Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.</p>
2697
+ * @public
2698
2698
  */
2699
2699
  AfterCreationTime?: Date;
2700
2700
  /**
2701
- * @public
2702
2701
  * <p>Specifies the upper bound for the ListAdapterVersions operation.
2703
2702
  * Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.</p>
2703
+ * @public
2704
2704
  */
2705
2705
  BeforeCreationTime?: Date;
2706
2706
  /**
2707
- * @public
2708
2707
  * <p>The maximum number of results to return when listing adapter versions.</p>
2708
+ * @public
2709
2709
  */
2710
2710
  MaxResults?: number;
2711
2711
  /**
2712
- * @public
2713
2712
  * <p>Identifies the next page of results to return when listing adapter versions.</p>
2713
+ * @public
2714
2714
  */
2715
2715
  NextToken?: string;
2716
2716
  }
@@ -2719,13 +2719,13 @@ export interface ListAdapterVersionsRequest {
2719
2719
  */
2720
2720
  export interface ListAdapterVersionsResponse {
2721
2721
  /**
2722
- * @public
2723
2722
  * <p>Adapter versions that match the filtering criteria specified when calling ListAdapters.</p>
2723
+ * @public
2724
2724
  */
2725
2725
  AdapterVersions?: AdapterVersionOverview[];
2726
2726
  /**
2727
- * @public
2728
2727
  * <p>Identifies the next page of results to return when listing adapter versions.</p>
2728
+ * @public
2729
2729
  */
2730
2730
  NextToken?: string;
2731
2731
  }
@@ -2734,8 +2734,8 @@ export interface ListAdapterVersionsResponse {
2734
2734
  */
2735
2735
  export interface ListTagsForResourceRequest {
2736
2736
  /**
2737
- * @public
2738
2737
  * <p>The Amazon Resource Name (ARN) that specifies the resource to list tags for.</p>
2738
+ * @public
2739
2739
  */
2740
2740
  ResourceARN: string | undefined;
2741
2741
  }
@@ -2744,25 +2744,25 @@ export interface ListTagsForResourceRequest {
2744
2744
  */
2745
2745
  export interface ListTagsForResourceResponse {
2746
2746
  /**
2747
- * @public
2748
2747
  * <p>A set of tags (key-value pairs) that are part of the requested resource.</p>
2748
+ * @public
2749
2749
  */
2750
2750
  Tags?: Record<string, string>;
2751
2751
  }
2752
2752
  /**
2753
- * @public
2754
2753
  * <p>The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of
2755
2754
  * an asynchronous document operation. </p>
2755
+ * @public
2756
2756
  */
2757
2757
  export interface NotificationChannel {
2758
2758
  /**
2759
- * @public
2760
2759
  * <p>The Amazon SNS topic that Amazon Textract posts the completion status to.</p>
2760
+ * @public
2761
2761
  */
2762
2762
  SNSTopicArn: string | undefined;
2763
2763
  /**
2764
- * @public
2765
2764
  * <p>The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic. </p>
2765
+ * @public
2766
2766
  */
2767
2767
  RoleArn: string | undefined;
2768
2768
  }
@@ -2771,66 +2771,66 @@ export interface NotificationChannel {
2771
2771
  */
2772
2772
  export interface StartDocumentAnalysisRequest {
2773
2773
  /**
2774
- * @public
2775
2774
  * <p>The location of the document to be processed.</p>
2775
+ * @public
2776
2776
  */
2777
2777
  DocumentLocation: DocumentLocation | undefined;
2778
2778
  /**
2779
- * @public
2780
2779
  * <p>A list of the types of analysis to perform. Add TABLES to the list to return information
2781
2780
  * about the tables that are detected in the input document. Add FORMS to return detected
2782
2781
  * form data. To perform both types of analysis, add TABLES
2783
2782
  * and FORMS to <code>FeatureTypes</code>. All lines and words detected in the document are
2784
2783
  * included in the response (including text that isn't related to the value of
2785
2784
  * <code>FeatureTypes</code>). </p>
2785
+ * @public
2786
2786
  */
2787
2787
  FeatureTypes: FeatureType[] | undefined;
2788
2788
  /**
2789
- * @public
2790
2789
  * <p>The idempotent token that you use to identify the start request. If you use the same
2791
2790
  * token with multiple <code>StartDocumentAnalysis</code> requests, the same
2792
2791
  * <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same
2793
2792
  * job from being accidentally started more than once. For more information, see
2794
2793
  * <a href="https://docs.aws.amazon.com/textract/latest/dg/api-async.html">Calling Amazon Textract Asynchronous Operations</a>.</p>
2794
+ * @public
2795
2795
  */
2796
2796
  ClientRequestToken?: string;
2797
2797
  /**
2798
- * @public
2799
2798
  * <p>An identifier that you specify that's included in the completion notification published
2800
2799
  * to the Amazon SNS topic. For example, you can use <code>JobTag</code> to identify the type of
2801
2800
  * document that the completion notification corresponds to (such as a tax form or a
2802
2801
  * receipt).</p>
2802
+ * @public
2803
2803
  */
2804
2804
  JobTag?: string;
2805
2805
  /**
2806
- * @public
2807
2806
  * <p>The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the
2808
2807
  * operation to. </p>
2808
+ * @public
2809
2809
  */
2810
2810
  NotificationChannel?: NotificationChannel;
2811
2811
  /**
2812
- * @public
2813
2812
  * <p>Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save
2814
2813
  * the results internally to be accessed by the GetDocumentAnalysis operation.</p>
2814
+ * @public
2815
2815
  */
2816
2816
  OutputConfig?: OutputConfig;
2817
2817
  /**
2818
- * @public
2819
2818
  * <p>The KMS key used to encrypt the inference results. This can be
2820
2819
  * in either Key ID or Key Alias format. When a KMS key is provided, the
2821
2820
  * KMS key will be used for server-side encryption of the objects in the
2822
2821
  * customer bucket. When this parameter is not enabled, the result will
2823
2822
  * be encrypted server side,using SSE-S3.</p>
2823
+ * @public
2824
2824
  */
2825
2825
  KMSKeyId?: string;
2826
2826
  /**
2827
- * @public
2828
2827
  * <p></p>
2828
+ * @public
2829
2829
  */
2830
2830
  QueriesConfig?: QueriesConfig;
2831
2831
  /**
2832
- * @public
2833
2832
  * <p>Specifies the adapter to be used when analyzing a document.</p>
2833
+ * @public
2834
2834
  */
2835
2835
  AdaptersConfig?: AdaptersConfig;
2836
2836
  }
@@ -2839,10 +2839,10 @@ export interface StartDocumentAnalysisRequest {
2839
2839
  */
2840
2840
  export interface StartDocumentAnalysisResponse {
2841
2841
  /**
2842
- * @public
2843
2842
  * <p>The identifier for the document text detection job. Use <code>JobId</code> to identify
2844
2843
  * the job in a subsequent call to <code>GetDocumentAnalysis</code>. A <code>JobId</code> value
2845
2844
  * is only valid for 7 days.</p>
2845
+ * @public
2846
2846
  */
2847
2847
  JobId?: string;
2848
2848
  }
@@ -2851,46 +2851,46 @@ export interface StartDocumentAnalysisResponse {
2851
2851
  */
2852
2852
  export interface StartDocumentTextDetectionRequest {
2853
2853
  /**
2854
- * @public
2855
2854
  * <p>The location of the document to be processed.</p>
2855
+ * @public
2856
2856
  */
2857
2857
  DocumentLocation: DocumentLocation | undefined;
2858
2858
  /**
2859
- * @public
2860
2859
  * <p>The idempotent token that's used to identify the start request. If you use the same
2861
2860
  * token with multiple <code>StartDocumentTextDetection</code> requests, the same
2862
2861
  * <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same
2863
2862
  * job from being accidentally started more than once. For more information, see
2864
2863
  * <a href="https://docs.aws.amazon.com/textract/latest/dg/api-async.html">Calling Amazon Textract Asynchronous Operations</a>.</p>
2864
+ * @public
2865
2865
  */
2866
2866
  ClientRequestToken?: string;
2867
2867
  /**
2868
- * @public
2869
2868
  * <p>An identifier that you specify that's included in the completion notification published
2870
2869
  * to the Amazon SNS topic. For example, you can use <code>JobTag</code> to identify the type of
2871
2870
  * document that the completion notification corresponds to (such as a tax form or a
2872
2871
  * receipt).</p>
2872
+ * @public
2873
2873
  */
2874
2874
  JobTag?: string;
2875
2875
  /**
2876
- * @public
2877
2876
  * <p>The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the
2878
2877
  * operation to. </p>
2878
+ * @public
2879
2879
  */
2880
2880
  NotificationChannel?: NotificationChannel;
2881
2881
  /**
2882
- * @public
2883
2882
  * <p>Sets if the output will go to a customer defined bucket. By default Amazon Textract will
2884
2883
  * save the results internally to be accessed with the GetDocumentTextDetection operation.</p>
2884
+ * @public
2885
2885
  */
2886
2886
  OutputConfig?: OutputConfig;
2887
2887
  /**
2888
- * @public
2889
2888
  * <p>The KMS key used to encrypt the inference results. This can be
2890
2889
  * in either Key ID or Key Alias format. When a KMS key is provided, the
2891
2890
  * KMS key will be used for server-side encryption of the objects in the
2892
2891
  * customer bucket. When this parameter is not enabled, the result will
2893
2892
  * be encrypted server side,using SSE-S3.</p>
2893
+ * @public
2894
2894
  */
2895
2895
  KMSKeyId?: string;
2896
2896
  }
@@ -2899,10 +2899,10 @@ export interface StartDocumentTextDetectionRequest {
2899
2899
  */
2900
2900
  export interface StartDocumentTextDetectionResponse {
2901
2901
  /**
2902
- * @public
2903
2902
  * <p>The identifier of the text detection job for the document. Use <code>JobId</code> to
2904
2903
  * identify the job in a subsequent call to <code>GetDocumentTextDetection</code>.
2905
2904
  * A <code>JobId</code> value is only valid for 7 days.</p>
2905
+ * @public
2906
2906
  */
2907
2907
  JobId?: string;
2908
2908
  }
@@ -2911,46 +2911,46 @@ export interface StartDocumentTextDetectionResponse {
2911
2911
  */
2912
2912
  export interface StartExpenseAnalysisRequest {
2913
2913
  /**
2914
- * @public
2915
2914
  * <p>The location of the document to be processed.</p>
2915
+ * @public
2916
2916
  */
2917
2917
  DocumentLocation: DocumentLocation | undefined;
2918
2918
  /**
2919
- * @public
2920
2919
  * <p>The idempotent token that's used to identify the start request. If you use the same token with multiple <code>StartDocumentTextDetection</code> requests, the same <code>JobId</code> is returned.
2921
2920
  * Use <code>ClientRequestToken</code> to prevent the same job from being accidentally started more than once.
2922
2921
  * For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/api-async.html">Calling Amazon Textract Asynchronous Operations</a>
2923
2922
  * </p>
2923
+ * @public
2924
2924
  */
2925
2925
  ClientRequestToken?: string;
2926
2926
  /**
2927
- * @public
2928
2927
  * <p>An identifier you specify that's included in the completion notification published
2929
2928
  * to the Amazon SNS topic. For example, you can use <code>JobTag</code> to identify the type of
2930
2929
  * document that the completion notification corresponds to (such as a tax form or a
2931
2930
  * receipt).</p>
2931
+ * @public
2932
2932
  */
2933
2933
  JobTag?: string;
2934
2934
  /**
2935
- * @public
2936
2935
  * <p>The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the
2937
2936
  * operation to. </p>
2937
+ * @public
2938
2938
  */
2939
2939
  NotificationChannel?: NotificationChannel;
2940
2940
  /**
2941
- * @public
2942
2941
  * <p>Sets if the output will go to a customer defined bucket. By default, Amazon Textract will
2943
2942
  * save the results internally to be accessed by the <code>GetExpenseAnalysis</code>
2944
2943
  * operation.</p>
2944
+ * @public
2945
2945
  */
2946
2946
  OutputConfig?: OutputConfig;
2947
2947
  /**
2948
- * @public
2949
2948
  * <p>The KMS key used to encrypt the inference results. This can be
2950
2949
  * in either Key ID or Key Alias format. When a KMS key is provided, the
2951
2950
  * KMS key will be used for server-side encryption of the objects in the
2952
2951
  * customer bucket. When this parameter is not enabled, the result will
2953
2952
  * be encrypted server side,using SSE-S3.</p>
2953
+ * @public
2954
2954
  */
2955
2955
  KMSKeyId?: string;
2956
2956
  }
@@ -2959,9 +2959,9 @@ export interface StartExpenseAnalysisRequest {
2959
2959
  */
2960
2960
  export interface StartExpenseAnalysisResponse {
2961
2961
  /**
2962
- * @public
2963
2962
  * <p>A unique identifier for the text detection job. The <code>JobId</code> is returned from
2964
2963
  * <code>StartExpenseAnalysis</code>. A <code>JobId</code> value is only valid for 7 days.</p>
2964
+ * @public
2965
2965
  */
2966
2966
  JobId?: string;
2967
2967
  }
@@ -2970,37 +2970,36 @@ export interface StartExpenseAnalysisResponse {
2970
2970
  */
2971
2971
  export interface StartLendingAnalysisRequest {
2972
2972
  /**
2973
- * @public
2974
2973
  * <p>The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous
2975
2974
  * operations.</p>
2976
2975
  * <p>The input document can be an image file in JPEG or PNG format. It can also be a file in
2977
2976
  * PDF format.</p>
2977
+ * @public
2978
2978
  */
2979
2979
  DocumentLocation: DocumentLocation | undefined;
2980
2980
  /**
2981
- * @public
2982
2981
  * <p>The idempotent token that you use to identify the start request. If you use the same token
2983
2982
  * with multiple <code>StartLendingAnalysis</code> requests, the same <code>JobId</code> is
2984
2983
  * returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidentally
2985
2984
  * started more than once. For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/api-sync.html">Calling Amazon Textract Asynchronous Operations</a>.</p>
2985
+ * @public
2986
2986
  */
2987
2987
  ClientRequestToken?: string;
2988
2988
  /**
2989
- * @public
2990
2989
  * <p>An identifier that you specify to be included in the completion notification published to
2991
2990
  * the Amazon SNS topic. For example, you can use <code>JobTag</code> to identify the type of
2992
2991
  * document that the completion notification corresponds to (such as a tax form or a
2993
2992
  * receipt).</p>
2993
+ * @public
2994
2994
  */
2995
2995
  JobTag?: string;
2996
2996
  /**
2997
- * @public
2998
2997
  * <p>The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of
2999
2998
  * an asynchronous document operation. </p>
2999
+ * @public
3000
3000
  */
3001
3001
  NotificationChannel?: NotificationChannel;
3002
3002
  /**
3003
- * @public
3004
3003
  * <p>Sets whether or not your output will go to a user created bucket. Used to set the name
3005
3004
  * of the bucket, and the prefix on the output file.</p>
3006
3005
  * <p>
@@ -3018,14 +3017,15 @@ export interface StartLendingAnalysisRequest {
3018
3017
  * <p>For more information on data privacy,
3019
3018
  * see the <a href="https://aws.amazon.com/compliance/data-privacy-faq/">Data Privacy
3020
3019
  * FAQ</a>.</p>
3020
+ * @public
3021
3021
  */
3022
3022
  OutputConfig?: OutputConfig;
3023
3023
  /**
3024
- * @public
3025
3024
  * <p>The KMS key used to encrypt the inference results. This can be in either Key ID or Key
3026
3025
  * Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of
3027
3026
  * the objects in the customer bucket. When this parameter is not enabled, the result will be
3028
3027
  * encrypted server side, using SSE-S3. </p>
3028
+ * @public
3029
3029
  */
3030
3030
  KMSKeyId?: string;
3031
3031
  }
@@ -3034,10 +3034,10 @@ export interface StartLendingAnalysisRequest {
3034
3034
  */
3035
3035
  export interface StartLendingAnalysisResponse {
3036
3036
  /**
3037
- * @public
3038
3037
  * <p>A unique identifier for the lending or text-detection job. The <code>JobId</code> is
3039
3038
  * returned from <code>StartLendingAnalysis</code>. A <code>JobId</code> value is only valid for 7
3040
3039
  * days.</p>
3040
+ * @public
3041
3041
  */
3042
3042
  JobId?: string;
3043
3043
  }
@@ -3046,13 +3046,13 @@ export interface StartLendingAnalysisResponse {
3046
3046
  */
3047
3047
  export interface TagResourceRequest {
3048
3048
  /**
3049
- * @public
3050
3049
  * <p>The Amazon Resource Name (ARN) that specifies the resource to be tagged.</p>
3050
+ * @public
3051
3051
  */
3052
3052
  ResourceARN: string | undefined;
3053
3053
  /**
3054
- * @public
3055
3054
  * <p>A set of tags (key-value pairs) that you want to assign to the resource.</p>
3055
+ * @public
3056
3056
  */
3057
3057
  Tags: Record<string, string> | undefined;
3058
3058
  }
@@ -3066,13 +3066,13 @@ export interface TagResourceResponse {
3066
3066
  */
3067
3067
  export interface UntagResourceRequest {
3068
3068
  /**
3069
- * @public
3070
3069
  * <p>The Amazon Resource Name (ARN) that specifies the resource to be untagged.</p>
3070
+ * @public
3071
3071
  */
3072
3072
  ResourceARN: string | undefined;
3073
3073
  /**
3074
- * @public
3075
3074
  * <p>Specifies the tags to be removed from the resource specified by the ResourceARN.</p>
3075
+ * @public
3076
3076
  */
3077
3077
  TagKeys: string[] | undefined;
3078
3078
  }
@@ -3086,23 +3086,23 @@ export interface UntagResourceResponse {
3086
3086
  */
3087
3087
  export interface UpdateAdapterRequest {
3088
3088
  /**
3089
- * @public
3090
3089
  * <p>A string containing a unique ID for the adapter that will be updated.</p>
3090
+ * @public
3091
3091
  */
3092
3092
  AdapterId: string | undefined;
3093
3093
  /**
3094
- * @public
3095
3094
  * <p>The new description to be applied to the adapter.</p>
3095
+ * @public
3096
3096
  */
3097
3097
  Description?: string;
3098
3098
  /**
3099
- * @public
3100
3099
  * <p>The new name to be applied to the adapter.</p>
3100
+ * @public
3101
3101
  */
3102
3102
  AdapterName?: string;
3103
3103
  /**
3104
- * @public
3105
3104
  * <p>The new auto-update status to be applied to the adapter.</p>
3105
+ * @public
3106
3106
  */
3107
3107
  AutoUpdate?: AutoUpdate;
3108
3108
  }
@@ -3111,33 +3111,33 @@ export interface UpdateAdapterRequest {
3111
3111
  */
3112
3112
  export interface UpdateAdapterResponse {
3113
3113
  /**
3114
- * @public
3115
3114
  * <p>A string containing a unique ID for the adapter that has been updated.</p>
3115
+ * @public
3116
3116
  */
3117
3117
  AdapterId?: string;
3118
3118
  /**
3119
- * @public
3120
3119
  * <p>A string containing the name of the adapter that has been updated.</p>
3120
+ * @public
3121
3121
  */
3122
3122
  AdapterName?: string;
3123
3123
  /**
3124
- * @public
3125
3124
  * <p>An object specifying the creation time of the the adapter that has been updated.</p>
3125
+ * @public
3126
3126
  */
3127
3127
  CreationTime?: Date;
3128
3128
  /**
3129
- * @public
3130
3129
  * <p>A string containing the description of the adapter that has been updated.</p>
3130
+ * @public
3131
3131
  */
3132
3132
  Description?: string;
3133
3133
  /**
3134
- * @public
3135
3134
  * <p>List of the targeted feature types for the updated adapter.</p>
3135
+ * @public
3136
3136
  */
3137
3137
  FeatureTypes?: FeatureType[];
3138
3138
  /**
3139
- * @public
3140
3139
  * <p>The auto-update status of the adapter that has been updated.</p>
3140
+ * @public
3141
3141
  */
3142
3142
  AutoUpdate?: AutoUpdate;
3143
3143
  }