@aws-sdk/client-textract 3.36.0 → 3.36.1
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/CHANGELOG.md +11 -0
- package/dist-cjs/Textract.js +0 -5
- package/dist-cjs/TextractClient.js +0 -10
- package/dist-cjs/commands/AnalyzeDocumentCommand.js +0 -54
- package/dist-cjs/commands/AnalyzeExpenseCommand.js +0 -37
- package/dist-cjs/commands/DetectDocumentTextCommand.js +0 -34
- package/dist-cjs/commands/GetDocumentAnalysisCommand.js +0 -68
- package/dist-cjs/commands/GetDocumentTextDetectionCommand.js +0 -48
- package/dist-cjs/commands/StartDocumentAnalysisCommand.js +0 -41
- package/dist-cjs/commands/StartDocumentTextDetectionCommand.js +0 -40
- package/dist-cjs/models/models_0.js +0 -147
- package/dist-cjs/protocols/Aws_json1_1.js +0 -5
- package/dist-cjs/runtimeConfig.browser.js +1 -5
- package/dist-cjs/runtimeConfig.js +1 -5
- package/dist-cjs/runtimeConfig.native.js +0 -3
- package/dist-cjs/runtimeConfig.shared.js +0 -3
- package/dist-types/ts3.4/Textract.d.ts +8 -180
- package/dist-types/ts3.4/TextractClient.d.ts +24 -91
- package/dist-types/ts3.4/commands/AnalyzeDocumentCommand.d.ts +2 -50
- package/dist-types/ts3.4/commands/AnalyzeExpenseCommand.d.ts +2 -33
- package/dist-types/ts3.4/commands/DetectDocumentTextCommand.d.ts +2 -30
- package/dist-types/ts3.4/commands/GetDocumentAnalysisCommand.d.ts +2 -64
- package/dist-types/ts3.4/commands/GetDocumentTextDetectionCommand.d.ts +2 -44
- package/dist-types/ts3.4/commands/StartDocumentAnalysisCommand.d.ts +2 -37
- package/dist-types/ts3.4/commands/StartDocumentTextDetectionCommand.d.ts +2 -36
- package/dist-types/ts3.4/models/models_0.d.ts +195 -893
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
- package/package.json +3 -3
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
import { LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
|
|
3
|
-
|
|
4
|
-
* <p>You aren't authorized to perform the action. Use the Amazon Resource Name (ARN)
|
|
5
|
-
* of an authorized user or IAM role to perform the operation.</p>
|
|
6
|
-
*/
|
|
3
|
+
|
|
7
4
|
export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
|
|
8
5
|
name: "AccessDeniedException";
|
|
9
6
|
$fault: "client";
|
|
@@ -11,80 +8,31 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare
|
|
|
11
8
|
Code?: string;
|
|
12
9
|
}
|
|
13
10
|
export declare namespace AccessDeniedException {
|
|
14
|
-
|
|
15
|
-
* @internal
|
|
16
|
-
*/
|
|
11
|
+
|
|
17
12
|
const filterSensitiveLog: (obj: AccessDeniedException) => any;
|
|
18
13
|
}
|
|
19
|
-
|
|
20
|
-
* <p>The S3 bucket name and file name that identifies the document.</p>
|
|
21
|
-
* <p>The AWS Region for the S3 bucket that contains the document must match the Region that
|
|
22
|
-
* you use for Amazon Textract operations.</p>
|
|
23
|
-
*
|
|
24
|
-
* <p>For Amazon Textract to process a file in an S3 bucket, the user must have
|
|
25
|
-
* permission to access the S3 bucket and file.
|
|
26
|
-
*
|
|
27
|
-
* </p>
|
|
28
|
-
*/
|
|
14
|
+
|
|
29
15
|
export interface S3Object {
|
|
30
|
-
|
|
31
|
-
* <p>The name of the S3 bucket. Note that the # character is not valid in the file
|
|
32
|
-
* name.</p>
|
|
33
|
-
*/
|
|
16
|
+
|
|
34
17
|
Bucket?: string;
|
|
35
|
-
|
|
36
|
-
* <p>The file name of the input document. Synchronous operations can use image files that are
|
|
37
|
-
* in JPEG or PNG format. Asynchronous operations also support PDF format files.</p>
|
|
38
|
-
*/
|
|
18
|
+
|
|
39
19
|
Name?: string;
|
|
40
|
-
|
|
41
|
-
* <p>If the bucket has versioning enabled, you can specify the object version. </p>
|
|
42
|
-
*/
|
|
20
|
+
|
|
43
21
|
Version?: string;
|
|
44
22
|
}
|
|
45
23
|
export declare namespace S3Object {
|
|
46
|
-
|
|
47
|
-
* @internal
|
|
48
|
-
*/
|
|
24
|
+
|
|
49
25
|
const filterSensitiveLog: (obj: S3Object) => any;
|
|
50
26
|
}
|
|
51
|
-
|
|
52
|
-
* <p>The input document, either as bytes or as an S3 object.</p>
|
|
53
|
-
* <p>You pass image bytes to an Amazon Textract API operation by using the <code>Bytes</code>
|
|
54
|
-
* property. For example, you would use the <code>Bytes</code> property to pass a document
|
|
55
|
-
* loaded from a local file system. Image bytes passed by using the <code>Bytes</code>
|
|
56
|
-
* property must be base64 encoded. Your code might not need to encode document file bytes if
|
|
57
|
-
* you're using an AWS SDK to call Amazon Textract API operations. </p>
|
|
58
|
-
* <p>You pass images stored in an S3 bucket to an Amazon Textract API operation by using the
|
|
59
|
-
* <code>S3Object</code> property. Documents stored in an S3 bucket don't need to be base64
|
|
60
|
-
* encoded.</p>
|
|
61
|
-
* <p>The AWS Region for the S3 bucket that contains the S3 object must match the AWS
|
|
62
|
-
* Region that you use for Amazon Textract operations.</p>
|
|
63
|
-
* <p>If you use the AWS CLI to call Amazon Textract operations, passing image bytes using
|
|
64
|
-
* the Bytes property isn't supported. You must first upload the document to an Amazon S3
|
|
65
|
-
* bucket, and then call the operation using the S3Object property.</p>
|
|
66
|
-
*
|
|
67
|
-
* <p>For Amazon Textract to process an S3 object, the user must have permission
|
|
68
|
-
* to access the S3 object. </p>
|
|
69
|
-
*/
|
|
27
|
+
|
|
70
28
|
export interface Document {
|
|
71
|
-
|
|
72
|
-
* <p>A blob of base64-encoded document bytes. The maximum size of a document that's provided
|
|
73
|
-
* in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.</p>
|
|
74
|
-
* <p>If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode
|
|
75
|
-
* image bytes passed using the <code>Bytes</code> field. </p>
|
|
76
|
-
*/
|
|
29
|
+
|
|
77
30
|
Bytes?: Uint8Array;
|
|
78
|
-
|
|
79
|
-
* <p>Identifies an S3 object as the document source. The maximum size of a document that's
|
|
80
|
-
* stored in an S3 bucket is 5 MB.</p>
|
|
81
|
-
*/
|
|
31
|
+
|
|
82
32
|
S3Object?: S3Object;
|
|
83
33
|
}
|
|
84
34
|
export declare namespace Document {
|
|
85
|
-
|
|
86
|
-
* @internal
|
|
87
|
-
*/
|
|
35
|
+
|
|
88
36
|
const filterSensitiveLog: (obj: Document) => any;
|
|
89
37
|
}
|
|
90
38
|
export declare enum FeatureType {
|
|
@@ -95,74 +43,38 @@ export declare enum ContentClassifier {
|
|
|
95
43
|
FREE_OF_ADULT_CONTENT = "FreeOfAdultContent",
|
|
96
44
|
FREE_OF_PERSONALLY_IDENTIFIABLE_INFORMATION = "FreeOfPersonallyIdentifiableInformation"
|
|
97
45
|
}
|
|
98
|
-
|
|
99
|
-
* <p>Allows you to set attributes of the image. Currently, you can declare an image as free
|
|
100
|
-
* of personally identifiable information and adult content. </p>
|
|
101
|
-
*/
|
|
46
|
+
|
|
102
47
|
export interface HumanLoopDataAttributes {
|
|
103
|
-
|
|
104
|
-
* <p>Sets whether the input image is free of personally identifiable information or adult
|
|
105
|
-
* content.</p>
|
|
106
|
-
*/
|
|
48
|
+
|
|
107
49
|
ContentClassifiers?: (ContentClassifier | string)[];
|
|
108
50
|
}
|
|
109
51
|
export declare namespace HumanLoopDataAttributes {
|
|
110
|
-
|
|
111
|
-
* @internal
|
|
112
|
-
*/
|
|
52
|
+
|
|
113
53
|
const filterSensitiveLog: (obj: HumanLoopDataAttributes) => any;
|
|
114
54
|
}
|
|
115
|
-
|
|
116
|
-
* <p>Sets up the human review workflow the document will be sent to if one of the conditions
|
|
117
|
-
* is met. You can also set certain attributes of the image before review. </p>
|
|
118
|
-
*/
|
|
55
|
+
|
|
119
56
|
export interface HumanLoopConfig {
|
|
120
|
-
|
|
121
|
-
* <p>The name of the human workflow used for this image. This should be kept unique within a
|
|
122
|
-
* region.</p>
|
|
123
|
-
*/
|
|
57
|
+
|
|
124
58
|
HumanLoopName: string | undefined;
|
|
125
|
-
|
|
126
|
-
* <p>The Amazon Resource Name (ARN) of the flow definition.</p>
|
|
127
|
-
*/
|
|
59
|
+
|
|
128
60
|
FlowDefinitionArn: string | undefined;
|
|
129
|
-
|
|
130
|
-
* <p>Sets attributes of the input data.</p>
|
|
131
|
-
*/
|
|
61
|
+
|
|
132
62
|
DataAttributes?: HumanLoopDataAttributes;
|
|
133
63
|
}
|
|
134
64
|
export declare namespace HumanLoopConfig {
|
|
135
|
-
|
|
136
|
-
* @internal
|
|
137
|
-
*/
|
|
65
|
+
|
|
138
66
|
const filterSensitiveLog: (obj: HumanLoopConfig) => any;
|
|
139
67
|
}
|
|
140
68
|
export interface AnalyzeDocumentRequest {
|
|
141
|
-
|
|
142
|
-
* <p>The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI
|
|
143
|
-
* to call Amazon Textract operations, you can't pass image bytes. The document must be an image
|
|
144
|
-
* in JPEG or PNG format.</p>
|
|
145
|
-
* <p>If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode
|
|
146
|
-
* image bytes that are passed using the <code>Bytes</code> field. </p>
|
|
147
|
-
*/
|
|
69
|
+
|
|
148
70
|
Document: Document | undefined;
|
|
149
|
-
|
|
150
|
-
* <p>A list of the types of analysis to perform. Add TABLES to the list to return information
|
|
151
|
-
* about the tables that are detected in the input document. Add FORMS to return detected form data.
|
|
152
|
-
* To perform both types of analysis, add TABLES and FORMS to
|
|
153
|
-
* <code>FeatureTypes</code>. All lines and words detected in the document are included in
|
|
154
|
-
* the response (including text that isn't related to the value of <code>FeatureTypes</code>). </p>
|
|
155
|
-
*/
|
|
71
|
+
|
|
156
72
|
FeatureTypes: (FeatureType | string)[] | undefined;
|
|
157
|
-
|
|
158
|
-
* <p>Sets the configuration for the human in the loop workflow for analyzing documents.</p>
|
|
159
|
-
*/
|
|
73
|
+
|
|
160
74
|
HumanLoopConfig?: HumanLoopConfig;
|
|
161
75
|
}
|
|
162
76
|
export declare namespace AnalyzeDocumentRequest {
|
|
163
|
-
|
|
164
|
-
* @internal
|
|
165
|
-
*/
|
|
77
|
+
|
|
166
78
|
const filterSensitiveLog: (obj: AnalyzeDocumentRequest) => any;
|
|
167
79
|
}
|
|
168
80
|
export declare enum BlockType {
|
|
@@ -178,94 +90,41 @@ export declare enum EntityType {
|
|
|
178
90
|
KEY = "KEY",
|
|
179
91
|
VALUE = "VALUE"
|
|
180
92
|
}
|
|
181
|
-
|
|
182
|
-
* <p>The bounding box around the detected page, text, key-value pair, table, table cell, or
|
|
183
|
-
* selection element on a document page. The <code>left</code> (x-coordinate) and
|
|
184
|
-
* <code>top</code> (y-coordinate) are coordinates that represent the top and left sides of
|
|
185
|
-
* the bounding box. Note that the upper-left corner of the image is the origin (0,0). </p>
|
|
186
|
-
* <p>The <code>top</code> and <code>left</code> values returned are ratios of the overall
|
|
187
|
-
* document page size. For example, if the input image is 700 x 200 pixels, and the top-left
|
|
188
|
-
* coordinate of the bounding box is 350 x 50 pixels, the API returns a <code>left</code>
|
|
189
|
-
* value of 0.5 (350/700) and a <code>top</code> value of 0.25 (50/200).</p>
|
|
190
|
-
* <p>The <code>width</code> and <code>height</code> values represent the dimensions of the
|
|
191
|
-
* bounding box as a ratio of the overall document page dimension. For example, if the
|
|
192
|
-
* document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width
|
|
193
|
-
* returned is 0.1. </p>
|
|
194
|
-
*/
|
|
93
|
+
|
|
195
94
|
export interface BoundingBox {
|
|
196
|
-
|
|
197
|
-
* <p>The width of the bounding box as a ratio of the overall document page
|
|
198
|
-
* width.</p>
|
|
199
|
-
*/
|
|
95
|
+
|
|
200
96
|
Width?: number;
|
|
201
|
-
|
|
202
|
-
* <p>The height of the bounding box as a ratio of the overall document page
|
|
203
|
-
* height.</p>
|
|
204
|
-
*/
|
|
97
|
+
|
|
205
98
|
Height?: number;
|
|
206
|
-
|
|
207
|
-
* <p>The left coordinate of the bounding box as a ratio of overall document page
|
|
208
|
-
* width.</p>
|
|
209
|
-
*/
|
|
99
|
+
|
|
210
100
|
Left?: number;
|
|
211
|
-
|
|
212
|
-
* <p>The top coordinate of the bounding box as a ratio of overall document page
|
|
213
|
-
* height.</p>
|
|
214
|
-
*/
|
|
101
|
+
|
|
215
102
|
Top?: number;
|
|
216
103
|
}
|
|
217
104
|
export declare namespace BoundingBox {
|
|
218
|
-
|
|
219
|
-
* @internal
|
|
220
|
-
*/
|
|
105
|
+
|
|
221
106
|
const filterSensitiveLog: (obj: BoundingBox) => any;
|
|
222
107
|
}
|
|
223
|
-
|
|
224
|
-
* <p>The X and Y coordinates of a point on a document page. The X and Y
|
|
225
|
-
* values that are returned are ratios of the overall document page size. For example, if the
|
|
226
|
-
* input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is
|
|
227
|
-
* at the (350,50) pixel coordinate on the document page.</p>
|
|
228
|
-
*
|
|
229
|
-
* <p>An array of <code>Point</code> objects, <code>Polygon</code>, is returned
|
|
230
|
-
* by <a>DetectDocumentText</a>. <code>Polygon</code> represents a fine-grained
|
|
231
|
-
* polygon around detected text. For more information, see Geometry in the Amazon Textract
|
|
232
|
-
* Developer Guide. </p>
|
|
233
|
-
*/
|
|
108
|
+
|
|
234
109
|
export interface Point {
|
|
235
|
-
|
|
236
|
-
* <p>The value of the X coordinate for a point on a <code>Polygon</code>.</p>
|
|
237
|
-
*/
|
|
110
|
+
|
|
238
111
|
X?: number;
|
|
239
|
-
|
|
240
|
-
* <p>The value of the Y coordinate for a point on a <code>Polygon</code>.</p>
|
|
241
|
-
*/
|
|
112
|
+
|
|
242
113
|
Y?: number;
|
|
243
114
|
}
|
|
244
115
|
export declare namespace Point {
|
|
245
|
-
|
|
246
|
-
* @internal
|
|
247
|
-
*/
|
|
116
|
+
|
|
248
117
|
const filterSensitiveLog: (obj: Point) => any;
|
|
249
118
|
}
|
|
250
|
-
|
|
251
|
-
* <p>Information about where the following items are located on a document page: detected
|
|
252
|
-
* page, text, key-value pairs, tables, table cells, and selection elements.</p>
|
|
253
|
-
*/
|
|
119
|
+
|
|
254
120
|
export interface Geometry {
|
|
255
|
-
|
|
256
|
-
* <p>An axis-aligned coarse representation of the location of the recognized item on the
|
|
257
|
-
* document page.</p>
|
|
258
|
-
*/
|
|
121
|
+
|
|
259
122
|
BoundingBox?: BoundingBox;
|
|
260
|
-
|
|
261
|
-
* <p>Within the bounding box, a fine-grained polygon around the recognized item.</p>
|
|
262
|
-
*/
|
|
123
|
+
|
|
263
124
|
Polygon?: Point[];
|
|
264
125
|
}
|
|
265
126
|
export declare namespace Geometry {
|
|
266
|
-
|
|
267
|
-
* @internal
|
|
268
|
-
*/
|
|
127
|
+
|
|
269
128
|
const filterSensitiveLog: (obj: Geometry) => any;
|
|
270
129
|
}
|
|
271
130
|
export declare enum RelationshipType {
|
|
@@ -273,34 +132,15 @@ export declare enum RelationshipType {
|
|
|
273
132
|
COMPLEX_FEATURES = "COMPLEX_FEATURES",
|
|
274
133
|
VALUE = "VALUE"
|
|
275
134
|
}
|
|
276
|
-
|
|
277
|
-
* <p>Information about how blocks are related to each other. A <code>Block</code> object
|
|
278
|
-
* contains 0 or more <code>Relation</code> objects in a list, <code>Relationships</code>. For
|
|
279
|
-
* more information, see <a>Block</a>.</p>
|
|
280
|
-
* <p>The <code>Type</code> element provides the type of the relationship for all blocks in
|
|
281
|
-
* the <code>IDs</code> array. </p>
|
|
282
|
-
*/
|
|
135
|
+
|
|
283
136
|
export interface Relationship {
|
|
284
|
-
|
|
285
|
-
* <p>The type of relationship that the blocks in the IDs array have with the current block.
|
|
286
|
-
* The relationship can be <code>VALUE</code> or <code>CHILD</code>. A relationship of type
|
|
287
|
-
* VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a
|
|
288
|
-
* key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in
|
|
289
|
-
* the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of
|
|
290
|
-
* Selection Elements.</p>
|
|
291
|
-
*/
|
|
137
|
+
|
|
292
138
|
Type?: RelationshipType | string;
|
|
293
|
-
|
|
294
|
-
* <p>An
|
|
295
|
-
* array of IDs for related blocks. You can get the type of the relationship from the
|
|
296
|
-
* <code>Type</code> element.</p>
|
|
297
|
-
*/
|
|
139
|
+
|
|
298
140
|
Ids?: string[];
|
|
299
141
|
}
|
|
300
142
|
export declare namespace Relationship {
|
|
301
|
-
|
|
302
|
-
* @internal
|
|
303
|
-
*/
|
|
143
|
+
|
|
304
144
|
const filterSensitiveLog: (obj: Relationship) => any;
|
|
305
145
|
}
|
|
306
146
|
export declare enum SelectionStatus {
|
|
@@ -311,256 +151,78 @@ export declare enum TextType {
|
|
|
311
151
|
HANDWRITING = "HANDWRITING",
|
|
312
152
|
PRINTED = "PRINTED"
|
|
313
153
|
}
|
|
314
|
-
|
|
315
|
-
* <p>A <code>Block</code> represents items that are recognized in a document within a group
|
|
316
|
-
* of pixels close to each other. The information returned in a <code>Block</code> object
|
|
317
|
-
* depends on the type of operation. In text detection for documents (for example <a>DetectDocumentText</a>), you get information about the detected words and lines
|
|
318
|
-
* of text. In text analysis (for example <a>AnalyzeDocument</a>), you can also get
|
|
319
|
-
* information about the fields, tables, and selection elements that are detected in the
|
|
320
|
-
* document.</p>
|
|
321
|
-
* <p>An array of <code>Block</code> objects is returned by both synchronous and asynchronous
|
|
322
|
-
* operations. In synchronous operations, such as <a>DetectDocumentText</a>, the
|
|
323
|
-
* array of <code>Block</code> objects is the entire set of results. In asynchronous
|
|
324
|
-
* operations, such as <a>GetDocumentAnalysis</a>, the array is returned over one
|
|
325
|
-
* or more responses.</p>
|
|
326
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works.html">How Amazon Textract Works</a>.</p>
|
|
327
|
-
*/
|
|
154
|
+
|
|
328
155
|
export interface Block {
|
|
329
|
-
|
|
330
|
-
* <p>The type of text item that's recognized. In operations for text detection, the following
|
|
331
|
-
* types are returned:</p>
|
|
332
|
-
* <ul>
|
|
333
|
-
* <li>
|
|
334
|
-
* <p>
|
|
335
|
-
* <i>PAGE</i> - Contains a list of the LINE <code>Block</code> objects
|
|
336
|
-
* that are detected on a document page.</p>
|
|
337
|
-
* </li>
|
|
338
|
-
* <li>
|
|
339
|
-
* <p>
|
|
340
|
-
* <i>WORD</i> - A word detected on a document page. A word is one or
|
|
341
|
-
* more ISO basic Latin script characters that aren't separated by spaces.</p>
|
|
342
|
-
* </li>
|
|
343
|
-
* <li>
|
|
344
|
-
* <p>
|
|
345
|
-
* <i>LINE</i> - A string of tab-delimited, contiguous words that are
|
|
346
|
-
* detected on a document page.</p>
|
|
347
|
-
* </li>
|
|
348
|
-
* </ul>
|
|
349
|
-
* <p>In text analysis operations, the following types are returned:</p>
|
|
350
|
-
* <ul>
|
|
351
|
-
* <li>
|
|
352
|
-
* <p>
|
|
353
|
-
* <i>PAGE</i> - Contains a list of child <code>Block</code> objects
|
|
354
|
-
* that are detected on a document page.</p>
|
|
355
|
-
* </li>
|
|
356
|
-
* <li>
|
|
357
|
-
* <p>
|
|
358
|
-
* <i>KEY_VALUE_SET</i> - Stores the KEY and VALUE <code>Block</code>
|
|
359
|
-
* objects for linked text that's detected on a document page. Use the
|
|
360
|
-
* <code>EntityType</code> field to determine if a KEY_VALUE_SET object is a KEY
|
|
361
|
-
* <code>Block</code> object or a VALUE <code>Block</code> object. </p>
|
|
362
|
-
* </li>
|
|
363
|
-
* <li>
|
|
364
|
-
* <p>
|
|
365
|
-
* <i>WORD</i> - A word that's detected on a document page. A word is
|
|
366
|
-
* one or more ISO basic Latin script characters that aren't separated by spaces.</p>
|
|
367
|
-
* </li>
|
|
368
|
-
* <li>
|
|
369
|
-
* <p>
|
|
370
|
-
* <i>LINE</i> - A string of tab-delimited, contiguous words that are
|
|
371
|
-
* detected on a document page.</p>
|
|
372
|
-
* </li>
|
|
373
|
-
* <li>
|
|
374
|
-
* <p>
|
|
375
|
-
* <i>TABLE</i> - A table that's detected on a document page. A table
|
|
376
|
-
* is grid-based information with two or more rows or columns, with a cell span of one
|
|
377
|
-
* row and one column each. </p>
|
|
378
|
-
* </li>
|
|
379
|
-
* <li>
|
|
380
|
-
* <p>
|
|
381
|
-
* <i>CELL</i> - A cell within a detected table. The cell is the parent
|
|
382
|
-
* of the block that contains the text in the cell.</p>
|
|
383
|
-
* </li>
|
|
384
|
-
* <li>
|
|
385
|
-
* <p>
|
|
386
|
-
* <i>SELECTION_ELEMENT</i> - A selection element such as an option
|
|
387
|
-
* button (radio button) or a check box that's detected on a document page. Use the
|
|
388
|
-
* value of <code>SelectionStatus</code> to determine the status of the selection
|
|
389
|
-
* element.</p>
|
|
390
|
-
* </li>
|
|
391
|
-
* </ul>
|
|
392
|
-
*/
|
|
156
|
+
|
|
393
157
|
BlockType?: BlockType | string;
|
|
394
|
-
|
|
395
|
-
* <p>The confidence score that Amazon Textract has in the accuracy of the recognized text and
|
|
396
|
-
* the accuracy of the geometry points around the recognized text.</p>
|
|
397
|
-
*/
|
|
158
|
+
|
|
398
159
|
Confidence?: number;
|
|
399
|
-
|
|
400
|
-
* <p>The word or line of text that's recognized by Amazon Textract. </p>
|
|
401
|
-
*/
|
|
160
|
+
|
|
402
161
|
Text?: string;
|
|
403
|
-
|
|
404
|
-
* <p>The kind of text that Amazon Textract has detected. Can check for handwritten text and
|
|
405
|
-
* printed text.</p>
|
|
406
|
-
*/
|
|
162
|
+
|
|
407
163
|
TextType?: TextType | string;
|
|
408
|
-
|
|
409
|
-
* <p>The row in which a table cell is located. The first row position is 1.
|
|
410
|
-
* <code>RowIndex</code> isn't returned by <code>DetectDocumentText</code> and
|
|
411
|
-
* <code>GetDocumentTextDetection</code>.</p>
|
|
412
|
-
*/
|
|
164
|
+
|
|
413
165
|
RowIndex?: number;
|
|
414
|
-
|
|
415
|
-
* <p>The column in which a table cell appears. The first column position is 1.
|
|
416
|
-
* <code>ColumnIndex</code> isn't returned by <code>DetectDocumentText</code> and
|
|
417
|
-
* <code>GetDocumentTextDetection</code>.</p>
|
|
418
|
-
*/
|
|
166
|
+
|
|
419
167
|
ColumnIndex?: number;
|
|
420
|
-
|
|
421
|
-
* <p>The number of rows that a table cell spans. Currently this value is always 1, even if
|
|
422
|
-
* the number of rows spanned is greater than 1. <code>RowSpan</code> isn't returned by
|
|
423
|
-
* <code>DetectDocumentText</code> and <code>GetDocumentTextDetection</code>.</p>
|
|
424
|
-
*/
|
|
168
|
+
|
|
425
169
|
RowSpan?: number;
|
|
426
|
-
|
|
427
|
-
* <p>The number of columns that a table cell spans. Currently this value is always 1, even if
|
|
428
|
-
* the number of columns spanned is greater than 1. <code>ColumnSpan</code> isn't returned by
|
|
429
|
-
* <code>DetectDocumentText</code> and <code>GetDocumentTextDetection</code>. </p>
|
|
430
|
-
*/
|
|
170
|
+
|
|
431
171
|
ColumnSpan?: number;
|
|
432
|
-
|
|
433
|
-
* <p>The location of the recognized text on the image. It includes an axis-aligned, coarse
|
|
434
|
-
* bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial
|
|
435
|
-
* information. </p>
|
|
436
|
-
*/
|
|
172
|
+
|
|
437
173
|
Geometry?: Geometry;
|
|
438
|
-
|
|
439
|
-
* <p>The identifier for the recognized text. The identifier is only unique for a single
|
|
440
|
-
* operation. </p>
|
|
441
|
-
*/
|
|
174
|
+
|
|
442
175
|
Id?: string;
|
|
443
|
-
|
|
444
|
-
* <p>A list of child blocks of the current block. For example, a LINE object has child blocks
|
|
445
|
-
* for each WORD block that's part of the line of text. There aren't Relationship objects in
|
|
446
|
-
* the list for relationships that don't exist, such as when the current block has no child
|
|
447
|
-
* blocks. The list size can be the following:</p>
|
|
448
|
-
* <ul>
|
|
449
|
-
* <li>
|
|
450
|
-
* <p>0 - The block has no child blocks.</p>
|
|
451
|
-
* </li>
|
|
452
|
-
* <li>
|
|
453
|
-
* <p>1 - The block has child blocks.</p>
|
|
454
|
-
* </li>
|
|
455
|
-
* </ul>
|
|
456
|
-
*/
|
|
176
|
+
|
|
457
177
|
Relationships?: Relationship[];
|
|
458
|
-
|
|
459
|
-
* <p>The type of entity. The following can be returned:</p>
|
|
460
|
-
* <ul>
|
|
461
|
-
* <li>
|
|
462
|
-
* <p>
|
|
463
|
-
* <i>KEY</i> - An identifier for a field on the document.</p>
|
|
464
|
-
* </li>
|
|
465
|
-
* <li>
|
|
466
|
-
* <p>
|
|
467
|
-
* <i>VALUE</i> - The field text.</p>
|
|
468
|
-
* </li>
|
|
469
|
-
* </ul>
|
|
470
|
-
* <p>
|
|
471
|
-
* <code>EntityTypes</code> isn't returned by <code>DetectDocumentText</code> and
|
|
472
|
-
* <code>GetDocumentTextDetection</code>.</p>
|
|
473
|
-
*/
|
|
178
|
+
|
|
474
179
|
EntityTypes?: (EntityType | string)[];
|
|
475
|
-
|
|
476
|
-
* <p>The selection status of a selection element, such as an option button or check box.
|
|
477
|
-
* </p>
|
|
478
|
-
*/
|
|
180
|
+
|
|
479
181
|
SelectionStatus?: SelectionStatus | string;
|
|
480
|
-
|
|
481
|
-
* <p>The page on which a block was detected. <code>Page</code> is returned by asynchronous
|
|
482
|
-
* operations. Page values greater than 1 are only returned for multipage documents that are
|
|
483
|
-
* in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is
|
|
484
|
-
* considered to be a single-page document. The value of <code>Page</code> is always 1.
|
|
485
|
-
* Synchronous operations don't return <code>Page</code> because every input document is
|
|
486
|
-
* considered to be a single-page document.</p>
|
|
487
|
-
*/
|
|
182
|
+
|
|
488
183
|
Page?: number;
|
|
489
184
|
}
|
|
490
185
|
export declare namespace Block {
|
|
491
|
-
|
|
492
|
-
* @internal
|
|
493
|
-
*/
|
|
186
|
+
|
|
494
187
|
const filterSensitiveLog: (obj: Block) => any;
|
|
495
188
|
}
|
|
496
|
-
|
|
497
|
-
* <p>Information about the input document.</p>
|
|
498
|
-
*/
|
|
189
|
+
|
|
499
190
|
export interface DocumentMetadata {
|
|
500
|
-
|
|
501
|
-
* <p>The number of pages that are detected in the document.</p>
|
|
502
|
-
*/
|
|
191
|
+
|
|
503
192
|
Pages?: number;
|
|
504
193
|
}
|
|
505
194
|
export declare namespace DocumentMetadata {
|
|
506
|
-
|
|
507
|
-
* @internal
|
|
508
|
-
*/
|
|
195
|
+
|
|
509
196
|
const filterSensitiveLog: (obj: DocumentMetadata) => any;
|
|
510
197
|
}
|
|
511
|
-
|
|
512
|
-
* <p>Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the
|
|
513
|
-
* input did not trigger human review.</p>
|
|
514
|
-
*/
|
|
198
|
+
|
|
515
199
|
export interface HumanLoopActivationOutput {
|
|
516
|
-
|
|
517
|
-
* <p>The Amazon Resource Name (ARN) of the HumanLoop created.</p>
|
|
518
|
-
*/
|
|
200
|
+
|
|
519
201
|
HumanLoopArn?: string;
|
|
520
|
-
|
|
521
|
-
* <p>Shows if and why human review was needed.</p>
|
|
522
|
-
*/
|
|
202
|
+
|
|
523
203
|
HumanLoopActivationReasons?: string[];
|
|
524
|
-
|
|
525
|
-
* <p>Shows the result of condition evaluations, including those conditions which activated a
|
|
526
|
-
* human review.</p>
|
|
527
|
-
*/
|
|
204
|
+
|
|
528
205
|
HumanLoopActivationConditionsEvaluationResults?: __LazyJsonString | string;
|
|
529
206
|
}
|
|
530
207
|
export declare namespace HumanLoopActivationOutput {
|
|
531
|
-
|
|
532
|
-
* @internal
|
|
533
|
-
*/
|
|
208
|
+
|
|
534
209
|
const filterSensitiveLog: (obj: HumanLoopActivationOutput) => any;
|
|
535
210
|
}
|
|
536
211
|
export interface AnalyzeDocumentResponse {
|
|
537
|
-
|
|
538
|
-
* <p>Metadata about the analyzed document. An example is the number of pages.</p>
|
|
539
|
-
*/
|
|
212
|
+
|
|
540
213
|
DocumentMetadata?: DocumentMetadata;
|
|
541
|
-
|
|
542
|
-
* <p>The items that are detected and analyzed by <code>AnalyzeDocument</code>.</p>
|
|
543
|
-
*/
|
|
214
|
+
|
|
544
215
|
Blocks?: Block[];
|
|
545
|
-
|
|
546
|
-
* <p>Shows the results of the human in the loop evaluation.</p>
|
|
547
|
-
*/
|
|
216
|
+
|
|
548
217
|
HumanLoopActivationOutput?: HumanLoopActivationOutput;
|
|
549
|
-
|
|
550
|
-
* <p>The version of the model used to analyze the document.</p>
|
|
551
|
-
*/
|
|
218
|
+
|
|
552
219
|
AnalyzeDocumentModelVersion?: string;
|
|
553
220
|
}
|
|
554
221
|
export declare namespace AnalyzeDocumentResponse {
|
|
555
|
-
|
|
556
|
-
* @internal
|
|
557
|
-
*/
|
|
222
|
+
|
|
558
223
|
const filterSensitiveLog: (obj: AnalyzeDocumentResponse) => any;
|
|
559
224
|
}
|
|
560
|
-
|
|
561
|
-
* <p>Amazon Textract isn't able to read the document. For more information on the document
|
|
562
|
-
* limits in Amazon Textract, see <a>limits</a>.</p>
|
|
563
|
-
*/
|
|
225
|
+
|
|
564
226
|
export interface BadDocumentException extends __SmithyException, $MetadataBearer {
|
|
565
227
|
name: "BadDocumentException";
|
|
566
228
|
$fault: "client";
|
|
@@ -568,16 +230,10 @@ export interface BadDocumentException extends __SmithyException, $MetadataBearer
|
|
|
568
230
|
Code?: string;
|
|
569
231
|
}
|
|
570
232
|
export declare namespace BadDocumentException {
|
|
571
|
-
|
|
572
|
-
* @internal
|
|
573
|
-
*/
|
|
233
|
+
|
|
574
234
|
const filterSensitiveLog: (obj: BadDocumentException) => any;
|
|
575
235
|
}
|
|
576
|
-
|
|
577
|
-
* <p>The document can't be processed because it's too large. The maximum document size for
|
|
578
|
-
* synchronous operations 10 MB. The maximum document size for asynchronous operations is 500
|
|
579
|
-
* MB for PDF files.</p>
|
|
580
|
-
*/
|
|
236
|
+
|
|
581
237
|
export interface DocumentTooLargeException extends __SmithyException, $MetadataBearer {
|
|
582
238
|
name: "DocumentTooLargeException";
|
|
583
239
|
$fault: "client";
|
|
@@ -585,41 +241,27 @@ export interface DocumentTooLargeException extends __SmithyException, $MetadataB
|
|
|
585
241
|
Code?: string;
|
|
586
242
|
}
|
|
587
243
|
export declare namespace DocumentTooLargeException {
|
|
588
|
-
|
|
589
|
-
* @internal
|
|
590
|
-
*/
|
|
244
|
+
|
|
591
245
|
const filterSensitiveLog: (obj: DocumentTooLargeException) => any;
|
|
592
246
|
}
|
|
593
|
-
|
|
594
|
-
* <p>Indicates you have exceeded the maximum number of active human in the loop workflows available</p>
|
|
595
|
-
*/
|
|
247
|
+
|
|
596
248
|
export interface HumanLoopQuotaExceededException extends __SmithyException, $MetadataBearer {
|
|
597
249
|
name: "HumanLoopQuotaExceededException";
|
|
598
250
|
$fault: "client";
|
|
599
|
-
|
|
600
|
-
* <p>The resource type.</p>
|
|
601
|
-
*/
|
|
251
|
+
|
|
602
252
|
ResourceType?: string;
|
|
603
|
-
|
|
604
|
-
* <p>The quota code.</p>
|
|
605
|
-
*/
|
|
253
|
+
|
|
606
254
|
QuotaCode?: string;
|
|
607
|
-
|
|
608
|
-
* <p>The service code.</p>
|
|
609
|
-
*/
|
|
255
|
+
|
|
610
256
|
ServiceCode?: string;
|
|
611
257
|
Message?: string;
|
|
612
258
|
Code?: string;
|
|
613
259
|
}
|
|
614
260
|
export declare namespace HumanLoopQuotaExceededException {
|
|
615
|
-
|
|
616
|
-
* @internal
|
|
617
|
-
*/
|
|
261
|
+
|
|
618
262
|
const filterSensitiveLog: (obj: HumanLoopQuotaExceededException) => any;
|
|
619
263
|
}
|
|
620
|
-
|
|
621
|
-
* <p>Amazon Textract experienced a service issue. Try your call again.</p>
|
|
622
|
-
*/
|
|
264
|
+
|
|
623
265
|
export interface InternalServerError extends __SmithyException, $MetadataBearer {
|
|
624
266
|
name: "InternalServerError";
|
|
625
267
|
$fault: "server";
|
|
@@ -627,18 +269,10 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer
|
|
|
627
269
|
Code?: string;
|
|
628
270
|
}
|
|
629
271
|
export declare namespace InternalServerError {
|
|
630
|
-
|
|
631
|
-
* @internal
|
|
632
|
-
*/
|
|
272
|
+
|
|
633
273
|
const filterSensitiveLog: (obj: InternalServerError) => any;
|
|
634
274
|
}
|
|
635
|
-
|
|
636
|
-
* <p>An input parameter violated a constraint. For example, in synchronous operations,
|
|
637
|
-
* an <code>InvalidParameterException</code> exception occurs
|
|
638
|
-
* when neither of the <code>S3Object</code> or <code>Bytes</code> values are supplied in the <code>Document</code>
|
|
639
|
-
* request parameter.
|
|
640
|
-
* Validate your parameter before calling the API operation again.</p>
|
|
641
|
-
*/
|
|
275
|
+
|
|
642
276
|
export interface InvalidParameterException extends __SmithyException, $MetadataBearer {
|
|
643
277
|
name: "InvalidParameterException";
|
|
644
278
|
$fault: "client";
|
|
@@ -646,17 +280,10 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB
|
|
|
646
280
|
Code?: string;
|
|
647
281
|
}
|
|
648
282
|
export declare namespace InvalidParameterException {
|
|
649
|
-
|
|
650
|
-
* @internal
|
|
651
|
-
*/
|
|
283
|
+
|
|
652
284
|
const filterSensitiveLog: (obj: InvalidParameterException) => any;
|
|
653
285
|
}
|
|
654
|
-
|
|
655
|
-
* <p>Amazon Textract is unable to access the S3 object that's specified in the request.
|
|
656
|
-
* for more information, <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html">Configure Access to Amazon S3</a>
|
|
657
|
-
* For troubleshooting information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html">Troubleshooting Amazon S3</a>
|
|
658
|
-
* </p>
|
|
659
|
-
*/
|
|
286
|
+
|
|
660
287
|
export interface InvalidS3ObjectException extends __SmithyException, $MetadataBearer {
|
|
661
288
|
name: "InvalidS3ObjectException";
|
|
662
289
|
$fault: "client";
|
|
@@ -664,15 +291,10 @@ export interface InvalidS3ObjectException extends __SmithyException, $MetadataBe
|
|
|
664
291
|
Code?: string;
|
|
665
292
|
}
|
|
666
293
|
export declare namespace InvalidS3ObjectException {
|
|
667
|
-
|
|
668
|
-
* @internal
|
|
669
|
-
*/
|
|
294
|
+
|
|
670
295
|
const filterSensitiveLog: (obj: InvalidS3ObjectException) => any;
|
|
671
296
|
}
|
|
672
|
-
|
|
673
|
-
* <p>The number of requests exceeded your throughput limit. If you want to increase this limit,
|
|
674
|
-
* contact Amazon Textract.</p>
|
|
675
|
-
*/
|
|
297
|
+
|
|
676
298
|
export interface ProvisionedThroughputExceededException extends __SmithyException, $MetadataBearer {
|
|
677
299
|
name: "ProvisionedThroughputExceededException";
|
|
678
300
|
$fault: "client";
|
|
@@ -680,14 +302,10 @@ export interface ProvisionedThroughputExceededException extends __SmithyExceptio
|
|
|
680
302
|
Code?: string;
|
|
681
303
|
}
|
|
682
304
|
export declare namespace ProvisionedThroughputExceededException {
|
|
683
|
-
|
|
684
|
-
* @internal
|
|
685
|
-
*/
|
|
305
|
+
|
|
686
306
|
const filterSensitiveLog: (obj: ProvisionedThroughputExceededException) => any;
|
|
687
307
|
}
|
|
688
|
-
|
|
689
|
-
* <p>Amazon Textract is temporarily unable to process the request. Try your call again.</p>
|
|
690
|
-
*/
|
|
308
|
+
|
|
691
309
|
export interface ThrottlingException extends __SmithyException, $MetadataBearer {
|
|
692
310
|
name: "ThrottlingException";
|
|
693
311
|
$fault: "server";
|
|
@@ -695,15 +313,10 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer
|
|
|
695
313
|
Code?: string;
|
|
696
314
|
}
|
|
697
315
|
export declare namespace ThrottlingException {
|
|
698
|
-
|
|
699
|
-
* @internal
|
|
700
|
-
*/
|
|
316
|
+
|
|
701
317
|
const filterSensitiveLog: (obj: ThrottlingException) => any;
|
|
702
318
|
}
|
|
703
|
-
|
|
704
|
-
* <p>The format of the input document isn't supported. Documents for synchronous operations can be in
|
|
705
|
-
* PNG or JPEG format. Documents for asynchronous operations can also be in PDF format.</p>
|
|
706
|
-
*/
|
|
319
|
+
|
|
707
320
|
export interface UnsupportedDocumentException extends __SmithyException, $MetadataBearer {
|
|
708
321
|
name: "UnsupportedDocumentException";
|
|
709
322
|
$fault: "client";
|
|
@@ -711,262 +324,138 @@ export interface UnsupportedDocumentException extends __SmithyException, $Metada
|
|
|
711
324
|
Code?: string;
|
|
712
325
|
}
|
|
713
326
|
export declare namespace UnsupportedDocumentException {
|
|
714
|
-
|
|
715
|
-
* @internal
|
|
716
|
-
*/
|
|
327
|
+
|
|
717
328
|
const filterSensitiveLog: (obj: UnsupportedDocumentException) => any;
|
|
718
329
|
}
|
|
719
330
|
export interface AnalyzeExpenseRequest {
|
|
720
|
-
|
|
721
|
-
* <p>The input document, either as bytes or as an S3 object.</p>
|
|
722
|
-
* <p>You pass image bytes to an Amazon Textract API operation by using the <code>Bytes</code>
|
|
723
|
-
* property. For example, you would use the <code>Bytes</code> property to pass a document
|
|
724
|
-
* loaded from a local file system. Image bytes passed by using the <code>Bytes</code>
|
|
725
|
-
* property must be base64 encoded. Your code might not need to encode document file bytes if
|
|
726
|
-
* you're using an AWS SDK to call Amazon Textract API operations. </p>
|
|
727
|
-
* <p>You pass images stored in an S3 bucket to an Amazon Textract API operation by using the
|
|
728
|
-
* <code>S3Object</code> property. Documents stored in an S3 bucket don't need to be base64
|
|
729
|
-
* encoded.</p>
|
|
730
|
-
* <p>The AWS Region for the S3 bucket that contains the S3 object must match the AWS
|
|
731
|
-
* Region that you use for Amazon Textract operations.</p>
|
|
732
|
-
* <p>If you use the AWS CLI to call Amazon Textract operations, passing image bytes using
|
|
733
|
-
* the Bytes property isn't supported. You must first upload the document to an Amazon S3
|
|
734
|
-
* bucket, and then call the operation using the S3Object property.</p>
|
|
735
|
-
*
|
|
736
|
-
* <p>For Amazon Textract to process an S3 object, the user must have permission
|
|
737
|
-
* to access the S3 object. </p>
|
|
738
|
-
*/
|
|
331
|
+
|
|
739
332
|
Document: Document | undefined;
|
|
740
333
|
}
|
|
741
334
|
export declare namespace AnalyzeExpenseRequest {
|
|
742
|
-
|
|
743
|
-
* @internal
|
|
744
|
-
*/
|
|
335
|
+
|
|
745
336
|
const filterSensitiveLog: (obj: AnalyzeExpenseRequest) => any;
|
|
746
337
|
}
|
|
747
|
-
|
|
748
|
-
* <p>An object used to store information about the Value or Label detected by Amazon Textract.</p>
|
|
749
|
-
*/
|
|
338
|
+
|
|
750
339
|
export interface ExpenseDetection {
|
|
751
|
-
|
|
752
|
-
* <p>The word or line of text recognized by Amazon Textract</p>
|
|
753
|
-
*/
|
|
340
|
+
|
|
754
341
|
Text?: string;
|
|
755
|
-
|
|
756
|
-
* <p>Information about where the following items are located on a document page: detected
|
|
757
|
-
* page, text, key-value pairs, tables, table cells, and selection elements.</p>
|
|
758
|
-
*/
|
|
342
|
+
|
|
759
343
|
Geometry?: Geometry;
|
|
760
|
-
|
|
761
|
-
* <p>The confidence in detection, as a percentage</p>
|
|
762
|
-
*/
|
|
344
|
+
|
|
763
345
|
Confidence?: number;
|
|
764
346
|
}
|
|
765
347
|
export declare namespace ExpenseDetection {
|
|
766
|
-
|
|
767
|
-
* @internal
|
|
768
|
-
*/
|
|
348
|
+
|
|
769
349
|
const filterSensitiveLog: (obj: ExpenseDetection) => any;
|
|
770
350
|
}
|
|
771
|
-
|
|
772
|
-
* <p>An object used to store information about the Type detected by Amazon Textract.</p>
|
|
773
|
-
*/
|
|
351
|
+
|
|
774
352
|
export interface ExpenseType {
|
|
775
|
-
|
|
776
|
-
* <p>The word or line of text detected by Amazon Textract.</p>
|
|
777
|
-
*/
|
|
353
|
+
|
|
778
354
|
Text?: string;
|
|
779
|
-
|
|
780
|
-
* <p>The confidence of accuracy, as a percentage.</p>
|
|
781
|
-
*/
|
|
355
|
+
|
|
782
356
|
Confidence?: number;
|
|
783
357
|
}
|
|
784
358
|
export declare namespace ExpenseType {
|
|
785
|
-
|
|
786
|
-
* @internal
|
|
787
|
-
*/
|
|
359
|
+
|
|
788
360
|
const filterSensitiveLog: (obj: ExpenseType) => any;
|
|
789
361
|
}
|
|
790
|
-
|
|
791
|
-
* <p>Breakdown of detected information, seperated into
|
|
792
|
-
* the catagories Type, LableDetection, and ValueDetection</p>
|
|
793
|
-
*/
|
|
362
|
+
|
|
794
363
|
export interface ExpenseField {
|
|
795
|
-
|
|
796
|
-
* <p>The implied label of a detected element. Present alongside LabelDetection for explicit elements.</p>
|
|
797
|
-
*/
|
|
364
|
+
|
|
798
365
|
Type?: ExpenseType;
|
|
799
|
-
|
|
800
|
-
* <p>The explicitly stated label of a detected element.</p>
|
|
801
|
-
*/
|
|
366
|
+
|
|
802
367
|
LabelDetection?: ExpenseDetection;
|
|
803
|
-
|
|
804
|
-
* <p>The value of a detected element. Present in explicit and implicit elements.</p>
|
|
805
|
-
*/
|
|
368
|
+
|
|
806
369
|
ValueDetection?: ExpenseDetection;
|
|
807
|
-
|
|
808
|
-
* <p>The page number the value was detected on.</p>
|
|
809
|
-
*/
|
|
370
|
+
|
|
810
371
|
PageNumber?: number;
|
|
811
372
|
}
|
|
812
373
|
export declare namespace ExpenseField {
|
|
813
|
-
|
|
814
|
-
* @internal
|
|
815
|
-
*/
|
|
374
|
+
|
|
816
375
|
const filterSensitiveLog: (obj: ExpenseField) => any;
|
|
817
376
|
}
|
|
818
|
-
|
|
819
|
-
* <p>A structure that holds information about the different lines found in a document's tables.</p>
|
|
820
|
-
*/
|
|
377
|
+
|
|
821
378
|
export interface LineItemFields {
|
|
822
|
-
|
|
823
|
-
* <p>ExpenseFields used to show information from detected lines on a table.</p>
|
|
824
|
-
*/
|
|
379
|
+
|
|
825
380
|
LineItemExpenseFields?: ExpenseField[];
|
|
826
381
|
}
|
|
827
382
|
export declare namespace LineItemFields {
|
|
828
|
-
|
|
829
|
-
* @internal
|
|
830
|
-
*/
|
|
383
|
+
|
|
831
384
|
const filterSensitiveLog: (obj: LineItemFields) => any;
|
|
832
385
|
}
|
|
833
|
-
|
|
834
|
-
* <p>A grouping of tables which contain LineItems, with each table identified by the table's <code>LineItemGroupIndex</code>.</p>
|
|
835
|
-
*/
|
|
386
|
+
|
|
836
387
|
export interface LineItemGroup {
|
|
837
|
-
|
|
838
|
-
* <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>
|
|
839
|
-
*/
|
|
388
|
+
|
|
840
389
|
LineItemGroupIndex?: number;
|
|
841
|
-
|
|
842
|
-
* <p>The breakdown of information on a particular line of a table. </p>
|
|
843
|
-
*/
|
|
390
|
+
|
|
844
391
|
LineItems?: LineItemFields[];
|
|
845
392
|
}
|
|
846
393
|
export declare namespace LineItemGroup {
|
|
847
|
-
|
|
848
|
-
* @internal
|
|
849
|
-
*/
|
|
394
|
+
|
|
850
395
|
const filterSensitiveLog: (obj: LineItemGroup) => any;
|
|
851
396
|
}
|
|
852
|
-
|
|
853
|
-
* <p>The structure holding all the information returned by AnalyzeExpense</p>
|
|
854
|
-
*/
|
|
397
|
+
|
|
855
398
|
export interface ExpenseDocument {
|
|
856
|
-
|
|
857
|
-
* <p>Denotes which invoice or receipt in the document the information is coming from.
|
|
858
|
-
* First document will be 1, the second 2, and so on.</p>
|
|
859
|
-
*/
|
|
399
|
+
|
|
860
400
|
ExpenseIndex?: number;
|
|
861
|
-
|
|
862
|
-
* <p>Any information found outside of a table by Amazon Textract.</p>
|
|
863
|
-
*/
|
|
401
|
+
|
|
864
402
|
SummaryFields?: ExpenseField[];
|
|
865
|
-
|
|
866
|
-
* <p>Information detected on each table of a document, seperated into <code>LineItems</code>.</p>
|
|
867
|
-
*/
|
|
403
|
+
|
|
868
404
|
LineItemGroups?: LineItemGroup[];
|
|
869
405
|
}
|
|
870
406
|
export declare namespace ExpenseDocument {
|
|
871
|
-
|
|
872
|
-
* @internal
|
|
873
|
-
*/
|
|
407
|
+
|
|
874
408
|
const filterSensitiveLog: (obj: ExpenseDocument) => any;
|
|
875
409
|
}
|
|
876
410
|
export interface AnalyzeExpenseResponse {
|
|
877
|
-
|
|
878
|
-
* <p>Information about the input document.</p>
|
|
879
|
-
*/
|
|
411
|
+
|
|
880
412
|
DocumentMetadata?: DocumentMetadata;
|
|
881
|
-
|
|
882
|
-
* <p>The expenses detected by Amazon Textract.</p>
|
|
883
|
-
*/
|
|
413
|
+
|
|
884
414
|
ExpenseDocuments?: ExpenseDocument[];
|
|
885
415
|
}
|
|
886
416
|
export declare namespace AnalyzeExpenseResponse {
|
|
887
|
-
|
|
888
|
-
* @internal
|
|
889
|
-
*/
|
|
417
|
+
|
|
890
418
|
const filterSensitiveLog: (obj: AnalyzeExpenseResponse) => any;
|
|
891
419
|
}
|
|
892
420
|
export interface DetectDocumentTextRequest {
|
|
893
|
-
|
|
894
|
-
* <p>The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI
|
|
895
|
-
* to call Amazon Textract operations, you can't pass image bytes. The document must be an image
|
|
896
|
-
* in JPEG or PNG format.</p>
|
|
897
|
-
* <p>If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode
|
|
898
|
-
* image bytes that are passed using the <code>Bytes</code> field. </p>
|
|
899
|
-
*/
|
|
421
|
+
|
|
900
422
|
Document: Document | undefined;
|
|
901
423
|
}
|
|
902
424
|
export declare namespace DetectDocumentTextRequest {
|
|
903
|
-
|
|
904
|
-
* @internal
|
|
905
|
-
*/
|
|
425
|
+
|
|
906
426
|
const filterSensitiveLog: (obj: DetectDocumentTextRequest) => any;
|
|
907
427
|
}
|
|
908
428
|
export interface DetectDocumentTextResponse {
|
|
909
|
-
|
|
910
|
-
* <p>Metadata about the document. It contains the number of pages that are detected in the
|
|
911
|
-
* document.</p>
|
|
912
|
-
*/
|
|
429
|
+
|
|
913
430
|
DocumentMetadata?: DocumentMetadata;
|
|
914
|
-
|
|
915
|
-
* <p>An array of <code>Block</code> objects that contain the text that's detected in the
|
|
916
|
-
* document.</p>
|
|
917
|
-
*/
|
|
431
|
+
|
|
918
432
|
Blocks?: Block[];
|
|
919
|
-
|
|
920
|
-
* <p></p>
|
|
921
|
-
*/
|
|
433
|
+
|
|
922
434
|
DetectDocumentTextModelVersion?: string;
|
|
923
435
|
}
|
|
924
436
|
export declare namespace DetectDocumentTextResponse {
|
|
925
|
-
|
|
926
|
-
* @internal
|
|
927
|
-
*/
|
|
437
|
+
|
|
928
438
|
const filterSensitiveLog: (obj: DetectDocumentTextResponse) => any;
|
|
929
439
|
}
|
|
930
|
-
|
|
931
|
-
* <p>The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous
|
|
932
|
-
* operations such as <a>StartDocumentTextDetection</a>.</p>
|
|
933
|
-
* <p>The input document can be an image file in JPEG or PNG format. It can also be a file in
|
|
934
|
-
* PDF format.</p>
|
|
935
|
-
*/
|
|
440
|
+
|
|
936
441
|
export interface DocumentLocation {
|
|
937
|
-
|
|
938
|
-
* <p>The Amazon S3 bucket that contains the input document.</p>
|
|
939
|
-
*/
|
|
442
|
+
|
|
940
443
|
S3Object?: S3Object;
|
|
941
444
|
}
|
|
942
445
|
export declare namespace DocumentLocation {
|
|
943
|
-
|
|
944
|
-
* @internal
|
|
945
|
-
*/
|
|
446
|
+
|
|
946
447
|
const filterSensitiveLog: (obj: DocumentLocation) => any;
|
|
947
448
|
}
|
|
948
449
|
export interface GetDocumentAnalysisRequest {
|
|
949
|
-
|
|
950
|
-
* <p>A unique identifier for the text-detection job. The <code>JobId</code> is returned from
|
|
951
|
-
* <code>StartDocumentAnalysis</code>. A <code>JobId</code> value is only valid for 7 days.</p>
|
|
952
|
-
*/
|
|
450
|
+
|
|
953
451
|
JobId: string | undefined;
|
|
954
|
-
|
|
955
|
-
* <p>The maximum number of results to return per paginated call. The largest value that you
|
|
956
|
-
* can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results
|
|
957
|
-
* is returned. The default value is 1,000.</p>
|
|
958
|
-
*/
|
|
452
|
+
|
|
959
453
|
MaxResults?: number;
|
|
960
|
-
|
|
961
|
-
* <p>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination
|
|
962
|
-
* token in the response. You can use this pagination token to retrieve the next set of blocks.</p>
|
|
963
|
-
*/
|
|
454
|
+
|
|
964
455
|
NextToken?: string;
|
|
965
456
|
}
|
|
966
457
|
export declare namespace GetDocumentAnalysisRequest {
|
|
967
|
-
|
|
968
|
-
* @internal
|
|
969
|
-
*/
|
|
458
|
+
|
|
970
459
|
const filterSensitiveLog: (obj: GetDocumentAnalysisRequest) => any;
|
|
971
460
|
}
|
|
972
461
|
export declare enum JobStatus {
|
|
@@ -975,67 +464,38 @@ export declare enum JobStatus {
|
|
|
975
464
|
PARTIAL_SUCCESS = "PARTIAL_SUCCESS",
|
|
976
465
|
SUCCEEDED = "SUCCEEDED"
|
|
977
466
|
}
|
|
978
|
-
|
|
979
|
-
* <p>A warning about an issue that occurred during asynchronous text analysis (<a>StartDocumentAnalysis</a>) or asynchronous document text detection (<a>StartDocumentTextDetection</a>). </p>
|
|
980
|
-
*/
|
|
467
|
+
|
|
981
468
|
export interface Warning {
|
|
982
|
-
|
|
983
|
-
* <p>The error code for the warning.</p>
|
|
984
|
-
*/
|
|
469
|
+
|
|
985
470
|
ErrorCode?: string;
|
|
986
|
-
|
|
987
|
-
* <p>A list of the pages that the warning applies to.</p>
|
|
988
|
-
*/
|
|
471
|
+
|
|
989
472
|
Pages?: number[];
|
|
990
473
|
}
|
|
991
474
|
export declare namespace Warning {
|
|
992
|
-
|
|
993
|
-
* @internal
|
|
994
|
-
*/
|
|
475
|
+
|
|
995
476
|
const filterSensitiveLog: (obj: Warning) => any;
|
|
996
477
|
}
|
|
997
478
|
export interface GetDocumentAnalysisResponse {
|
|
998
|
-
|
|
999
|
-
* <p>Information about a document that Amazon Textract processed. <code>DocumentMetadata</code> is
|
|
1000
|
-
* returned in every page of paginated responses from an Amazon Textract video operation.</p>
|
|
1001
|
-
*/
|
|
479
|
+
|
|
1002
480
|
DocumentMetadata?: DocumentMetadata;
|
|
1003
|
-
|
|
1004
|
-
* <p>The current status of the text detection job.</p>
|
|
1005
|
-
*/
|
|
481
|
+
|
|
1006
482
|
JobStatus?: JobStatus | string;
|
|
1007
|
-
|
|
1008
|
-
* <p>If the response is truncated, Amazon Textract returns this token. You can use this token in
|
|
1009
|
-
* the subsequent request to retrieve the next set of text detection results.</p>
|
|
1010
|
-
*/
|
|
483
|
+
|
|
1011
484
|
NextToken?: string;
|
|
1012
|
-
|
|
1013
|
-
* <p>The results of the text-analysis operation.</p>
|
|
1014
|
-
*/
|
|
485
|
+
|
|
1015
486
|
Blocks?: Block[];
|
|
1016
|
-
|
|
1017
|
-
* <p>A list of warnings that occurred during the document-analysis operation.</p>
|
|
1018
|
-
*/
|
|
487
|
+
|
|
1019
488
|
Warnings?: Warning[];
|
|
1020
|
-
|
|
1021
|
-
* <p>Returns if the detection job could not be completed. Contains explanation for what error occured.</p>
|
|
1022
|
-
*/
|
|
489
|
+
|
|
1023
490
|
StatusMessage?: string;
|
|
1024
|
-
|
|
1025
|
-
* <p></p>
|
|
1026
|
-
*/
|
|
491
|
+
|
|
1027
492
|
AnalyzeDocumentModelVersion?: string;
|
|
1028
493
|
}
|
|
1029
494
|
export declare namespace GetDocumentAnalysisResponse {
|
|
1030
|
-
|
|
1031
|
-
* @internal
|
|
1032
|
-
*/
|
|
495
|
+
|
|
1033
496
|
const filterSensitiveLog: (obj: GetDocumentAnalysisResponse) => any;
|
|
1034
497
|
}
|
|
1035
|
-
|
|
1036
|
-
* <p>An invalid job identifier was passed to <a>GetDocumentAnalysis</a> or to
|
|
1037
|
-
* <a>GetDocumentAnalysis</a>.</p>
|
|
1038
|
-
*/
|
|
498
|
+
|
|
1039
499
|
export interface InvalidJobIdException extends __SmithyException, $MetadataBearer {
|
|
1040
500
|
name: "InvalidJobIdException";
|
|
1041
501
|
$fault: "client";
|
|
@@ -1043,15 +503,10 @@ export interface InvalidJobIdException extends __SmithyException, $MetadataBeare
|
|
|
1043
503
|
Code?: string;
|
|
1044
504
|
}
|
|
1045
505
|
export declare namespace InvalidJobIdException {
|
|
1046
|
-
|
|
1047
|
-
* @internal
|
|
1048
|
-
*/
|
|
506
|
+
|
|
1049
507
|
const filterSensitiveLog: (obj: InvalidJobIdException) => any;
|
|
1050
508
|
}
|
|
1051
|
-
|
|
1052
|
-
* <p> Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key
|
|
1053
|
-
* was entered incorrectly. </p>
|
|
1054
|
-
*/
|
|
509
|
+
|
|
1055
510
|
export interface InvalidKMSKeyException extends __SmithyException, $MetadataBearer {
|
|
1056
511
|
name: "InvalidKMSKeyException";
|
|
1057
512
|
$fault: "client";
|
|
@@ -1059,79 +514,42 @@ export interface InvalidKMSKeyException extends __SmithyException, $MetadataBear
|
|
|
1059
514
|
Code?: string;
|
|
1060
515
|
}
|
|
1061
516
|
export declare namespace InvalidKMSKeyException {
|
|
1062
|
-
|
|
1063
|
-
* @internal
|
|
1064
|
-
*/
|
|
517
|
+
|
|
1065
518
|
const filterSensitiveLog: (obj: InvalidKMSKeyException) => any;
|
|
1066
519
|
}
|
|
1067
520
|
export interface GetDocumentTextDetectionRequest {
|
|
1068
|
-
|
|
1069
|
-
* <p>A unique identifier for the text detection job. The <code>JobId</code> is returned from
|
|
1070
|
-
* <code>StartDocumentTextDetection</code>. A <code>JobId</code> value is only valid for 7 days.</p>
|
|
1071
|
-
*/
|
|
521
|
+
|
|
1072
522
|
JobId: string | undefined;
|
|
1073
|
-
|
|
1074
|
-
* <p>The maximum number of results to return per paginated call. The largest value you can
|
|
1075
|
-
* specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is
|
|
1076
|
-
* returned. The default value is 1,000.</p>
|
|
1077
|
-
*/
|
|
523
|
+
|
|
1078
524
|
MaxResults?: number;
|
|
1079
|
-
|
|
1080
|
-
* <p>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination
|
|
1081
|
-
* token in the response. You can use this pagination token to retrieve the next set of blocks.</p>
|
|
1082
|
-
*/
|
|
525
|
+
|
|
1083
526
|
NextToken?: string;
|
|
1084
527
|
}
|
|
1085
528
|
export declare namespace GetDocumentTextDetectionRequest {
|
|
1086
|
-
|
|
1087
|
-
* @internal
|
|
1088
|
-
*/
|
|
529
|
+
|
|
1089
530
|
const filterSensitiveLog: (obj: GetDocumentTextDetectionRequest) => any;
|
|
1090
531
|
}
|
|
1091
532
|
export interface GetDocumentTextDetectionResponse {
|
|
1092
|
-
|
|
1093
|
-
* <p>Information about a document that Amazon Textract processed. <code>DocumentMetadata</code> is
|
|
1094
|
-
* returned in every page of paginated responses from an Amazon Textract video operation.</p>
|
|
1095
|
-
*/
|
|
533
|
+
|
|
1096
534
|
DocumentMetadata?: DocumentMetadata;
|
|
1097
|
-
|
|
1098
|
-
* <p>The current status of the text detection job.</p>
|
|
1099
|
-
*/
|
|
535
|
+
|
|
1100
536
|
JobStatus?: JobStatus | string;
|
|
1101
|
-
|
|
1102
|
-
* <p>If the response is truncated, Amazon Textract returns this token. You can use this token in
|
|
1103
|
-
* the subsequent request to retrieve the next set of text-detection results.</p>
|
|
1104
|
-
*/
|
|
537
|
+
|
|
1105
538
|
NextToken?: string;
|
|
1106
|
-
|
|
1107
|
-
* <p>The results of the text-detection operation.</p>
|
|
1108
|
-
*/
|
|
539
|
+
|
|
1109
540
|
Blocks?: Block[];
|
|
1110
|
-
|
|
1111
|
-
* <p>A list of warnings that occurred during the text-detection operation for the
|
|
1112
|
-
* document.</p>
|
|
1113
|
-
*/
|
|
541
|
+
|
|
1114
542
|
Warnings?: Warning[];
|
|
1115
|
-
|
|
1116
|
-
* <p>Returns if the detection job could not be completed. Contains explanation for what error occured. </p>
|
|
1117
|
-
*/
|
|
543
|
+
|
|
1118
544
|
StatusMessage?: string;
|
|
1119
|
-
|
|
1120
|
-
* <p></p>
|
|
1121
|
-
*/
|
|
545
|
+
|
|
1122
546
|
DetectDocumentTextModelVersion?: string;
|
|
1123
547
|
}
|
|
1124
548
|
export declare namespace GetDocumentTextDetectionResponse {
|
|
1125
|
-
|
|
1126
|
-
* @internal
|
|
1127
|
-
*/
|
|
549
|
+
|
|
1128
550
|
const filterSensitiveLog: (obj: GetDocumentTextDetectionResponse) => any;
|
|
1129
551
|
}
|
|
1130
|
-
|
|
1131
|
-
* <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at
|
|
1132
|
-
* least one of the other input parameters is different from the previous call to the
|
|
1133
|
-
* operation. </p>
|
|
1134
|
-
*/
|
|
552
|
+
|
|
1135
553
|
export interface IdempotentParameterMismatchException extends __SmithyException, $MetadataBearer {
|
|
1136
554
|
name: "IdempotentParameterMismatchException";
|
|
1137
555
|
$fault: "client";
|
|
@@ -1139,18 +557,10 @@ export interface IdempotentParameterMismatchException extends __SmithyException,
|
|
|
1139
557
|
Code?: string;
|
|
1140
558
|
}
|
|
1141
559
|
export declare namespace IdempotentParameterMismatchException {
|
|
1142
|
-
|
|
1143
|
-
* @internal
|
|
1144
|
-
*/
|
|
560
|
+
|
|
1145
561
|
const filterSensitiveLog: (obj: IdempotentParameterMismatchException) => any;
|
|
1146
562
|
}
|
|
1147
|
-
|
|
1148
|
-
* <p>An Amazon Textract service limit was exceeded. For example, if you start too many
|
|
1149
|
-
* asynchronous jobs concurrently, calls to start operations
|
|
1150
|
-
* (<code>StartDocumentTextDetection</code>, for example) raise a LimitExceededException
|
|
1151
|
-
* exception (HTTP status code: 400) until the number of concurrently running jobs is below
|
|
1152
|
-
* the Amazon Textract service limit. </p>
|
|
1153
|
-
*/
|
|
563
|
+
|
|
1154
564
|
export interface LimitExceededException extends __SmithyException, $MetadataBearer {
|
|
1155
565
|
name: "LimitExceededException";
|
|
1156
566
|
$fault: "client";
|
|
@@ -1158,190 +568,82 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear
|
|
|
1158
568
|
Code?: string;
|
|
1159
569
|
}
|
|
1160
570
|
export declare namespace LimitExceededException {
|
|
1161
|
-
|
|
1162
|
-
* @internal
|
|
1163
|
-
*/
|
|
571
|
+
|
|
1164
572
|
const filterSensitiveLog: (obj: LimitExceededException) => any;
|
|
1165
573
|
}
|
|
1166
|
-
|
|
1167
|
-
* <p>The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of
|
|
1168
|
-
* an asynchronous document operation, such as <a>StartDocumentTextDetection</a>. </p>
|
|
1169
|
-
*/
|
|
574
|
+
|
|
1170
575
|
export interface NotificationChannel {
|
|
1171
|
-
|
|
1172
|
-
* <p>The Amazon SNS topic that Amazon Textract posts the completion status to.</p>
|
|
1173
|
-
*/
|
|
576
|
+
|
|
1174
577
|
SNSTopicArn: string | undefined;
|
|
1175
|
-
|
|
1176
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic. </p>
|
|
1177
|
-
*/
|
|
578
|
+
|
|
1178
579
|
RoleArn: string | undefined;
|
|
1179
580
|
}
|
|
1180
581
|
export declare namespace NotificationChannel {
|
|
1181
|
-
|
|
1182
|
-
* @internal
|
|
1183
|
-
*/
|
|
582
|
+
|
|
1184
583
|
const filterSensitiveLog: (obj: NotificationChannel) => any;
|
|
1185
584
|
}
|
|
1186
|
-
|
|
1187
|
-
* <p>Sets whether or not your output will go to a user created bucket. Used to set the name
|
|
1188
|
-
* of the bucket, and the prefix on the output file.</p>
|
|
1189
|
-
* <p>
|
|
1190
|
-
* <code>OutputConfig</code> is an optional parameter which lets you adjust where your output will be placed.
|
|
1191
|
-
* By default, Amazon Textract will store the results internally and can only be accessed by the Get
|
|
1192
|
-
* API operations. With OutputConfig enabled, you can set the name of the bucket the output will be
|
|
1193
|
-
* sent to and the file prefix of the results where you can download your results. Additionally, you
|
|
1194
|
-
* can set the <code>KMSKeyID</code> parameter to a customer master key (CMK) to encrypt your output. Without this
|
|
1195
|
-
* parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.</p>
|
|
1196
|
-
* <p>Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account
|
|
1197
|
-
* is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after
|
|
1198
|
-
* 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>
|
|
1199
|
-
* </p>
|
|
1200
|
-
* <p>For more information on data privacy,
|
|
1201
|
-
* see the <a href="https://aws.amazon.com/compliance/data-privacy-faq/">Data Privacy
|
|
1202
|
-
* FAQ</a>.</p>
|
|
1203
|
-
*/
|
|
585
|
+
|
|
1204
586
|
export interface OutputConfig {
|
|
1205
|
-
|
|
1206
|
-
* <p>The name of the bucket your output will go to.</p>
|
|
1207
|
-
*/
|
|
587
|
+
|
|
1208
588
|
S3Bucket: string | undefined;
|
|
1209
|
-
|
|
1210
|
-
* <p>The prefix of the object key that the output will be saved to. When not enabled, the
|
|
1211
|
-
* prefix will be “textract_output".</p>
|
|
1212
|
-
*/
|
|
589
|
+
|
|
1213
590
|
S3Prefix?: string;
|
|
1214
591
|
}
|
|
1215
592
|
export declare namespace OutputConfig {
|
|
1216
|
-
|
|
1217
|
-
* @internal
|
|
1218
|
-
*/
|
|
593
|
+
|
|
1219
594
|
const filterSensitiveLog: (obj: OutputConfig) => any;
|
|
1220
595
|
}
|
|
1221
596
|
export interface StartDocumentAnalysisRequest {
|
|
1222
|
-
|
|
1223
|
-
* <p>The location of the document to be processed.</p>
|
|
1224
|
-
*/
|
|
597
|
+
|
|
1225
598
|
DocumentLocation: DocumentLocation | undefined;
|
|
1226
|
-
|
|
1227
|
-
* <p>A list of the types of analysis to perform. Add TABLES to the list to return information
|
|
1228
|
-
* about the tables that are detected in the input document. Add FORMS to return detected
|
|
1229
|
-
* form data. To perform both types of analysis, add TABLES
|
|
1230
|
-
* and FORMS to <code>FeatureTypes</code>. All lines and words detected in the document are
|
|
1231
|
-
* included in the response (including text that isn't related to the value of
|
|
1232
|
-
* <code>FeatureTypes</code>). </p>
|
|
1233
|
-
*/
|
|
599
|
+
|
|
1234
600
|
FeatureTypes: (FeatureType | string)[] | undefined;
|
|
1235
|
-
|
|
1236
|
-
* <p>The idempotent token that you use to identify the start request. If you use the same
|
|
1237
|
-
* token with multiple <code>StartDocumentAnalysis</code> requests, the same
|
|
1238
|
-
* <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same
|
|
1239
|
-
* job from being accidentally started more than once. For more information, see
|
|
1240
|
-
* <a href="https://docs.aws.amazon.com/textract/latest/dg/api-async.html">Calling Amazon Textract Asynchronous Operations</a>.</p>
|
|
1241
|
-
*/
|
|
601
|
+
|
|
1242
602
|
ClientRequestToken?: string;
|
|
1243
|
-
|
|
1244
|
-
* <p>An identifier that you specify that's included in the completion notification published
|
|
1245
|
-
* to the Amazon SNS topic. For example, you can use <code>JobTag</code> to identify the type of
|
|
1246
|
-
* document that the completion notification corresponds to (such as a tax form or a
|
|
1247
|
-
* receipt).</p>
|
|
1248
|
-
*/
|
|
603
|
+
|
|
1249
604
|
JobTag?: string;
|
|
1250
|
-
|
|
1251
|
-
* <p>The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the
|
|
1252
|
-
* operation to. </p>
|
|
1253
|
-
*/
|
|
605
|
+
|
|
1254
606
|
NotificationChannel?: NotificationChannel;
|
|
1255
|
-
|
|
1256
|
-
* <p>Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save
|
|
1257
|
-
* the results internally to be accessed by the GetDocumentAnalysis operation.</p>
|
|
1258
|
-
*/
|
|
607
|
+
|
|
1259
608
|
OutputConfig?: OutputConfig;
|
|
1260
|
-
|
|
1261
|
-
* <p>The KMS key used to encrypt the inference results. This can be
|
|
1262
|
-
* in either Key ID or Key Alias format. When a KMS key is provided, the
|
|
1263
|
-
* KMS key will be used for server-side encryption of the objects in the
|
|
1264
|
-
* customer bucket. When this parameter is not enabled, the result will
|
|
1265
|
-
* be encrypted server side,using SSE-S3.</p>
|
|
1266
|
-
*/
|
|
609
|
+
|
|
1267
610
|
KMSKeyId?: string;
|
|
1268
611
|
}
|
|
1269
612
|
export declare namespace StartDocumentAnalysisRequest {
|
|
1270
|
-
|
|
1271
|
-
* @internal
|
|
1272
|
-
*/
|
|
613
|
+
|
|
1273
614
|
const filterSensitiveLog: (obj: StartDocumentAnalysisRequest) => any;
|
|
1274
615
|
}
|
|
1275
616
|
export interface StartDocumentAnalysisResponse {
|
|
1276
|
-
|
|
1277
|
-
* <p>The identifier for the document text detection job. Use <code>JobId</code> to identify
|
|
1278
|
-
* the job in a subsequent call to <code>GetDocumentAnalysis</code>. A <code>JobId</code> value
|
|
1279
|
-
* is only valid for 7 days.</p>
|
|
1280
|
-
*/
|
|
617
|
+
|
|
1281
618
|
JobId?: string;
|
|
1282
619
|
}
|
|
1283
620
|
export declare namespace StartDocumentAnalysisResponse {
|
|
1284
|
-
|
|
1285
|
-
* @internal
|
|
1286
|
-
*/
|
|
621
|
+
|
|
1287
622
|
const filterSensitiveLog: (obj: StartDocumentAnalysisResponse) => any;
|
|
1288
623
|
}
|
|
1289
624
|
export interface StartDocumentTextDetectionRequest {
|
|
1290
|
-
|
|
1291
|
-
* <p>The location of the document to be processed.</p>
|
|
1292
|
-
*/
|
|
625
|
+
|
|
1293
626
|
DocumentLocation: DocumentLocation | undefined;
|
|
1294
|
-
|
|
1295
|
-
* <p>The idempotent token that's used to identify the start request. If you use the same
|
|
1296
|
-
* token with multiple <code>StartDocumentTextDetection</code> requests, the same
|
|
1297
|
-
* <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same
|
|
1298
|
-
* job from being accidentally started more than once. For more information, see
|
|
1299
|
-
* <a href="https://docs.aws.amazon.com/textract/latest/dg/api-async.html">Calling Amazon Textract Asynchronous Operations</a>.</p>
|
|
1300
|
-
*/
|
|
627
|
+
|
|
1301
628
|
ClientRequestToken?: string;
|
|
1302
|
-
|
|
1303
|
-
* <p>An identifier that you specify that's included in the completion notification published
|
|
1304
|
-
* to the Amazon SNS topic. For example, you can use <code>JobTag</code> to identify the type of
|
|
1305
|
-
* document that the completion notification corresponds to (such as a tax form or a
|
|
1306
|
-
* receipt).</p>
|
|
1307
|
-
*/
|
|
629
|
+
|
|
1308
630
|
JobTag?: string;
|
|
1309
|
-
|
|
1310
|
-
* <p>The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the
|
|
1311
|
-
* operation to. </p>
|
|
1312
|
-
*/
|
|
631
|
+
|
|
1313
632
|
NotificationChannel?: NotificationChannel;
|
|
1314
|
-
|
|
1315
|
-
* <p>Sets if the output will go to a customer defined bucket. By default Amazon Textract will
|
|
1316
|
-
* save the results internally to be accessed with the GetDocumentTextDetection operation.</p>
|
|
1317
|
-
*/
|
|
633
|
+
|
|
1318
634
|
OutputConfig?: OutputConfig;
|
|
1319
|
-
|
|
1320
|
-
* <p>The KMS key used to encrypt the inference results. This can be
|
|
1321
|
-
* in either Key ID or Key Alias format. When a KMS key is provided, the
|
|
1322
|
-
* KMS key will be used for server-side encryption of the objects in the
|
|
1323
|
-
* customer bucket. When this parameter is not enabled, the result will
|
|
1324
|
-
* be encrypted server side,using SSE-S3.</p>
|
|
1325
|
-
*/
|
|
635
|
+
|
|
1326
636
|
KMSKeyId?: string;
|
|
1327
637
|
}
|
|
1328
638
|
export declare namespace StartDocumentTextDetectionRequest {
|
|
1329
|
-
|
|
1330
|
-
* @internal
|
|
1331
|
-
*/
|
|
639
|
+
|
|
1332
640
|
const filterSensitiveLog: (obj: StartDocumentTextDetectionRequest) => any;
|
|
1333
641
|
}
|
|
1334
642
|
export interface StartDocumentTextDetectionResponse {
|
|
1335
|
-
|
|
1336
|
-
* <p>The identifier of the text detection job for the document. Use <code>JobId</code> to
|
|
1337
|
-
* identify the job in a subsequent call to <code>GetDocumentTextDetection</code>.
|
|
1338
|
-
* A <code>JobId</code> value is only valid for 7 days.</p>
|
|
1339
|
-
*/
|
|
643
|
+
|
|
1340
644
|
JobId?: string;
|
|
1341
645
|
}
|
|
1342
646
|
export declare namespace StartDocumentTextDetectionResponse {
|
|
1343
|
-
|
|
1344
|
-
* @internal
|
|
1345
|
-
*/
|
|
647
|
+
|
|
1346
648
|
const filterSensitiveLog: (obj: StartDocumentTextDetectionResponse) => any;
|
|
1347
649
|
}
|