@aws-sdk/client-textract 3.687.0 → 3.692.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.
- package/dist-types/models/models_0.d.ts +293 -293
- package/dist-types/ts3.4/models/models_0.d.ts +296 -293
- package/package.json +35 -35
|
@@ -8,8 +8,8 @@ import { TextractServiceException as __BaseException } from "./TextractServiceEx
|
|
|
8
8
|
export declare class AccessDeniedException extends __BaseException {
|
|
9
9
|
readonly name: "AccessDeniedException";
|
|
10
10
|
readonly $fault: "client";
|
|
11
|
-
Message?: string;
|
|
12
|
-
Code?: string;
|
|
11
|
+
Message?: string | undefined;
|
|
12
|
+
Code?: string | undefined;
|
|
13
13
|
/**
|
|
14
14
|
* @internal
|
|
15
15
|
*/
|
|
@@ -50,7 +50,7 @@ export interface Adapter {
|
|
|
50
50
|
* </ul>
|
|
51
51
|
* @public
|
|
52
52
|
*/
|
|
53
|
-
Pages?: string[];
|
|
53
|
+
Pages?: string[] | undefined;
|
|
54
54
|
/**
|
|
55
55
|
* <p>A string that identifies the version of the adapter.</p>
|
|
56
56
|
* @public
|
|
@@ -81,22 +81,22 @@ export interface AdapterOverview {
|
|
|
81
81
|
* <p>A unique identifier for the adapter resource.</p>
|
|
82
82
|
* @public
|
|
83
83
|
*/
|
|
84
|
-
AdapterId?: string;
|
|
84
|
+
AdapterId?: string | undefined;
|
|
85
85
|
/**
|
|
86
86
|
* <p>A string naming the adapter resource.</p>
|
|
87
87
|
* @public
|
|
88
88
|
*/
|
|
89
|
-
AdapterName?: string;
|
|
89
|
+
AdapterName?: string | undefined;
|
|
90
90
|
/**
|
|
91
91
|
* <p>The date and time that the adapter was created.</p>
|
|
92
92
|
* @public
|
|
93
93
|
*/
|
|
94
|
-
CreationTime?: Date;
|
|
94
|
+
CreationTime?: Date | undefined;
|
|
95
95
|
/**
|
|
96
96
|
* <p>The feature types that the adapter is operating on.</p>
|
|
97
97
|
* @public
|
|
98
98
|
*/
|
|
99
|
-
FeatureTypes?: FeatureType[];
|
|
99
|
+
FeatureTypes?: FeatureType[] | undefined;
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
102
|
* <p>Contains information about adapters used when analyzing a document,
|
|
@@ -126,18 +126,18 @@ export interface S3Object {
|
|
|
126
126
|
* name.</p>
|
|
127
127
|
* @public
|
|
128
128
|
*/
|
|
129
|
-
Bucket?: string;
|
|
129
|
+
Bucket?: string | undefined;
|
|
130
130
|
/**
|
|
131
131
|
* <p>The file name of the input document. Synchronous operations can use image files that are
|
|
132
132
|
* in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.</p>
|
|
133
133
|
* @public
|
|
134
134
|
*/
|
|
135
|
-
Name?: string;
|
|
135
|
+
Name?: string | undefined;
|
|
136
136
|
/**
|
|
137
137
|
* <p>If the bucket has versioning enabled, you can specify the object version. </p>
|
|
138
138
|
* @public
|
|
139
139
|
*/
|
|
140
|
-
Version?: string;
|
|
140
|
+
Version?: string | undefined;
|
|
141
141
|
}
|
|
142
142
|
/**
|
|
143
143
|
* <p>The dataset configuration options for a given version of an adapter.
|
|
@@ -155,7 +155,7 @@ export interface AdapterVersionDatasetConfig {
|
|
|
155
155
|
* </p>
|
|
156
156
|
* @public
|
|
157
157
|
*/
|
|
158
|
-
ManifestS3Object?: S3Object;
|
|
158
|
+
ManifestS3Object?: S3Object | undefined;
|
|
159
159
|
}
|
|
160
160
|
/**
|
|
161
161
|
* <p>The evaluation metrics (F1 score, Precision, and Recall) for an adapter version.</p>
|
|
@@ -166,17 +166,17 @@ export interface EvaluationMetric {
|
|
|
166
166
|
* <p>The F1 score for an adapter version.</p>
|
|
167
167
|
* @public
|
|
168
168
|
*/
|
|
169
|
-
F1Score?: number;
|
|
169
|
+
F1Score?: number | undefined;
|
|
170
170
|
/**
|
|
171
171
|
* <p>The Precision score for an adapter version.</p>
|
|
172
172
|
* @public
|
|
173
173
|
*/
|
|
174
|
-
Precision?: number;
|
|
174
|
+
Precision?: number | undefined;
|
|
175
175
|
/**
|
|
176
176
|
* <p>The Recall score for an adapter version.</p>
|
|
177
177
|
* @public
|
|
178
178
|
*/
|
|
179
|
-
Recall?: number;
|
|
179
|
+
Recall?: number | undefined;
|
|
180
180
|
}
|
|
181
181
|
/**
|
|
182
182
|
* <p>Contains information on the metrics used to evalute the peformance of a given adapter version. Includes data for
|
|
@@ -188,17 +188,17 @@ export interface AdapterVersionEvaluationMetric {
|
|
|
188
188
|
* <p>The F1 score, precision, and recall metrics for the baseline model.</p>
|
|
189
189
|
* @public
|
|
190
190
|
*/
|
|
191
|
-
Baseline?: EvaluationMetric;
|
|
191
|
+
Baseline?: EvaluationMetric | undefined;
|
|
192
192
|
/**
|
|
193
193
|
* <p>The F1 score, precision, and recall metrics for the baseline model.</p>
|
|
194
194
|
* @public
|
|
195
195
|
*/
|
|
196
|
-
AdapterVersion?: EvaluationMetric;
|
|
196
|
+
AdapterVersion?: EvaluationMetric | undefined;
|
|
197
197
|
/**
|
|
198
198
|
* <p>Indicates the feature type being analyzed by a given adapter version.</p>
|
|
199
199
|
* @public
|
|
200
200
|
*/
|
|
201
|
-
FeatureType?: FeatureType;
|
|
201
|
+
FeatureType?: FeatureType | undefined;
|
|
202
202
|
}
|
|
203
203
|
/**
|
|
204
204
|
* @public
|
|
@@ -224,32 +224,32 @@ export interface AdapterVersionOverview {
|
|
|
224
224
|
* <p>A unique identifier for the adapter associated with a given adapter version.</p>
|
|
225
225
|
* @public
|
|
226
226
|
*/
|
|
227
|
-
AdapterId?: string;
|
|
227
|
+
AdapterId?: string | undefined;
|
|
228
228
|
/**
|
|
229
229
|
* <p>An identified for a given adapter version.</p>
|
|
230
230
|
* @public
|
|
231
231
|
*/
|
|
232
|
-
AdapterVersion?: string;
|
|
232
|
+
AdapterVersion?: string | undefined;
|
|
233
233
|
/**
|
|
234
234
|
* <p>The date and time that a given adapter version was created.</p>
|
|
235
235
|
* @public
|
|
236
236
|
*/
|
|
237
|
-
CreationTime?: Date;
|
|
237
|
+
CreationTime?: Date | undefined;
|
|
238
238
|
/**
|
|
239
239
|
* <p>The feature types that the adapter version is operating on.</p>
|
|
240
240
|
* @public
|
|
241
241
|
*/
|
|
242
|
-
FeatureTypes?: FeatureType[];
|
|
242
|
+
FeatureTypes?: FeatureType[] | undefined;
|
|
243
243
|
/**
|
|
244
244
|
* <p>Contains information on the status of a given adapter version.</p>
|
|
245
245
|
* @public
|
|
246
246
|
*/
|
|
247
|
-
Status?: AdapterVersionStatus;
|
|
247
|
+
Status?: AdapterVersionStatus | undefined;
|
|
248
248
|
/**
|
|
249
249
|
* <p>A message explaining the status of a given adapter vesion.</p>
|
|
250
250
|
* @public
|
|
251
251
|
*/
|
|
252
|
-
StatusMessage?: string;
|
|
252
|
+
StatusMessage?: string | undefined;
|
|
253
253
|
}
|
|
254
254
|
/**
|
|
255
255
|
* <p>The input document, either as bytes or as an S3 object.</p>
|
|
@@ -278,13 +278,13 @@ export interface Document {
|
|
|
278
278
|
* image bytes passed using the <code>Bytes</code> field. </p>
|
|
279
279
|
* @public
|
|
280
280
|
*/
|
|
281
|
-
Bytes?: Uint8Array;
|
|
281
|
+
Bytes?: Uint8Array | undefined;
|
|
282
282
|
/**
|
|
283
283
|
* <p>Identifies an S3 object as the document source. The maximum size of a document that's
|
|
284
284
|
* stored in an S3 bucket is 5 MB.</p>
|
|
285
285
|
* @public
|
|
286
286
|
*/
|
|
287
|
-
S3Object?: S3Object;
|
|
287
|
+
S3Object?: S3Object | undefined;
|
|
288
288
|
}
|
|
289
289
|
/**
|
|
290
290
|
* @public
|
|
@@ -309,7 +309,7 @@ export interface HumanLoopDataAttributes {
|
|
|
309
309
|
* content.</p>
|
|
310
310
|
* @public
|
|
311
311
|
*/
|
|
312
|
-
ContentClassifiers?: ContentClassifier[];
|
|
312
|
+
ContentClassifiers?: ContentClassifier[] | undefined;
|
|
313
313
|
}
|
|
314
314
|
/**
|
|
315
315
|
* <p>Sets up the human review workflow the document will be sent to if one of the conditions
|
|
@@ -332,7 +332,7 @@ export interface HumanLoopConfig {
|
|
|
332
332
|
* <p>Sets attributes of the input data.</p>
|
|
333
333
|
* @public
|
|
334
334
|
*/
|
|
335
|
-
DataAttributes?: HumanLoopDataAttributes;
|
|
335
|
+
DataAttributes?: HumanLoopDataAttributes | undefined;
|
|
336
336
|
}
|
|
337
337
|
/**
|
|
338
338
|
* <p>Each query contains the question you want to ask in the Text and the alias you want to associate.</p>
|
|
@@ -348,7 +348,7 @@ export interface Query {
|
|
|
348
348
|
* <p>Alias attached to the query, for ease of location.</p>
|
|
349
349
|
* @public
|
|
350
350
|
*/
|
|
351
|
-
Alias?: string;
|
|
351
|
+
Alias?: string | undefined;
|
|
352
352
|
/**
|
|
353
353
|
* <p>Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a
|
|
354
354
|
* list of rules for using this parameter.</p>
|
|
@@ -373,7 +373,7 @@ export interface Query {
|
|
|
373
373
|
* </ul>
|
|
374
374
|
* @public
|
|
375
375
|
*/
|
|
376
|
-
Pages?: string[];
|
|
376
|
+
Pages?: string[] | undefined;
|
|
377
377
|
}
|
|
378
378
|
/**
|
|
379
379
|
* <p></p>
|
|
@@ -413,17 +413,17 @@ export interface AnalyzeDocumentRequest {
|
|
|
413
413
|
* documents.</p>
|
|
414
414
|
* @public
|
|
415
415
|
*/
|
|
416
|
-
HumanLoopConfig?: HumanLoopConfig;
|
|
416
|
+
HumanLoopConfig?: HumanLoopConfig | undefined;
|
|
417
417
|
/**
|
|
418
418
|
* <p>Contains Queries and the alias for those Queries, as determined by the input. </p>
|
|
419
419
|
* @public
|
|
420
420
|
*/
|
|
421
|
-
QueriesConfig?: QueriesConfig;
|
|
421
|
+
QueriesConfig?: QueriesConfig | undefined;
|
|
422
422
|
/**
|
|
423
423
|
* <p>Specifies the adapter to be used when analyzing a document.</p>
|
|
424
424
|
* @public
|
|
425
425
|
*/
|
|
426
|
-
AdaptersConfig?: AdaptersConfig;
|
|
426
|
+
AdaptersConfig?: AdaptersConfig | undefined;
|
|
427
427
|
}
|
|
428
428
|
/**
|
|
429
429
|
* @public
|
|
@@ -499,25 +499,25 @@ export interface BoundingBox {
|
|
|
499
499
|
* width.</p>
|
|
500
500
|
* @public
|
|
501
501
|
*/
|
|
502
|
-
Width?: number;
|
|
502
|
+
Width?: number | undefined;
|
|
503
503
|
/**
|
|
504
504
|
* <p>The height of the bounding box as a ratio of the overall document page
|
|
505
505
|
* height.</p>
|
|
506
506
|
* @public
|
|
507
507
|
*/
|
|
508
|
-
Height?: number;
|
|
508
|
+
Height?: number | undefined;
|
|
509
509
|
/**
|
|
510
510
|
* <p>The left coordinate of the bounding box as a ratio of overall document page
|
|
511
511
|
* width.</p>
|
|
512
512
|
* @public
|
|
513
513
|
*/
|
|
514
|
-
Left?: number;
|
|
514
|
+
Left?: number | undefined;
|
|
515
515
|
/**
|
|
516
516
|
* <p>The top coordinate of the bounding box as a ratio of overall document page
|
|
517
517
|
* height.</p>
|
|
518
518
|
* @public
|
|
519
519
|
*/
|
|
520
|
-
Top?: number;
|
|
520
|
+
Top?: number | undefined;
|
|
521
521
|
}
|
|
522
522
|
/**
|
|
523
523
|
* <p>The X and Y coordinates of a point on a document page. The X and Y
|
|
@@ -535,12 +535,12 @@ export interface Point {
|
|
|
535
535
|
* <p>The value of the X coordinate for a point on a <code>Polygon</code>.</p>
|
|
536
536
|
* @public
|
|
537
537
|
*/
|
|
538
|
-
X?: number;
|
|
538
|
+
X?: number | undefined;
|
|
539
539
|
/**
|
|
540
540
|
* <p>The value of the Y coordinate for a point on a <code>Polygon</code>.</p>
|
|
541
541
|
* @public
|
|
542
542
|
*/
|
|
543
|
-
Y?: number;
|
|
543
|
+
Y?: number | undefined;
|
|
544
544
|
}
|
|
545
545
|
/**
|
|
546
546
|
* <p>Information about where the following items are located on a document page: detected
|
|
@@ -553,12 +553,12 @@ export interface Geometry {
|
|
|
553
553
|
* document page.</p>
|
|
554
554
|
* @public
|
|
555
555
|
*/
|
|
556
|
-
BoundingBox?: BoundingBox;
|
|
556
|
+
BoundingBox?: BoundingBox | undefined;
|
|
557
557
|
/**
|
|
558
558
|
* <p>Within the bounding box, a fine-grained polygon around the recognized item.</p>
|
|
559
559
|
* @public
|
|
560
560
|
*/
|
|
561
|
-
Polygon?: Point[];
|
|
561
|
+
Polygon?: Point[] | undefined;
|
|
562
562
|
}
|
|
563
563
|
/**
|
|
564
564
|
* @public
|
|
@@ -631,14 +631,14 @@ export interface Relationship {
|
|
|
631
631
|
* </ul>
|
|
632
632
|
* @public
|
|
633
633
|
*/
|
|
634
|
-
Type?: RelationshipType;
|
|
634
|
+
Type?: RelationshipType | undefined;
|
|
635
635
|
/**
|
|
636
636
|
* <p>An
|
|
637
637
|
* array of IDs for related blocks. You can get the type of the relationship from the
|
|
638
638
|
* <code>Type</code> element.</p>
|
|
639
639
|
* @public
|
|
640
640
|
*/
|
|
641
|
-
Ids?: string[];
|
|
641
|
+
Ids?: string[] | undefined;
|
|
642
642
|
}
|
|
643
643
|
/**
|
|
644
644
|
* @public
|
|
@@ -821,63 +821,63 @@ export interface Block {
|
|
|
821
821
|
* </ul>
|
|
822
822
|
* @public
|
|
823
823
|
*/
|
|
824
|
-
BlockType?: BlockType;
|
|
824
|
+
BlockType?: BlockType | undefined;
|
|
825
825
|
/**
|
|
826
826
|
* <p>The confidence score that Amazon Textract has in the accuracy of the recognized text and
|
|
827
827
|
* the accuracy of the geometry points around the recognized text.</p>
|
|
828
828
|
* @public
|
|
829
829
|
*/
|
|
830
|
-
Confidence?: number;
|
|
830
|
+
Confidence?: number | undefined;
|
|
831
831
|
/**
|
|
832
832
|
* <p>The word or line of text that's recognized by Amazon Textract. </p>
|
|
833
833
|
* @public
|
|
834
834
|
*/
|
|
835
|
-
Text?: string;
|
|
835
|
+
Text?: string | undefined;
|
|
836
836
|
/**
|
|
837
837
|
* <p>The kind of text that Amazon Textract has detected. Can check for handwritten text and
|
|
838
838
|
* printed text.</p>
|
|
839
839
|
* @public
|
|
840
840
|
*/
|
|
841
|
-
TextType?: TextType;
|
|
841
|
+
TextType?: TextType | undefined;
|
|
842
842
|
/**
|
|
843
843
|
* <p>The row in which a table cell is located. The first row position is 1.
|
|
844
844
|
* <code>RowIndex</code> isn't returned by <code>DetectDocumentText</code> and
|
|
845
845
|
* <code>GetDocumentTextDetection</code>.</p>
|
|
846
846
|
* @public
|
|
847
847
|
*/
|
|
848
|
-
RowIndex?: number;
|
|
848
|
+
RowIndex?: number | undefined;
|
|
849
849
|
/**
|
|
850
850
|
* <p>The column in which a table cell appears. The first column position is 1.
|
|
851
851
|
* <code>ColumnIndex</code> isn't returned by <code>DetectDocumentText</code> and
|
|
852
852
|
* <code>GetDocumentTextDetection</code>.</p>
|
|
853
853
|
* @public
|
|
854
854
|
*/
|
|
855
|
-
ColumnIndex?: number;
|
|
855
|
+
ColumnIndex?: number | undefined;
|
|
856
856
|
/**
|
|
857
857
|
* <p>The number of rows that a table cell spans. <code>RowSpan</code> isn't returned by
|
|
858
858
|
* <code>DetectDocumentText</code> and <code>GetDocumentTextDetection</code>.</p>
|
|
859
859
|
* @public
|
|
860
860
|
*/
|
|
861
|
-
RowSpan?: number;
|
|
861
|
+
RowSpan?: number | undefined;
|
|
862
862
|
/**
|
|
863
863
|
* <p>The number of columns that a table cell spans. <code>ColumnSpan</code> isn't returned by
|
|
864
864
|
* <code>DetectDocumentText</code> and <code>GetDocumentTextDetection</code>. </p>
|
|
865
865
|
* @public
|
|
866
866
|
*/
|
|
867
|
-
ColumnSpan?: number;
|
|
867
|
+
ColumnSpan?: number | undefined;
|
|
868
868
|
/**
|
|
869
869
|
* <p>The location of the recognized text on the image. It includes an axis-aligned, coarse
|
|
870
870
|
* bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial
|
|
871
871
|
* information. </p>
|
|
872
872
|
* @public
|
|
873
873
|
*/
|
|
874
|
-
Geometry?: Geometry;
|
|
874
|
+
Geometry?: Geometry | undefined;
|
|
875
875
|
/**
|
|
876
876
|
* <p>The identifier for the recognized text. The identifier is only unique for a single
|
|
877
877
|
* operation. </p>
|
|
878
878
|
* @public
|
|
879
879
|
*/
|
|
880
|
-
Id?: string;
|
|
880
|
+
Id?: string | undefined;
|
|
881
881
|
/**
|
|
882
882
|
* <p>A list of relationship objects that describe how blocks are related to each other. For
|
|
883
883
|
* example, a LINE block object contains a CHILD relationship type with the WORD blocks that
|
|
@@ -885,7 +885,7 @@ export interface Block {
|
|
|
885
885
|
* that don't exist, such as when the current block has no child blocks.</p>
|
|
886
886
|
* @public
|
|
887
887
|
*/
|
|
888
|
-
Relationships?: Relationship[];
|
|
888
|
+
Relationships?: Relationship[] | undefined;
|
|
889
889
|
/**
|
|
890
890
|
* <p>The type of entity. </p>
|
|
891
891
|
* <p>The following entity types can be returned by FORMS analysis:</p>
|
|
@@ -941,13 +941,13 @@ export interface Block {
|
|
|
941
941
|
* <code>GetDocumentTextDetection</code>.</p>
|
|
942
942
|
* @public
|
|
943
943
|
*/
|
|
944
|
-
EntityTypes?: EntityType[];
|
|
944
|
+
EntityTypes?: EntityType[] | undefined;
|
|
945
945
|
/**
|
|
946
946
|
* <p>The selection status of a selection element, such as an option button or check box.
|
|
947
947
|
* </p>
|
|
948
948
|
* @public
|
|
949
949
|
*/
|
|
950
|
-
SelectionStatus?: SelectionStatus;
|
|
950
|
+
SelectionStatus?: SelectionStatus | undefined;
|
|
951
951
|
/**
|
|
952
952
|
* <p>The page on which a block was detected. <code>Page</code> is returned by synchronous and
|
|
953
953
|
* asynchronous operations. Page values greater than 1 are only returned for multipage
|
|
@@ -957,12 +957,12 @@ export interface Block {
|
|
|
957
957
|
* always 1. </p>
|
|
958
958
|
* @public
|
|
959
959
|
*/
|
|
960
|
-
Page?: number;
|
|
960
|
+
Page?: number | undefined;
|
|
961
961
|
/**
|
|
962
962
|
* <p></p>
|
|
963
963
|
* @public
|
|
964
964
|
*/
|
|
965
|
-
Query?: Query;
|
|
965
|
+
Query?: Query | undefined;
|
|
966
966
|
}
|
|
967
967
|
/**
|
|
968
968
|
* <p>Information about the input document.</p>
|
|
@@ -973,7 +973,7 @@ export interface DocumentMetadata {
|
|
|
973
973
|
* <p>The number of pages that are detected in the document.</p>
|
|
974
974
|
* @public
|
|
975
975
|
*/
|
|
976
|
-
Pages?: number;
|
|
976
|
+
Pages?: number | undefined;
|
|
977
977
|
}
|
|
978
978
|
/**
|
|
979
979
|
* <p>Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the
|
|
@@ -985,18 +985,18 @@ export interface HumanLoopActivationOutput {
|
|
|
985
985
|
* <p>The Amazon Resource Name (ARN) of the HumanLoop created.</p>
|
|
986
986
|
* @public
|
|
987
987
|
*/
|
|
988
|
-
HumanLoopArn?: string;
|
|
988
|
+
HumanLoopArn?: string | undefined;
|
|
989
989
|
/**
|
|
990
990
|
* <p>Shows if and why human review was needed.</p>
|
|
991
991
|
* @public
|
|
992
992
|
*/
|
|
993
|
-
HumanLoopActivationReasons?: string[];
|
|
993
|
+
HumanLoopActivationReasons?: string[] | undefined;
|
|
994
994
|
/**
|
|
995
995
|
* <p>Shows the result of condition evaluations, including those conditions which activated a
|
|
996
996
|
* human review.</p>
|
|
997
997
|
* @public
|
|
998
998
|
*/
|
|
999
|
-
HumanLoopActivationConditionsEvaluationResults?: __LazyJsonString | string;
|
|
999
|
+
HumanLoopActivationConditionsEvaluationResults?: __LazyJsonString | string | undefined;
|
|
1000
1000
|
}
|
|
1001
1001
|
/**
|
|
1002
1002
|
* @public
|
|
@@ -1006,22 +1006,22 @@ export interface AnalyzeDocumentResponse {
|
|
|
1006
1006
|
* <p>Metadata about the analyzed document. An example is the number of pages.</p>
|
|
1007
1007
|
* @public
|
|
1008
1008
|
*/
|
|
1009
|
-
DocumentMetadata?: DocumentMetadata;
|
|
1009
|
+
DocumentMetadata?: DocumentMetadata | undefined;
|
|
1010
1010
|
/**
|
|
1011
1011
|
* <p>The items that are detected and analyzed by <code>AnalyzeDocument</code>.</p>
|
|
1012
1012
|
* @public
|
|
1013
1013
|
*/
|
|
1014
|
-
Blocks?: Block[];
|
|
1014
|
+
Blocks?: Block[] | undefined;
|
|
1015
1015
|
/**
|
|
1016
1016
|
* <p>Shows the results of the human in the loop evaluation.</p>
|
|
1017
1017
|
* @public
|
|
1018
1018
|
*/
|
|
1019
|
-
HumanLoopActivationOutput?: HumanLoopActivationOutput;
|
|
1019
|
+
HumanLoopActivationOutput?: HumanLoopActivationOutput | undefined;
|
|
1020
1020
|
/**
|
|
1021
1021
|
* <p>The version of the model used to analyze the document.</p>
|
|
1022
1022
|
* @public
|
|
1023
1023
|
*/
|
|
1024
|
-
AnalyzeDocumentModelVersion?: string;
|
|
1024
|
+
AnalyzeDocumentModelVersion?: string | undefined;
|
|
1025
1025
|
}
|
|
1026
1026
|
/**
|
|
1027
1027
|
* <p>Amazon Textract isn't able to read the document. For more information on the document
|
|
@@ -1031,8 +1031,8 @@ export interface AnalyzeDocumentResponse {
|
|
|
1031
1031
|
export declare class BadDocumentException extends __BaseException {
|
|
1032
1032
|
readonly name: "BadDocumentException";
|
|
1033
1033
|
readonly $fault: "client";
|
|
1034
|
-
Message?: string;
|
|
1035
|
-
Code?: string;
|
|
1034
|
+
Message?: string | undefined;
|
|
1035
|
+
Code?: string | undefined;
|
|
1036
1036
|
/**
|
|
1037
1037
|
* @internal
|
|
1038
1038
|
*/
|
|
@@ -1047,8 +1047,8 @@ export declare class BadDocumentException extends __BaseException {
|
|
|
1047
1047
|
export declare class DocumentTooLargeException extends __BaseException {
|
|
1048
1048
|
readonly name: "DocumentTooLargeException";
|
|
1049
1049
|
readonly $fault: "client";
|
|
1050
|
-
Message?: string;
|
|
1051
|
-
Code?: string;
|
|
1050
|
+
Message?: string | undefined;
|
|
1051
|
+
Code?: string | undefined;
|
|
1052
1052
|
/**
|
|
1053
1053
|
* @internal
|
|
1054
1054
|
*/
|
|
@@ -1065,19 +1065,19 @@ export declare class HumanLoopQuotaExceededException extends __BaseException {
|
|
|
1065
1065
|
* <p>The resource type.</p>
|
|
1066
1066
|
* @public
|
|
1067
1067
|
*/
|
|
1068
|
-
ResourceType?: string;
|
|
1068
|
+
ResourceType?: string | undefined;
|
|
1069
1069
|
/**
|
|
1070
1070
|
* <p>The quota code.</p>
|
|
1071
1071
|
* @public
|
|
1072
1072
|
*/
|
|
1073
|
-
QuotaCode?: string;
|
|
1073
|
+
QuotaCode?: string | undefined;
|
|
1074
1074
|
/**
|
|
1075
1075
|
* <p>The service code.</p>
|
|
1076
1076
|
* @public
|
|
1077
1077
|
*/
|
|
1078
|
-
ServiceCode?: string;
|
|
1079
|
-
Message?: string;
|
|
1080
|
-
Code?: string;
|
|
1078
|
+
ServiceCode?: string | undefined;
|
|
1079
|
+
Message?: string | undefined;
|
|
1080
|
+
Code?: string | undefined;
|
|
1081
1081
|
/**
|
|
1082
1082
|
* @internal
|
|
1083
1083
|
*/
|
|
@@ -1090,8 +1090,8 @@ export declare class HumanLoopQuotaExceededException extends __BaseException {
|
|
|
1090
1090
|
export declare class InternalServerError extends __BaseException {
|
|
1091
1091
|
readonly name: "InternalServerError";
|
|
1092
1092
|
readonly $fault: "server";
|
|
1093
|
-
Message?: string;
|
|
1094
|
-
Code?: string;
|
|
1093
|
+
Message?: string | undefined;
|
|
1094
|
+
Code?: string | undefined;
|
|
1095
1095
|
/**
|
|
1096
1096
|
* @internal
|
|
1097
1097
|
*/
|
|
@@ -1108,8 +1108,8 @@ export declare class InternalServerError extends __BaseException {
|
|
|
1108
1108
|
export declare class InvalidParameterException extends __BaseException {
|
|
1109
1109
|
readonly name: "InvalidParameterException";
|
|
1110
1110
|
readonly $fault: "client";
|
|
1111
|
-
Message?: string;
|
|
1112
|
-
Code?: string;
|
|
1111
|
+
Message?: string | undefined;
|
|
1112
|
+
Code?: string | undefined;
|
|
1113
1113
|
/**
|
|
1114
1114
|
* @internal
|
|
1115
1115
|
*/
|
|
@@ -1125,8 +1125,8 @@ export declare class InvalidParameterException extends __BaseException {
|
|
|
1125
1125
|
export declare class InvalidS3ObjectException extends __BaseException {
|
|
1126
1126
|
readonly name: "InvalidS3ObjectException";
|
|
1127
1127
|
readonly $fault: "client";
|
|
1128
|
-
Message?: string;
|
|
1129
|
-
Code?: string;
|
|
1128
|
+
Message?: string | undefined;
|
|
1129
|
+
Code?: string | undefined;
|
|
1130
1130
|
/**
|
|
1131
1131
|
* @internal
|
|
1132
1132
|
*/
|
|
@@ -1140,8 +1140,8 @@ export declare class InvalidS3ObjectException extends __BaseException {
|
|
|
1140
1140
|
export declare class ProvisionedThroughputExceededException extends __BaseException {
|
|
1141
1141
|
readonly name: "ProvisionedThroughputExceededException";
|
|
1142
1142
|
readonly $fault: "client";
|
|
1143
|
-
Message?: string;
|
|
1144
|
-
Code?: string;
|
|
1143
|
+
Message?: string | undefined;
|
|
1144
|
+
Code?: string | undefined;
|
|
1145
1145
|
/**
|
|
1146
1146
|
* @internal
|
|
1147
1147
|
*/
|
|
@@ -1154,8 +1154,8 @@ export declare class ProvisionedThroughputExceededException extends __BaseExcept
|
|
|
1154
1154
|
export declare class ThrottlingException extends __BaseException {
|
|
1155
1155
|
readonly name: "ThrottlingException";
|
|
1156
1156
|
readonly $fault: "server";
|
|
1157
|
-
Message?: string;
|
|
1158
|
-
Code?: string;
|
|
1157
|
+
Message?: string | undefined;
|
|
1158
|
+
Code?: string | undefined;
|
|
1159
1159
|
/**
|
|
1160
1160
|
* @internal
|
|
1161
1161
|
*/
|
|
@@ -1169,8 +1169,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
1169
1169
|
export declare class UnsupportedDocumentException extends __BaseException {
|
|
1170
1170
|
readonly name: "UnsupportedDocumentException";
|
|
1171
1171
|
readonly $fault: "client";
|
|
1172
|
-
Message?: string;
|
|
1173
|
-
Code?: string;
|
|
1172
|
+
Message?: string | undefined;
|
|
1173
|
+
Code?: string | undefined;
|
|
1174
1174
|
/**
|
|
1175
1175
|
* @internal
|
|
1176
1176
|
*/
|
|
@@ -1248,12 +1248,12 @@ export interface ExpenseCurrency {
|
|
|
1248
1248
|
* </ul>
|
|
1249
1249
|
* @public
|
|
1250
1250
|
*/
|
|
1251
|
-
Code?: string;
|
|
1251
|
+
Code?: string | undefined;
|
|
1252
1252
|
/**
|
|
1253
1253
|
* <p>Percentage confideence in the detected currency.</p>
|
|
1254
1254
|
* @public
|
|
1255
1255
|
*/
|
|
1256
|
-
Confidence?: number;
|
|
1256
|
+
Confidence?: number | undefined;
|
|
1257
1257
|
}
|
|
1258
1258
|
/**
|
|
1259
1259
|
* <p>Shows the group that a certain key belongs to. This helps differentiate between
|
|
@@ -1266,12 +1266,12 @@ export interface ExpenseGroupProperty {
|
|
|
1266
1266
|
* <p>Informs you on whether the expense group is a name or an address.</p>
|
|
1267
1267
|
* @public
|
|
1268
1268
|
*/
|
|
1269
|
-
Types?: string[];
|
|
1269
|
+
Types?: string[] | undefined;
|
|
1270
1270
|
/**
|
|
1271
1271
|
* <p>Provides a group Id number, which will be the same for each in the group.</p>
|
|
1272
1272
|
* @public
|
|
1273
1273
|
*/
|
|
1274
|
-
Id?: string;
|
|
1274
|
+
Id?: string | undefined;
|
|
1275
1275
|
}
|
|
1276
1276
|
/**
|
|
1277
1277
|
* <p>An object used to store information about the Value or Label detected by Amazon Textract.</p>
|
|
@@ -1282,18 +1282,18 @@ export interface ExpenseDetection {
|
|
|
1282
1282
|
* <p>The word or line of text recognized by Amazon Textract</p>
|
|
1283
1283
|
* @public
|
|
1284
1284
|
*/
|
|
1285
|
-
Text?: string;
|
|
1285
|
+
Text?: string | undefined;
|
|
1286
1286
|
/**
|
|
1287
1287
|
* <p>Information about where the following items are located on a document page: detected
|
|
1288
1288
|
* page, text, key-value pairs, tables, table cells, and selection elements.</p>
|
|
1289
1289
|
* @public
|
|
1290
1290
|
*/
|
|
1291
|
-
Geometry?: Geometry;
|
|
1291
|
+
Geometry?: Geometry | undefined;
|
|
1292
1292
|
/**
|
|
1293
1293
|
* <p>The confidence in detection, as a percentage</p>
|
|
1294
1294
|
* @public
|
|
1295
1295
|
*/
|
|
1296
|
-
Confidence?: number;
|
|
1296
|
+
Confidence?: number | undefined;
|
|
1297
1297
|
}
|
|
1298
1298
|
/**
|
|
1299
1299
|
* <p>An object used to store information about the Type detected by Amazon Textract.</p>
|
|
@@ -1304,12 +1304,12 @@ export interface ExpenseType {
|
|
|
1304
1304
|
* <p>The word or line of text detected by Amazon Textract.</p>
|
|
1305
1305
|
* @public
|
|
1306
1306
|
*/
|
|
1307
|
-
Text?: string;
|
|
1307
|
+
Text?: string | undefined;
|
|
1308
1308
|
/**
|
|
1309
1309
|
* <p>The confidence of accuracy, as a percentage.</p>
|
|
1310
1310
|
* @public
|
|
1311
1311
|
*/
|
|
1312
|
-
Confidence?: number;
|
|
1312
|
+
Confidence?: number | undefined;
|
|
1313
1313
|
}
|
|
1314
1314
|
/**
|
|
1315
1315
|
* <p>Breakdown of detected information, seperated into
|
|
@@ -1321,34 +1321,34 @@ export interface ExpenseField {
|
|
|
1321
1321
|
* <p>The implied label of a detected element. Present alongside LabelDetection for explicit elements.</p>
|
|
1322
1322
|
* @public
|
|
1323
1323
|
*/
|
|
1324
|
-
Type?: ExpenseType;
|
|
1324
|
+
Type?: ExpenseType | undefined;
|
|
1325
1325
|
/**
|
|
1326
1326
|
* <p>The explicitly stated label of a detected element.</p>
|
|
1327
1327
|
* @public
|
|
1328
1328
|
*/
|
|
1329
|
-
LabelDetection?: ExpenseDetection;
|
|
1329
|
+
LabelDetection?: ExpenseDetection | undefined;
|
|
1330
1330
|
/**
|
|
1331
1331
|
* <p>The value of a detected element. Present in explicit and implicit elements.</p>
|
|
1332
1332
|
* @public
|
|
1333
1333
|
*/
|
|
1334
|
-
ValueDetection?: ExpenseDetection;
|
|
1334
|
+
ValueDetection?: ExpenseDetection | undefined;
|
|
1335
1335
|
/**
|
|
1336
1336
|
* <p>The page number the value was detected on.</p>
|
|
1337
1337
|
* @public
|
|
1338
1338
|
*/
|
|
1339
|
-
PageNumber?: number;
|
|
1339
|
+
PageNumber?: number | undefined;
|
|
1340
1340
|
/**
|
|
1341
1341
|
* <p>Shows the kind of currency, both the code and confidence associated with any monatary value
|
|
1342
1342
|
* detected.</p>
|
|
1343
1343
|
* @public
|
|
1344
1344
|
*/
|
|
1345
|
-
Currency?: ExpenseCurrency;
|
|
1345
|
+
Currency?: ExpenseCurrency | undefined;
|
|
1346
1346
|
/**
|
|
1347
1347
|
* <p>Shows which group a response object belongs to, such as whether an address line
|
|
1348
1348
|
* belongs to the vendor's address or the recipent's address.</p>
|
|
1349
1349
|
* @public
|
|
1350
1350
|
*/
|
|
1351
|
-
GroupProperties?: ExpenseGroupProperty[];
|
|
1351
|
+
GroupProperties?: ExpenseGroupProperty[] | undefined;
|
|
1352
1352
|
}
|
|
1353
1353
|
/**
|
|
1354
1354
|
* <p>A structure that holds information about the different lines found in a document's tables.</p>
|
|
@@ -1359,7 +1359,7 @@ export interface LineItemFields {
|
|
|
1359
1359
|
* <p>ExpenseFields used to show information from detected lines on a table.</p>
|
|
1360
1360
|
* @public
|
|
1361
1361
|
*/
|
|
1362
|
-
LineItemExpenseFields?: ExpenseField[];
|
|
1362
|
+
LineItemExpenseFields?: ExpenseField[] | undefined;
|
|
1363
1363
|
}
|
|
1364
1364
|
/**
|
|
1365
1365
|
* <p>A grouping of tables which contain LineItems, with each table identified by the table's <code>LineItemGroupIndex</code>.</p>
|
|
@@ -1370,12 +1370,12 @@ export interface LineItemGroup {
|
|
|
1370
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
1371
|
* @public
|
|
1372
1372
|
*/
|
|
1373
|
-
LineItemGroupIndex?: number;
|
|
1373
|
+
LineItemGroupIndex?: number | undefined;
|
|
1374
1374
|
/**
|
|
1375
1375
|
* <p>The breakdown of information on a particular line of a table. </p>
|
|
1376
1376
|
* @public
|
|
1377
1377
|
*/
|
|
1378
|
-
LineItems?: LineItemFields[];
|
|
1378
|
+
LineItems?: LineItemFields[] | undefined;
|
|
1379
1379
|
}
|
|
1380
1380
|
/**
|
|
1381
1381
|
* <p>The structure holding all the information returned by AnalyzeExpense</p>
|
|
@@ -1387,23 +1387,23 @@ export interface ExpenseDocument {
|
|
|
1387
1387
|
* First document will be 1, the second 2, and so on.</p>
|
|
1388
1388
|
* @public
|
|
1389
1389
|
*/
|
|
1390
|
-
ExpenseIndex?: number;
|
|
1390
|
+
ExpenseIndex?: number | undefined;
|
|
1391
1391
|
/**
|
|
1392
1392
|
* <p>Any information found outside of a table by Amazon Textract.</p>
|
|
1393
1393
|
* @public
|
|
1394
1394
|
*/
|
|
1395
|
-
SummaryFields?: ExpenseField[];
|
|
1395
|
+
SummaryFields?: ExpenseField[] | undefined;
|
|
1396
1396
|
/**
|
|
1397
1397
|
* <p>Information detected on each table of a document, seperated into <code>LineItems</code>.</p>
|
|
1398
1398
|
* @public
|
|
1399
1399
|
*/
|
|
1400
|
-
LineItemGroups?: LineItemGroup[];
|
|
1400
|
+
LineItemGroups?: LineItemGroup[] | undefined;
|
|
1401
1401
|
/**
|
|
1402
1402
|
* <p>This is a block object, the same as reported when DetectDocumentText is run on a document.
|
|
1403
1403
|
* It provides word level recognition of text.</p>
|
|
1404
1404
|
* @public
|
|
1405
1405
|
*/
|
|
1406
|
-
Blocks?: Block[];
|
|
1406
|
+
Blocks?: Block[] | undefined;
|
|
1407
1407
|
}
|
|
1408
1408
|
/**
|
|
1409
1409
|
* @public
|
|
@@ -1413,12 +1413,12 @@ export interface AnalyzeExpenseResponse {
|
|
|
1413
1413
|
* <p>Information about the input document.</p>
|
|
1414
1414
|
* @public
|
|
1415
1415
|
*/
|
|
1416
|
-
DocumentMetadata?: DocumentMetadata;
|
|
1416
|
+
DocumentMetadata?: DocumentMetadata | undefined;
|
|
1417
1417
|
/**
|
|
1418
1418
|
* <p>The expenses detected by Amazon Textract.</p>
|
|
1419
1419
|
* @public
|
|
1420
1420
|
*/
|
|
1421
|
-
ExpenseDocuments?: ExpenseDocument[];
|
|
1421
|
+
ExpenseDocuments?: ExpenseDocument[] | undefined;
|
|
1422
1422
|
}
|
|
1423
1423
|
/**
|
|
1424
1424
|
* @public
|
|
@@ -1451,12 +1451,12 @@ export interface NormalizedValue {
|
|
|
1451
1451
|
* <p>The value of the date, written as Year-Month-DayTHour:Minute:Second.</p>
|
|
1452
1452
|
* @public
|
|
1453
1453
|
*/
|
|
1454
|
-
Value?: string;
|
|
1454
|
+
Value?: string | undefined;
|
|
1455
1455
|
/**
|
|
1456
1456
|
* <p>The normalized type of the value detected. In this case, DATE.</p>
|
|
1457
1457
|
* @public
|
|
1458
1458
|
*/
|
|
1459
|
-
ValueType?: ValueType;
|
|
1459
|
+
ValueType?: ValueType | undefined;
|
|
1460
1460
|
}
|
|
1461
1461
|
/**
|
|
1462
1462
|
* <p>Used to contain the information detected by an AnalyzeID operation.</p>
|
|
@@ -1473,12 +1473,12 @@ export interface AnalyzeIDDetections {
|
|
|
1473
1473
|
* written in a more machine readable way.</p>
|
|
1474
1474
|
* @public
|
|
1475
1475
|
*/
|
|
1476
|
-
NormalizedValue?: NormalizedValue;
|
|
1476
|
+
NormalizedValue?: NormalizedValue | undefined;
|
|
1477
1477
|
/**
|
|
1478
1478
|
* <p>The confidence score of the detected text.</p>
|
|
1479
1479
|
* @public
|
|
1480
1480
|
*/
|
|
1481
|
-
Confidence?: number;
|
|
1481
|
+
Confidence?: number | undefined;
|
|
1482
1482
|
}
|
|
1483
1483
|
/**
|
|
1484
1484
|
* <p>Structure containing both the normalized type of the extracted information
|
|
@@ -1490,12 +1490,12 @@ export interface IdentityDocumentField {
|
|
|
1490
1490
|
* <p>Used to contain the information detected by an AnalyzeID operation.</p>
|
|
1491
1491
|
* @public
|
|
1492
1492
|
*/
|
|
1493
|
-
Type?: AnalyzeIDDetections;
|
|
1493
|
+
Type?: AnalyzeIDDetections | undefined;
|
|
1494
1494
|
/**
|
|
1495
1495
|
* <p>Used to contain the information detected by an AnalyzeID operation.</p>
|
|
1496
1496
|
* @public
|
|
1497
1497
|
*/
|
|
1498
|
-
ValueDetection?: AnalyzeIDDetections;
|
|
1498
|
+
ValueDetection?: AnalyzeIDDetections | undefined;
|
|
1499
1499
|
}
|
|
1500
1500
|
/**
|
|
1501
1501
|
* <p>The structure that lists each document processed in an AnalyzeID operation.</p>
|
|
@@ -1507,18 +1507,18 @@ export interface IdentityDocument {
|
|
|
1507
1507
|
* is marked 1, the second 2 and so on.</p>
|
|
1508
1508
|
* @public
|
|
1509
1509
|
*/
|
|
1510
|
-
DocumentIndex?: number;
|
|
1510
|
+
DocumentIndex?: number | undefined;
|
|
1511
1511
|
/**
|
|
1512
1512
|
* <p>The structure used to record information extracted from identity documents.
|
|
1513
1513
|
* Contains both normalized field and value of the extracted text.</p>
|
|
1514
1514
|
* @public
|
|
1515
1515
|
*/
|
|
1516
|
-
IdentityDocumentFields?: IdentityDocumentField[];
|
|
1516
|
+
IdentityDocumentFields?: IdentityDocumentField[] | undefined;
|
|
1517
1517
|
/**
|
|
1518
1518
|
* <p>Individual word recognition, as returned by document detection.</p>
|
|
1519
1519
|
* @public
|
|
1520
1520
|
*/
|
|
1521
|
-
Blocks?: Block[];
|
|
1521
|
+
Blocks?: Block[] | undefined;
|
|
1522
1522
|
}
|
|
1523
1523
|
/**
|
|
1524
1524
|
* @public
|
|
@@ -1529,17 +1529,17 @@ export interface AnalyzeIDResponse {
|
|
|
1529
1529
|
* the list and the response structure for the document.</p>
|
|
1530
1530
|
* @public
|
|
1531
1531
|
*/
|
|
1532
|
-
IdentityDocuments?: IdentityDocument[];
|
|
1532
|
+
IdentityDocuments?: IdentityDocument[] | undefined;
|
|
1533
1533
|
/**
|
|
1534
1534
|
* <p>Information about the input document.</p>
|
|
1535
1535
|
* @public
|
|
1536
1536
|
*/
|
|
1537
|
-
DocumentMetadata?: DocumentMetadata;
|
|
1537
|
+
DocumentMetadata?: DocumentMetadata | undefined;
|
|
1538
1538
|
/**
|
|
1539
1539
|
* <p>The version of the AnalyzeIdentity API being used to process documents.</p>
|
|
1540
1540
|
* @public
|
|
1541
1541
|
*/
|
|
1542
|
-
AnalyzeIDModelVersion?: string;
|
|
1542
|
+
AnalyzeIDModelVersion?: string | undefined;
|
|
1543
1543
|
}
|
|
1544
1544
|
/**
|
|
1545
1545
|
* @public
|
|
@@ -1560,8 +1560,8 @@ export type AutoUpdate = (typeof AutoUpdate)[keyof typeof AutoUpdate];
|
|
|
1560
1560
|
export declare class ConflictException extends __BaseException {
|
|
1561
1561
|
readonly name: "ConflictException";
|
|
1562
1562
|
readonly $fault: "client";
|
|
1563
|
-
Message?: string;
|
|
1564
|
-
Code?: string;
|
|
1563
|
+
Message?: string | undefined;
|
|
1564
|
+
Code?: string | undefined;
|
|
1565
1565
|
/**
|
|
1566
1566
|
* @internal
|
|
1567
1567
|
*/
|
|
@@ -1582,12 +1582,12 @@ export interface CreateAdapterRequest {
|
|
|
1582
1582
|
* This token is employed to avoid unintentionally creating the same session multiple times.</p>
|
|
1583
1583
|
* @public
|
|
1584
1584
|
*/
|
|
1585
|
-
ClientRequestToken?: string;
|
|
1585
|
+
ClientRequestToken?: string | undefined;
|
|
1586
1586
|
/**
|
|
1587
1587
|
* <p>The description to be assigned to the adapter being created.</p>
|
|
1588
1588
|
* @public
|
|
1589
1589
|
*/
|
|
1590
|
-
Description?: string;
|
|
1590
|
+
Description?: string | undefined;
|
|
1591
1591
|
/**
|
|
1592
1592
|
* <p>The type of feature that the adapter is being trained on. Currrenly, supported feature
|
|
1593
1593
|
* types are: <code>QUERIES</code>
|
|
@@ -1599,12 +1599,12 @@ export interface CreateAdapterRequest {
|
|
|
1599
1599
|
* <p>Controls whether or not the adapter should automatically update.</p>
|
|
1600
1600
|
* @public
|
|
1601
1601
|
*/
|
|
1602
|
-
AutoUpdate?: AutoUpdate;
|
|
1602
|
+
AutoUpdate?: AutoUpdate | undefined;
|
|
1603
1603
|
/**
|
|
1604
1604
|
* <p>A list of tags to be added to the adapter.</p>
|
|
1605
1605
|
* @public
|
|
1606
1606
|
*/
|
|
1607
|
-
Tags?: Record<string, string
|
|
1607
|
+
Tags?: Record<string, string> | undefined;
|
|
1608
1608
|
}
|
|
1609
1609
|
/**
|
|
1610
1610
|
* @public
|
|
@@ -1614,7 +1614,7 @@ export interface CreateAdapterResponse {
|
|
|
1614
1614
|
* <p>A string containing the unique ID for the adapter that has been created.</p>
|
|
1615
1615
|
* @public
|
|
1616
1616
|
*/
|
|
1617
|
-
AdapterId?: string;
|
|
1617
|
+
AdapterId?: string | undefined;
|
|
1618
1618
|
}
|
|
1619
1619
|
/**
|
|
1620
1620
|
* <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at
|
|
@@ -1625,8 +1625,8 @@ export interface CreateAdapterResponse {
|
|
|
1625
1625
|
export declare class IdempotentParameterMismatchException extends __BaseException {
|
|
1626
1626
|
readonly name: "IdempotentParameterMismatchException";
|
|
1627
1627
|
readonly $fault: "client";
|
|
1628
|
-
Message?: string;
|
|
1629
|
-
Code?: string;
|
|
1628
|
+
Message?: string | undefined;
|
|
1629
|
+
Code?: string | undefined;
|
|
1630
1630
|
/**
|
|
1631
1631
|
* @internal
|
|
1632
1632
|
*/
|
|
@@ -1643,8 +1643,8 @@ export declare class IdempotentParameterMismatchException extends __BaseExceptio
|
|
|
1643
1643
|
export declare class LimitExceededException extends __BaseException {
|
|
1644
1644
|
readonly name: "LimitExceededException";
|
|
1645
1645
|
readonly $fault: "client";
|
|
1646
|
-
Message?: string;
|
|
1647
|
-
Code?: string;
|
|
1646
|
+
Message?: string | undefined;
|
|
1647
|
+
Code?: string | undefined;
|
|
1648
1648
|
/**
|
|
1649
1649
|
* @internal
|
|
1650
1650
|
*/
|
|
@@ -1657,8 +1657,8 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1657
1657
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
1658
1658
|
readonly name: "ServiceQuotaExceededException";
|
|
1659
1659
|
readonly $fault: "client";
|
|
1660
|
-
Message?: string;
|
|
1661
|
-
Code?: string;
|
|
1660
|
+
Message?: string | undefined;
|
|
1661
|
+
Code?: string | undefined;
|
|
1662
1662
|
/**
|
|
1663
1663
|
* @internal
|
|
1664
1664
|
*/
|
|
@@ -1671,8 +1671,8 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
1671
1671
|
export declare class ValidationException extends __BaseException {
|
|
1672
1672
|
readonly name: "ValidationException";
|
|
1673
1673
|
readonly $fault: "client";
|
|
1674
|
-
Message?: string;
|
|
1675
|
-
Code?: string;
|
|
1674
|
+
Message?: string | undefined;
|
|
1675
|
+
Code?: string | undefined;
|
|
1676
1676
|
/**
|
|
1677
1677
|
* @internal
|
|
1678
1678
|
*/
|
|
@@ -1709,7 +1709,7 @@ export interface OutputConfig {
|
|
|
1709
1709
|
* prefix will be “textract_output".</p>
|
|
1710
1710
|
* @public
|
|
1711
1711
|
*/
|
|
1712
|
-
S3Prefix?: string;
|
|
1712
|
+
S3Prefix?: string | undefined;
|
|
1713
1713
|
}
|
|
1714
1714
|
/**
|
|
1715
1715
|
* @public
|
|
@@ -1726,7 +1726,7 @@ export interface CreateAdapterVersionRequest {
|
|
|
1726
1726
|
* This token is employed to avoid unintentionally creating the same session multiple times.</p>
|
|
1727
1727
|
* @public
|
|
1728
1728
|
*/
|
|
1729
|
-
ClientRequestToken?: string;
|
|
1729
|
+
ClientRequestToken?: string | undefined;
|
|
1730
1730
|
/**
|
|
1731
1731
|
* <p>Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object as the
|
|
1732
1732
|
* value.</p>
|
|
@@ -1737,7 +1737,7 @@ export interface CreateAdapterVersionRequest {
|
|
|
1737
1737
|
* <p>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.</p>
|
|
1738
1738
|
* @public
|
|
1739
1739
|
*/
|
|
1740
|
-
KMSKeyId?: string;
|
|
1740
|
+
KMSKeyId?: string | undefined;
|
|
1741
1741
|
/**
|
|
1742
1742
|
* <p>Sets whether or not your output will go to a user created bucket. Used to set the name
|
|
1743
1743
|
* of the bucket, and the prefix on the output file.</p>
|
|
@@ -1763,7 +1763,7 @@ export interface CreateAdapterVersionRequest {
|
|
|
1763
1763
|
* <p>A set of tags (key-value pairs) that you want to attach to the adapter version. </p>
|
|
1764
1764
|
* @public
|
|
1765
1765
|
*/
|
|
1766
|
-
Tags?: Record<string, string
|
|
1766
|
+
Tags?: Record<string, string> | undefined;
|
|
1767
1767
|
}
|
|
1768
1768
|
/**
|
|
1769
1769
|
* @public
|
|
@@ -1773,12 +1773,12 @@ export interface CreateAdapterVersionResponse {
|
|
|
1773
1773
|
* <p>A string containing the unique ID for the adapter that has received a new version.</p>
|
|
1774
1774
|
* @public
|
|
1775
1775
|
*/
|
|
1776
|
-
AdapterId?: string;
|
|
1776
|
+
AdapterId?: string | undefined;
|
|
1777
1777
|
/**
|
|
1778
1778
|
* <p>A string describing the new version of the adapter.</p>
|
|
1779
1779
|
* @public
|
|
1780
1780
|
*/
|
|
1781
|
-
AdapterVersion?: string;
|
|
1781
|
+
AdapterVersion?: string | undefined;
|
|
1782
1782
|
}
|
|
1783
1783
|
/**
|
|
1784
1784
|
* <p> Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key
|
|
@@ -1788,8 +1788,8 @@ export interface CreateAdapterVersionResponse {
|
|
|
1788
1788
|
export declare class InvalidKMSKeyException extends __BaseException {
|
|
1789
1789
|
readonly name: "InvalidKMSKeyException";
|
|
1790
1790
|
readonly $fault: "client";
|
|
1791
|
-
Message?: string;
|
|
1792
|
-
Code?: string;
|
|
1791
|
+
Message?: string | undefined;
|
|
1792
|
+
Code?: string | undefined;
|
|
1793
1793
|
/**
|
|
1794
1794
|
* @internal
|
|
1795
1795
|
*/
|
|
@@ -1802,8 +1802,8 @@ export declare class InvalidKMSKeyException extends __BaseException {
|
|
|
1802
1802
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
1803
1803
|
readonly name: "ResourceNotFoundException";
|
|
1804
1804
|
readonly $fault: "client";
|
|
1805
|
-
Message?: string;
|
|
1806
|
-
Code?: string;
|
|
1805
|
+
Message?: string | undefined;
|
|
1806
|
+
Code?: string | undefined;
|
|
1807
1807
|
/**
|
|
1808
1808
|
* @internal
|
|
1809
1809
|
*/
|
|
@@ -1867,18 +1867,18 @@ export interface DetectDocumentTextResponse {
|
|
|
1867
1867
|
* document.</p>
|
|
1868
1868
|
* @public
|
|
1869
1869
|
*/
|
|
1870
|
-
DocumentMetadata?: DocumentMetadata;
|
|
1870
|
+
DocumentMetadata?: DocumentMetadata | undefined;
|
|
1871
1871
|
/**
|
|
1872
1872
|
* <p>An array of <code>Block</code> objects that contain the text that's detected in the
|
|
1873
1873
|
* document.</p>
|
|
1874
1874
|
* @public
|
|
1875
1875
|
*/
|
|
1876
|
-
Blocks?: Block[];
|
|
1876
|
+
Blocks?: Block[] | undefined;
|
|
1877
1877
|
/**
|
|
1878
1878
|
* <p></p>
|
|
1879
1879
|
* @public
|
|
1880
1880
|
*/
|
|
1881
|
-
DetectDocumentTextModelVersion?: string;
|
|
1881
|
+
DetectDocumentTextModelVersion?: string | undefined;
|
|
1882
1882
|
}
|
|
1883
1883
|
/**
|
|
1884
1884
|
* <p>A structure that holds information regarding a detected signature on a page.</p>
|
|
@@ -1889,7 +1889,7 @@ export interface DetectedSignature {
|
|
|
1889
1889
|
* <p>The page a detected signature was found on.</p>
|
|
1890
1890
|
* @public
|
|
1891
1891
|
*/
|
|
1892
|
-
Page?: number;
|
|
1892
|
+
Page?: number | undefined;
|
|
1893
1893
|
}
|
|
1894
1894
|
/**
|
|
1895
1895
|
* <p>Contains information about the pages of a document, defined by logical boundary.</p>
|
|
@@ -1900,12 +1900,12 @@ export interface SplitDocument {
|
|
|
1900
1900
|
* <p>The index for a given document in a DocumentGroup of a specific Type.</p>
|
|
1901
1901
|
* @public
|
|
1902
1902
|
*/
|
|
1903
|
-
Index?: number;
|
|
1903
|
+
Index?: number | undefined;
|
|
1904
1904
|
/**
|
|
1905
1905
|
* <p>An array of page numbers for a for a given document, ordered by logical boundary.</p>
|
|
1906
1906
|
* @public
|
|
1907
1907
|
*/
|
|
1908
|
-
Pages?: number[];
|
|
1908
|
+
Pages?: number[] | undefined;
|
|
1909
1909
|
}
|
|
1910
1910
|
/**
|
|
1911
1911
|
* <p>A structure containing information about an undetected signature on a page where it was expected but not found.</p>
|
|
@@ -1916,7 +1916,7 @@ export interface UndetectedSignature {
|
|
|
1916
1916
|
* <p>The page where a signature was expected but not found.</p>
|
|
1917
1917
|
* @public
|
|
1918
1918
|
*/
|
|
1919
|
-
Page?: number;
|
|
1919
|
+
Page?: number | undefined;
|
|
1920
1920
|
}
|
|
1921
1921
|
/**
|
|
1922
1922
|
* <p>Summary information about documents grouped by the same document type.</p>
|
|
@@ -1927,22 +1927,22 @@ export interface DocumentGroup {
|
|
|
1927
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
1928
|
* @public
|
|
1929
1929
|
*/
|
|
1930
|
-
Type?: string;
|
|
1930
|
+
Type?: string | undefined;
|
|
1931
1931
|
/**
|
|
1932
1932
|
* <p>An array that contains information about the pages of a document, defined by logical boundary.</p>
|
|
1933
1933
|
* @public
|
|
1934
1934
|
*/
|
|
1935
|
-
SplitDocuments?: SplitDocument[];
|
|
1935
|
+
SplitDocuments?: SplitDocument[] | undefined;
|
|
1936
1936
|
/**
|
|
1937
1937
|
* <p>A list of the detected signatures found in a document group.</p>
|
|
1938
1938
|
* @public
|
|
1939
1939
|
*/
|
|
1940
|
-
DetectedSignatures?: DetectedSignature[];
|
|
1940
|
+
DetectedSignatures?: DetectedSignature[] | undefined;
|
|
1941
1941
|
/**
|
|
1942
1942
|
* <p>A list of any expected signatures not found in a document group.</p>
|
|
1943
1943
|
* @public
|
|
1944
1944
|
*/
|
|
1945
|
-
UndetectedSignatures?: UndetectedSignature[];
|
|
1945
|
+
UndetectedSignatures?: UndetectedSignature[] | undefined;
|
|
1946
1946
|
}
|
|
1947
1947
|
/**
|
|
1948
1948
|
* <p>The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous
|
|
@@ -1956,7 +1956,7 @@ export interface DocumentLocation {
|
|
|
1956
1956
|
* <p>The Amazon S3 bucket that contains the input document.</p>
|
|
1957
1957
|
* @public
|
|
1958
1958
|
*/
|
|
1959
|
-
S3Object?: S3Object;
|
|
1959
|
+
S3Object?: S3Object | undefined;
|
|
1960
1960
|
}
|
|
1961
1961
|
/**
|
|
1962
1962
|
* <p>The results extracted for a lending document.</p>
|
|
@@ -1967,23 +1967,23 @@ export interface LendingDetection {
|
|
|
1967
1967
|
* <p>The text extracted for a detected value in a lending document.</p>
|
|
1968
1968
|
* @public
|
|
1969
1969
|
*/
|
|
1970
|
-
Text?: string;
|
|
1970
|
+
Text?: string | undefined;
|
|
1971
1971
|
/**
|
|
1972
1972
|
* <p>The selection status of a selection element, such as an option button or check box.</p>
|
|
1973
1973
|
* @public
|
|
1974
1974
|
*/
|
|
1975
|
-
SelectionStatus?: SelectionStatus;
|
|
1975
|
+
SelectionStatus?: SelectionStatus | undefined;
|
|
1976
1976
|
/**
|
|
1977
1977
|
* <p>Information about where the following items are located on a document page: detected
|
|
1978
1978
|
* page, text, key-value pairs, tables, table cells, and selection elements.</p>
|
|
1979
1979
|
* @public
|
|
1980
1980
|
*/
|
|
1981
|
-
Geometry?: Geometry;
|
|
1981
|
+
Geometry?: Geometry | undefined;
|
|
1982
1982
|
/**
|
|
1983
1983
|
* <p>The confidence level for the text of a detected value in a lending document.</p>
|
|
1984
1984
|
* @public
|
|
1985
1985
|
*/
|
|
1986
|
-
Confidence?: number;
|
|
1986
|
+
Confidence?: number | undefined;
|
|
1987
1987
|
}
|
|
1988
1988
|
/**
|
|
1989
1989
|
* <p>Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and geometry.</p>
|
|
@@ -1994,17 +1994,17 @@ export interface LendingField {
|
|
|
1994
1994
|
* <p>The type of the lending document.</p>
|
|
1995
1995
|
* @public
|
|
1996
1996
|
*/
|
|
1997
|
-
Type?: string;
|
|
1997
|
+
Type?: string | undefined;
|
|
1998
1998
|
/**
|
|
1999
1999
|
* <p>The results extracted for a lending document.</p>
|
|
2000
2000
|
* @public
|
|
2001
2001
|
*/
|
|
2002
|
-
KeyDetection?: LendingDetection;
|
|
2002
|
+
KeyDetection?: LendingDetection | undefined;
|
|
2003
2003
|
/**
|
|
2004
2004
|
* <p>An array of LendingDetection objects.</p>
|
|
2005
2005
|
* @public
|
|
2006
2006
|
*/
|
|
2007
|
-
ValueDetections?: LendingDetection[];
|
|
2007
|
+
ValueDetections?: LendingDetection[] | undefined;
|
|
2008
2008
|
}
|
|
2009
2009
|
/**
|
|
2010
2010
|
* <p>Information regarding a detected signature on a page.</p>
|
|
@@ -2015,13 +2015,13 @@ export interface SignatureDetection {
|
|
|
2015
2015
|
* <p>The confidence, from 0 to 100, in the predicted values for a detected signature.</p>
|
|
2016
2016
|
* @public
|
|
2017
2017
|
*/
|
|
2018
|
-
Confidence?: number;
|
|
2018
|
+
Confidence?: number | undefined;
|
|
2019
2019
|
/**
|
|
2020
2020
|
* <p>Information about where the following items are located on a document page: detected
|
|
2021
2021
|
* page, text, key-value pairs, tables, table cells, and selection elements.</p>
|
|
2022
2022
|
* @public
|
|
2023
2023
|
*/
|
|
2024
|
-
Geometry?: Geometry;
|
|
2024
|
+
Geometry?: Geometry | undefined;
|
|
2025
2025
|
}
|
|
2026
2026
|
/**
|
|
2027
2027
|
* <p>Holds the structured data returned by AnalyzeDocument for lending documents.</p>
|
|
@@ -2032,12 +2032,12 @@ export interface LendingDocument {
|
|
|
2032
2032
|
* <p>An array of LendingField objects.</p>
|
|
2033
2033
|
* @public
|
|
2034
2034
|
*/
|
|
2035
|
-
LendingFields?: LendingField[];
|
|
2035
|
+
LendingFields?: LendingField[] | undefined;
|
|
2036
2036
|
/**
|
|
2037
2037
|
* <p>A list of signatures detected in a lending document.</p>
|
|
2038
2038
|
* @public
|
|
2039
2039
|
*/
|
|
2040
|
-
SignatureDetections?: SignatureDetection[];
|
|
2040
|
+
SignatureDetections?: SignatureDetection[] | undefined;
|
|
2041
2041
|
}
|
|
2042
2042
|
/**
|
|
2043
2043
|
* <p>Contains information extracted by an analysis operation after using StartLendingAnalysis.</p>
|
|
@@ -2048,17 +2048,17 @@ export interface Extraction {
|
|
|
2048
2048
|
* <p>Holds the structured data returned by AnalyzeDocument for lending documents.</p>
|
|
2049
2049
|
* @public
|
|
2050
2050
|
*/
|
|
2051
|
-
LendingDocument?: LendingDocument;
|
|
2051
|
+
LendingDocument?: LendingDocument | undefined;
|
|
2052
2052
|
/**
|
|
2053
2053
|
* <p>The structure holding all the information returned by AnalyzeExpense</p>
|
|
2054
2054
|
* @public
|
|
2055
2055
|
*/
|
|
2056
|
-
ExpenseDocument?: ExpenseDocument;
|
|
2056
|
+
ExpenseDocument?: ExpenseDocument | undefined;
|
|
2057
2057
|
/**
|
|
2058
2058
|
* <p>The structure that lists each document processed in an AnalyzeID operation.</p>
|
|
2059
2059
|
* @public
|
|
2060
2060
|
*/
|
|
2061
|
-
IdentityDocument?: IdentityDocument;
|
|
2061
|
+
IdentityDocument?: IdentityDocument | undefined;
|
|
2062
2062
|
}
|
|
2063
2063
|
/**
|
|
2064
2064
|
* @public
|
|
@@ -2078,37 +2078,37 @@ export interface GetAdapterResponse {
|
|
|
2078
2078
|
* <p>A string identifying the adapter that information has been retrieved for.</p>
|
|
2079
2079
|
* @public
|
|
2080
2080
|
*/
|
|
2081
|
-
AdapterId?: string;
|
|
2081
|
+
AdapterId?: string | undefined;
|
|
2082
2082
|
/**
|
|
2083
2083
|
* <p>The name of the requested adapter.</p>
|
|
2084
2084
|
* @public
|
|
2085
2085
|
*/
|
|
2086
|
-
AdapterName?: string;
|
|
2086
|
+
AdapterName?: string | undefined;
|
|
2087
2087
|
/**
|
|
2088
2088
|
* <p>The date and time the requested adapter was created at.</p>
|
|
2089
2089
|
* @public
|
|
2090
2090
|
*/
|
|
2091
|
-
CreationTime?: Date;
|
|
2091
|
+
CreationTime?: Date | undefined;
|
|
2092
2092
|
/**
|
|
2093
2093
|
* <p>The description for the requested adapter.</p>
|
|
2094
2094
|
* @public
|
|
2095
2095
|
*/
|
|
2096
|
-
Description?: string;
|
|
2096
|
+
Description?: string | undefined;
|
|
2097
2097
|
/**
|
|
2098
2098
|
* <p>List of the targeted feature types for the requested adapter.</p>
|
|
2099
2099
|
* @public
|
|
2100
2100
|
*/
|
|
2101
|
-
FeatureTypes?: FeatureType[];
|
|
2101
|
+
FeatureTypes?: FeatureType[] | undefined;
|
|
2102
2102
|
/**
|
|
2103
2103
|
* <p>Binary value indicating if the adapter is being automatically updated or not.</p>
|
|
2104
2104
|
* @public
|
|
2105
2105
|
*/
|
|
2106
|
-
AutoUpdate?: AutoUpdate;
|
|
2106
|
+
AutoUpdate?: AutoUpdate | undefined;
|
|
2107
2107
|
/**
|
|
2108
2108
|
* <p>A set of tags (key-value pairs) associated with the adapter that has been retrieved.</p>
|
|
2109
2109
|
* @public
|
|
2110
2110
|
*/
|
|
2111
|
-
Tags?: Record<string, string
|
|
2111
|
+
Tags?: Record<string, string> | undefined;
|
|
2112
2112
|
}
|
|
2113
2113
|
/**
|
|
2114
2114
|
* @public
|
|
@@ -2133,43 +2133,43 @@ export interface GetAdapterVersionResponse {
|
|
|
2133
2133
|
* <p>A string containing a unique ID for the adapter version being retrieved.</p>
|
|
2134
2134
|
* @public
|
|
2135
2135
|
*/
|
|
2136
|
-
AdapterId?: string;
|
|
2136
|
+
AdapterId?: string | undefined;
|
|
2137
2137
|
/**
|
|
2138
2138
|
* <p>A string containing the adapter version that has been retrieved.</p>
|
|
2139
2139
|
* @public
|
|
2140
2140
|
*/
|
|
2141
|
-
AdapterVersion?: string;
|
|
2141
|
+
AdapterVersion?: string | undefined;
|
|
2142
2142
|
/**
|
|
2143
2143
|
* <p>The time that the adapter version was created.</p>
|
|
2144
2144
|
* @public
|
|
2145
2145
|
*/
|
|
2146
|
-
CreationTime?: Date;
|
|
2146
|
+
CreationTime?: Date | undefined;
|
|
2147
2147
|
/**
|
|
2148
2148
|
* <p>List of the targeted feature types for the requested adapter version.</p>
|
|
2149
2149
|
* @public
|
|
2150
2150
|
*/
|
|
2151
|
-
FeatureTypes?: FeatureType[];
|
|
2151
|
+
FeatureTypes?: FeatureType[] | undefined;
|
|
2152
2152
|
/**
|
|
2153
2153
|
* <p>The status of the adapter version that has been requested.</p>
|
|
2154
2154
|
* @public
|
|
2155
2155
|
*/
|
|
2156
|
-
Status?: AdapterVersionStatus;
|
|
2156
|
+
Status?: AdapterVersionStatus | undefined;
|
|
2157
2157
|
/**
|
|
2158
2158
|
* <p>A message that describes the status of the requested adapter version.</p>
|
|
2159
2159
|
* @public
|
|
2160
2160
|
*/
|
|
2161
|
-
StatusMessage?: string;
|
|
2161
|
+
StatusMessage?: string | undefined;
|
|
2162
2162
|
/**
|
|
2163
2163
|
* <p>Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the
|
|
2164
2164
|
* value.</p>
|
|
2165
2165
|
* @public
|
|
2166
2166
|
*/
|
|
2167
|
-
DatasetConfig?: AdapterVersionDatasetConfig;
|
|
2167
|
+
DatasetConfig?: AdapterVersionDatasetConfig | undefined;
|
|
2168
2168
|
/**
|
|
2169
2169
|
* <p>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.</p>
|
|
2170
2170
|
* @public
|
|
2171
2171
|
*/
|
|
2172
|
-
KMSKeyId?: string;
|
|
2172
|
+
KMSKeyId?: string | undefined;
|
|
2173
2173
|
/**
|
|
2174
2174
|
* <p>Sets whether or not your output will go to a user created bucket. Used to set the name
|
|
2175
2175
|
* of the bucket, and the prefix on the output file.</p>
|
|
@@ -2190,18 +2190,18 @@ export interface GetAdapterVersionResponse {
|
|
|
2190
2190
|
* FAQ</a>.</p>
|
|
2191
2191
|
* @public
|
|
2192
2192
|
*/
|
|
2193
|
-
OutputConfig?: OutputConfig;
|
|
2193
|
+
OutputConfig?: OutputConfig | undefined;
|
|
2194
2194
|
/**
|
|
2195
2195
|
* <p>The evaluation metrics (F1 score, Precision, and Recall) for the requested version,
|
|
2196
2196
|
* grouped by baseline metrics and adapter version.</p>
|
|
2197
2197
|
* @public
|
|
2198
2198
|
*/
|
|
2199
|
-
EvaluationMetrics?: AdapterVersionEvaluationMetric[];
|
|
2199
|
+
EvaluationMetrics?: AdapterVersionEvaluationMetric[] | undefined;
|
|
2200
2200
|
/**
|
|
2201
2201
|
* <p>A set of tags (key-value pairs) that are associated with the adapter version.</p>
|
|
2202
2202
|
* @public
|
|
2203
2203
|
*/
|
|
2204
|
-
Tags?: Record<string, string
|
|
2204
|
+
Tags?: Record<string, string> | undefined;
|
|
2205
2205
|
}
|
|
2206
2206
|
/**
|
|
2207
2207
|
* @public
|
|
@@ -2220,14 +2220,14 @@ export interface GetDocumentAnalysisRequest {
|
|
|
2220
2220
|
* is returned. The default value is 1,000.</p>
|
|
2221
2221
|
* @public
|
|
2222
2222
|
*/
|
|
2223
|
-
MaxResults?: number;
|
|
2223
|
+
MaxResults?: number | undefined;
|
|
2224
2224
|
/**
|
|
2225
2225
|
* <p>If the previous response was incomplete (because there are more blocks to retrieve),
|
|
2226
2226
|
* Amazon Textract returns a pagination token in the response. You can use this pagination
|
|
2227
2227
|
* token to retrieve the next set of blocks.</p>
|
|
2228
2228
|
* @public
|
|
2229
2229
|
*/
|
|
2230
|
-
NextToken?: string;
|
|
2230
|
+
NextToken?: string | undefined;
|
|
2231
2231
|
}
|
|
2232
2232
|
/**
|
|
2233
2233
|
* @public
|
|
@@ -2252,12 +2252,12 @@ export interface Warning {
|
|
|
2252
2252
|
* <p>The error code for the warning.</p>
|
|
2253
2253
|
* @public
|
|
2254
2254
|
*/
|
|
2255
|
-
ErrorCode?: string;
|
|
2255
|
+
ErrorCode?: string | undefined;
|
|
2256
2256
|
/**
|
|
2257
2257
|
* <p>A list of the pages that the warning applies to.</p>
|
|
2258
2258
|
* @public
|
|
2259
2259
|
*/
|
|
2260
|
-
Pages?: number[];
|
|
2260
|
+
Pages?: number[] | undefined;
|
|
2261
2261
|
}
|
|
2262
2262
|
/**
|
|
2263
2263
|
* @public
|
|
@@ -2269,39 +2269,39 @@ export interface GetDocumentAnalysisResponse {
|
|
|
2269
2269
|
* Amazon Textract video operation.</p>
|
|
2270
2270
|
* @public
|
|
2271
2271
|
*/
|
|
2272
|
-
DocumentMetadata?: DocumentMetadata;
|
|
2272
|
+
DocumentMetadata?: DocumentMetadata | undefined;
|
|
2273
2273
|
/**
|
|
2274
2274
|
* <p>The current status of the text detection job.</p>
|
|
2275
2275
|
* @public
|
|
2276
2276
|
*/
|
|
2277
|
-
JobStatus?: JobStatus;
|
|
2277
|
+
JobStatus?: JobStatus | undefined;
|
|
2278
2278
|
/**
|
|
2279
2279
|
* <p>If the response is truncated, Amazon Textract returns this token. You can use this token
|
|
2280
2280
|
* in the subsequent request to retrieve the next set of text detection results.</p>
|
|
2281
2281
|
* @public
|
|
2282
2282
|
*/
|
|
2283
|
-
NextToken?: string;
|
|
2283
|
+
NextToken?: string | undefined;
|
|
2284
2284
|
/**
|
|
2285
2285
|
* <p>The results of the text-analysis operation.</p>
|
|
2286
2286
|
* @public
|
|
2287
2287
|
*/
|
|
2288
|
-
Blocks?: Block[];
|
|
2288
|
+
Blocks?: Block[] | undefined;
|
|
2289
2289
|
/**
|
|
2290
2290
|
* <p>A list of warnings that occurred during the document-analysis operation.</p>
|
|
2291
2291
|
* @public
|
|
2292
2292
|
*/
|
|
2293
|
-
Warnings?: Warning[];
|
|
2293
|
+
Warnings?: Warning[] | undefined;
|
|
2294
2294
|
/**
|
|
2295
2295
|
* <p>Returns if the detection job could not be completed. Contains explanation for what error
|
|
2296
2296
|
* occured.</p>
|
|
2297
2297
|
* @public
|
|
2298
2298
|
*/
|
|
2299
|
-
StatusMessage?: string;
|
|
2299
|
+
StatusMessage?: string | undefined;
|
|
2300
2300
|
/**
|
|
2301
2301
|
* <p></p>
|
|
2302
2302
|
* @public
|
|
2303
2303
|
*/
|
|
2304
|
-
AnalyzeDocumentModelVersion?: string;
|
|
2304
|
+
AnalyzeDocumentModelVersion?: string | undefined;
|
|
2305
2305
|
}
|
|
2306
2306
|
/**
|
|
2307
2307
|
* <p>An invalid job identifier was passed to an asynchronous analysis operation.</p>
|
|
@@ -2310,8 +2310,8 @@ export interface GetDocumentAnalysisResponse {
|
|
|
2310
2310
|
export declare class InvalidJobIdException extends __BaseException {
|
|
2311
2311
|
readonly name: "InvalidJobIdException";
|
|
2312
2312
|
readonly $fault: "client";
|
|
2313
|
-
Message?: string;
|
|
2314
|
-
Code?: string;
|
|
2313
|
+
Message?: string | undefined;
|
|
2314
|
+
Code?: string | undefined;
|
|
2315
2315
|
/**
|
|
2316
2316
|
* @internal
|
|
2317
2317
|
*/
|
|
@@ -2333,13 +2333,13 @@ export interface GetDocumentTextDetectionRequest {
|
|
|
2333
2333
|
* returned. The default value is 1,000.</p>
|
|
2334
2334
|
* @public
|
|
2335
2335
|
*/
|
|
2336
|
-
MaxResults?: number;
|
|
2336
|
+
MaxResults?: number | undefined;
|
|
2337
2337
|
/**
|
|
2338
2338
|
* <p>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination
|
|
2339
2339
|
* token in the response. You can use this pagination token to retrieve the next set of blocks.</p>
|
|
2340
2340
|
* @public
|
|
2341
2341
|
*/
|
|
2342
|
-
NextToken?: string;
|
|
2342
|
+
NextToken?: string | undefined;
|
|
2343
2343
|
}
|
|
2344
2344
|
/**
|
|
2345
2345
|
* @public
|
|
@@ -2350,39 +2350,39 @@ export interface GetDocumentTextDetectionResponse {
|
|
|
2350
2350
|
* returned in every page of paginated responses from an Amazon Textract video operation.</p>
|
|
2351
2351
|
* @public
|
|
2352
2352
|
*/
|
|
2353
|
-
DocumentMetadata?: DocumentMetadata;
|
|
2353
|
+
DocumentMetadata?: DocumentMetadata | undefined;
|
|
2354
2354
|
/**
|
|
2355
2355
|
* <p>The current status of the text detection job.</p>
|
|
2356
2356
|
* @public
|
|
2357
2357
|
*/
|
|
2358
|
-
JobStatus?: JobStatus;
|
|
2358
|
+
JobStatus?: JobStatus | undefined;
|
|
2359
2359
|
/**
|
|
2360
2360
|
* <p>If the response is truncated, Amazon Textract returns this token. You can use this token in
|
|
2361
2361
|
* the subsequent request to retrieve the next set of text-detection results.</p>
|
|
2362
2362
|
* @public
|
|
2363
2363
|
*/
|
|
2364
|
-
NextToken?: string;
|
|
2364
|
+
NextToken?: string | undefined;
|
|
2365
2365
|
/**
|
|
2366
2366
|
* <p>The results of the text-detection operation.</p>
|
|
2367
2367
|
* @public
|
|
2368
2368
|
*/
|
|
2369
|
-
Blocks?: Block[];
|
|
2369
|
+
Blocks?: Block[] | undefined;
|
|
2370
2370
|
/**
|
|
2371
2371
|
* <p>A list of warnings that occurred during the text-detection operation for the
|
|
2372
2372
|
* document.</p>
|
|
2373
2373
|
* @public
|
|
2374
2374
|
*/
|
|
2375
|
-
Warnings?: Warning[];
|
|
2375
|
+
Warnings?: Warning[] | undefined;
|
|
2376
2376
|
/**
|
|
2377
2377
|
* <p>Returns if the detection job could not be completed. Contains explanation for what error occured. </p>
|
|
2378
2378
|
* @public
|
|
2379
2379
|
*/
|
|
2380
|
-
StatusMessage?: string;
|
|
2380
|
+
StatusMessage?: string | undefined;
|
|
2381
2381
|
/**
|
|
2382
2382
|
* <p></p>
|
|
2383
2383
|
* @public
|
|
2384
2384
|
*/
|
|
2385
|
-
DetectDocumentTextModelVersion?: string;
|
|
2385
|
+
DetectDocumentTextModelVersion?: string | undefined;
|
|
2386
2386
|
}
|
|
2387
2387
|
/**
|
|
2388
2388
|
* @public
|
|
@@ -2400,13 +2400,13 @@ export interface GetExpenseAnalysisRequest {
|
|
|
2400
2400
|
* returned. The default value is 20.</p>
|
|
2401
2401
|
* @public
|
|
2402
2402
|
*/
|
|
2403
|
-
MaxResults?: number;
|
|
2403
|
+
MaxResults?: number | undefined;
|
|
2404
2404
|
/**
|
|
2405
2405
|
* <p>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination
|
|
2406
2406
|
* token in the response. You can use this pagination token to retrieve the next set of blocks.</p>
|
|
2407
2407
|
* @public
|
|
2408
2408
|
*/
|
|
2409
|
-
NextToken?: string;
|
|
2409
|
+
NextToken?: string | undefined;
|
|
2410
2410
|
}
|
|
2411
2411
|
/**
|
|
2412
2412
|
* @public
|
|
@@ -2417,39 +2417,39 @@ export interface GetExpenseAnalysisResponse {
|
|
|
2417
2417
|
* returned in every page of paginated responses from an Amazon Textract operation.</p>
|
|
2418
2418
|
* @public
|
|
2419
2419
|
*/
|
|
2420
|
-
DocumentMetadata?: DocumentMetadata;
|
|
2420
|
+
DocumentMetadata?: DocumentMetadata | undefined;
|
|
2421
2421
|
/**
|
|
2422
2422
|
* <p>The current status of the text detection job.</p>
|
|
2423
2423
|
* @public
|
|
2424
2424
|
*/
|
|
2425
|
-
JobStatus?: JobStatus;
|
|
2425
|
+
JobStatus?: JobStatus | undefined;
|
|
2426
2426
|
/**
|
|
2427
2427
|
* <p>If the response is truncated, Amazon Textract returns this token. You can use this token in
|
|
2428
2428
|
* the subsequent request to retrieve the next set of text-detection results.</p>
|
|
2429
2429
|
* @public
|
|
2430
2430
|
*/
|
|
2431
|
-
NextToken?: string;
|
|
2431
|
+
NextToken?: string | undefined;
|
|
2432
2432
|
/**
|
|
2433
2433
|
* <p>The expenses detected by Amazon Textract.</p>
|
|
2434
2434
|
* @public
|
|
2435
2435
|
*/
|
|
2436
|
-
ExpenseDocuments?: ExpenseDocument[];
|
|
2436
|
+
ExpenseDocuments?: ExpenseDocument[] | undefined;
|
|
2437
2437
|
/**
|
|
2438
2438
|
* <p>A list of warnings that occurred during the text-detection operation for the
|
|
2439
2439
|
* document.</p>
|
|
2440
2440
|
* @public
|
|
2441
2441
|
*/
|
|
2442
|
-
Warnings?: Warning[];
|
|
2442
|
+
Warnings?: Warning[] | undefined;
|
|
2443
2443
|
/**
|
|
2444
2444
|
* <p>Returns if the detection job could not be completed. Contains explanation for what error occured. </p>
|
|
2445
2445
|
* @public
|
|
2446
2446
|
*/
|
|
2447
|
-
StatusMessage?: string;
|
|
2447
|
+
StatusMessage?: string | undefined;
|
|
2448
2448
|
/**
|
|
2449
2449
|
* <p>The current model version of AnalyzeExpense.</p>
|
|
2450
2450
|
* @public
|
|
2451
2451
|
*/
|
|
2452
|
-
AnalyzeExpenseModelVersion?: string;
|
|
2452
|
+
AnalyzeExpenseModelVersion?: string | undefined;
|
|
2453
2453
|
}
|
|
2454
2454
|
/**
|
|
2455
2455
|
* @public
|
|
@@ -2468,14 +2468,14 @@ export interface GetLendingAnalysisRequest {
|
|
|
2468
2468
|
* returned. The default value is 30.</p>
|
|
2469
2469
|
* @public
|
|
2470
2470
|
*/
|
|
2471
|
-
MaxResults?: number;
|
|
2471
|
+
MaxResults?: number | undefined;
|
|
2472
2472
|
/**
|
|
2473
2473
|
* <p>If the previous response was incomplete, Amazon Textract returns a pagination token in
|
|
2474
2474
|
* the response. You can use this pagination token to retrieve the next set of lending
|
|
2475
2475
|
* results.</p>
|
|
2476
2476
|
* @public
|
|
2477
2477
|
*/
|
|
2478
|
-
NextToken?: string;
|
|
2478
|
+
NextToken?: string | undefined;
|
|
2479
2479
|
}
|
|
2480
2480
|
/**
|
|
2481
2481
|
* <p>Contains information regarding predicted values returned by Amazon Textract operations, including the
|
|
@@ -2487,12 +2487,12 @@ export interface Prediction {
|
|
|
2487
2487
|
* <p>The predicted value of a detected object.</p>
|
|
2488
2488
|
* @public
|
|
2489
2489
|
*/
|
|
2490
|
-
Value?: string;
|
|
2490
|
+
Value?: string | undefined;
|
|
2491
2491
|
/**
|
|
2492
2492
|
* <p>Amazon Textract's confidence in its predicted value.</p>
|
|
2493
2493
|
* @public
|
|
2494
2494
|
*/
|
|
2495
|
-
Confidence?: number;
|
|
2495
|
+
Confidence?: number | undefined;
|
|
2496
2496
|
}
|
|
2497
2497
|
/**
|
|
2498
2498
|
* <p>The class assigned to a Page object detected in an input document.
|
|
@@ -2522,17 +2522,17 @@ export interface LendingResult {
|
|
|
2522
2522
|
* <p>The page number for a page, with regard to whole submission.</p>
|
|
2523
2523
|
* @public
|
|
2524
2524
|
*/
|
|
2525
|
-
Page?: number;
|
|
2525
|
+
Page?: number | undefined;
|
|
2526
2526
|
/**
|
|
2527
2527
|
* <p>The classifier result for a given page.</p>
|
|
2528
2528
|
* @public
|
|
2529
2529
|
*/
|
|
2530
|
-
PageClassification?: PageClassification;
|
|
2530
|
+
PageClassification?: PageClassification | undefined;
|
|
2531
2531
|
/**
|
|
2532
2532
|
* <p>An array of Extraction to hold structured data. e.g. normalized key value pairs instead of raw OCR detections .</p>
|
|
2533
2533
|
* @public
|
|
2534
2534
|
*/
|
|
2535
|
-
Extractions?: Extraction[];
|
|
2535
|
+
Extractions?: Extraction[] | undefined;
|
|
2536
2536
|
}
|
|
2537
2537
|
/**
|
|
2538
2538
|
* @public
|
|
@@ -2542,40 +2542,40 @@ export interface GetLendingAnalysisResponse {
|
|
|
2542
2542
|
* <p>Information about the input document.</p>
|
|
2543
2543
|
* @public
|
|
2544
2544
|
*/
|
|
2545
|
-
DocumentMetadata?: DocumentMetadata;
|
|
2545
|
+
DocumentMetadata?: DocumentMetadata | undefined;
|
|
2546
2546
|
/**
|
|
2547
2547
|
* <p> The current status of the lending analysis job.</p>
|
|
2548
2548
|
* @public
|
|
2549
2549
|
*/
|
|
2550
|
-
JobStatus?: JobStatus;
|
|
2550
|
+
JobStatus?: JobStatus | undefined;
|
|
2551
2551
|
/**
|
|
2552
2552
|
* <p>If the response is truncated, Amazon Textract returns this token.
|
|
2553
2553
|
* You can use this token in the subsequent request to retrieve the next set of lending results.</p>
|
|
2554
2554
|
* @public
|
|
2555
2555
|
*/
|
|
2556
|
-
NextToken?: string;
|
|
2556
|
+
NextToken?: string | undefined;
|
|
2557
2557
|
/**
|
|
2558
2558
|
* <p> Holds the information returned by one of AmazonTextract's document analysis
|
|
2559
2559
|
* operations for the pinstripe.</p>
|
|
2560
2560
|
* @public
|
|
2561
2561
|
*/
|
|
2562
|
-
Results?: LendingResult[];
|
|
2562
|
+
Results?: LendingResult[] | undefined;
|
|
2563
2563
|
/**
|
|
2564
2564
|
* <p> A list of warnings that occurred during the lending analysis operation. </p>
|
|
2565
2565
|
* @public
|
|
2566
2566
|
*/
|
|
2567
|
-
Warnings?: Warning[];
|
|
2567
|
+
Warnings?: Warning[] | undefined;
|
|
2568
2568
|
/**
|
|
2569
2569
|
* <p> Returns if the lending analysis job could not be completed. Contains explanation for
|
|
2570
2570
|
* what error occurred. </p>
|
|
2571
2571
|
* @public
|
|
2572
2572
|
*/
|
|
2573
|
-
StatusMessage?: string;
|
|
2573
|
+
StatusMessage?: string | undefined;
|
|
2574
2574
|
/**
|
|
2575
2575
|
* <p> The current model version of the Analyze Lending API.</p>
|
|
2576
2576
|
* @public
|
|
2577
2577
|
*/
|
|
2578
|
-
AnalyzeLendingModelVersion?: string;
|
|
2578
|
+
AnalyzeLendingModelVersion?: string | undefined;
|
|
2579
2579
|
}
|
|
2580
2580
|
/**
|
|
2581
2581
|
* @public
|
|
@@ -2597,12 +2597,12 @@ export interface LendingSummary {
|
|
|
2597
2597
|
* <p>Contains an array of all DocumentGroup objects.</p>
|
|
2598
2598
|
* @public
|
|
2599
2599
|
*/
|
|
2600
|
-
DocumentGroups?: DocumentGroup[];
|
|
2600
|
+
DocumentGroups?: DocumentGroup[] | undefined;
|
|
2601
2601
|
/**
|
|
2602
2602
|
* <p>UndetectedDocumentTypes.</p>
|
|
2603
2603
|
* @public
|
|
2604
2604
|
*/
|
|
2605
|
-
UndetectedDocumentTypes?: string[];
|
|
2605
|
+
UndetectedDocumentTypes?: string[] | undefined;
|
|
2606
2606
|
}
|
|
2607
2607
|
/**
|
|
2608
2608
|
* @public
|
|
@@ -2612,33 +2612,33 @@ export interface GetLendingAnalysisSummaryResponse {
|
|
|
2612
2612
|
* <p>Information about the input document.</p>
|
|
2613
2613
|
* @public
|
|
2614
2614
|
*/
|
|
2615
|
-
DocumentMetadata?: DocumentMetadata;
|
|
2615
|
+
DocumentMetadata?: DocumentMetadata | undefined;
|
|
2616
2616
|
/**
|
|
2617
2617
|
* <p> The current status of the lending analysis job. </p>
|
|
2618
2618
|
* @public
|
|
2619
2619
|
*/
|
|
2620
|
-
JobStatus?: JobStatus;
|
|
2620
|
+
JobStatus?: JobStatus | undefined;
|
|
2621
2621
|
/**
|
|
2622
2622
|
* <p> Contains summary information for documents grouped by type.</p>
|
|
2623
2623
|
* @public
|
|
2624
2624
|
*/
|
|
2625
|
-
Summary?: LendingSummary;
|
|
2625
|
+
Summary?: LendingSummary | undefined;
|
|
2626
2626
|
/**
|
|
2627
2627
|
* <p>A list of warnings that occurred during the lending analysis operation.</p>
|
|
2628
2628
|
* @public
|
|
2629
2629
|
*/
|
|
2630
|
-
Warnings?: Warning[];
|
|
2630
|
+
Warnings?: Warning[] | undefined;
|
|
2631
2631
|
/**
|
|
2632
2632
|
* <p>Returns if the lending analysis could not be completed. Contains explanation for what error
|
|
2633
2633
|
* occurred.</p>
|
|
2634
2634
|
* @public
|
|
2635
2635
|
*/
|
|
2636
|
-
StatusMessage?: string;
|
|
2636
|
+
StatusMessage?: string | undefined;
|
|
2637
2637
|
/**
|
|
2638
2638
|
* <p>The current model version of the Analyze Lending API.</p>
|
|
2639
2639
|
* @public
|
|
2640
2640
|
*/
|
|
2641
|
-
AnalyzeLendingModelVersion?: string;
|
|
2641
|
+
AnalyzeLendingModelVersion?: string | undefined;
|
|
2642
2642
|
}
|
|
2643
2643
|
/**
|
|
2644
2644
|
* @public
|
|
@@ -2649,23 +2649,23 @@ export interface ListAdaptersRequest {
|
|
|
2649
2649
|
* Ensures ListAdapters returns only adapters created after the specified creation time.</p>
|
|
2650
2650
|
* @public
|
|
2651
2651
|
*/
|
|
2652
|
-
AfterCreationTime?: Date;
|
|
2652
|
+
AfterCreationTime?: Date | undefined;
|
|
2653
2653
|
/**
|
|
2654
2654
|
* <p>Specifies the upper bound for the ListAdapters operation.
|
|
2655
2655
|
* Ensures ListAdapters returns only adapters created before the specified creation time.</p>
|
|
2656
2656
|
* @public
|
|
2657
2657
|
*/
|
|
2658
|
-
BeforeCreationTime?: Date;
|
|
2658
|
+
BeforeCreationTime?: Date | undefined;
|
|
2659
2659
|
/**
|
|
2660
2660
|
* <p>The maximum number of results to return when listing adapters.</p>
|
|
2661
2661
|
* @public
|
|
2662
2662
|
*/
|
|
2663
|
-
MaxResults?: number;
|
|
2663
|
+
MaxResults?: number | undefined;
|
|
2664
2664
|
/**
|
|
2665
2665
|
* <p>Identifies the next page of results to return when listing adapters.</p>
|
|
2666
2666
|
* @public
|
|
2667
2667
|
*/
|
|
2668
|
-
NextToken?: string;
|
|
2668
|
+
NextToken?: string | undefined;
|
|
2669
2669
|
}
|
|
2670
2670
|
/**
|
|
2671
2671
|
* @public
|
|
@@ -2675,12 +2675,12 @@ export interface ListAdaptersResponse {
|
|
|
2675
2675
|
* <p>A list of adapters that matches the filtering criteria specified when calling ListAdapters.</p>
|
|
2676
2676
|
* @public
|
|
2677
2677
|
*/
|
|
2678
|
-
Adapters?: AdapterOverview[];
|
|
2678
|
+
Adapters?: AdapterOverview[] | undefined;
|
|
2679
2679
|
/**
|
|
2680
2680
|
* <p>Identifies the next page of results to return when listing adapters.</p>
|
|
2681
2681
|
* @public
|
|
2682
2682
|
*/
|
|
2683
|
-
NextToken?: string;
|
|
2683
|
+
NextToken?: string | undefined;
|
|
2684
2684
|
}
|
|
2685
2685
|
/**
|
|
2686
2686
|
* @public
|
|
@@ -2690,29 +2690,29 @@ export interface ListAdapterVersionsRequest {
|
|
|
2690
2690
|
* <p>A string containing a unique ID for the adapter to match for when listing adapter versions.</p>
|
|
2691
2691
|
* @public
|
|
2692
2692
|
*/
|
|
2693
|
-
AdapterId?: string;
|
|
2693
|
+
AdapterId?: string | undefined;
|
|
2694
2694
|
/**
|
|
2695
2695
|
* <p>Specifies the lower bound for the ListAdapterVersions operation.
|
|
2696
2696
|
* Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.</p>
|
|
2697
2697
|
* @public
|
|
2698
2698
|
*/
|
|
2699
|
-
AfterCreationTime?: Date;
|
|
2699
|
+
AfterCreationTime?: Date | undefined;
|
|
2700
2700
|
/**
|
|
2701
2701
|
* <p>Specifies the upper bound for the ListAdapterVersions operation.
|
|
2702
2702
|
* Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.</p>
|
|
2703
2703
|
* @public
|
|
2704
2704
|
*/
|
|
2705
|
-
BeforeCreationTime?: Date;
|
|
2705
|
+
BeforeCreationTime?: Date | undefined;
|
|
2706
2706
|
/**
|
|
2707
2707
|
* <p>The maximum number of results to return when listing adapter versions.</p>
|
|
2708
2708
|
* @public
|
|
2709
2709
|
*/
|
|
2710
|
-
MaxResults?: number;
|
|
2710
|
+
MaxResults?: number | undefined;
|
|
2711
2711
|
/**
|
|
2712
2712
|
* <p>Identifies the next page of results to return when listing adapter versions.</p>
|
|
2713
2713
|
* @public
|
|
2714
2714
|
*/
|
|
2715
|
-
NextToken?: string;
|
|
2715
|
+
NextToken?: string | undefined;
|
|
2716
2716
|
}
|
|
2717
2717
|
/**
|
|
2718
2718
|
* @public
|
|
@@ -2722,12 +2722,12 @@ export interface ListAdapterVersionsResponse {
|
|
|
2722
2722
|
* <p>Adapter versions that match the filtering criteria specified when calling ListAdapters.</p>
|
|
2723
2723
|
* @public
|
|
2724
2724
|
*/
|
|
2725
|
-
AdapterVersions?: AdapterVersionOverview[];
|
|
2725
|
+
AdapterVersions?: AdapterVersionOverview[] | undefined;
|
|
2726
2726
|
/**
|
|
2727
2727
|
* <p>Identifies the next page of results to return when listing adapter versions.</p>
|
|
2728
2728
|
* @public
|
|
2729
2729
|
*/
|
|
2730
|
-
NextToken?: string;
|
|
2730
|
+
NextToken?: string | undefined;
|
|
2731
2731
|
}
|
|
2732
2732
|
/**
|
|
2733
2733
|
* @public
|
|
@@ -2747,7 +2747,7 @@ export interface ListTagsForResourceResponse {
|
|
|
2747
2747
|
* <p>A set of tags (key-value pairs) that are part of the requested resource.</p>
|
|
2748
2748
|
* @public
|
|
2749
2749
|
*/
|
|
2750
|
-
Tags?: Record<string, string
|
|
2750
|
+
Tags?: Record<string, string> | undefined;
|
|
2751
2751
|
}
|
|
2752
2752
|
/**
|
|
2753
2753
|
* <p>The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of
|
|
@@ -2793,7 +2793,7 @@ export interface StartDocumentAnalysisRequest {
|
|
|
2793
2793
|
* <a href="https://docs.aws.amazon.com/textract/latest/dg/api-async.html">Calling Amazon Textract Asynchronous Operations</a>.</p>
|
|
2794
2794
|
* @public
|
|
2795
2795
|
*/
|
|
2796
|
-
ClientRequestToken?: string;
|
|
2796
|
+
ClientRequestToken?: string | undefined;
|
|
2797
2797
|
/**
|
|
2798
2798
|
* <p>An identifier that you specify that's included in the completion notification published
|
|
2799
2799
|
* to the Amazon SNS topic. For example, you can use <code>JobTag</code> to identify the type of
|
|
@@ -2801,19 +2801,19 @@ export interface StartDocumentAnalysisRequest {
|
|
|
2801
2801
|
* receipt).</p>
|
|
2802
2802
|
* @public
|
|
2803
2803
|
*/
|
|
2804
|
-
JobTag?: string;
|
|
2804
|
+
JobTag?: string | undefined;
|
|
2805
2805
|
/**
|
|
2806
2806
|
* <p>The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the
|
|
2807
2807
|
* operation to. </p>
|
|
2808
2808
|
* @public
|
|
2809
2809
|
*/
|
|
2810
|
-
NotificationChannel?: NotificationChannel;
|
|
2810
|
+
NotificationChannel?: NotificationChannel | undefined;
|
|
2811
2811
|
/**
|
|
2812
2812
|
* <p>Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save
|
|
2813
2813
|
* the results internally to be accessed by the GetDocumentAnalysis operation.</p>
|
|
2814
2814
|
* @public
|
|
2815
2815
|
*/
|
|
2816
|
-
OutputConfig?: OutputConfig;
|
|
2816
|
+
OutputConfig?: OutputConfig | undefined;
|
|
2817
2817
|
/**
|
|
2818
2818
|
* <p>The KMS key used to encrypt the inference results. This can be
|
|
2819
2819
|
* in either Key ID or Key Alias format. When a KMS key is provided, the
|
|
@@ -2822,17 +2822,17 @@ export interface StartDocumentAnalysisRequest {
|
|
|
2822
2822
|
* be encrypted server side,using SSE-S3.</p>
|
|
2823
2823
|
* @public
|
|
2824
2824
|
*/
|
|
2825
|
-
KMSKeyId?: string;
|
|
2825
|
+
KMSKeyId?: string | undefined;
|
|
2826
2826
|
/**
|
|
2827
2827
|
* <p></p>
|
|
2828
2828
|
* @public
|
|
2829
2829
|
*/
|
|
2830
|
-
QueriesConfig?: QueriesConfig;
|
|
2830
|
+
QueriesConfig?: QueriesConfig | undefined;
|
|
2831
2831
|
/**
|
|
2832
2832
|
* <p>Specifies the adapter to be used when analyzing a document.</p>
|
|
2833
2833
|
* @public
|
|
2834
2834
|
*/
|
|
2835
|
-
AdaptersConfig?: AdaptersConfig;
|
|
2835
|
+
AdaptersConfig?: AdaptersConfig | undefined;
|
|
2836
2836
|
}
|
|
2837
2837
|
/**
|
|
2838
2838
|
* @public
|
|
@@ -2844,7 +2844,7 @@ export interface StartDocumentAnalysisResponse {
|
|
|
2844
2844
|
* is only valid for 7 days.</p>
|
|
2845
2845
|
* @public
|
|
2846
2846
|
*/
|
|
2847
|
-
JobId?: string;
|
|
2847
|
+
JobId?: string | undefined;
|
|
2848
2848
|
}
|
|
2849
2849
|
/**
|
|
2850
2850
|
* @public
|
|
@@ -2863,7 +2863,7 @@ export interface StartDocumentTextDetectionRequest {
|
|
|
2863
2863
|
* <a href="https://docs.aws.amazon.com/textract/latest/dg/api-async.html">Calling Amazon Textract Asynchronous Operations</a>.</p>
|
|
2864
2864
|
* @public
|
|
2865
2865
|
*/
|
|
2866
|
-
ClientRequestToken?: string;
|
|
2866
|
+
ClientRequestToken?: string | undefined;
|
|
2867
2867
|
/**
|
|
2868
2868
|
* <p>An identifier that you specify that's included in the completion notification published
|
|
2869
2869
|
* to the Amazon SNS topic. For example, you can use <code>JobTag</code> to identify the type of
|
|
@@ -2871,19 +2871,19 @@ export interface StartDocumentTextDetectionRequest {
|
|
|
2871
2871
|
* receipt).</p>
|
|
2872
2872
|
* @public
|
|
2873
2873
|
*/
|
|
2874
|
-
JobTag?: string;
|
|
2874
|
+
JobTag?: string | undefined;
|
|
2875
2875
|
/**
|
|
2876
2876
|
* <p>The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the
|
|
2877
2877
|
* operation to. </p>
|
|
2878
2878
|
* @public
|
|
2879
2879
|
*/
|
|
2880
|
-
NotificationChannel?: NotificationChannel;
|
|
2880
|
+
NotificationChannel?: NotificationChannel | undefined;
|
|
2881
2881
|
/**
|
|
2882
2882
|
* <p>Sets if the output will go to a customer defined bucket. By default Amazon Textract will
|
|
2883
2883
|
* save the results internally to be accessed with the GetDocumentTextDetection operation.</p>
|
|
2884
2884
|
* @public
|
|
2885
2885
|
*/
|
|
2886
|
-
OutputConfig?: OutputConfig;
|
|
2886
|
+
OutputConfig?: OutputConfig | undefined;
|
|
2887
2887
|
/**
|
|
2888
2888
|
* <p>The KMS key used to encrypt the inference results. This can be
|
|
2889
2889
|
* in either Key ID or Key Alias format. When a KMS key is provided, the
|
|
@@ -2892,7 +2892,7 @@ export interface StartDocumentTextDetectionRequest {
|
|
|
2892
2892
|
* be encrypted server side,using SSE-S3.</p>
|
|
2893
2893
|
* @public
|
|
2894
2894
|
*/
|
|
2895
|
-
KMSKeyId?: string;
|
|
2895
|
+
KMSKeyId?: string | undefined;
|
|
2896
2896
|
}
|
|
2897
2897
|
/**
|
|
2898
2898
|
* @public
|
|
@@ -2904,7 +2904,7 @@ export interface StartDocumentTextDetectionResponse {
|
|
|
2904
2904
|
* A <code>JobId</code> value is only valid for 7 days.</p>
|
|
2905
2905
|
* @public
|
|
2906
2906
|
*/
|
|
2907
|
-
JobId?: string;
|
|
2907
|
+
JobId?: string | undefined;
|
|
2908
2908
|
}
|
|
2909
2909
|
/**
|
|
2910
2910
|
* @public
|
|
@@ -2922,7 +2922,7 @@ export interface StartExpenseAnalysisRequest {
|
|
|
2922
2922
|
* </p>
|
|
2923
2923
|
* @public
|
|
2924
2924
|
*/
|
|
2925
|
-
ClientRequestToken?: string;
|
|
2925
|
+
ClientRequestToken?: string | undefined;
|
|
2926
2926
|
/**
|
|
2927
2927
|
* <p>An identifier you specify that's included in the completion notification published
|
|
2928
2928
|
* to the Amazon SNS topic. For example, you can use <code>JobTag</code> to identify the type of
|
|
@@ -2930,20 +2930,20 @@ export interface StartExpenseAnalysisRequest {
|
|
|
2930
2930
|
* receipt).</p>
|
|
2931
2931
|
* @public
|
|
2932
2932
|
*/
|
|
2933
|
-
JobTag?: string;
|
|
2933
|
+
JobTag?: string | undefined;
|
|
2934
2934
|
/**
|
|
2935
2935
|
* <p>The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the
|
|
2936
2936
|
* operation to. </p>
|
|
2937
2937
|
* @public
|
|
2938
2938
|
*/
|
|
2939
|
-
NotificationChannel?: NotificationChannel;
|
|
2939
|
+
NotificationChannel?: NotificationChannel | undefined;
|
|
2940
2940
|
/**
|
|
2941
2941
|
* <p>Sets if the output will go to a customer defined bucket. By default, Amazon Textract will
|
|
2942
2942
|
* save the results internally to be accessed by the <code>GetExpenseAnalysis</code>
|
|
2943
2943
|
* operation.</p>
|
|
2944
2944
|
* @public
|
|
2945
2945
|
*/
|
|
2946
|
-
OutputConfig?: OutputConfig;
|
|
2946
|
+
OutputConfig?: OutputConfig | undefined;
|
|
2947
2947
|
/**
|
|
2948
2948
|
* <p>The KMS key used to encrypt the inference results. This can be
|
|
2949
2949
|
* in either Key ID or Key Alias format. When a KMS key is provided, the
|
|
@@ -2952,7 +2952,7 @@ export interface StartExpenseAnalysisRequest {
|
|
|
2952
2952
|
* be encrypted server side,using SSE-S3.</p>
|
|
2953
2953
|
* @public
|
|
2954
2954
|
*/
|
|
2955
|
-
KMSKeyId?: string;
|
|
2955
|
+
KMSKeyId?: string | undefined;
|
|
2956
2956
|
}
|
|
2957
2957
|
/**
|
|
2958
2958
|
* @public
|
|
@@ -2963,7 +2963,7 @@ export interface StartExpenseAnalysisResponse {
|
|
|
2963
2963
|
* <code>StartExpenseAnalysis</code>. A <code>JobId</code> value is only valid for 7 days.</p>
|
|
2964
2964
|
* @public
|
|
2965
2965
|
*/
|
|
2966
|
-
JobId?: string;
|
|
2966
|
+
JobId?: string | undefined;
|
|
2967
2967
|
}
|
|
2968
2968
|
/**
|
|
2969
2969
|
* @public
|
|
@@ -2984,7 +2984,7 @@ export interface StartLendingAnalysisRequest {
|
|
|
2984
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
2985
|
* @public
|
|
2986
2986
|
*/
|
|
2987
|
-
ClientRequestToken?: string;
|
|
2987
|
+
ClientRequestToken?: string | undefined;
|
|
2988
2988
|
/**
|
|
2989
2989
|
* <p>An identifier that you specify to be included in the completion notification published to
|
|
2990
2990
|
* the Amazon SNS topic. For example, you can use <code>JobTag</code> to identify the type of
|
|
@@ -2992,13 +2992,13 @@ export interface StartLendingAnalysisRequest {
|
|
|
2992
2992
|
* receipt).</p>
|
|
2993
2993
|
* @public
|
|
2994
2994
|
*/
|
|
2995
|
-
JobTag?: string;
|
|
2995
|
+
JobTag?: string | undefined;
|
|
2996
2996
|
/**
|
|
2997
2997
|
* <p>The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of
|
|
2998
2998
|
* an asynchronous document operation. </p>
|
|
2999
2999
|
* @public
|
|
3000
3000
|
*/
|
|
3001
|
-
NotificationChannel?: NotificationChannel;
|
|
3001
|
+
NotificationChannel?: NotificationChannel | undefined;
|
|
3002
3002
|
/**
|
|
3003
3003
|
* <p>Sets whether or not your output will go to a user created bucket. Used to set the name
|
|
3004
3004
|
* of the bucket, and the prefix on the output file.</p>
|
|
@@ -3019,7 +3019,7 @@ export interface StartLendingAnalysisRequest {
|
|
|
3019
3019
|
* FAQ</a>.</p>
|
|
3020
3020
|
* @public
|
|
3021
3021
|
*/
|
|
3022
|
-
OutputConfig?: OutputConfig;
|
|
3022
|
+
OutputConfig?: OutputConfig | undefined;
|
|
3023
3023
|
/**
|
|
3024
3024
|
* <p>The KMS key used to encrypt the inference results. This can be in either Key ID or Key
|
|
3025
3025
|
* Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of
|
|
@@ -3027,7 +3027,7 @@ export interface StartLendingAnalysisRequest {
|
|
|
3027
3027
|
* encrypted server side, using SSE-S3. </p>
|
|
3028
3028
|
* @public
|
|
3029
3029
|
*/
|
|
3030
|
-
KMSKeyId?: string;
|
|
3030
|
+
KMSKeyId?: string | undefined;
|
|
3031
3031
|
}
|
|
3032
3032
|
/**
|
|
3033
3033
|
* @public
|
|
@@ -3039,7 +3039,7 @@ export interface StartLendingAnalysisResponse {
|
|
|
3039
3039
|
* days.</p>
|
|
3040
3040
|
* @public
|
|
3041
3041
|
*/
|
|
3042
|
-
JobId?: string;
|
|
3042
|
+
JobId?: string | undefined;
|
|
3043
3043
|
}
|
|
3044
3044
|
/**
|
|
3045
3045
|
* @public
|
|
@@ -3094,17 +3094,17 @@ export interface UpdateAdapterRequest {
|
|
|
3094
3094
|
* <p>The new description to be applied to the adapter.</p>
|
|
3095
3095
|
* @public
|
|
3096
3096
|
*/
|
|
3097
|
-
Description?: string;
|
|
3097
|
+
Description?: string | undefined;
|
|
3098
3098
|
/**
|
|
3099
3099
|
* <p>The new name to be applied to the adapter.</p>
|
|
3100
3100
|
* @public
|
|
3101
3101
|
*/
|
|
3102
|
-
AdapterName?: string;
|
|
3102
|
+
AdapterName?: string | undefined;
|
|
3103
3103
|
/**
|
|
3104
3104
|
* <p>The new auto-update status to be applied to the adapter.</p>
|
|
3105
3105
|
* @public
|
|
3106
3106
|
*/
|
|
3107
|
-
AutoUpdate?: AutoUpdate;
|
|
3107
|
+
AutoUpdate?: AutoUpdate | undefined;
|
|
3108
3108
|
}
|
|
3109
3109
|
/**
|
|
3110
3110
|
* @public
|
|
@@ -3114,30 +3114,30 @@ export interface UpdateAdapterResponse {
|
|
|
3114
3114
|
* <p>A string containing a unique ID for the adapter that has been updated.</p>
|
|
3115
3115
|
* @public
|
|
3116
3116
|
*/
|
|
3117
|
-
AdapterId?: string;
|
|
3117
|
+
AdapterId?: string | undefined;
|
|
3118
3118
|
/**
|
|
3119
3119
|
* <p>A string containing the name of the adapter that has been updated.</p>
|
|
3120
3120
|
* @public
|
|
3121
3121
|
*/
|
|
3122
|
-
AdapterName?: string;
|
|
3122
|
+
AdapterName?: string | undefined;
|
|
3123
3123
|
/**
|
|
3124
3124
|
* <p>An object specifying the creation time of the the adapter that has been updated.</p>
|
|
3125
3125
|
* @public
|
|
3126
3126
|
*/
|
|
3127
|
-
CreationTime?: Date;
|
|
3127
|
+
CreationTime?: Date | undefined;
|
|
3128
3128
|
/**
|
|
3129
3129
|
* <p>A string containing the description of the adapter that has been updated.</p>
|
|
3130
3130
|
* @public
|
|
3131
3131
|
*/
|
|
3132
|
-
Description?: string;
|
|
3132
|
+
Description?: string | undefined;
|
|
3133
3133
|
/**
|
|
3134
3134
|
* <p>List of the targeted feature types for the updated adapter.</p>
|
|
3135
3135
|
* @public
|
|
3136
3136
|
*/
|
|
3137
|
-
FeatureTypes?: FeatureType[];
|
|
3137
|
+
FeatureTypes?: FeatureType[] | undefined;
|
|
3138
3138
|
/**
|
|
3139
3139
|
* <p>The auto-update status of the adapter that has been updated.</p>
|
|
3140
3140
|
* @public
|
|
3141
3141
|
*/
|
|
3142
|
-
AutoUpdate?: AutoUpdate;
|
|
3142
|
+
AutoUpdate?: AutoUpdate | undefined;
|
|
3143
3143
|
}
|