@aws-sdk/client-textract 3.427.0 → 3.429.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/README.md +103 -7
- package/dist-cjs/Textract.js +24 -0
- package/dist-cjs/commands/CreateAdapterCommand.js +51 -0
- package/dist-cjs/commands/CreateAdapterVersionCommand.js +51 -0
- package/dist-cjs/commands/DeleteAdapterCommand.js +51 -0
- package/dist-cjs/commands/DeleteAdapterVersionCommand.js +51 -0
- package/dist-cjs/commands/GetAdapterCommand.js +51 -0
- package/dist-cjs/commands/GetAdapterVersionCommand.js +51 -0
- package/dist-cjs/commands/ListAdapterVersionsCommand.js +51 -0
- package/dist-cjs/commands/ListAdaptersCommand.js +51 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +51 -0
- package/dist-cjs/commands/TagResourceCommand.js +51 -0
- package/dist-cjs/commands/UntagResourceCommand.js +51 -0
- package/dist-cjs/commands/UpdateAdapterCommand.js +51 -0
- package/dist-cjs/commands/index.js +12 -0
- package/dist-cjs/index.js +1 -0
- package/dist-cjs/models/models_0.js +92 -21
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListAdapterVersionsPaginator.js +29 -0
- package/dist-cjs/pagination/ListAdaptersPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +6 -0
- package/dist-cjs/protocols/Aws_json1_1.js +951 -40
- package/dist-es/Textract.js +24 -0
- package/dist-es/commands/CreateAdapterCommand.js +47 -0
- package/dist-es/commands/CreateAdapterVersionCommand.js +47 -0
- package/dist-es/commands/DeleteAdapterCommand.js +47 -0
- package/dist-es/commands/DeleteAdapterVersionCommand.js +47 -0
- package/dist-es/commands/GetAdapterCommand.js +47 -0
- package/dist-es/commands/GetAdapterVersionCommand.js +47 -0
- package/dist-es/commands/ListAdapterVersionsCommand.js +47 -0
- package/dist-es/commands/ListAdaptersCommand.js +47 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +47 -0
- package/dist-es/commands/TagResourceCommand.js +47 -0
- package/dist-es/commands/UntagResourceCommand.js +47 -0
- package/dist-es/commands/UpdateAdapterCommand.js +47 -0
- package/dist-es/commands/index.js +12 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/models_0.js +84 -17
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListAdapterVersionsPaginator.js +25 -0
- package/dist-es/pagination/ListAdaptersPaginator.js +25 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_json1_1.js +927 -40
- package/dist-types/Textract.d.ts +84 -0
- package/dist-types/TextractClient.d.ts +14 -2
- package/dist-types/commands/AnalyzeDocumentCommand.d.ts +11 -0
- package/dist-types/commands/CreateAdapterCommand.d.ts +128 -0
- package/dist-types/commands/CreateAdapterVersionCommand.d.ts +148 -0
- package/dist-types/commands/DeleteAdapterCommand.d.ts +101 -0
- package/dist-types/commands/DeleteAdapterVersionCommand.d.ts +103 -0
- package/dist-types/commands/GetAdapterCommand.d.ts +111 -0
- package/dist-types/commands/GetAdapterVersionCommand.d.ts +140 -0
- package/dist-types/commands/ListAdapterVersionsCommand.d.ts +116 -0
- package/dist-types/commands/ListAdaptersCommand.d.ts +110 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +102 -0
- package/dist-types/commands/StartDocumentAnalysisCommand.d.ts +11 -0
- package/dist-types/commands/TagResourceCommand.d.ts +104 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +101 -0
- package/dist-types/commands/UpdateAdapterCommand.d.ts +114 -0
- package/dist-types/commands/index.d.ts +12 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1002 -187
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListAdapterVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAdaptersPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +108 -0
- package/dist-types/ts3.4/Textract.d.ts +204 -0
- package/dist-types/ts3.4/TextractClient.d.ts +74 -2
- package/dist-types/ts3.4/commands/CreateAdapterCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateAdapterVersionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteAdapterCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteAdapterVersionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetAdapterCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetAdapterVersionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListAdapterVersionsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListAdaptersCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateAdapterCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +12 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +252 -55
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListAdapterVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAdaptersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +144 -0
- package/package.json +34 -32
|
@@ -15,6 +15,101 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
15
15
|
*/
|
|
16
16
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
17
17
|
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
* <p>An adapter selected for use when analyzing documents. Contains an adapter ID and a version number.
|
|
21
|
+
* Contains information on pages selected for analysis when analyzing documents asychronously.</p>
|
|
22
|
+
*/
|
|
23
|
+
export interface Adapter {
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>A unique identifier for the adapter resource.</p>
|
|
27
|
+
*/
|
|
28
|
+
AdapterId: string | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* @public
|
|
31
|
+
* <p>Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a
|
|
32
|
+
* list of rules for using this parameter.</p>
|
|
33
|
+
* <ul>
|
|
34
|
+
* <li>
|
|
35
|
+
* <p>If a page is not specified, it is set to <code>["1"]</code> by default.</p>
|
|
36
|
+
* </li>
|
|
37
|
+
* <li>
|
|
38
|
+
* <p>The following characters are allowed in the parameter's string:
|
|
39
|
+
* <code>0 1 2 3 4 5 6 7 8 9 - *</code>. No whitespace is allowed.</p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>When using * to indicate all pages, it must be the only element in the list.</p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>You can use page intervals, such as <code>["1-3", "1-1", "4-*"]</code>. Where <code>*</code> indicates last page of
|
|
46
|
+
* document.</p>
|
|
47
|
+
* </li>
|
|
48
|
+
* <li>
|
|
49
|
+
* <p>Specified pages must be greater than 0 and less than or equal to the number of pages in the document.</p>
|
|
50
|
+
* </li>
|
|
51
|
+
* </ul>
|
|
52
|
+
*/
|
|
53
|
+
Pages?: string[];
|
|
54
|
+
/**
|
|
55
|
+
* @public
|
|
56
|
+
* <p>A string that identifies the version of the adapter.</p>
|
|
57
|
+
*/
|
|
58
|
+
Version: string | undefined;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* @public
|
|
62
|
+
* @enum
|
|
63
|
+
*/
|
|
64
|
+
export declare const FeatureType: {
|
|
65
|
+
readonly FORMS: "FORMS";
|
|
66
|
+
readonly LAYOUT: "LAYOUT";
|
|
67
|
+
readonly QUERIES: "QUERIES";
|
|
68
|
+
readonly SIGNATURES: "SIGNATURES";
|
|
69
|
+
readonly TABLES: "TABLES";
|
|
70
|
+
};
|
|
71
|
+
/**
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
export type FeatureType = (typeof FeatureType)[keyof typeof FeatureType];
|
|
75
|
+
/**
|
|
76
|
+
* @public
|
|
77
|
+
* <p>Contains information on the adapter, including the adapter ID, Name, Creation time, and feature types.</p>
|
|
78
|
+
*/
|
|
79
|
+
export interface AdapterOverview {
|
|
80
|
+
/**
|
|
81
|
+
* @public
|
|
82
|
+
* <p>A unique identifier for the adapter resource.</p>
|
|
83
|
+
*/
|
|
84
|
+
AdapterId?: string;
|
|
85
|
+
/**
|
|
86
|
+
* @public
|
|
87
|
+
* <p>A string naming the adapter resource.</p>
|
|
88
|
+
*/
|
|
89
|
+
AdapterName?: string;
|
|
90
|
+
/**
|
|
91
|
+
* @public
|
|
92
|
+
* <p>The date and time that the adapter was created.</p>
|
|
93
|
+
*/
|
|
94
|
+
CreationTime?: Date;
|
|
95
|
+
/**
|
|
96
|
+
* @public
|
|
97
|
+
* <p>The feature types that the adapter is operating on.</p>
|
|
98
|
+
*/
|
|
99
|
+
FeatureTypes?: FeatureType[];
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* @public
|
|
103
|
+
* <p>Contains information about adapters used when analyzing a document,
|
|
104
|
+
* with each adapter specified using an AdapterId and version</p>
|
|
105
|
+
*/
|
|
106
|
+
export interface AdaptersConfig {
|
|
107
|
+
/**
|
|
108
|
+
* @public
|
|
109
|
+
* <p>A list of adapters to be used when analyzing the specified document.</p>
|
|
110
|
+
*/
|
|
111
|
+
Adapters: Adapter[] | undefined;
|
|
112
|
+
}
|
|
18
113
|
/**
|
|
19
114
|
* @public
|
|
20
115
|
* <p>The S3 bucket name and file name that identifies the document.</p>
|
|
@@ -44,6 +139,118 @@ export interface S3Object {
|
|
|
44
139
|
*/
|
|
45
140
|
Version?: string;
|
|
46
141
|
}
|
|
142
|
+
/**
|
|
143
|
+
* @public
|
|
144
|
+
* <p>The dataset configuration options for a given version of an adapter.
|
|
145
|
+
* Can include an Amazon S3 bucket if specified.</p>
|
|
146
|
+
*/
|
|
147
|
+
export interface AdapterVersionDatasetConfig {
|
|
148
|
+
/**
|
|
149
|
+
* @public
|
|
150
|
+
* <p>The S3 bucket name and file name that identifies the document.</p>
|
|
151
|
+
* <p>The AWS Region for the S3 bucket that contains the document must match the Region that
|
|
152
|
+
* you use for Amazon Textract operations.</p>
|
|
153
|
+
* <p>For Amazon Textract to process a file in an S3 bucket, the user must have
|
|
154
|
+
* permission to access the S3 bucket and file.
|
|
155
|
+
*
|
|
156
|
+
* </p>
|
|
157
|
+
*/
|
|
158
|
+
ManifestS3Object?: S3Object;
|
|
159
|
+
}
|
|
160
|
+
/**
|
|
161
|
+
* @public
|
|
162
|
+
* <p>The evaluation metrics (F1 score, Precision, and Recall) for an adapter version.</p>
|
|
163
|
+
*/
|
|
164
|
+
export interface EvaluationMetric {
|
|
165
|
+
/**
|
|
166
|
+
* @public
|
|
167
|
+
* <p>The F1 score for an adapter version.</p>
|
|
168
|
+
*/
|
|
169
|
+
F1Score?: number;
|
|
170
|
+
/**
|
|
171
|
+
* @public
|
|
172
|
+
* <p>The Precision score for an adapter version.</p>
|
|
173
|
+
*/
|
|
174
|
+
Precision?: number;
|
|
175
|
+
/**
|
|
176
|
+
* @public
|
|
177
|
+
* <p>The Recall score for an adapter version.</p>
|
|
178
|
+
*/
|
|
179
|
+
Recall?: number;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* @public
|
|
183
|
+
* <p>Contains information on the metrics used to evalute the peformance of a given adapter version. Includes data for
|
|
184
|
+
* baseline model performance and individual adapter version perfromance.</p>
|
|
185
|
+
*/
|
|
186
|
+
export interface AdapterVersionEvaluationMetric {
|
|
187
|
+
/**
|
|
188
|
+
* @public
|
|
189
|
+
* <p>The F1 score, precision, and recall metrics for the baseline model.</p>
|
|
190
|
+
*/
|
|
191
|
+
Baseline?: EvaluationMetric;
|
|
192
|
+
/**
|
|
193
|
+
* @public
|
|
194
|
+
* <p>The F1 score, precision, and recall metrics for the baseline model.</p>
|
|
195
|
+
*/
|
|
196
|
+
AdapterVersion?: EvaluationMetric;
|
|
197
|
+
/**
|
|
198
|
+
* @public
|
|
199
|
+
* <p>Indicates the feature type being analyzed by a given adapter version.</p>
|
|
200
|
+
*/
|
|
201
|
+
FeatureType?: FeatureType;
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* @public
|
|
205
|
+
* @enum
|
|
206
|
+
*/
|
|
207
|
+
export declare const AdapterVersionStatus: {
|
|
208
|
+
readonly ACTIVE: "ACTIVE";
|
|
209
|
+
readonly AT_RISK: "AT_RISK";
|
|
210
|
+
readonly CREATION_ERROR: "CREATION_ERROR";
|
|
211
|
+
readonly CREATION_IN_PROGRESS: "CREATION_IN_PROGRESS";
|
|
212
|
+
readonly DEPRECATED: "DEPRECATED";
|
|
213
|
+
};
|
|
214
|
+
/**
|
|
215
|
+
* @public
|
|
216
|
+
*/
|
|
217
|
+
export type AdapterVersionStatus = (typeof AdapterVersionStatus)[keyof typeof AdapterVersionStatus];
|
|
218
|
+
/**
|
|
219
|
+
* @public
|
|
220
|
+
* <p>Summary info for an adapter version. Contains information on the AdapterId, AdapterVersion, CreationTime, FeatureTypes, and Status.</p>
|
|
221
|
+
*/
|
|
222
|
+
export interface AdapterVersionOverview {
|
|
223
|
+
/**
|
|
224
|
+
* @public
|
|
225
|
+
* <p>A unique identifier for the adapter associated with a given adapter version.</p>
|
|
226
|
+
*/
|
|
227
|
+
AdapterId?: string;
|
|
228
|
+
/**
|
|
229
|
+
* @public
|
|
230
|
+
* <p>An identified for a given adapter version.</p>
|
|
231
|
+
*/
|
|
232
|
+
AdapterVersion?: string;
|
|
233
|
+
/**
|
|
234
|
+
* @public
|
|
235
|
+
* <p>The date and time that a given adapter version was created.</p>
|
|
236
|
+
*/
|
|
237
|
+
CreationTime?: Date;
|
|
238
|
+
/**
|
|
239
|
+
* @public
|
|
240
|
+
* <p>The feature types that the adapter version is operating on.</p>
|
|
241
|
+
*/
|
|
242
|
+
FeatureTypes?: FeatureType[];
|
|
243
|
+
/**
|
|
244
|
+
* @public
|
|
245
|
+
* <p>Contains information on the status of a given adapter version.</p>
|
|
246
|
+
*/
|
|
247
|
+
Status?: AdapterVersionStatus;
|
|
248
|
+
/**
|
|
249
|
+
* @public
|
|
250
|
+
* <p>A message explaining the status of a given adapter vesion.</p>
|
|
251
|
+
*/
|
|
252
|
+
StatusMessage?: string;
|
|
253
|
+
}
|
|
47
254
|
/**
|
|
48
255
|
* @public
|
|
49
256
|
* <p>The input document, either as bytes or as an S3 object.</p>
|
|
@@ -79,21 +286,6 @@ export interface Document {
|
|
|
79
286
|
*/
|
|
80
287
|
S3Object?: S3Object;
|
|
81
288
|
}
|
|
82
|
-
/**
|
|
83
|
-
* @public
|
|
84
|
-
* @enum
|
|
85
|
-
*/
|
|
86
|
-
export declare const FeatureType: {
|
|
87
|
-
readonly FORMS: "FORMS";
|
|
88
|
-
readonly LAYOUT: "LAYOUT";
|
|
89
|
-
readonly QUERIES: "QUERIES";
|
|
90
|
-
readonly SIGNATURES: "SIGNATURES";
|
|
91
|
-
readonly TABLES: "TABLES";
|
|
92
|
-
};
|
|
93
|
-
/**
|
|
94
|
-
* @public
|
|
95
|
-
*/
|
|
96
|
-
export type FeatureType = (typeof FeatureType)[keyof typeof FeatureType];
|
|
97
289
|
/**
|
|
98
290
|
* @public
|
|
99
291
|
* @enum
|
|
@@ -117,7 +309,7 @@ export interface HumanLoopDataAttributes {
|
|
|
117
309
|
* <p>Sets whether the input image is free of personally identifiable information or adult
|
|
118
310
|
* content.</p>
|
|
119
311
|
*/
|
|
120
|
-
ContentClassifiers?:
|
|
312
|
+
ContentClassifiers?: ContentClassifier[];
|
|
121
313
|
}
|
|
122
314
|
/**
|
|
123
315
|
* @public
|
|
@@ -212,13 +404,10 @@ export interface AnalyzeDocumentRequest {
|
|
|
212
404
|
* <p>A list of the types of analysis to perform. Add TABLES to the list to return information
|
|
213
405
|
* about the tables that are detected in the input document. Add FORMS to return detected form
|
|
214
406
|
* data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list
|
|
215
|
-
* to return information about the layout of the document.
|
|
216
|
-
* and table analysis, add TABLES and FORMS to <code>FeatureTypes</code>. To detect signatures
|
|
217
|
-
* within the document and within form data and table data, add SIGNATURES to either TABLES or
|
|
218
|
-
* FORMS. All lines and words detected in the document are included in the response (including
|
|
407
|
+
* to return information about the layout of the document. All lines and words detected in the document are included in the response (including
|
|
219
408
|
* text that isn't related to the value of <code>FeatureTypes</code>). </p>
|
|
220
409
|
*/
|
|
221
|
-
FeatureTypes:
|
|
410
|
+
FeatureTypes: FeatureType[] | undefined;
|
|
222
411
|
/**
|
|
223
412
|
* @public
|
|
224
413
|
* <p>Sets the configuration for the human in the loop workflow for analyzing
|
|
@@ -230,6 +419,11 @@ export interface AnalyzeDocumentRequest {
|
|
|
230
419
|
* <p>Contains Queries and the alias for those Queries, as determined by the input. </p>
|
|
231
420
|
*/
|
|
232
421
|
QueriesConfig?: QueriesConfig;
|
|
422
|
+
/**
|
|
423
|
+
* @public
|
|
424
|
+
* <p>Specifies the adapter to be used when analyzing a document.</p>
|
|
425
|
+
*/
|
|
426
|
+
AdaptersConfig?: AdaptersConfig;
|
|
233
427
|
}
|
|
234
428
|
/**
|
|
235
429
|
* @public
|
|
@@ -437,7 +631,7 @@ export interface Relationship {
|
|
|
437
631
|
* </li>
|
|
438
632
|
* </ul>
|
|
439
633
|
*/
|
|
440
|
-
Type?: RelationshipType
|
|
634
|
+
Type?: RelationshipType;
|
|
441
635
|
/**
|
|
442
636
|
* @public
|
|
443
637
|
* <p>An
|
|
@@ -583,8 +777,51 @@ export interface Block {
|
|
|
583
777
|
* response. Also contains location and confidence score.</p>
|
|
584
778
|
* </li>
|
|
585
779
|
* </ul>
|
|
780
|
+
* <p>The following BlockTypes are only returned for Amazon Textract Layout.</p>
|
|
781
|
+
* <ul>
|
|
782
|
+
* <li>
|
|
783
|
+
* <p>
|
|
784
|
+
* <code>LAYOUT_TITLE</code> - The main title of the document.</p>
|
|
785
|
+
* </li>
|
|
786
|
+
* <li>
|
|
787
|
+
* <p>
|
|
788
|
+
* <code>LAYOUT_HEADER</code> - Text located in the top margin of the document.</p>
|
|
789
|
+
* </li>
|
|
790
|
+
* <li>
|
|
791
|
+
* <p>
|
|
792
|
+
* <code>LAYOUT_FOOTER</code> - Text located in the bottom margin of the document.</p>
|
|
793
|
+
* </li>
|
|
794
|
+
* <li>
|
|
795
|
+
* <p>
|
|
796
|
+
* <code>LAYOUT_SECTION_HEADER</code> - The titles of sections within a document.</p>
|
|
797
|
+
* </li>
|
|
798
|
+
* <li>
|
|
799
|
+
* <p>
|
|
800
|
+
* <code>LAYOUT_PAGE_NUMBER</code> - The page number of the documents.</p>
|
|
801
|
+
* </li>
|
|
802
|
+
* <li>
|
|
803
|
+
* <p>
|
|
804
|
+
* <code>LAYOUT_LIST</code> - Any information grouped together in list form. </p>
|
|
805
|
+
* </li>
|
|
806
|
+
* <li>
|
|
807
|
+
* <p>
|
|
808
|
+
* <code>LAYOUT_FIGURE</code> - Indicates the location of an image in a document.</p>
|
|
809
|
+
* </li>
|
|
810
|
+
* <li>
|
|
811
|
+
* <p>
|
|
812
|
+
* <code>LAYOUT_TABLE</code> - Indicates the location of a table in the document.</p>
|
|
813
|
+
* </li>
|
|
814
|
+
* <li>
|
|
815
|
+
* <p>
|
|
816
|
+
* <code>LAYOUT_KEY_VALUE</code> - Indicates the location of form key-values in a document.</p>
|
|
817
|
+
* </li>
|
|
818
|
+
* <li>
|
|
819
|
+
* <p>
|
|
820
|
+
* <code>LAYOUT_TEXT</code> - Text that is present typically as a part of paragraphs in documents.</p>
|
|
821
|
+
* </li>
|
|
822
|
+
* </ul>
|
|
586
823
|
*/
|
|
587
|
-
BlockType?: BlockType
|
|
824
|
+
BlockType?: BlockType;
|
|
588
825
|
/**
|
|
589
826
|
* @public
|
|
590
827
|
* <p>The confidence score that Amazon Textract has in the accuracy of the recognized text and
|
|
@@ -601,7 +838,7 @@ export interface Block {
|
|
|
601
838
|
* <p>The kind of text that Amazon Textract has detected. Can check for handwritten text and
|
|
602
839
|
* printed text.</p>
|
|
603
840
|
*/
|
|
604
|
-
TextType?: TextType
|
|
841
|
+
TextType?: TextType;
|
|
605
842
|
/**
|
|
606
843
|
* @public
|
|
607
844
|
* <p>The row in which a table cell is located. The first row position is 1.
|
|
@@ -704,13 +941,13 @@ export interface Block {
|
|
|
704
941
|
* <code>EntityTypes</code> isn't returned by <code>DetectDocumentText</code> and
|
|
705
942
|
* <code>GetDocumentTextDetection</code>.</p>
|
|
706
943
|
*/
|
|
707
|
-
EntityTypes?:
|
|
944
|
+
EntityTypes?: EntityType[];
|
|
708
945
|
/**
|
|
709
946
|
* @public
|
|
710
947
|
* <p>The selection status of a selection element, such as an option button or check box.
|
|
711
948
|
* </p>
|
|
712
949
|
*/
|
|
713
|
-
SelectionStatus?: SelectionStatus
|
|
950
|
+
SelectionStatus?: SelectionStatus;
|
|
714
951
|
/**
|
|
715
952
|
* @public
|
|
716
953
|
* <p>The page on which a block was detected. <code>Page</code> is returned by synchronous and
|
|
@@ -1219,7 +1456,7 @@ export interface NormalizedValue {
|
|
|
1219
1456
|
* @public
|
|
1220
1457
|
* <p>The normalized type of the value detected. In this case, DATE.</p>
|
|
1221
1458
|
*/
|
|
1222
|
-
ValueType?: ValueType
|
|
1459
|
+
ValueType?: ValueType;
|
|
1223
1460
|
}
|
|
1224
1461
|
/**
|
|
1225
1462
|
* @public
|
|
@@ -1306,91 +1543,394 @@ export interface AnalyzeIDResponse {
|
|
|
1306
1543
|
}
|
|
1307
1544
|
/**
|
|
1308
1545
|
* @public
|
|
1546
|
+
* @enum
|
|
1309
1547
|
*/
|
|
1310
|
-
export
|
|
1548
|
+
export declare const AutoUpdate: {
|
|
1549
|
+
readonly DISABLED: "DISABLED";
|
|
1550
|
+
readonly ENABLED: "ENABLED";
|
|
1551
|
+
};
|
|
1552
|
+
/**
|
|
1553
|
+
* @public
|
|
1554
|
+
*/
|
|
1555
|
+
export type AutoUpdate = (typeof AutoUpdate)[keyof typeof AutoUpdate];
|
|
1556
|
+
/**
|
|
1557
|
+
* @public
|
|
1558
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
1559
|
+
*/
|
|
1560
|
+
export declare class ConflictException extends __BaseException {
|
|
1561
|
+
readonly name: "ConflictException";
|
|
1562
|
+
readonly $fault: "client";
|
|
1563
|
+
Message?: string;
|
|
1564
|
+
Code?: string;
|
|
1311
1565
|
/**
|
|
1312
|
-
* @
|
|
1313
|
-
* <p>The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI
|
|
1314
|
-
* to call Amazon Textract operations, you can't pass image bytes. The document must be an image
|
|
1315
|
-
* in JPEG or PNG format.</p>
|
|
1316
|
-
* <p>If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode
|
|
1317
|
-
* image bytes that are passed using the <code>Bytes</code> field. </p>
|
|
1566
|
+
* @internal
|
|
1318
1567
|
*/
|
|
1319
|
-
|
|
1568
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
1320
1569
|
}
|
|
1321
1570
|
/**
|
|
1322
1571
|
* @public
|
|
1323
1572
|
*/
|
|
1324
|
-
export interface
|
|
1573
|
+
export interface CreateAdapterRequest {
|
|
1325
1574
|
/**
|
|
1326
1575
|
* @public
|
|
1327
|
-
* <p>
|
|
1328
|
-
* document.</p>
|
|
1576
|
+
* <p>The name to be assigned to the adapter being created.</p>
|
|
1329
1577
|
*/
|
|
1330
|
-
|
|
1578
|
+
AdapterName: string | undefined;
|
|
1331
1579
|
/**
|
|
1332
1580
|
* @public
|
|
1333
|
-
* <p>
|
|
1334
|
-
*
|
|
1581
|
+
* <p>Idempotent token is used to recognize the request. If the same token is used with multiple
|
|
1582
|
+
* CreateAdapter requests, the same session is returned.
|
|
1583
|
+
* This token is employed to avoid unintentionally creating the same session multiple times.</p>
|
|
1335
1584
|
*/
|
|
1336
|
-
|
|
1585
|
+
ClientRequestToken?: string;
|
|
1337
1586
|
/**
|
|
1338
1587
|
* @public
|
|
1339
|
-
* <p
|
|
1588
|
+
* <p>The description to be assigned to the adapter being created.</p>
|
|
1340
1589
|
*/
|
|
1341
|
-
|
|
1342
|
-
}
|
|
1343
|
-
/**
|
|
1344
|
-
* @public
|
|
1345
|
-
* <p>A structure that holds information regarding a detected signature on a page.</p>
|
|
1346
|
-
*/
|
|
1347
|
-
export interface DetectedSignature {
|
|
1590
|
+
Description?: string;
|
|
1348
1591
|
/**
|
|
1349
1592
|
* @public
|
|
1350
|
-
* <p>The
|
|
1593
|
+
* <p>The type of feature that the adapter is being trained on. Currrenly, supported feature
|
|
1594
|
+
* types are: <code>QUERIES</code>
|
|
1595
|
+
* </p>
|
|
1351
1596
|
*/
|
|
1352
|
-
|
|
1353
|
-
}
|
|
1354
|
-
/**
|
|
1355
|
-
* @public
|
|
1356
|
-
* <p>Contains information about the pages of a document, defined by logical boundary.</p>
|
|
1357
|
-
*/
|
|
1358
|
-
export interface SplitDocument {
|
|
1597
|
+
FeatureTypes: FeatureType[] | undefined;
|
|
1359
1598
|
/**
|
|
1360
1599
|
* @public
|
|
1361
|
-
* <p>
|
|
1600
|
+
* <p>Controls whether or not the adapter should automatically update.</p>
|
|
1362
1601
|
*/
|
|
1363
|
-
|
|
1602
|
+
AutoUpdate?: AutoUpdate;
|
|
1364
1603
|
/**
|
|
1365
1604
|
* @public
|
|
1366
|
-
* <p>
|
|
1605
|
+
* <p>A list of tags to be added to the adapter.</p>
|
|
1367
1606
|
*/
|
|
1368
|
-
|
|
1607
|
+
Tags?: Record<string, string>;
|
|
1369
1608
|
}
|
|
1370
1609
|
/**
|
|
1371
1610
|
* @public
|
|
1372
|
-
* <p>A structure containing information about an undetected signature on a page where it was expected but not found.</p>
|
|
1373
1611
|
*/
|
|
1374
|
-
export interface
|
|
1612
|
+
export interface CreateAdapterResponse {
|
|
1375
1613
|
/**
|
|
1376
1614
|
* @public
|
|
1377
|
-
* <p>
|
|
1615
|
+
* <p>A string containing the unique ID for the adapter that has been created.</p>
|
|
1378
1616
|
*/
|
|
1379
|
-
|
|
1617
|
+
AdapterId?: string;
|
|
1380
1618
|
}
|
|
1381
1619
|
/**
|
|
1382
1620
|
* @public
|
|
1383
|
-
* <p>
|
|
1621
|
+
* <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at
|
|
1622
|
+
* least one of the other input parameters is different from the previous call to the
|
|
1623
|
+
* operation. </p>
|
|
1384
1624
|
*/
|
|
1385
|
-
export
|
|
1625
|
+
export declare class IdempotentParameterMismatchException extends __BaseException {
|
|
1626
|
+
readonly name: "IdempotentParameterMismatchException";
|
|
1627
|
+
readonly $fault: "client";
|
|
1628
|
+
Message?: string;
|
|
1629
|
+
Code?: string;
|
|
1386
1630
|
/**
|
|
1387
|
-
* @
|
|
1388
|
-
* <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>
|
|
1631
|
+
* @internal
|
|
1389
1632
|
*/
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1633
|
+
constructor(opts: __ExceptionOptionType<IdempotentParameterMismatchException, __BaseException>);
|
|
1634
|
+
}
|
|
1635
|
+
/**
|
|
1636
|
+
* @public
|
|
1637
|
+
* <p>An Amazon Textract service limit was exceeded. For example, if you start too many
|
|
1638
|
+
* asynchronous jobs concurrently, calls to start operations
|
|
1639
|
+
* (<code>StartDocumentTextDetection</code>, for example) raise a LimitExceededException
|
|
1640
|
+
* exception (HTTP status code: 400) until the number of concurrently running jobs is below
|
|
1641
|
+
* the Amazon Textract service limit. </p>
|
|
1642
|
+
*/
|
|
1643
|
+
export declare class LimitExceededException extends __BaseException {
|
|
1644
|
+
readonly name: "LimitExceededException";
|
|
1645
|
+
readonly $fault: "client";
|
|
1646
|
+
Message?: string;
|
|
1647
|
+
Code?: string;
|
|
1648
|
+
/**
|
|
1649
|
+
* @internal
|
|
1650
|
+
*/
|
|
1651
|
+
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
1652
|
+
}
|
|
1653
|
+
/**
|
|
1654
|
+
* @public
|
|
1655
|
+
* <p>Returned when a request cannot be completed as it would exceed a maximum service quota.</p>
|
|
1656
|
+
*/
|
|
1657
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
1658
|
+
readonly name: "ServiceQuotaExceededException";
|
|
1659
|
+
readonly $fault: "client";
|
|
1660
|
+
Message?: string;
|
|
1661
|
+
Code?: string;
|
|
1662
|
+
/**
|
|
1663
|
+
* @internal
|
|
1664
|
+
*/
|
|
1665
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
1666
|
+
}
|
|
1667
|
+
/**
|
|
1668
|
+
* @public
|
|
1669
|
+
* <p> Indicates that a request was not valid. Check request for proper formatting. </p>
|
|
1670
|
+
*/
|
|
1671
|
+
export declare class ValidationException extends __BaseException {
|
|
1672
|
+
readonly name: "ValidationException";
|
|
1673
|
+
readonly $fault: "client";
|
|
1674
|
+
Message?: string;
|
|
1675
|
+
Code?: string;
|
|
1676
|
+
/**
|
|
1677
|
+
* @internal
|
|
1678
|
+
*/
|
|
1679
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
1680
|
+
}
|
|
1681
|
+
/**
|
|
1682
|
+
* @public
|
|
1683
|
+
* <p>Sets whether or not your output will go to a user created bucket. Used to set the name
|
|
1684
|
+
* of the bucket, and the prefix on the output file.</p>
|
|
1685
|
+
* <p>
|
|
1686
|
+
* <code>OutputConfig</code> is an optional parameter which lets you adjust where your
|
|
1687
|
+
* output will be placed. By default, Amazon Textract will store the results internally and can
|
|
1688
|
+
* only be accessed by the Get API operations. With <code>OutputConfig</code> enabled, you can
|
|
1689
|
+
* set the name of the bucket the output will be sent to the file prefix of the results where
|
|
1690
|
+
* you can download your results. Additionally, you can set the <code>KMSKeyID</code>
|
|
1691
|
+
* parameter to a customer master key (CMK) to encrypt your output. Without this parameter set
|
|
1692
|
+
* Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.</p>
|
|
1693
|
+
* <p>Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account
|
|
1694
|
+
* is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after
|
|
1695
|
+
* the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html"> Managing AI services opt-out policy. </a>
|
|
1696
|
+
* </p>
|
|
1697
|
+
* <p>For more information on data privacy,
|
|
1698
|
+
* see the <a href="https://aws.amazon.com/compliance/data-privacy-faq/">Data Privacy
|
|
1699
|
+
* FAQ</a>.</p>
|
|
1700
|
+
*/
|
|
1701
|
+
export interface OutputConfig {
|
|
1702
|
+
/**
|
|
1703
|
+
* @public
|
|
1704
|
+
* <p>The name of the bucket your output will go to.</p>
|
|
1705
|
+
*/
|
|
1706
|
+
S3Bucket: string | undefined;
|
|
1707
|
+
/**
|
|
1708
|
+
* @public
|
|
1709
|
+
* <p>The prefix of the object key that the output will be saved to. When not enabled, the
|
|
1710
|
+
* prefix will be “textract_output".</p>
|
|
1711
|
+
*/
|
|
1712
|
+
S3Prefix?: string;
|
|
1713
|
+
}
|
|
1714
|
+
/**
|
|
1715
|
+
* @public
|
|
1716
|
+
*/
|
|
1717
|
+
export interface CreateAdapterVersionRequest {
|
|
1718
|
+
/**
|
|
1719
|
+
* @public
|
|
1720
|
+
* <p>A string containing a unique ID for the adapter that will receive a new version.</p>
|
|
1721
|
+
*/
|
|
1722
|
+
AdapterId: string | undefined;
|
|
1723
|
+
/**
|
|
1724
|
+
* @public
|
|
1725
|
+
* <p>Idempotent token is used to recognize the request. If the same token is used with multiple
|
|
1726
|
+
* CreateAdapterVersion requests, the same session is returned.
|
|
1727
|
+
* This token is employed to avoid unintentionally creating the same session multiple times.</p>
|
|
1728
|
+
*/
|
|
1729
|
+
ClientRequestToken?: string;
|
|
1730
|
+
/**
|
|
1731
|
+
* @public
|
|
1732
|
+
* <p>Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object as the
|
|
1733
|
+
* value.</p>
|
|
1734
|
+
*/
|
|
1735
|
+
DatasetConfig: AdapterVersionDatasetConfig | undefined;
|
|
1736
|
+
/**
|
|
1737
|
+
* @public
|
|
1738
|
+
* <p>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.</p>
|
|
1739
|
+
*/
|
|
1740
|
+
KMSKeyId?: string;
|
|
1741
|
+
/**
|
|
1742
|
+
* @public
|
|
1743
|
+
* <p>Sets whether or not your output will go to a user created bucket. Used to set the name
|
|
1744
|
+
* of the bucket, and the prefix on the output file.</p>
|
|
1745
|
+
* <p>
|
|
1746
|
+
* <code>OutputConfig</code> is an optional parameter which lets you adjust where your
|
|
1747
|
+
* output will be placed. By default, Amazon Textract will store the results internally and can
|
|
1748
|
+
* only be accessed by the Get API operations. With <code>OutputConfig</code> enabled, you can
|
|
1749
|
+
* set the name of the bucket the output will be sent to the file prefix of the results where
|
|
1750
|
+
* you can download your results. Additionally, you can set the <code>KMSKeyID</code>
|
|
1751
|
+
* parameter to a customer master key (CMK) to encrypt your output. Without this parameter set
|
|
1752
|
+
* Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.</p>
|
|
1753
|
+
* <p>Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account
|
|
1754
|
+
* is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after
|
|
1755
|
+
* the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html"> Managing AI services opt-out policy. </a>
|
|
1756
|
+
* </p>
|
|
1757
|
+
* <p>For more information on data privacy,
|
|
1758
|
+
* see the <a href="https://aws.amazon.com/compliance/data-privacy-faq/">Data Privacy
|
|
1759
|
+
* FAQ</a>.</p>
|
|
1760
|
+
*/
|
|
1761
|
+
OutputConfig: OutputConfig | undefined;
|
|
1762
|
+
/**
|
|
1763
|
+
* @public
|
|
1764
|
+
* <p>A set of tags (key-value pairs) that you want to attach to the adapter version. </p>
|
|
1765
|
+
*/
|
|
1766
|
+
Tags?: Record<string, string>;
|
|
1767
|
+
}
|
|
1768
|
+
/**
|
|
1769
|
+
* @public
|
|
1770
|
+
*/
|
|
1771
|
+
export interface CreateAdapterVersionResponse {
|
|
1772
|
+
/**
|
|
1773
|
+
* @public
|
|
1774
|
+
* <p>A string containing the unique ID for the adapter that has received a new version.</p>
|
|
1775
|
+
*/
|
|
1776
|
+
AdapterId?: string;
|
|
1777
|
+
/**
|
|
1778
|
+
* @public
|
|
1779
|
+
* <p>A string describing the new version of the adapter.</p>
|
|
1780
|
+
*/
|
|
1781
|
+
AdapterVersion?: string;
|
|
1782
|
+
}
|
|
1783
|
+
/**
|
|
1784
|
+
* @public
|
|
1785
|
+
* <p> Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key
|
|
1786
|
+
* was entered incorrectly. </p>
|
|
1787
|
+
*/
|
|
1788
|
+
export declare class InvalidKMSKeyException extends __BaseException {
|
|
1789
|
+
readonly name: "InvalidKMSKeyException";
|
|
1790
|
+
readonly $fault: "client";
|
|
1791
|
+
Message?: string;
|
|
1792
|
+
Code?: string;
|
|
1793
|
+
/**
|
|
1794
|
+
* @internal
|
|
1795
|
+
*/
|
|
1796
|
+
constructor(opts: __ExceptionOptionType<InvalidKMSKeyException, __BaseException>);
|
|
1797
|
+
}
|
|
1798
|
+
/**
|
|
1799
|
+
* @public
|
|
1800
|
+
* <p> Returned when an operation tried to access a nonexistent resource. </p>
|
|
1801
|
+
*/
|
|
1802
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
1803
|
+
readonly name: "ResourceNotFoundException";
|
|
1804
|
+
readonly $fault: "client";
|
|
1805
|
+
Message?: string;
|
|
1806
|
+
Code?: string;
|
|
1807
|
+
/**
|
|
1808
|
+
* @internal
|
|
1809
|
+
*/
|
|
1810
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
1811
|
+
}
|
|
1812
|
+
/**
|
|
1813
|
+
* @public
|
|
1814
|
+
*/
|
|
1815
|
+
export interface DeleteAdapterRequest {
|
|
1816
|
+
/**
|
|
1817
|
+
* @public
|
|
1818
|
+
* <p>A string containing a unique ID for the adapter to be deleted.</p>
|
|
1819
|
+
*/
|
|
1820
|
+
AdapterId: string | undefined;
|
|
1821
|
+
}
|
|
1822
|
+
/**
|
|
1823
|
+
* @public
|
|
1824
|
+
*/
|
|
1825
|
+
export interface DeleteAdapterResponse {
|
|
1826
|
+
}
|
|
1827
|
+
/**
|
|
1828
|
+
* @public
|
|
1829
|
+
*/
|
|
1830
|
+
export interface DeleteAdapterVersionRequest {
|
|
1831
|
+
/**
|
|
1832
|
+
* @public
|
|
1833
|
+
* <p>A string containing a unique ID for the adapter version that will be deleted.</p>
|
|
1834
|
+
*/
|
|
1835
|
+
AdapterId: string | undefined;
|
|
1836
|
+
/**
|
|
1837
|
+
* @public
|
|
1838
|
+
* <p>Specifies the adapter version to be deleted.</p>
|
|
1839
|
+
*/
|
|
1840
|
+
AdapterVersion: string | undefined;
|
|
1841
|
+
}
|
|
1842
|
+
/**
|
|
1843
|
+
* @public
|
|
1844
|
+
*/
|
|
1845
|
+
export interface DeleteAdapterVersionResponse {
|
|
1846
|
+
}
|
|
1847
|
+
/**
|
|
1848
|
+
* @public
|
|
1849
|
+
*/
|
|
1850
|
+
export interface DetectDocumentTextRequest {
|
|
1851
|
+
/**
|
|
1852
|
+
* @public
|
|
1853
|
+
* <p>The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI
|
|
1854
|
+
* to call Amazon Textract operations, you can't pass image bytes. The document must be an image
|
|
1855
|
+
* in JPEG or PNG format.</p>
|
|
1856
|
+
* <p>If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode
|
|
1857
|
+
* image bytes that are passed using the <code>Bytes</code> field. </p>
|
|
1858
|
+
*/
|
|
1859
|
+
Document: Document | undefined;
|
|
1860
|
+
}
|
|
1861
|
+
/**
|
|
1862
|
+
* @public
|
|
1863
|
+
*/
|
|
1864
|
+
export interface DetectDocumentTextResponse {
|
|
1865
|
+
/**
|
|
1866
|
+
* @public
|
|
1867
|
+
* <p>Metadata about the document. It contains the number of pages that are detected in the
|
|
1868
|
+
* document.</p>
|
|
1869
|
+
*/
|
|
1870
|
+
DocumentMetadata?: DocumentMetadata;
|
|
1871
|
+
/**
|
|
1872
|
+
* @public
|
|
1873
|
+
* <p>An array of <code>Block</code> objects that contain the text that's detected in the
|
|
1874
|
+
* document.</p>
|
|
1875
|
+
*/
|
|
1876
|
+
Blocks?: Block[];
|
|
1877
|
+
/**
|
|
1878
|
+
* @public
|
|
1879
|
+
* <p></p>
|
|
1880
|
+
*/
|
|
1881
|
+
DetectDocumentTextModelVersion?: string;
|
|
1882
|
+
}
|
|
1883
|
+
/**
|
|
1884
|
+
* @public
|
|
1885
|
+
* <p>A structure that holds information regarding a detected signature on a page.</p>
|
|
1886
|
+
*/
|
|
1887
|
+
export interface DetectedSignature {
|
|
1888
|
+
/**
|
|
1889
|
+
* @public
|
|
1890
|
+
* <p>The page a detected signature was found on.</p>
|
|
1891
|
+
*/
|
|
1892
|
+
Page?: number;
|
|
1893
|
+
}
|
|
1894
|
+
/**
|
|
1895
|
+
* @public
|
|
1896
|
+
* <p>Contains information about the pages of a document, defined by logical boundary.</p>
|
|
1897
|
+
*/
|
|
1898
|
+
export interface SplitDocument {
|
|
1899
|
+
/**
|
|
1900
|
+
* @public
|
|
1901
|
+
* <p>The index for a given document in a DocumentGroup of a specific Type.</p>
|
|
1902
|
+
*/
|
|
1903
|
+
Index?: number;
|
|
1904
|
+
/**
|
|
1905
|
+
* @public
|
|
1906
|
+
* <p>An array of page numbers for a for a given document, ordered by logical boundary.</p>
|
|
1907
|
+
*/
|
|
1908
|
+
Pages?: number[];
|
|
1909
|
+
}
|
|
1910
|
+
/**
|
|
1911
|
+
* @public
|
|
1912
|
+
* <p>A structure containing information about an undetected signature on a page where it was expected but not found.</p>
|
|
1913
|
+
*/
|
|
1914
|
+
export interface UndetectedSignature {
|
|
1915
|
+
/**
|
|
1916
|
+
* @public
|
|
1917
|
+
* <p>The page where a signature was expected but not found.</p>
|
|
1918
|
+
*/
|
|
1919
|
+
Page?: number;
|
|
1920
|
+
}
|
|
1921
|
+
/**
|
|
1922
|
+
* @public
|
|
1923
|
+
* <p>Summary information about documents grouped by the same document type.</p>
|
|
1924
|
+
*/
|
|
1925
|
+
export interface DocumentGroup {
|
|
1926
|
+
/**
|
|
1927
|
+
* @public
|
|
1928
|
+
* <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>
|
|
1929
|
+
*/
|
|
1930
|
+
Type?: string;
|
|
1931
|
+
/**
|
|
1932
|
+
* @public
|
|
1933
|
+
* <p>An array that contains information about the pages of a document, defined by logical boundary.</p>
|
|
1394
1934
|
*/
|
|
1395
1935
|
SplitDocuments?: SplitDocument[];
|
|
1396
1936
|
/**
|
|
@@ -1432,7 +1972,7 @@ export interface LendingDetection {
|
|
|
1432
1972
|
* @public
|
|
1433
1973
|
* <p>The selection status of a selection element, such as an option button or check box.</p>
|
|
1434
1974
|
*/
|
|
1435
|
-
SelectionStatus?: SelectionStatus
|
|
1975
|
+
SelectionStatus?: SelectionStatus;
|
|
1436
1976
|
/**
|
|
1437
1977
|
* @public
|
|
1438
1978
|
* <p>Information about where the following items are located on a document page: detected
|
|
@@ -1452,73 +1992,216 @@ export interface LendingDetection {
|
|
|
1452
1992
|
export interface LendingField {
|
|
1453
1993
|
/**
|
|
1454
1994
|
* @public
|
|
1455
|
-
* <p>The type of the lending document.</p>
|
|
1995
|
+
* <p>The type of the lending document.</p>
|
|
1996
|
+
*/
|
|
1997
|
+
Type?: string;
|
|
1998
|
+
/**
|
|
1999
|
+
* @public
|
|
2000
|
+
* <p>The results extracted for a lending document.</p>
|
|
2001
|
+
*/
|
|
2002
|
+
KeyDetection?: LendingDetection;
|
|
2003
|
+
/**
|
|
2004
|
+
* @public
|
|
2005
|
+
* <p>An array of LendingDetection objects.</p>
|
|
2006
|
+
*/
|
|
2007
|
+
ValueDetections?: LendingDetection[];
|
|
2008
|
+
}
|
|
2009
|
+
/**
|
|
2010
|
+
* @public
|
|
2011
|
+
* <p>Information regarding a detected signature on a page.</p>
|
|
2012
|
+
*/
|
|
2013
|
+
export interface SignatureDetection {
|
|
2014
|
+
/**
|
|
2015
|
+
* @public
|
|
2016
|
+
* <p>The confidence, from 0 to 100, in the predicted values for a detected signature.</p>
|
|
2017
|
+
*/
|
|
2018
|
+
Confidence?: number;
|
|
2019
|
+
/**
|
|
2020
|
+
* @public
|
|
2021
|
+
* <p>Information about where the following items are located on a document page: detected
|
|
2022
|
+
* page, text, key-value pairs, tables, table cells, and selection elements.</p>
|
|
2023
|
+
*/
|
|
2024
|
+
Geometry?: Geometry;
|
|
2025
|
+
}
|
|
2026
|
+
/**
|
|
2027
|
+
* @public
|
|
2028
|
+
* <p>Holds the structured data returned by AnalyzeDocument for lending documents.</p>
|
|
2029
|
+
*/
|
|
2030
|
+
export interface LendingDocument {
|
|
2031
|
+
/**
|
|
2032
|
+
* @public
|
|
2033
|
+
* <p>An array of LendingField objects.</p>
|
|
2034
|
+
*/
|
|
2035
|
+
LendingFields?: LendingField[];
|
|
2036
|
+
/**
|
|
2037
|
+
* @public
|
|
2038
|
+
* <p>A list of signatures detected in a lending document.</p>
|
|
2039
|
+
*/
|
|
2040
|
+
SignatureDetections?: SignatureDetection[];
|
|
2041
|
+
}
|
|
2042
|
+
/**
|
|
2043
|
+
* @public
|
|
2044
|
+
* <p>Contains information extracted by an analysis operation after using StartLendingAnalysis.</p>
|
|
2045
|
+
*/
|
|
2046
|
+
export interface Extraction {
|
|
2047
|
+
/**
|
|
2048
|
+
* @public
|
|
2049
|
+
* <p>Holds the structured data returned by AnalyzeDocument for lending documents.</p>
|
|
2050
|
+
*/
|
|
2051
|
+
LendingDocument?: LendingDocument;
|
|
2052
|
+
/**
|
|
2053
|
+
* @public
|
|
2054
|
+
* <p>The structure holding all the information returned by AnalyzeExpense</p>
|
|
2055
|
+
*/
|
|
2056
|
+
ExpenseDocument?: ExpenseDocument;
|
|
2057
|
+
/**
|
|
2058
|
+
* @public
|
|
2059
|
+
* <p>The structure that lists each document processed in an AnalyzeID operation.</p>
|
|
2060
|
+
*/
|
|
2061
|
+
IdentityDocument?: IdentityDocument;
|
|
2062
|
+
}
|
|
2063
|
+
/**
|
|
2064
|
+
* @public
|
|
2065
|
+
*/
|
|
2066
|
+
export interface GetAdapterRequest {
|
|
2067
|
+
/**
|
|
2068
|
+
* @public
|
|
2069
|
+
* <p>A string containing a unique ID for the adapter.</p>
|
|
2070
|
+
*/
|
|
2071
|
+
AdapterId: string | undefined;
|
|
2072
|
+
}
|
|
2073
|
+
/**
|
|
2074
|
+
* @public
|
|
2075
|
+
*/
|
|
2076
|
+
export interface GetAdapterResponse {
|
|
2077
|
+
/**
|
|
2078
|
+
* @public
|
|
2079
|
+
* <p>A string identifying the adapter that information has been retrieved for.</p>
|
|
2080
|
+
*/
|
|
2081
|
+
AdapterId?: string;
|
|
2082
|
+
/**
|
|
2083
|
+
* @public
|
|
2084
|
+
* <p>The name of the requested adapter.</p>
|
|
2085
|
+
*/
|
|
2086
|
+
AdapterName?: string;
|
|
2087
|
+
/**
|
|
2088
|
+
* @public
|
|
2089
|
+
* <p>The date and time the requested adapter was created at.</p>
|
|
2090
|
+
*/
|
|
2091
|
+
CreationTime?: Date;
|
|
2092
|
+
/**
|
|
2093
|
+
* @public
|
|
2094
|
+
* <p>The description for the requested adapter.</p>
|
|
2095
|
+
*/
|
|
2096
|
+
Description?: string;
|
|
2097
|
+
/**
|
|
2098
|
+
* @public
|
|
2099
|
+
* <p>List of the targeted feature types for the requested adapter.</p>
|
|
2100
|
+
*/
|
|
2101
|
+
FeatureTypes?: FeatureType[];
|
|
2102
|
+
/**
|
|
2103
|
+
* @public
|
|
2104
|
+
* <p>Binary value indicating if the adapter is being automatically updated or not.</p>
|
|
2105
|
+
*/
|
|
2106
|
+
AutoUpdate?: AutoUpdate;
|
|
2107
|
+
/**
|
|
2108
|
+
* @public
|
|
2109
|
+
* <p>A set of tags (key-value pairs) associated with the adapter that has been retrieved.</p>
|
|
2110
|
+
*/
|
|
2111
|
+
Tags?: Record<string, string>;
|
|
2112
|
+
}
|
|
2113
|
+
/**
|
|
2114
|
+
* @public
|
|
2115
|
+
*/
|
|
2116
|
+
export interface GetAdapterVersionRequest {
|
|
2117
|
+
/**
|
|
2118
|
+
* @public
|
|
2119
|
+
* <p>A string specifying a unique ID for the adapter version you want to retrieve information for.</p>
|
|
2120
|
+
*/
|
|
2121
|
+
AdapterId: string | undefined;
|
|
2122
|
+
/**
|
|
2123
|
+
* @public
|
|
2124
|
+
* <p>A string specifying the adapter version you want to retrieve information for.</p>
|
|
2125
|
+
*/
|
|
2126
|
+
AdapterVersion: string | undefined;
|
|
2127
|
+
}
|
|
2128
|
+
/**
|
|
2129
|
+
* @public
|
|
2130
|
+
*/
|
|
2131
|
+
export interface GetAdapterVersionResponse {
|
|
2132
|
+
/**
|
|
2133
|
+
* @public
|
|
2134
|
+
* <p>A string containing a unique ID for the adapter version being retrieved.</p>
|
|
2135
|
+
*/
|
|
2136
|
+
AdapterId?: string;
|
|
2137
|
+
/**
|
|
2138
|
+
* @public
|
|
2139
|
+
* <p>A string containing the adapter version that has been retrieved.</p>
|
|
1456
2140
|
*/
|
|
1457
|
-
|
|
2141
|
+
AdapterVersion?: string;
|
|
1458
2142
|
/**
|
|
1459
2143
|
* @public
|
|
1460
|
-
* <p>The
|
|
2144
|
+
* <p>The time that the adapter version was created.</p>
|
|
1461
2145
|
*/
|
|
1462
|
-
|
|
2146
|
+
CreationTime?: Date;
|
|
1463
2147
|
/**
|
|
1464
2148
|
* @public
|
|
1465
|
-
* <p>
|
|
2149
|
+
* <p>List of the targeted feature types for the requested adapter version.</p>
|
|
1466
2150
|
*/
|
|
1467
|
-
|
|
1468
|
-
}
|
|
1469
|
-
/**
|
|
1470
|
-
* @public
|
|
1471
|
-
* <p>Information regarding a detected signature on a page.</p>
|
|
1472
|
-
*/
|
|
1473
|
-
export interface SignatureDetection {
|
|
2151
|
+
FeatureTypes?: FeatureType[];
|
|
1474
2152
|
/**
|
|
1475
2153
|
* @public
|
|
1476
|
-
* <p>The
|
|
2154
|
+
* <p>The status of the adapter version that has been requested.</p>
|
|
1477
2155
|
*/
|
|
1478
|
-
|
|
2156
|
+
Status?: AdapterVersionStatus;
|
|
1479
2157
|
/**
|
|
1480
2158
|
* @public
|
|
1481
|
-
* <p>
|
|
1482
|
-
* page, text, key-value pairs, tables, table cells, and selection elements.</p>
|
|
2159
|
+
* <p>A message that describes the status of the requested adapter version.</p>
|
|
1483
2160
|
*/
|
|
1484
|
-
|
|
1485
|
-
}
|
|
1486
|
-
/**
|
|
1487
|
-
* @public
|
|
1488
|
-
* <p>Holds the structured data returned by AnalyzeDocument for lending documents.</p>
|
|
1489
|
-
*/
|
|
1490
|
-
export interface LendingDocument {
|
|
2161
|
+
StatusMessage?: string;
|
|
1491
2162
|
/**
|
|
1492
2163
|
* @public
|
|
1493
|
-
* <p>
|
|
2164
|
+
* <p>Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the
|
|
2165
|
+
* value.</p>
|
|
1494
2166
|
*/
|
|
1495
|
-
|
|
2167
|
+
DatasetConfig?: AdapterVersionDatasetConfig;
|
|
1496
2168
|
/**
|
|
1497
2169
|
* @public
|
|
1498
|
-
* <p>
|
|
2170
|
+
* <p>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.</p>
|
|
1499
2171
|
*/
|
|
1500
|
-
|
|
1501
|
-
}
|
|
1502
|
-
/**
|
|
1503
|
-
* @public
|
|
1504
|
-
* <p>Contains information extracted by an analysis operation after using StartLendingAnalysis.</p>
|
|
1505
|
-
*/
|
|
1506
|
-
export interface Extraction {
|
|
2172
|
+
KMSKeyId?: string;
|
|
1507
2173
|
/**
|
|
1508
2174
|
* @public
|
|
1509
|
-
* <p>
|
|
2175
|
+
* <p>Sets whether or not your output will go to a user created bucket. Used to set the name
|
|
2176
|
+
* of the bucket, and the prefix on the output file.</p>
|
|
2177
|
+
* <p>
|
|
2178
|
+
* <code>OutputConfig</code> is an optional parameter which lets you adjust where your
|
|
2179
|
+
* output will be placed. By default, Amazon Textract will store the results internally and can
|
|
2180
|
+
* only be accessed by the Get API operations. With <code>OutputConfig</code> enabled, you can
|
|
2181
|
+
* set the name of the bucket the output will be sent to the file prefix of the results where
|
|
2182
|
+
* you can download your results. Additionally, you can set the <code>KMSKeyID</code>
|
|
2183
|
+
* parameter to a customer master key (CMK) to encrypt your output. Without this parameter set
|
|
2184
|
+
* Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.</p>
|
|
2185
|
+
* <p>Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account
|
|
2186
|
+
* is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after
|
|
2187
|
+
* the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html"> Managing AI services opt-out policy. </a>
|
|
2188
|
+
* </p>
|
|
2189
|
+
* <p>For more information on data privacy,
|
|
2190
|
+
* see the <a href="https://aws.amazon.com/compliance/data-privacy-faq/">Data Privacy
|
|
2191
|
+
* FAQ</a>.</p>
|
|
1510
2192
|
*/
|
|
1511
|
-
|
|
2193
|
+
OutputConfig?: OutputConfig;
|
|
1512
2194
|
/**
|
|
1513
2195
|
* @public
|
|
1514
|
-
* <p>The
|
|
2196
|
+
* <p>The evaluation metrics (F1 score, Precision, and Recall) for the requested version,
|
|
2197
|
+
* grouped by baseline metrics and adapter version.</p>
|
|
1515
2198
|
*/
|
|
1516
|
-
|
|
2199
|
+
EvaluationMetrics?: AdapterVersionEvaluationMetric[];
|
|
1517
2200
|
/**
|
|
1518
2201
|
* @public
|
|
1519
|
-
* <p>
|
|
2202
|
+
* <p>A set of tags (key-value pairs) that are associated with the adapter version.</p>
|
|
1520
2203
|
*/
|
|
1521
|
-
|
|
2204
|
+
Tags?: Record<string, string>;
|
|
1522
2205
|
}
|
|
1523
2206
|
/**
|
|
1524
2207
|
* @public
|
|
@@ -1591,7 +2274,7 @@ export interface GetDocumentAnalysisResponse {
|
|
|
1591
2274
|
* @public
|
|
1592
2275
|
* <p>The current status of the text detection job.</p>
|
|
1593
2276
|
*/
|
|
1594
|
-
JobStatus?: JobStatus
|
|
2277
|
+
JobStatus?: JobStatus;
|
|
1595
2278
|
/**
|
|
1596
2279
|
* @public
|
|
1597
2280
|
* <p>If the response is truncated, Amazon Textract returns this token. You can use this token
|
|
@@ -1634,21 +2317,6 @@ export declare class InvalidJobIdException extends __BaseException {
|
|
|
1634
2317
|
*/
|
|
1635
2318
|
constructor(opts: __ExceptionOptionType<InvalidJobIdException, __BaseException>);
|
|
1636
2319
|
}
|
|
1637
|
-
/**
|
|
1638
|
-
* @public
|
|
1639
|
-
* <p> Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key
|
|
1640
|
-
* was entered incorrectly. </p>
|
|
1641
|
-
*/
|
|
1642
|
-
export declare class InvalidKMSKeyException extends __BaseException {
|
|
1643
|
-
readonly name: "InvalidKMSKeyException";
|
|
1644
|
-
readonly $fault: "client";
|
|
1645
|
-
Message?: string;
|
|
1646
|
-
Code?: string;
|
|
1647
|
-
/**
|
|
1648
|
-
* @internal
|
|
1649
|
-
*/
|
|
1650
|
-
constructor(opts: __ExceptionOptionType<InvalidKMSKeyException, __BaseException>);
|
|
1651
|
-
}
|
|
1652
2320
|
/**
|
|
1653
2321
|
* @public
|
|
1654
2322
|
*/
|
|
@@ -1687,7 +2355,7 @@ export interface GetDocumentTextDetectionResponse {
|
|
|
1687
2355
|
* @public
|
|
1688
2356
|
* <p>The current status of the text detection job.</p>
|
|
1689
2357
|
*/
|
|
1690
|
-
JobStatus?: JobStatus
|
|
2358
|
+
JobStatus?: JobStatus;
|
|
1691
2359
|
/**
|
|
1692
2360
|
* @public
|
|
1693
2361
|
* <p>If the response is truncated, Amazon Textract returns this token. You can use this token in
|
|
@@ -1754,7 +2422,7 @@ export interface GetExpenseAnalysisResponse {
|
|
|
1754
2422
|
* @public
|
|
1755
2423
|
* <p>The current status of the text detection job.</p>
|
|
1756
2424
|
*/
|
|
1757
|
-
JobStatus?: JobStatus
|
|
2425
|
+
JobStatus?: JobStatus;
|
|
1758
2426
|
/**
|
|
1759
2427
|
* @public
|
|
1760
2428
|
* <p>If the response is truncated, Amazon Textract returns this token. You can use this token in
|
|
@@ -1879,7 +2547,7 @@ export interface GetLendingAnalysisResponse {
|
|
|
1879
2547
|
* @public
|
|
1880
2548
|
* <p> The current status of the lending analysis job.</p>
|
|
1881
2549
|
*/
|
|
1882
|
-
JobStatus?: JobStatus
|
|
2550
|
+
JobStatus?: JobStatus;
|
|
1883
2551
|
/**
|
|
1884
2552
|
* @public
|
|
1885
2553
|
* <p>If the response is truncated, Amazon Textract returns this token.
|
|
@@ -1949,7 +2617,7 @@ export interface GetLendingAnalysisSummaryResponse {
|
|
|
1949
2617
|
* @public
|
|
1950
2618
|
* <p> The current status of the lending analysis job. </p>
|
|
1951
2619
|
*/
|
|
1952
|
-
JobStatus?: JobStatus
|
|
2620
|
+
JobStatus?: JobStatus;
|
|
1953
2621
|
/**
|
|
1954
2622
|
* @public
|
|
1955
2623
|
* <p> Contains summary information for documents grouped by type.</p>
|
|
@@ -1974,87 +2642,129 @@ export interface GetLendingAnalysisSummaryResponse {
|
|
|
1974
2642
|
}
|
|
1975
2643
|
/**
|
|
1976
2644
|
* @public
|
|
1977
|
-
* <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at
|
|
1978
|
-
* least one of the other input parameters is different from the previous call to the
|
|
1979
|
-
* operation. </p>
|
|
1980
2645
|
*/
|
|
1981
|
-
export
|
|
1982
|
-
readonly name: "IdempotentParameterMismatchException";
|
|
1983
|
-
readonly $fault: "client";
|
|
1984
|
-
Message?: string;
|
|
1985
|
-
Code?: string;
|
|
2646
|
+
export interface ListAdaptersRequest {
|
|
1986
2647
|
/**
|
|
1987
|
-
* @
|
|
2648
|
+
* @public
|
|
2649
|
+
* <p>Specifies the lower bound for the ListAdapters operation.
|
|
2650
|
+
* Ensures ListAdapters returns only adapters created after the specified creation time.</p>
|
|
1988
2651
|
*/
|
|
1989
|
-
|
|
2652
|
+
AfterCreationTime?: Date;
|
|
2653
|
+
/**
|
|
2654
|
+
* @public
|
|
2655
|
+
* <p>Specifies the upper bound for the ListAdapters operation.
|
|
2656
|
+
* Ensures ListAdapters returns only adapters created before the specified creation time.</p>
|
|
2657
|
+
*/
|
|
2658
|
+
BeforeCreationTime?: Date;
|
|
2659
|
+
/**
|
|
2660
|
+
* @public
|
|
2661
|
+
* <p>The maximum number of results to return when listing adapters.</p>
|
|
2662
|
+
*/
|
|
2663
|
+
MaxResults?: number;
|
|
2664
|
+
/**
|
|
2665
|
+
* @public
|
|
2666
|
+
* <p>Identifies the next page of results to return when listing adapters.</p>
|
|
2667
|
+
*/
|
|
2668
|
+
NextToken?: string;
|
|
1990
2669
|
}
|
|
1991
2670
|
/**
|
|
1992
2671
|
* @public
|
|
1993
|
-
* <p>An Amazon Textract service limit was exceeded. For example, if you start too many
|
|
1994
|
-
* asynchronous jobs concurrently, calls to start operations
|
|
1995
|
-
* (<code>StartDocumentTextDetection</code>, for example) raise a LimitExceededException
|
|
1996
|
-
* exception (HTTP status code: 400) until the number of concurrently running jobs is below
|
|
1997
|
-
* the Amazon Textract service limit. </p>
|
|
1998
2672
|
*/
|
|
1999
|
-
export
|
|
2000
|
-
readonly name: "LimitExceededException";
|
|
2001
|
-
readonly $fault: "client";
|
|
2002
|
-
Message?: string;
|
|
2003
|
-
Code?: string;
|
|
2673
|
+
export interface ListAdaptersResponse {
|
|
2004
2674
|
/**
|
|
2005
|
-
* @
|
|
2675
|
+
* @public
|
|
2676
|
+
* <p>A list of adapters that matches the filtering criteria specified when calling ListAdapters.</p>
|
|
2006
2677
|
*/
|
|
2007
|
-
|
|
2678
|
+
Adapters?: AdapterOverview[];
|
|
2679
|
+
/**
|
|
2680
|
+
* @public
|
|
2681
|
+
* <p>Identifies the next page of results to return when listing adapters.</p>
|
|
2682
|
+
*/
|
|
2683
|
+
NextToken?: string;
|
|
2008
2684
|
}
|
|
2009
2685
|
/**
|
|
2010
2686
|
* @public
|
|
2011
|
-
* <p>The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of
|
|
2012
|
-
* an asynchronous document operation. </p>
|
|
2013
2687
|
*/
|
|
2014
|
-
export interface
|
|
2688
|
+
export interface ListAdapterVersionsRequest {
|
|
2015
2689
|
/**
|
|
2016
2690
|
* @public
|
|
2017
|
-
* <p>
|
|
2691
|
+
* <p>A string containing a unique ID for the adapter to match for when listing adapter versions.</p>
|
|
2018
2692
|
*/
|
|
2019
|
-
|
|
2693
|
+
AdapterId?: string;
|
|
2020
2694
|
/**
|
|
2021
2695
|
* @public
|
|
2022
|
-
* <p>
|
|
2696
|
+
* <p>Specifies the lower bound for the ListAdapterVersions operation.
|
|
2697
|
+
* Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.</p>
|
|
2023
2698
|
*/
|
|
2024
|
-
|
|
2699
|
+
AfterCreationTime?: Date;
|
|
2700
|
+
/**
|
|
2701
|
+
* @public
|
|
2702
|
+
* <p>Specifies the upper bound for the ListAdapterVersions operation.
|
|
2703
|
+
* Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.</p>
|
|
2704
|
+
*/
|
|
2705
|
+
BeforeCreationTime?: Date;
|
|
2706
|
+
/**
|
|
2707
|
+
* @public
|
|
2708
|
+
* <p>The maximum number of results to return when listing adapter versions.</p>
|
|
2709
|
+
*/
|
|
2710
|
+
MaxResults?: number;
|
|
2711
|
+
/**
|
|
2712
|
+
* @public
|
|
2713
|
+
* <p>Identifies the next page of results to return when listing adapter versions.</p>
|
|
2714
|
+
*/
|
|
2715
|
+
NextToken?: string;
|
|
2025
2716
|
}
|
|
2026
2717
|
/**
|
|
2027
2718
|
* @public
|
|
2028
|
-
* <p>Sets whether or not your output will go to a user created bucket. Used to set the name
|
|
2029
|
-
* of the bucket, and the prefix on the output file.</p>
|
|
2030
|
-
* <p>
|
|
2031
|
-
* <code>OutputConfig</code> is an optional parameter which lets you adjust where your
|
|
2032
|
-
* output will be placed. By default, Amazon Textract will store the results internally and can
|
|
2033
|
-
* only be accessed by the Get API operations. With <code>OutputConfig</code> enabled, you can
|
|
2034
|
-
* set the name of the bucket the output will be sent to the file prefix of the results where
|
|
2035
|
-
* you can download your results. Additionally, you can set the <code>KMSKeyID</code>
|
|
2036
|
-
* parameter to a customer master key (CMK) to encrypt your output. Without this parameter set
|
|
2037
|
-
* Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.</p>
|
|
2038
|
-
* <p>Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account
|
|
2039
|
-
* is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after
|
|
2040
|
-
* the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html"> Managing AI services opt-out policy. </a>
|
|
2041
|
-
* </p>
|
|
2042
|
-
* <p>For more information on data privacy,
|
|
2043
|
-
* see the <a href="https://aws.amazon.com/compliance/data-privacy-faq/">Data Privacy
|
|
2044
|
-
* FAQ</a>.</p>
|
|
2045
2719
|
*/
|
|
2046
|
-
export interface
|
|
2720
|
+
export interface ListAdapterVersionsResponse {
|
|
2047
2721
|
/**
|
|
2048
2722
|
* @public
|
|
2049
|
-
* <p>
|
|
2723
|
+
* <p>Adapter versions that match the filtering criteria specified when calling ListAdapters.</p>
|
|
2050
2724
|
*/
|
|
2051
|
-
|
|
2725
|
+
AdapterVersions?: AdapterVersionOverview[];
|
|
2052
2726
|
/**
|
|
2053
2727
|
* @public
|
|
2054
|
-
* <p>
|
|
2055
|
-
* prefix will be “textract_output".</p>
|
|
2728
|
+
* <p>Identifies the next page of results to return when listing adapter versions.</p>
|
|
2056
2729
|
*/
|
|
2057
|
-
|
|
2730
|
+
NextToken?: string;
|
|
2731
|
+
}
|
|
2732
|
+
/**
|
|
2733
|
+
* @public
|
|
2734
|
+
*/
|
|
2735
|
+
export interface ListTagsForResourceRequest {
|
|
2736
|
+
/**
|
|
2737
|
+
* @public
|
|
2738
|
+
* <p>The Amazon Resource Name (ARN) that specifies the resource to list tags for.</p>
|
|
2739
|
+
*/
|
|
2740
|
+
ResourceARN: string | undefined;
|
|
2741
|
+
}
|
|
2742
|
+
/**
|
|
2743
|
+
* @public
|
|
2744
|
+
*/
|
|
2745
|
+
export interface ListTagsForResourceResponse {
|
|
2746
|
+
/**
|
|
2747
|
+
* @public
|
|
2748
|
+
* <p>A set of tags (key-value pairs) that are part of the requested resource.</p>
|
|
2749
|
+
*/
|
|
2750
|
+
Tags?: Record<string, string>;
|
|
2751
|
+
}
|
|
2752
|
+
/**
|
|
2753
|
+
* @public
|
|
2754
|
+
* <p>The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of
|
|
2755
|
+
* an asynchronous document operation. </p>
|
|
2756
|
+
*/
|
|
2757
|
+
export interface NotificationChannel {
|
|
2758
|
+
/**
|
|
2759
|
+
* @public
|
|
2760
|
+
* <p>The Amazon SNS topic that Amazon Textract posts the completion status to.</p>
|
|
2761
|
+
*/
|
|
2762
|
+
SNSTopicArn: string | undefined;
|
|
2763
|
+
/**
|
|
2764
|
+
* @public
|
|
2765
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic. </p>
|
|
2766
|
+
*/
|
|
2767
|
+
RoleArn: string | undefined;
|
|
2058
2768
|
}
|
|
2059
2769
|
/**
|
|
2060
2770
|
* @public
|
|
@@ -2074,7 +2784,7 @@ export interface StartDocumentAnalysisRequest {
|
|
|
2074
2784
|
* included in the response (including text that isn't related to the value of
|
|
2075
2785
|
* <code>FeatureTypes</code>). </p>
|
|
2076
2786
|
*/
|
|
2077
|
-
FeatureTypes:
|
|
2787
|
+
FeatureTypes: FeatureType[] | undefined;
|
|
2078
2788
|
/**
|
|
2079
2789
|
* @public
|
|
2080
2790
|
* <p>The idempotent token that you use to identify the start request. If you use the same
|
|
@@ -2118,6 +2828,11 @@ export interface StartDocumentAnalysisRequest {
|
|
|
2118
2828
|
* <p></p>
|
|
2119
2829
|
*/
|
|
2120
2830
|
QueriesConfig?: QueriesConfig;
|
|
2831
|
+
/**
|
|
2832
|
+
* @public
|
|
2833
|
+
* <p>Specifies the adapter to be used when analyzing a document.</p>
|
|
2834
|
+
*/
|
|
2835
|
+
AdaptersConfig?: AdaptersConfig;
|
|
2121
2836
|
}
|
|
2122
2837
|
/**
|
|
2123
2838
|
* @public
|
|
@@ -2326,3 +3041,103 @@ export interface StartLendingAnalysisResponse {
|
|
|
2326
3041
|
*/
|
|
2327
3042
|
JobId?: string;
|
|
2328
3043
|
}
|
|
3044
|
+
/**
|
|
3045
|
+
* @public
|
|
3046
|
+
*/
|
|
3047
|
+
export interface TagResourceRequest {
|
|
3048
|
+
/**
|
|
3049
|
+
* @public
|
|
3050
|
+
* <p>The Amazon Resource Name (ARN) that specifies the resource to be tagged.</p>
|
|
3051
|
+
*/
|
|
3052
|
+
ResourceARN: string | undefined;
|
|
3053
|
+
/**
|
|
3054
|
+
* @public
|
|
3055
|
+
* <p>A set of tags (key-value pairs) that you want to assign to the resource.</p>
|
|
3056
|
+
*/
|
|
3057
|
+
Tags: Record<string, string> | undefined;
|
|
3058
|
+
}
|
|
3059
|
+
/**
|
|
3060
|
+
* @public
|
|
3061
|
+
*/
|
|
3062
|
+
export interface TagResourceResponse {
|
|
3063
|
+
}
|
|
3064
|
+
/**
|
|
3065
|
+
* @public
|
|
3066
|
+
*/
|
|
3067
|
+
export interface UntagResourceRequest {
|
|
3068
|
+
/**
|
|
3069
|
+
* @public
|
|
3070
|
+
* <p>The Amazon Resource Name (ARN) that specifies the resource to be untagged.</p>
|
|
3071
|
+
*/
|
|
3072
|
+
ResourceARN: string | undefined;
|
|
3073
|
+
/**
|
|
3074
|
+
* @public
|
|
3075
|
+
* <p>Specifies the tags to be removed from the resource specified by the ResourceARN.</p>
|
|
3076
|
+
*/
|
|
3077
|
+
TagKeys: string[] | undefined;
|
|
3078
|
+
}
|
|
3079
|
+
/**
|
|
3080
|
+
* @public
|
|
3081
|
+
*/
|
|
3082
|
+
export interface UntagResourceResponse {
|
|
3083
|
+
}
|
|
3084
|
+
/**
|
|
3085
|
+
* @public
|
|
3086
|
+
*/
|
|
3087
|
+
export interface UpdateAdapterRequest {
|
|
3088
|
+
/**
|
|
3089
|
+
* @public
|
|
3090
|
+
* <p>A string containing a unique ID for the adapter that will be updated.</p>
|
|
3091
|
+
*/
|
|
3092
|
+
AdapterId: string | undefined;
|
|
3093
|
+
/**
|
|
3094
|
+
* @public
|
|
3095
|
+
* <p>The new description to be applied to the adapter.</p>
|
|
3096
|
+
*/
|
|
3097
|
+
Description?: string;
|
|
3098
|
+
/**
|
|
3099
|
+
* @public
|
|
3100
|
+
* <p>The new name to be applied to the adapter.</p>
|
|
3101
|
+
*/
|
|
3102
|
+
AdapterName?: string;
|
|
3103
|
+
/**
|
|
3104
|
+
* @public
|
|
3105
|
+
* <p>The new auto-update status to be applied to the adapter.</p>
|
|
3106
|
+
*/
|
|
3107
|
+
AutoUpdate?: AutoUpdate;
|
|
3108
|
+
}
|
|
3109
|
+
/**
|
|
3110
|
+
* @public
|
|
3111
|
+
*/
|
|
3112
|
+
export interface UpdateAdapterResponse {
|
|
3113
|
+
/**
|
|
3114
|
+
* @public
|
|
3115
|
+
* <p>A string containing a unique ID for the adapter that has been updated.</p>
|
|
3116
|
+
*/
|
|
3117
|
+
AdapterId?: string;
|
|
3118
|
+
/**
|
|
3119
|
+
* @public
|
|
3120
|
+
* <p>A string containing the name of the adapter that has been updated.</p>
|
|
3121
|
+
*/
|
|
3122
|
+
AdapterName?: string;
|
|
3123
|
+
/**
|
|
3124
|
+
* @public
|
|
3125
|
+
* <p>An object specifying the creation time of the the adapter that has been updated.</p>
|
|
3126
|
+
*/
|
|
3127
|
+
CreationTime?: Date;
|
|
3128
|
+
/**
|
|
3129
|
+
* @public
|
|
3130
|
+
* <p>A string containing the description of the adapter that has been updated.</p>
|
|
3131
|
+
*/
|
|
3132
|
+
Description?: string;
|
|
3133
|
+
/**
|
|
3134
|
+
* @public
|
|
3135
|
+
* <p>List of the targeted feature types for the updated adapter.</p>
|
|
3136
|
+
*/
|
|
3137
|
+
FeatureTypes?: FeatureType[];
|
|
3138
|
+
/**
|
|
3139
|
+
* @public
|
|
3140
|
+
* <p>The auto-update status of the adapter that has been updated.</p>
|
|
3141
|
+
*/
|
|
3142
|
+
AutoUpdate?: AutoUpdate;
|
|
3143
|
+
}
|