@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
|
@@ -7,205 +7,33 @@ import { GetDocumentTextDetectionCommandInput, GetDocumentTextDetectionCommandOu
|
|
|
7
7
|
import { StartDocumentAnalysisCommandInput, StartDocumentAnalysisCommandOutput } from "./commands/StartDocumentAnalysisCommand";
|
|
8
8
|
import { StartDocumentTextDetectionCommandInput, StartDocumentTextDetectionCommandOutput } from "./commands/StartDocumentTextDetectionCommand";
|
|
9
9
|
import { TextractClient } from "./TextractClient";
|
|
10
|
-
|
|
11
|
-
* <p>Amazon Textract detects and analyzes text in documents and converts it
|
|
12
|
-
* into machine-readable text. This is the API reference documentation for
|
|
13
|
-
* Amazon Textract.</p>
|
|
14
|
-
*/
|
|
10
|
+
|
|
15
11
|
export declare class Textract extends TextractClient {
|
|
16
|
-
|
|
17
|
-
* <p>Analyzes an input document for relationships between detected items. </p>
|
|
18
|
-
* <p>The types of information returned are as follows: </p>
|
|
19
|
-
* <ul>
|
|
20
|
-
* <li>
|
|
21
|
-
* <p>Form data (key-value pairs). The related information is returned in two <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY
|
|
22
|
-
* <code>Block</code> object and a VALUE <code>Block</code> object. For example,
|
|
23
|
-
* <i>Name: Ana Silva Carolina</i> contains a key and value.
|
|
24
|
-
* <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is
|
|
25
|
-
* the value.</p>
|
|
26
|
-
* </li>
|
|
27
|
-
* <li>
|
|
28
|
-
* <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL
|
|
29
|
-
* <code>Block</code> object is returned for each cell in a table.</p>
|
|
30
|
-
* </li>
|
|
31
|
-
* <li>
|
|
32
|
-
* <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> objects.
|
|
33
|
-
* All lines and words that are detected in the document are returned (including text that doesn't have a
|
|
34
|
-
* relationship with the value of <code>FeatureTypes</code>). </p>
|
|
35
|
-
* </li>
|
|
36
|
-
* </ul>
|
|
37
|
-
*
|
|
38
|
-
* <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.
|
|
39
|
-
* A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,
|
|
40
|
-
* including the selection status.</p>
|
|
41
|
-
* <p>You can choose which type of analysis to perform by specifying the <code>FeatureTypes</code> list.
|
|
42
|
-
* </p>
|
|
43
|
-
* <p>The output is returned in a list of <code>Block</code> objects.</p>
|
|
44
|
-
* <p>
|
|
45
|
-
* <code>AnalyzeDocument</code> is a synchronous operation. To analyze documents
|
|
46
|
-
* asynchronously, use <a>StartDocumentAnalysis</a>.</p>
|
|
47
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text Analysis</a>.</p>
|
|
48
|
-
*/
|
|
12
|
+
|
|
49
13
|
analyzeDocument(args: AnalyzeDocumentCommandInput, options?: __HttpHandlerOptions): Promise<AnalyzeDocumentCommandOutput>;
|
|
50
14
|
analyzeDocument(args: AnalyzeDocumentCommandInput, cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void): void;
|
|
51
15
|
analyzeDocument(args: AnalyzeDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void): void;
|
|
52
|
-
|
|
53
|
-
* <p>Analyzes an input document for financially related relationships between text.</p>
|
|
54
|
-
* <p>Information is returned as <code>ExpenseDocuments</code> and seperated as follows.</p>
|
|
55
|
-
* <ul>
|
|
56
|
-
* <li>
|
|
57
|
-
* <p>
|
|
58
|
-
* <code>LineItemGroups</code>- A data set containing <code>LineItems</code> which
|
|
59
|
-
* store information about the lines of text, such as an item purchased and its price on a receipt.</p>
|
|
60
|
-
* </li>
|
|
61
|
-
* <li>
|
|
62
|
-
* <p>
|
|
63
|
-
* <code>SummaryFields</code>- Contains all other information a receipt, such as header information
|
|
64
|
-
* or the vendors name.</p>
|
|
65
|
-
* </li>
|
|
66
|
-
* </ul>
|
|
67
|
-
*/
|
|
16
|
+
|
|
68
17
|
analyzeExpense(args: AnalyzeExpenseCommandInput, options?: __HttpHandlerOptions): Promise<AnalyzeExpenseCommandOutput>;
|
|
69
18
|
analyzeExpense(args: AnalyzeExpenseCommandInput, cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void): void;
|
|
70
19
|
analyzeExpense(args: AnalyzeExpenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void): void;
|
|
71
|
-
|
|
72
|
-
* <p>Detects text in the input document. Amazon Textract can detect lines of text and the
|
|
73
|
-
* words that make up a line of text. The input document must be an image in JPEG or PNG
|
|
74
|
-
* format. <code>DetectDocumentText</code> returns the detected text in an array of <a>Block</a> objects. </p>
|
|
75
|
-
* <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object
|
|
76
|
-
* is the parent of LINE <code>Block</code> objects that represent the lines of detected text on a page. A LINE <code>Block</code> object is
|
|
77
|
-
* a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>
|
|
78
|
-
*
|
|
79
|
-
* <p>
|
|
80
|
-
* <code>DetectDocumentText</code> is a synchronous operation. To analyze documents
|
|
81
|
-
* asynchronously, use <a>StartDocumentTextDetection</a>.</p>
|
|
82
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html">Document Text Detection</a>.</p>
|
|
83
|
-
*/
|
|
20
|
+
|
|
84
21
|
detectDocumentText(args: DetectDocumentTextCommandInput, options?: __HttpHandlerOptions): Promise<DetectDocumentTextCommandOutput>;
|
|
85
22
|
detectDocumentText(args: DetectDocumentTextCommandInput, cb: (err: any, data?: DetectDocumentTextCommandOutput) => void): void;
|
|
86
23
|
detectDocumentText(args: DetectDocumentTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectDocumentTextCommandOutput) => void): void;
|
|
87
|
-
|
|
88
|
-
* <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.</p>
|
|
89
|
-
* <p>You start asynchronous text analysis by calling <a>StartDocumentAnalysis</a>, which returns a job identifier
|
|
90
|
-
* (<code>JobId</code>). When the text analysis operation finishes, Amazon Textract publishes a
|
|
91
|
-
* completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to
|
|
92
|
-
* <code>StartDocumentAnalysis</code>. To get the results of the text-detection operation,
|
|
93
|
-
* first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
|
|
94
|
-
* If so, call <code>GetDocumentAnalysis</code>, and pass the job identifier
|
|
95
|
-
* (<code>JobId</code>) from the initial call to <code>StartDocumentAnalysis</code>.</p>
|
|
96
|
-
* <p>
|
|
97
|
-
* <code>GetDocumentAnalysis</code> returns an array of <a>Block</a> objects. The following
|
|
98
|
-
* types of information are returned: </p>
|
|
99
|
-
* <ul>
|
|
100
|
-
* <li>
|
|
101
|
-
* <p>Form data (key-value pairs). The related information is returned in two <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY
|
|
102
|
-
* <code>Block</code> object and a VALUE <code>Block</code> object. For example,
|
|
103
|
-
* <i>Name: Ana Silva Carolina</i> contains a key and value.
|
|
104
|
-
* <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is
|
|
105
|
-
* the value.</p>
|
|
106
|
-
* </li>
|
|
107
|
-
* <li>
|
|
108
|
-
* <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL
|
|
109
|
-
* <code>Block</code> object is returned for each cell in a table.</p>
|
|
110
|
-
* </li>
|
|
111
|
-
* <li>
|
|
112
|
-
* <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> objects.
|
|
113
|
-
* All lines and words that are detected in the document are returned (including text that doesn't have a
|
|
114
|
-
* relationship with the value of the <code>StartDocumentAnalysis</code>
|
|
115
|
-
* <code>FeatureTypes</code> input parameter). </p>
|
|
116
|
-
* </li>
|
|
117
|
-
* </ul>
|
|
118
|
-
*
|
|
119
|
-
* <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.
|
|
120
|
-
* A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,
|
|
121
|
-
* including the selection status.</p>
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
* <p>Use the <code>MaxResults</code> parameter to limit the number of blocks that are
|
|
126
|
-
* returned. If there are more results than specified in <code>MaxResults</code>, the value of
|
|
127
|
-
* <code>NextToken</code> in the operation response contains a pagination token for getting
|
|
128
|
-
* the next set of results. To get the next page of results, call
|
|
129
|
-
* <code>GetDocumentAnalysis</code>, and populate the <code>NextToken</code> request
|
|
130
|
-
* parameter with the token value that's returned from the previous call to
|
|
131
|
-
* <code>GetDocumentAnalysis</code>.</p>
|
|
132
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text Analysis</a>.</p>
|
|
133
|
-
*/
|
|
24
|
+
|
|
134
25
|
getDocumentAnalysis(args: GetDocumentAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<GetDocumentAnalysisCommandOutput>;
|
|
135
26
|
getDocumentAnalysis(args: GetDocumentAnalysisCommandInput, cb: (err: any, data?: GetDocumentAnalysisCommandOutput) => void): void;
|
|
136
27
|
getDocumentAnalysis(args: GetDocumentAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentAnalysisCommandOutput) => void): void;
|
|
137
|
-
|
|
138
|
-
* <p>Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
|
|
139
|
-
* Amazon Textract can detect lines of text and the words that make up a line of text.</p>
|
|
140
|
-
* <p>You start asynchronous text detection by calling <a>StartDocumentTextDetection</a>, which returns a job identifier
|
|
141
|
-
* (<code>JobId</code>). When the text detection operation finishes, Amazon Textract publishes a
|
|
142
|
-
* completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to
|
|
143
|
-
* <code>StartDocumentTextDetection</code>. To get the results of the text-detection
|
|
144
|
-
* operation, first check that the status value published to the Amazon SNS topic is
|
|
145
|
-
* <code>SUCCEEDED</code>. If so, call <code>GetDocumentTextDetection</code>, and pass the
|
|
146
|
-
* job identifier (<code>JobId</code>) from the initial call to
|
|
147
|
-
* <code>StartDocumentTextDetection</code>.</p>
|
|
148
|
-
* <p>
|
|
149
|
-
* <code>GetDocumentTextDetection</code> returns an array of <a>Block</a>
|
|
150
|
-
* objects. </p>
|
|
151
|
-
* <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object
|
|
152
|
-
* is the parent of LINE <code>Block</code> objects that represent the lines of detected text on a page. A LINE <code>Block</code> object is
|
|
153
|
-
* a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>
|
|
154
|
-
*
|
|
155
|
-
* <p>Use the MaxResults parameter to limit the number of blocks that are returned. If there
|
|
156
|
-
* are more results than specified in <code>MaxResults</code>, the value of
|
|
157
|
-
* <code>NextToken</code> in the operation response contains a pagination token for getting
|
|
158
|
-
* the next set of results. To get the next page of results, call
|
|
159
|
-
* <code>GetDocumentTextDetection</code>, and populate the <code>NextToken</code> request
|
|
160
|
-
* parameter with the token value that's returned from the previous call to
|
|
161
|
-
* <code>GetDocumentTextDetection</code>.</p>
|
|
162
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html">Document Text Detection</a>.</p>
|
|
163
|
-
*/
|
|
28
|
+
|
|
164
29
|
getDocumentTextDetection(args: GetDocumentTextDetectionCommandInput, options?: __HttpHandlerOptions): Promise<GetDocumentTextDetectionCommandOutput>;
|
|
165
30
|
getDocumentTextDetection(args: GetDocumentTextDetectionCommandInput, cb: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void): void;
|
|
166
31
|
getDocumentTextDetection(args: GetDocumentTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void): void;
|
|
167
|
-
|
|
168
|
-
* <p>Starts the asynchronous analysis of an input document for relationships between detected
|
|
169
|
-
* items such as key-value pairs, tables, and selection elements.</p>
|
|
170
|
-
*
|
|
171
|
-
* <p>
|
|
172
|
-
* <code>StartDocumentAnalysis</code> can analyze text in documents that are in JPEG, PNG, and PDF format. The
|
|
173
|
-
* documents are stored in an Amazon S3 bucket. Use <a>DocumentLocation</a> to specify the bucket name and file name
|
|
174
|
-
* of the document.
|
|
175
|
-
* </p>
|
|
176
|
-
* <p>
|
|
177
|
-
* <code>StartDocumentAnalysis</code> returns a job identifier
|
|
178
|
-
* (<code>JobId</code>) that you use to get the results of the operation. When text
|
|
179
|
-
* analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS)
|
|
180
|
-
* topic that you specify in <code>NotificationChannel</code>. To get the results of the text
|
|
181
|
-
* analysis operation, first check that the status value published to the Amazon SNS topic is
|
|
182
|
-
* <code>SUCCEEDED</code>. If so, call <a>GetDocumentAnalysis</a>, and pass
|
|
183
|
-
* the job identifier (<code>JobId</code>) from the initial call to
|
|
184
|
-
* <code>StartDocumentAnalysis</code>.</p>
|
|
185
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text Analysis</a>.</p>
|
|
186
|
-
*/
|
|
32
|
+
|
|
187
33
|
startDocumentAnalysis(args: StartDocumentAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<StartDocumentAnalysisCommandOutput>;
|
|
188
34
|
startDocumentAnalysis(args: StartDocumentAnalysisCommandInput, cb: (err: any, data?: StartDocumentAnalysisCommandOutput) => void): void;
|
|
189
35
|
startDocumentAnalysis(args: StartDocumentAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDocumentAnalysisCommandOutput) => void): void;
|
|
190
|
-
|
|
191
|
-
* <p>Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of
|
|
192
|
-
* text and the words that make up a line of text.</p>
|
|
193
|
-
* <p>
|
|
194
|
-
* <code>StartDocumentTextDetection</code> can analyze text in documents that are in JPEG, PNG, and PDF format. The
|
|
195
|
-
* documents are stored in an Amazon S3 bucket. Use <a>DocumentLocation</a> to specify the bucket name and file name
|
|
196
|
-
* of the document.
|
|
197
|
-
* </p>
|
|
198
|
-
* <p>
|
|
199
|
-
* <code>StartTextDetection</code> returns a job identifier
|
|
200
|
-
* (<code>JobId</code>) that you use to get the results of the operation. When text
|
|
201
|
-
* detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS)
|
|
202
|
-
* topic that you specify in <code>NotificationChannel</code>. To get the results of the text
|
|
203
|
-
* detection operation, first check that the status value published to the Amazon SNS topic is
|
|
204
|
-
* <code>SUCCEEDED</code>. If so, call <a>GetDocumentTextDetection</a>, and
|
|
205
|
-
* pass the job identifier (<code>JobId</code>) from the initial call to
|
|
206
|
-
* <code>StartDocumentTextDetection</code>.</p>
|
|
207
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html">Document Text Detection</a>.</p>
|
|
208
|
-
*/
|
|
36
|
+
|
|
209
37
|
startDocumentTextDetection(args: StartDocumentTextDetectionCommandInput, options?: __HttpHandlerOptions): Promise<StartDocumentTextDetectionCommandOutput>;
|
|
210
38
|
startDocumentTextDetection(args: StartDocumentTextDetectionCommandInput, cb: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void): void;
|
|
211
39
|
startDocumentTextDetection(args: StartDocumentTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void): void;
|
|
@@ -16,126 +16,59 @@ import { StartDocumentTextDetectionCommandInput, StartDocumentTextDetectionComma
|
|
|
16
16
|
export declare type ServiceInputTypes = AnalyzeDocumentCommandInput | AnalyzeExpenseCommandInput | DetectDocumentTextCommandInput | GetDocumentAnalysisCommandInput | GetDocumentTextDetectionCommandInput | StartDocumentAnalysisCommandInput | StartDocumentTextDetectionCommandInput;
|
|
17
17
|
export declare type ServiceOutputTypes = AnalyzeDocumentCommandOutput | AnalyzeExpenseCommandOutput | DetectDocumentTextCommandOutput | GetDocumentAnalysisCommandOutput | GetDocumentTextDetectionCommandOutput | StartDocumentAnalysisCommandOutput | StartDocumentTextDetectionCommandOutput;
|
|
18
18
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
19
|
-
|
|
20
|
-
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
21
|
-
*/
|
|
19
|
+
|
|
22
20
|
requestHandler?: __HttpHandler;
|
|
23
|
-
|
|
24
|
-
* A constructor for a class implementing the {@link __Hash} interface
|
|
25
|
-
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
26
|
-
* @internal
|
|
27
|
-
*/
|
|
21
|
+
|
|
28
22
|
sha256?: __HashConstructor;
|
|
29
|
-
|
|
30
|
-
* The function that will be used to convert strings into HTTP endpoints.
|
|
31
|
-
* @internal
|
|
32
|
-
*/
|
|
23
|
+
|
|
33
24
|
urlParser?: __UrlParser;
|
|
34
|
-
|
|
35
|
-
* A function that can calculate the length of a request body.
|
|
36
|
-
* @internal
|
|
37
|
-
*/
|
|
25
|
+
|
|
38
26
|
bodyLengthChecker?: (body: any) => number | undefined;
|
|
39
|
-
|
|
40
|
-
* A function that converts a stream into an array of bytes.
|
|
41
|
-
* @internal
|
|
42
|
-
*/
|
|
27
|
+
|
|
43
28
|
streamCollector?: __StreamCollector;
|
|
44
|
-
|
|
45
|
-
* The function that will be used to convert a base64-encoded string to a byte array.
|
|
46
|
-
* @internal
|
|
47
|
-
*/
|
|
29
|
+
|
|
48
30
|
base64Decoder?: __Decoder;
|
|
49
|
-
|
|
50
|
-
* The function that will be used to convert binary data to a base64-encoded string.
|
|
51
|
-
* @internal
|
|
52
|
-
*/
|
|
31
|
+
|
|
53
32
|
base64Encoder?: __Encoder;
|
|
54
|
-
|
|
55
|
-
* The function that will be used to convert a UTF8-encoded string to a byte array.
|
|
56
|
-
* @internal
|
|
57
|
-
*/
|
|
33
|
+
|
|
58
34
|
utf8Decoder?: __Decoder;
|
|
59
|
-
|
|
60
|
-
* The function that will be used to convert binary data to a UTF-8 encoded string.
|
|
61
|
-
* @internal
|
|
62
|
-
*/
|
|
35
|
+
|
|
63
36
|
utf8Encoder?: __Encoder;
|
|
64
|
-
|
|
65
|
-
* The runtime environment.
|
|
66
|
-
* @internal
|
|
67
|
-
*/
|
|
37
|
+
|
|
68
38
|
runtime?: string;
|
|
69
|
-
|
|
70
|
-
* Disable dyanamically changing the endpoint of the client based on the hostPrefix
|
|
71
|
-
* trait of an operation.
|
|
72
|
-
*/
|
|
39
|
+
|
|
73
40
|
disableHostPrefix?: boolean;
|
|
74
|
-
|
|
75
|
-
* Value for how many times a request will be made at most in case of retry.
|
|
76
|
-
*/
|
|
41
|
+
|
|
77
42
|
maxAttempts?: number | __Provider<number>;
|
|
78
|
-
|
|
79
|
-
* Specifies which retry algorithm to use.
|
|
80
|
-
*/
|
|
43
|
+
|
|
81
44
|
retryMode?: string | __Provider<string>;
|
|
82
|
-
|
|
83
|
-
* Optional logger for logging debug/info/warn/error.
|
|
84
|
-
*/
|
|
45
|
+
|
|
85
46
|
logger?: __Logger;
|
|
86
|
-
|
|
87
|
-
* Unique service identifier.
|
|
88
|
-
* @internal
|
|
89
|
-
*/
|
|
47
|
+
|
|
90
48
|
serviceId?: string;
|
|
91
|
-
|
|
92
|
-
* The AWS region to which this client will send requests
|
|
93
|
-
*/
|
|
49
|
+
|
|
94
50
|
region?: string | __Provider<string>;
|
|
95
|
-
|
|
96
|
-
* Default credentials provider; Not available in browser runtime.
|
|
97
|
-
* @internal
|
|
98
|
-
*/
|
|
51
|
+
|
|
99
52
|
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
|
|
100
|
-
|
|
101
|
-
* Fetch related hostname, signing name or signing region with given region.
|
|
102
|
-
* @internal
|
|
103
|
-
*/
|
|
53
|
+
|
|
104
54
|
regionInfoProvider?: RegionInfoProvider;
|
|
105
|
-
|
|
106
|
-
* The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
|
|
107
|
-
* @internal
|
|
108
|
-
*/
|
|
55
|
+
|
|
109
56
|
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
110
57
|
}
|
|
111
58
|
declare type TextractClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
|
|
112
|
-
|
|
113
|
-
* The configuration interface of TextractClient class constructor that set the region, credentials and other options.
|
|
114
|
-
*/
|
|
59
|
+
|
|
115
60
|
export interface TextractClientConfig extends TextractClientConfigType {
|
|
116
61
|
}
|
|
117
62
|
declare type TextractClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
|
|
118
|
-
|
|
119
|
-
* The resolved configuration interface of TextractClient class. This is resolved and normalized from the {@link TextractClientConfig | constructor configuration interface}.
|
|
120
|
-
*/
|
|
63
|
+
|
|
121
64
|
export interface TextractClientResolvedConfig extends TextractClientResolvedConfigType {
|
|
122
65
|
}
|
|
123
|
-
|
|
124
|
-
* <p>Amazon Textract detects and analyzes text in documents and converts it
|
|
125
|
-
* into machine-readable text. This is the API reference documentation for
|
|
126
|
-
* Amazon Textract.</p>
|
|
127
|
-
*/
|
|
66
|
+
|
|
128
67
|
export declare class TextractClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig> {
|
|
129
|
-
|
|
130
|
-
* The resolved configuration of TextractClient class. This is resolved and normalized from the {@link TextractClientConfig | constructor configuration interface}.
|
|
131
|
-
*/
|
|
68
|
+
|
|
132
69
|
readonly config: TextractClientResolvedConfig;
|
|
133
70
|
constructor(configuration: TextractClientConfig);
|
|
134
|
-
|
|
135
|
-
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
|
|
136
|
-
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
|
|
137
|
-
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
|
|
138
|
-
*/
|
|
71
|
+
|
|
139
72
|
destroy(): void;
|
|
140
73
|
}
|
|
141
74
|
export {};
|
|
@@ -6,59 +6,11 @@ export interface AnalyzeDocumentCommandInput extends AnalyzeDocumentRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface AnalyzeDocumentCommandOutput extends AnalyzeDocumentResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Analyzes an input document for relationships between detected items. </p>
|
|
11
|
-
* <p>The types of information returned are as follows: </p>
|
|
12
|
-
* <ul>
|
|
13
|
-
* <li>
|
|
14
|
-
* <p>Form data (key-value pairs). The related information is returned in two <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY
|
|
15
|
-
* <code>Block</code> object and a VALUE <code>Block</code> object. For example,
|
|
16
|
-
* <i>Name: Ana Silva Carolina</i> contains a key and value.
|
|
17
|
-
* <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is
|
|
18
|
-
* the value.</p>
|
|
19
|
-
* </li>
|
|
20
|
-
* <li>
|
|
21
|
-
* <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL
|
|
22
|
-
* <code>Block</code> object is returned for each cell in a table.</p>
|
|
23
|
-
* </li>
|
|
24
|
-
* <li>
|
|
25
|
-
* <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> objects.
|
|
26
|
-
* All lines and words that are detected in the document are returned (including text that doesn't have a
|
|
27
|
-
* relationship with the value of <code>FeatureTypes</code>). </p>
|
|
28
|
-
* </li>
|
|
29
|
-
* </ul>
|
|
30
|
-
*
|
|
31
|
-
* <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.
|
|
32
|
-
* A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,
|
|
33
|
-
* including the selection status.</p>
|
|
34
|
-
* <p>You can choose which type of analysis to perform by specifying the <code>FeatureTypes</code> list.
|
|
35
|
-
* </p>
|
|
36
|
-
* <p>The output is returned in a list of <code>Block</code> objects.</p>
|
|
37
|
-
* <p>
|
|
38
|
-
* <code>AnalyzeDocument</code> is a synchronous operation. To analyze documents
|
|
39
|
-
* asynchronously, use <a>StartDocumentAnalysis</a>.</p>
|
|
40
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text Analysis</a>.</p>
|
|
41
|
-
* @example
|
|
42
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
43
|
-
* ```javascript
|
|
44
|
-
* import { TextractClient, AnalyzeDocumentCommand } from "@aws-sdk/client-textract"; // ES Modules import
|
|
45
|
-
* // const { TextractClient, AnalyzeDocumentCommand } = require("@aws-sdk/client-textract"); // CommonJS import
|
|
46
|
-
* const client = new TextractClient(config);
|
|
47
|
-
* const command = new AnalyzeDocumentCommand(input);
|
|
48
|
-
* const response = await client.send(command);
|
|
49
|
-
* ```
|
|
50
|
-
*
|
|
51
|
-
* @see {@link AnalyzeDocumentCommandInput} for command's `input` shape.
|
|
52
|
-
* @see {@link AnalyzeDocumentCommandOutput} for command's `response` shape.
|
|
53
|
-
* @see {@link TextractClientResolvedConfig | config} for command's `input` shape.
|
|
54
|
-
*
|
|
55
|
-
*/
|
|
9
|
+
|
|
56
10
|
export declare class AnalyzeDocumentCommand extends $Command<AnalyzeDocumentCommandInput, AnalyzeDocumentCommandOutput, TextractClientResolvedConfig> {
|
|
57
11
|
readonly input: AnalyzeDocumentCommandInput;
|
|
58
12
|
constructor(input: AnalyzeDocumentCommandInput);
|
|
59
|
-
|
|
60
|
-
* @internal
|
|
61
|
-
*/
|
|
13
|
+
|
|
62
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AnalyzeDocumentCommandInput, AnalyzeDocumentCommandOutput>;
|
|
63
15
|
private serialize;
|
|
64
16
|
private deserialize;
|
|
@@ -6,42 +6,11 @@ export interface AnalyzeExpenseCommandInput extends AnalyzeExpenseRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface AnalyzeExpenseCommandOutput extends AnalyzeExpenseResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Analyzes an input document for financially related relationships between text.</p>
|
|
11
|
-
* <p>Information is returned as <code>ExpenseDocuments</code> and seperated as follows.</p>
|
|
12
|
-
* <ul>
|
|
13
|
-
* <li>
|
|
14
|
-
* <p>
|
|
15
|
-
* <code>LineItemGroups</code>- A data set containing <code>LineItems</code> which
|
|
16
|
-
* store information about the lines of text, such as an item purchased and its price on a receipt.</p>
|
|
17
|
-
* </li>
|
|
18
|
-
* <li>
|
|
19
|
-
* <p>
|
|
20
|
-
* <code>SummaryFields</code>- Contains all other information a receipt, such as header information
|
|
21
|
-
* or the vendors name.</p>
|
|
22
|
-
* </li>
|
|
23
|
-
* </ul>
|
|
24
|
-
* @example
|
|
25
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
26
|
-
* ```javascript
|
|
27
|
-
* import { TextractClient, AnalyzeExpenseCommand } from "@aws-sdk/client-textract"; // ES Modules import
|
|
28
|
-
* // const { TextractClient, AnalyzeExpenseCommand } = require("@aws-sdk/client-textract"); // CommonJS import
|
|
29
|
-
* const client = new TextractClient(config);
|
|
30
|
-
* const command = new AnalyzeExpenseCommand(input);
|
|
31
|
-
* const response = await client.send(command);
|
|
32
|
-
* ```
|
|
33
|
-
*
|
|
34
|
-
* @see {@link AnalyzeExpenseCommandInput} for command's `input` shape.
|
|
35
|
-
* @see {@link AnalyzeExpenseCommandOutput} for command's `response` shape.
|
|
36
|
-
* @see {@link TextractClientResolvedConfig | config} for command's `input` shape.
|
|
37
|
-
*
|
|
38
|
-
*/
|
|
9
|
+
|
|
39
10
|
export declare class AnalyzeExpenseCommand extends $Command<AnalyzeExpenseCommandInput, AnalyzeExpenseCommandOutput, TextractClientResolvedConfig> {
|
|
40
11
|
readonly input: AnalyzeExpenseCommandInput;
|
|
41
12
|
constructor(input: AnalyzeExpenseCommandInput);
|
|
42
|
-
|
|
43
|
-
* @internal
|
|
44
|
-
*/
|
|
13
|
+
|
|
45
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AnalyzeExpenseCommandInput, AnalyzeExpenseCommandOutput>;
|
|
46
15
|
private serialize;
|
|
47
16
|
private deserialize;
|
|
@@ -6,39 +6,11 @@ export interface DetectDocumentTextCommandInput extends DetectDocumentTextReques
|
|
|
6
6
|
}
|
|
7
7
|
export interface DetectDocumentTextCommandOutput extends DetectDocumentTextResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Detects text in the input document. Amazon Textract can detect lines of text and the
|
|
11
|
-
* words that make up a line of text. The input document must be an image in JPEG or PNG
|
|
12
|
-
* format. <code>DetectDocumentText</code> returns the detected text in an array of <a>Block</a> objects. </p>
|
|
13
|
-
* <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object
|
|
14
|
-
* is the parent of LINE <code>Block</code> objects that represent the lines of detected text on a page. A LINE <code>Block</code> object is
|
|
15
|
-
* a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>
|
|
16
|
-
*
|
|
17
|
-
* <p>
|
|
18
|
-
* <code>DetectDocumentText</code> is a synchronous operation. To analyze documents
|
|
19
|
-
* asynchronously, use <a>StartDocumentTextDetection</a>.</p>
|
|
20
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html">Document Text Detection</a>.</p>
|
|
21
|
-
* @example
|
|
22
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
23
|
-
* ```javascript
|
|
24
|
-
* import { TextractClient, DetectDocumentTextCommand } from "@aws-sdk/client-textract"; // ES Modules import
|
|
25
|
-
* // const { TextractClient, DetectDocumentTextCommand } = require("@aws-sdk/client-textract"); // CommonJS import
|
|
26
|
-
* const client = new TextractClient(config);
|
|
27
|
-
* const command = new DetectDocumentTextCommand(input);
|
|
28
|
-
* const response = await client.send(command);
|
|
29
|
-
* ```
|
|
30
|
-
*
|
|
31
|
-
* @see {@link DetectDocumentTextCommandInput} for command's `input` shape.
|
|
32
|
-
* @see {@link DetectDocumentTextCommandOutput} for command's `response` shape.
|
|
33
|
-
* @see {@link TextractClientResolvedConfig | config} for command's `input` shape.
|
|
34
|
-
*
|
|
35
|
-
*/
|
|
9
|
+
|
|
36
10
|
export declare class DetectDocumentTextCommand extends $Command<DetectDocumentTextCommandInput, DetectDocumentTextCommandOutput, TextractClientResolvedConfig> {
|
|
37
11
|
readonly input: DetectDocumentTextCommandInput;
|
|
38
12
|
constructor(input: DetectDocumentTextCommandInput);
|
|
39
|
-
|
|
40
|
-
* @internal
|
|
41
|
-
*/
|
|
13
|
+
|
|
42
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DetectDocumentTextCommandInput, DetectDocumentTextCommandOutput>;
|
|
43
15
|
private serialize;
|
|
44
16
|
private deserialize;
|
|
@@ -6,73 +6,11 @@ export interface GetDocumentAnalysisCommandInput extends GetDocumentAnalysisRequ
|
|
|
6
6
|
}
|
|
7
7
|
export interface GetDocumentAnalysisCommandOutput extends GetDocumentAnalysisResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.</p>
|
|
11
|
-
* <p>You start asynchronous text analysis by calling <a>StartDocumentAnalysis</a>, which returns a job identifier
|
|
12
|
-
* (<code>JobId</code>). When the text analysis operation finishes, Amazon Textract publishes a
|
|
13
|
-
* completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to
|
|
14
|
-
* <code>StartDocumentAnalysis</code>. To get the results of the text-detection operation,
|
|
15
|
-
* first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
|
|
16
|
-
* If so, call <code>GetDocumentAnalysis</code>, and pass the job identifier
|
|
17
|
-
* (<code>JobId</code>) from the initial call to <code>StartDocumentAnalysis</code>.</p>
|
|
18
|
-
* <p>
|
|
19
|
-
* <code>GetDocumentAnalysis</code> returns an array of <a>Block</a> objects. The following
|
|
20
|
-
* types of information are returned: </p>
|
|
21
|
-
* <ul>
|
|
22
|
-
* <li>
|
|
23
|
-
* <p>Form data (key-value pairs). The related information is returned in two <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY
|
|
24
|
-
* <code>Block</code> object and a VALUE <code>Block</code> object. For example,
|
|
25
|
-
* <i>Name: Ana Silva Carolina</i> contains a key and value.
|
|
26
|
-
* <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is
|
|
27
|
-
* the value.</p>
|
|
28
|
-
* </li>
|
|
29
|
-
* <li>
|
|
30
|
-
* <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL
|
|
31
|
-
* <code>Block</code> object is returned for each cell in a table.</p>
|
|
32
|
-
* </li>
|
|
33
|
-
* <li>
|
|
34
|
-
* <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> objects.
|
|
35
|
-
* All lines and words that are detected in the document are returned (including text that doesn't have a
|
|
36
|
-
* relationship with the value of the <code>StartDocumentAnalysis</code>
|
|
37
|
-
* <code>FeatureTypes</code> input parameter). </p>
|
|
38
|
-
* </li>
|
|
39
|
-
* </ul>
|
|
40
|
-
*
|
|
41
|
-
* <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.
|
|
42
|
-
* A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,
|
|
43
|
-
* including the selection status.</p>
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
* <p>Use the <code>MaxResults</code> parameter to limit the number of blocks that are
|
|
48
|
-
* returned. If there are more results than specified in <code>MaxResults</code>, the value of
|
|
49
|
-
* <code>NextToken</code> in the operation response contains a pagination token for getting
|
|
50
|
-
* the next set of results. To get the next page of results, call
|
|
51
|
-
* <code>GetDocumentAnalysis</code>, and populate the <code>NextToken</code> request
|
|
52
|
-
* parameter with the token value that's returned from the previous call to
|
|
53
|
-
* <code>GetDocumentAnalysis</code>.</p>
|
|
54
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text Analysis</a>.</p>
|
|
55
|
-
* @example
|
|
56
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
57
|
-
* ```javascript
|
|
58
|
-
* import { TextractClient, GetDocumentAnalysisCommand } from "@aws-sdk/client-textract"; // ES Modules import
|
|
59
|
-
* // const { TextractClient, GetDocumentAnalysisCommand } = require("@aws-sdk/client-textract"); // CommonJS import
|
|
60
|
-
* const client = new TextractClient(config);
|
|
61
|
-
* const command = new GetDocumentAnalysisCommand(input);
|
|
62
|
-
* const response = await client.send(command);
|
|
63
|
-
* ```
|
|
64
|
-
*
|
|
65
|
-
* @see {@link GetDocumentAnalysisCommandInput} for command's `input` shape.
|
|
66
|
-
* @see {@link GetDocumentAnalysisCommandOutput} for command's `response` shape.
|
|
67
|
-
* @see {@link TextractClientResolvedConfig | config} for command's `input` shape.
|
|
68
|
-
*
|
|
69
|
-
*/
|
|
9
|
+
|
|
70
10
|
export declare class GetDocumentAnalysisCommand extends $Command<GetDocumentAnalysisCommandInput, GetDocumentAnalysisCommandOutput, TextractClientResolvedConfig> {
|
|
71
11
|
readonly input: GetDocumentAnalysisCommandInput;
|
|
72
12
|
constructor(input: GetDocumentAnalysisCommandInput);
|
|
73
|
-
|
|
74
|
-
* @internal
|
|
75
|
-
*/
|
|
13
|
+
|
|
76
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDocumentAnalysisCommandInput, GetDocumentAnalysisCommandOutput>;
|
|
77
15
|
private serialize;
|
|
78
16
|
private deserialize;
|