@aws-sdk/client-textract 3.296.0 → 3.298.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/dist-cjs/commands/AnalyzeDocumentCommand.js +2 -3
  2. package/dist-cjs/commands/AnalyzeExpenseCommand.js +2 -3
  3. package/dist-cjs/commands/AnalyzeIDCommand.js +2 -3
  4. package/dist-cjs/commands/DetectDocumentTextCommand.js +2 -3
  5. package/dist-cjs/commands/GetDocumentAnalysisCommand.js +2 -3
  6. package/dist-cjs/commands/GetDocumentTextDetectionCommand.js +2 -3
  7. package/dist-cjs/commands/GetExpenseAnalysisCommand.js +2 -3
  8. package/dist-cjs/commands/GetLendingAnalysisCommand.js +2 -3
  9. package/dist-cjs/commands/GetLendingAnalysisSummaryCommand.js +2 -3
  10. package/dist-cjs/commands/StartDocumentAnalysisCommand.js +2 -3
  11. package/dist-cjs/commands/StartDocumentTextDetectionCommand.js +2 -3
  12. package/dist-cjs/commands/StartExpenseAnalysisCommand.js +2 -3
  13. package/dist-cjs/commands/StartLendingAnalysisCommand.js +2 -3
  14. package/dist-cjs/endpoint/ruleset.js +3 -3
  15. package/dist-cjs/models/models_0.js +12 -274
  16. package/dist-es/commands/AnalyzeDocumentCommand.js +2 -3
  17. package/dist-es/commands/AnalyzeExpenseCommand.js +2 -3
  18. package/dist-es/commands/AnalyzeIDCommand.js +2 -3
  19. package/dist-es/commands/DetectDocumentTextCommand.js +2 -3
  20. package/dist-es/commands/GetDocumentAnalysisCommand.js +2 -3
  21. package/dist-es/commands/GetDocumentTextDetectionCommand.js +2 -3
  22. package/dist-es/commands/GetExpenseAnalysisCommand.js +2 -3
  23. package/dist-es/commands/GetLendingAnalysisCommand.js +2 -3
  24. package/dist-es/commands/GetLendingAnalysisSummaryCommand.js +2 -3
  25. package/dist-es/commands/StartDocumentAnalysisCommand.js +2 -3
  26. package/dist-es/commands/StartDocumentTextDetectionCommand.js +2 -3
  27. package/dist-es/commands/StartExpenseAnalysisCommand.js +2 -3
  28. package/dist-es/commands/StartLendingAnalysisCommand.js +2 -3
  29. package/dist-es/endpoint/ruleset.js +3 -3
  30. package/dist-es/models/models_0.js +11 -204
  31. package/dist-types/Textract.d.ts +17 -13
  32. package/dist-types/TextractClient.d.ts +24 -4
  33. package/dist-types/commands/AnalyzeDocumentCommand.d.ts +16 -2
  34. package/dist-types/commands/AnalyzeExpenseCommand.d.ts +16 -0
  35. package/dist-types/commands/AnalyzeIDCommand.d.ts +17 -1
  36. package/dist-types/commands/DetectDocumentTextCommand.d.ts +16 -1
  37. package/dist-types/commands/GetDocumentAnalysisCommand.d.ts +16 -4
  38. package/dist-types/commands/GetDocumentTextDetectionCommand.d.ts +16 -1
  39. package/dist-types/commands/GetExpenseAnalysisCommand.d.ts +16 -0
  40. package/dist-types/commands/GetLendingAnalysisCommand.d.ts +18 -2
  41. package/dist-types/commands/GetLendingAnalysisSummaryCommand.d.ts +16 -0
  42. package/dist-types/commands/StartDocumentAnalysisCommand.d.ts +16 -1
  43. package/dist-types/commands/StartDocumentTextDetectionCommand.d.ts +16 -0
  44. package/dist-types/commands/StartExpenseAnalysisCommand.d.ts +16 -1
  45. package/dist-types/commands/StartLendingAnalysisCommand.d.ts +16 -0
  46. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  47. package/dist-types/models/TextractServiceException.d.ts +2 -0
  48. package/dist-types/models/models_0.d.ts +275 -300
  49. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  50. package/dist-types/ts3.4/models/models_0.d.ts +11 -174
  51. package/package.json +4 -3
@@ -14,12 +14,14 @@ import { StartExpenseAnalysisCommandInput, StartExpenseAnalysisCommandOutput } f
14
14
  import { StartLendingAnalysisCommandInput, StartLendingAnalysisCommandOutput } from "./commands/StartLendingAnalysisCommand";
15
15
  import { TextractClient } from "./TextractClient";
16
16
  /**
17
+ * @public
17
18
  * <p>Amazon Textract detects and analyzes text in documents and converts it
18
19
  * into machine-readable text. This is the API reference documentation for
19
20
  * Amazon Textract.</p>
20
21
  */
21
22
  export declare class Textract extends TextractClient {
22
23
  /**
24
+ * @public
23
25
  * <p>Analyzes an input document for relationships between detected items. </p>
24
26
  * <p>The types of information returned are as follows: </p>
25
27
  * <ul>
@@ -56,11 +58,9 @@ export declare class Textract extends TextractClient {
56
58
  * score.</p>
57
59
  * </li>
58
60
  * </ul>
59
- *
60
61
  * <p>Selection elements such as check boxes and option buttons (radio buttons) can be
61
62
  * detected in form data and in tables. A SELECTION_ELEMENT <code>Block</code> object contains
62
63
  * information about a selection element, including the selection status.</p>
63
- *
64
64
  * <p>You can choose which type of analysis to perform by specifying the
65
65
  * <code>FeatureTypes</code> list. </p>
66
66
  * <p>The output is returned in a list of <code>Block</code> objects.</p>
@@ -74,6 +74,7 @@ export declare class Textract extends TextractClient {
74
74
  analyzeDocument(args: AnalyzeDocumentCommandInput, cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void): void;
75
75
  analyzeDocument(args: AnalyzeDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void): void;
76
76
  /**
77
+ * @public
77
78
  * <p>
78
79
  * <code>AnalyzeExpense</code> synchronously analyzes an input document for financially
79
80
  * related relationships between text.</p>
@@ -97,15 +98,17 @@ export declare class Textract extends TextractClient {
97
98
  analyzeExpense(args: AnalyzeExpenseCommandInput, cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void): void;
98
99
  analyzeExpense(args: AnalyzeExpenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void): void;
99
100
  /**
101
+ * @public
100
102
  * <p>Analyzes identity documents for relevant information. This information is extracted and
101
103
  * returned as <code>IdentityDocumentFields</code>, which records both the normalized field
102
- * and value of the extracted text.Unlike other Amazon Textract operations,
104
+ * and value of the extracted text. Unlike other Amazon Textract operations,
103
105
  * <code>AnalyzeID</code> doesn't return any Geometry data.</p>
104
106
  */
105
107
  analyzeID(args: AnalyzeIDCommandInput, options?: __HttpHandlerOptions): Promise<AnalyzeIDCommandOutput>;
106
108
  analyzeID(args: AnalyzeIDCommandInput, cb: (err: any, data?: AnalyzeIDCommandOutput) => void): void;
107
109
  analyzeID(args: AnalyzeIDCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AnalyzeIDCommandOutput) => void): void;
108
110
  /**
111
+ * @public
109
112
  * <p>Detects text in the input document. Amazon Textract can detect lines of text and the
110
113
  * words that make up a line of text. The input document must be in one of the following image
111
114
  * formats: JPEG, PNG, PDF, or TIFF. <code>DetectDocumentText</code> returns the detected
@@ -113,7 +116,6 @@ export declare class Textract extends TextractClient {
113
116
  * <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object
114
117
  * 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
115
118
  * a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>
116
- *
117
119
  * <p>
118
120
  * <code>DetectDocumentText</code> is a synchronous operation. To analyze documents
119
121
  * asynchronously, use <a>StartDocumentTextDetection</a>.</p>
@@ -123,6 +125,7 @@ export declare class Textract extends TextractClient {
123
125
  detectDocumentText(args: DetectDocumentTextCommandInput, cb: (err: any, data?: DetectDocumentTextCommandOutput) => void): void;
124
126
  detectDocumentText(args: DetectDocumentTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectDocumentTextCommandOutput) => void): void;
125
127
  /**
128
+ * @public
126
129
  * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a
127
130
  * document.</p>
128
131
  * <p>You start asynchronous text analysis by calling <a>StartDocumentAnalysis</a>,
@@ -166,19 +169,15 @@ export declare class Textract extends TextractClient {
166
169
  * score.</p>
167
170
  * </li>
168
171
  * </ul>
169
- *
170
172
  * <note>
171
173
  * <p>While processing a document with queries, look out for
172
174
  * <code>INVALID_REQUEST_PARAMETERS</code> output. This indicates that either the per
173
175
  * page query limit has been exceeded or that the operation is trying to query a page in
174
176
  * the document which doesn’t exist. </p>
175
177
  * </note>
176
- *
177
178
  * <p>Selection elements such as check boxes and option buttons (radio buttons) can be
178
179
  * detected in form data and in tables. A SELECTION_ELEMENT <code>Block</code> object contains
179
180
  * information about a selection element, including the selection status.</p>
180
- *
181
- *
182
181
  * <p>Use the <code>MaxResults</code> parameter to limit the number of blocks that are
183
182
  * returned. If there are more results than specified in <code>MaxResults</code>, the value of
184
183
  * <code>NextToken</code> in the operation response contains a pagination token for getting
@@ -193,6 +192,7 @@ export declare class Textract extends TextractClient {
193
192
  getDocumentAnalysis(args: GetDocumentAnalysisCommandInput, cb: (err: any, data?: GetDocumentAnalysisCommandOutput) => void): void;
194
193
  getDocumentAnalysis(args: GetDocumentAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentAnalysisCommandOutput) => void): void;
195
194
  /**
195
+ * @public
196
196
  * <p>Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
197
197
  * Amazon Textract can detect lines of text and the words that make up a line of text.</p>
198
198
  * <p>You start asynchronous text detection by calling <a>StartDocumentTextDetection</a>, which returns a job identifier
@@ -209,7 +209,6 @@ export declare class Textract extends TextractClient {
209
209
  * <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object
210
210
  * 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
211
211
  * a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>
212
- *
213
212
  * <p>Use the MaxResults parameter to limit the number of blocks that are returned. If there
214
213
  * are more results than specified in <code>MaxResults</code>, the value of
215
214
  * <code>NextToken</code> in the operation response contains a pagination token for getting
@@ -223,6 +222,7 @@ export declare class Textract extends TextractClient {
223
222
  getDocumentTextDetection(args: GetDocumentTextDetectionCommandInput, cb: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void): void;
224
223
  getDocumentTextDetection(args: GetDocumentTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void): void;
225
224
  /**
225
+ * @public
226
226
  * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and
227
227
  * receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input
228
228
  * invoices and receipts.</p>
@@ -245,14 +245,15 @@ export declare class Textract extends TextractClient {
245
245
  getExpenseAnalysis(args: GetExpenseAnalysisCommandInput, cb: (err: any, data?: GetExpenseAnalysisCommandOutput) => void): void;
246
246
  getExpenseAnalysis(args: GetExpenseAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExpenseAnalysisCommandOutput) => void): void;
247
247
  /**
248
+ * @public
248
249
  * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a
249
250
  * lending document. </p>
250
- * <p>You start asynchronous text analysis by calling <code>StartLendingAnalysis</code>,
251
+ * <p>You start asynchronous text analysis by calling <code>StartLendingAnalysis</code>,
251
252
  * which returns a job identifier (<code>JobId</code>). When the text analysis operation
252
253
  * finishes, Amazon Textract publishes a completion status to the Amazon Simple
253
254
  * Notification Service (Amazon SNS) topic that's registered in the initial call to
254
255
  * <code>StartLendingAnalysis</code>. </p>
255
- * <p>To get the results of the text analysis operation, first check that the status value
256
+ * <p>To get the results of the text analysis operation, first check that the status value
256
257
  * published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass
257
258
  * the job identifier (<code>JobId</code>) from the initial call to
258
259
  * <code>StartLendingAnalysis</code>.</p>
@@ -261,6 +262,7 @@ export declare class Textract extends TextractClient {
261
262
  getLendingAnalysis(args: GetLendingAnalysisCommandInput, cb: (err: any, data?: GetLendingAnalysisCommandOutput) => void): void;
262
263
  getLendingAnalysis(args: GetLendingAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLendingAnalysisCommandOutput) => void): void;
263
264
  /**
265
+ * @public
264
266
  * <p>Gets summarized results for the <code>StartLendingAnalysis</code> operation, which analyzes
265
267
  * text in a lending document. The returned summary consists of information about documents grouped
266
268
  * together by a common document type. Information like detected signatures, page numbers, and split
@@ -278,9 +280,9 @@ export declare class Textract extends TextractClient {
278
280
  getLendingAnalysisSummary(args: GetLendingAnalysisSummaryCommandInput, cb: (err: any, data?: GetLendingAnalysisSummaryCommandOutput) => void): void;
279
281
  getLendingAnalysisSummary(args: GetLendingAnalysisSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLendingAnalysisSummaryCommandOutput) => void): void;
280
282
  /**
283
+ * @public
281
284
  * <p>Starts the asynchronous analysis of an input document for relationships between detected
282
285
  * items such as key-value pairs, tables, and selection elements.</p>
283
- *
284
286
  * <p>
285
287
  * <code>StartDocumentAnalysis</code> can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The
286
288
  * documents are stored in an Amazon S3 bucket. Use <a>DocumentLocation</a> to specify the bucket name and file name
@@ -301,6 +303,7 @@ export declare class Textract extends TextractClient {
301
303
  startDocumentAnalysis(args: StartDocumentAnalysisCommandInput, cb: (err: any, data?: StartDocumentAnalysisCommandOutput) => void): void;
302
304
  startDocumentAnalysis(args: StartDocumentAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDocumentAnalysisCommandOutput) => void): void;
303
305
  /**
306
+ * @public
304
307
  * <p>Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of
305
308
  * text and the words that make up a line of text.</p>
306
309
  * <p>
@@ -323,9 +326,9 @@ export declare class Textract extends TextractClient {
323
326
  startDocumentTextDetection(args: StartDocumentTextDetectionCommandInput, cb: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void): void;
324
327
  startDocumentTextDetection(args: StartDocumentTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void): void;
325
328
  /**
329
+ * @public
326
330
  * <p>Starts the asynchronous analysis of invoices or receipts for data like contact information,
327
331
  * items purchased, and vendor names.</p>
328
- *
329
332
  * <p>
330
333
  * <code>StartExpenseAnalysis</code> can analyze text in documents that are in JPEG, PNG, and
331
334
  * PDF format. The documents must be stored in an Amazon S3 bucket. Use the <a>DocumentLocation</a> parameter to specify the name of your S3 bucket and the name of the
@@ -344,6 +347,7 @@ export declare class Textract extends TextractClient {
344
347
  startExpenseAnalysis(args: StartExpenseAnalysisCommandInput, cb: (err: any, data?: StartExpenseAnalysisCommandOutput) => void): void;
345
348
  startExpenseAnalysis(args: StartExpenseAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExpenseAnalysisCommandOutput) => void): void;
346
349
  /**
350
+ * @public
347
351
  * <p>Starts the classification and analysis of an input document.
348
352
  * <code>StartLendingAnalysis</code> initiates the classification and analysis of a packet of
349
353
  * lending documents. <code>StartLendingAnalysis</code> operates on a document file located in an
@@ -21,15 +21,24 @@ import { StartDocumentTextDetectionCommandInput, StartDocumentTextDetectionComma
21
21
  import { StartExpenseAnalysisCommandInput, StartExpenseAnalysisCommandOutput } from "./commands/StartExpenseAnalysisCommand";
22
22
  import { StartLendingAnalysisCommandInput, StartLendingAnalysisCommandOutput } from "./commands/StartLendingAnalysisCommand";
23
23
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
24
+ /**
25
+ * @public
26
+ */
24
27
  export type ServiceInputTypes = AnalyzeDocumentCommandInput | AnalyzeExpenseCommandInput | AnalyzeIDCommandInput | DetectDocumentTextCommandInput | GetDocumentAnalysisCommandInput | GetDocumentTextDetectionCommandInput | GetExpenseAnalysisCommandInput | GetLendingAnalysisCommandInput | GetLendingAnalysisSummaryCommandInput | StartDocumentAnalysisCommandInput | StartDocumentTextDetectionCommandInput | StartExpenseAnalysisCommandInput | StartLendingAnalysisCommandInput;
28
+ /**
29
+ * @public
30
+ */
25
31
  export type ServiceOutputTypes = AnalyzeDocumentCommandOutput | AnalyzeExpenseCommandOutput | AnalyzeIDCommandOutput | DetectDocumentTextCommandOutput | GetDocumentAnalysisCommandOutput | GetDocumentTextDetectionCommandOutput | GetExpenseAnalysisCommandOutput | GetLendingAnalysisCommandOutput | GetLendingAnalysisSummaryCommandOutput | StartDocumentAnalysisCommandOutput | StartDocumentTextDetectionCommandOutput | StartExpenseAnalysisCommandOutput | StartLendingAnalysisCommandOutput;
32
+ /**
33
+ * @public
34
+ */
26
35
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
27
36
  /**
28
37
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
29
38
  */
30
39
  requestHandler?: __HttpHandler;
31
40
  /**
32
- * A constructor for a class implementing the {@link __Checksum} interface
41
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
33
42
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
34
43
  * @internal
35
44
  */
@@ -119,23 +128,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
119
128
  */
120
129
  logger?: __Logger;
121
130
  /**
122
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
131
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
123
132
  */
124
133
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
125
134
  }
135
+ /**
136
+ * @public
137
+ */
126
138
  type TextractClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
127
139
  /**
128
- * The configuration interface of TextractClient class constructor that set the region, credentials and other options.
140
+ * @public
141
+ *
142
+ * The configuration interface of TextractClient class constructor that set the region, credentials and other options.
129
143
  */
130
144
  export interface TextractClientConfig extends TextractClientConfigType {
131
145
  }
146
+ /**
147
+ * @public
148
+ */
132
149
  type TextractClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
133
150
  /**
134
- * The resolved configuration interface of TextractClient class. This is resolved and normalized from the {@link TextractClientConfig | constructor configuration interface}.
151
+ * @public
152
+ *
153
+ * The resolved configuration interface of TextractClient class. This is resolved and normalized from the {@link TextractClientConfig | constructor configuration interface}.
135
154
  */
136
155
  export interface TextractClientResolvedConfig extends TextractClientResolvedConfigType {
137
156
  }
138
157
  /**
158
+ * @public
139
159
  * <p>Amazon Textract detects and analyzes text in documents and converts it
140
160
  * into machine-readable text. This is the API reference documentation for
141
161
  * Amazon Textract.</p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AnalyzeDocumentRequest, AnalyzeDocumentResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AnalyzeDocumentCommand}.
8
10
  */
9
11
  export interface AnalyzeDocumentCommandInput extends AnalyzeDocumentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AnalyzeDocumentCommand}.
13
17
  */
14
18
  export interface AnalyzeDocumentCommandOutput extends AnalyzeDocumentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Analyzes an input document for relationships between detected items. </p>
18
23
  * <p>The types of information returned are as follows: </p>
19
24
  * <ul>
@@ -50,11 +55,9 @@ export interface AnalyzeDocumentCommandOutput extends AnalyzeDocumentResponse, _
50
55
  * score.</p>
51
56
  * </li>
52
57
  * </ul>
53
- *
54
58
  * <p>Selection elements such as check boxes and option buttons (radio buttons) can be
55
59
  * detected in form data and in tables. A SELECTION_ELEMENT <code>Block</code> object contains
56
60
  * information about a selection element, including the selection status.</p>
57
- *
58
61
  * <p>You can choose which type of analysis to perform by specifying the
59
62
  * <code>FeatureTypes</code> list. </p>
60
63
  * <p>The output is returned in a list of <code>Block</code> objects.</p>
@@ -73,6 +76,8 @@ export interface AnalyzeDocumentCommandOutput extends AnalyzeDocumentResponse, _
73
76
  * const response = await client.send(command);
74
77
  * ```
75
78
  *
79
+ * @param AnalyzeDocumentCommandInput - {@link AnalyzeDocumentCommandInput}
80
+ * @returns {@link AnalyzeDocumentCommandOutput}
76
81
  * @see {@link AnalyzeDocumentCommandInput} for command's `input` shape.
77
82
  * @see {@link AnalyzeDocumentCommandOutput} for command's `response` shape.
78
83
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -125,11 +130,20 @@ export interface AnalyzeDocumentCommandOutput extends AnalyzeDocumentResponse, _
125
130
  export declare class AnalyzeDocumentCommand extends $Command<AnalyzeDocumentCommandInput, AnalyzeDocumentCommandOutput, TextractClientResolvedConfig> {
126
131
  readonly input: AnalyzeDocumentCommandInput;
127
132
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
133
+ /**
134
+ * @public
135
+ */
128
136
  constructor(input: AnalyzeDocumentCommandInput);
129
137
  /**
130
138
  * @internal
131
139
  */
132
140
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AnalyzeDocumentCommandInput, AnalyzeDocumentCommandOutput>;
141
+ /**
142
+ * @internal
143
+ */
133
144
  private serialize;
145
+ /**
146
+ * @internal
147
+ */
134
148
  private deserialize;
135
149
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AnalyzeExpenseRequest, AnalyzeExpenseResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AnalyzeExpenseCommand}.
8
10
  */
9
11
  export interface AnalyzeExpenseCommandInput extends AnalyzeExpenseRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AnalyzeExpenseCommand}.
13
17
  */
14
18
  export interface AnalyzeExpenseCommandOutput extends AnalyzeExpenseResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>
18
23
  * <code>AnalyzeExpense</code> synchronously analyzes an input document for financially
19
24
  * related relationships between text.</p>
@@ -42,6 +47,8 @@ export interface AnalyzeExpenseCommandOutput extends AnalyzeExpenseResponse, __M
42
47
  * const response = await client.send(command);
43
48
  * ```
44
49
  *
50
+ * @param AnalyzeExpenseCommandInput - {@link AnalyzeExpenseCommandInput}
51
+ * @returns {@link AnalyzeExpenseCommandOutput}
45
52
  * @see {@link AnalyzeExpenseCommandInput} for command's `input` shape.
46
53
  * @see {@link AnalyzeExpenseCommandOutput} for command's `response` shape.
47
54
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -91,11 +98,20 @@ export interface AnalyzeExpenseCommandOutput extends AnalyzeExpenseResponse, __M
91
98
  export declare class AnalyzeExpenseCommand extends $Command<AnalyzeExpenseCommandInput, AnalyzeExpenseCommandOutput, TextractClientResolvedConfig> {
92
99
  readonly input: AnalyzeExpenseCommandInput;
93
100
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
101
+ /**
102
+ * @public
103
+ */
94
104
  constructor(input: AnalyzeExpenseCommandInput);
95
105
  /**
96
106
  * @internal
97
107
  */
98
108
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AnalyzeExpenseCommandInput, AnalyzeExpenseCommandOutput>;
109
+ /**
110
+ * @internal
111
+ */
99
112
  private serialize;
113
+ /**
114
+ * @internal
115
+ */
100
116
  private deserialize;
101
117
  }
@@ -4,19 +4,24 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AnalyzeIDRequest, AnalyzeIDResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AnalyzeIDCommand}.
8
10
  */
9
11
  export interface AnalyzeIDCommandInput extends AnalyzeIDRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AnalyzeIDCommand}.
13
17
  */
14
18
  export interface AnalyzeIDCommandOutput extends AnalyzeIDResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Analyzes identity documents for relevant information. This information is extracted and
18
23
  * returned as <code>IdentityDocumentFields</code>, which records both the normalized field
19
- * and value of the extracted text.Unlike other Amazon Textract operations,
24
+ * and value of the extracted text. Unlike other Amazon Textract operations,
20
25
  * <code>AnalyzeID</code> doesn't return any Geometry data.</p>
21
26
  * @example
22
27
  * Use a bare-bones client and the command you need to make an API call.
@@ -28,6 +33,8 @@ export interface AnalyzeIDCommandOutput extends AnalyzeIDResponse, __MetadataBea
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param AnalyzeIDCommandInput - {@link AnalyzeIDCommandInput}
37
+ * @returns {@link AnalyzeIDCommandOutput}
31
38
  * @see {@link AnalyzeIDCommandInput} for command's `input` shape.
32
39
  * @see {@link AnalyzeIDCommandOutput} for command's `response` shape.
33
40
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -77,11 +84,20 @@ export interface AnalyzeIDCommandOutput extends AnalyzeIDResponse, __MetadataBea
77
84
  export declare class AnalyzeIDCommand extends $Command<AnalyzeIDCommandInput, AnalyzeIDCommandOutput, TextractClientResolvedConfig> {
78
85
  readonly input: AnalyzeIDCommandInput;
79
86
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
87
+ /**
88
+ * @public
89
+ */
80
90
  constructor(input: AnalyzeIDCommandInput);
81
91
  /**
82
92
  * @internal
83
93
  */
84
94
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AnalyzeIDCommandInput, AnalyzeIDCommandOutput>;
95
+ /**
96
+ * @internal
97
+ */
85
98
  private serialize;
99
+ /**
100
+ * @internal
101
+ */
86
102
  private deserialize;
87
103
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DetectDocumentTextRequest, DetectDocumentTextResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DetectDocumentTextCommand}.
8
10
  */
9
11
  export interface DetectDocumentTextCommandInput extends DetectDocumentTextRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DetectDocumentTextCommand}.
13
17
  */
14
18
  export interface DetectDocumentTextCommandOutput extends DetectDocumentTextResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Detects text in the input document. Amazon Textract can detect lines of text and the
18
23
  * words that make up a line of text. The input document must be in one of the following image
19
24
  * formats: JPEG, PNG, PDF, or TIFF. <code>DetectDocumentText</code> returns the detected
@@ -21,7 +26,6 @@ export interface DetectDocumentTextCommandOutput extends DetectDocumentTextRespo
21
26
  * <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object
22
27
  * 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
23
28
  * a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>
24
- *
25
29
  * <p>
26
30
  * <code>DetectDocumentText</code> is a synchronous operation. To analyze documents
27
31
  * asynchronously, use <a>StartDocumentTextDetection</a>.</p>
@@ -36,6 +40,8 @@ export interface DetectDocumentTextCommandOutput extends DetectDocumentTextRespo
36
40
  * const response = await client.send(command);
37
41
  * ```
38
42
  *
43
+ * @param DetectDocumentTextCommandInput - {@link DetectDocumentTextCommandInput}
44
+ * @returns {@link DetectDocumentTextCommandOutput}
39
45
  * @see {@link DetectDocumentTextCommandInput} for command's `input` shape.
40
46
  * @see {@link DetectDocumentTextCommandOutput} for command's `response` shape.
41
47
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -85,11 +91,20 @@ export interface DetectDocumentTextCommandOutput extends DetectDocumentTextRespo
85
91
  export declare class DetectDocumentTextCommand extends $Command<DetectDocumentTextCommandInput, DetectDocumentTextCommandOutput, TextractClientResolvedConfig> {
86
92
  readonly input: DetectDocumentTextCommandInput;
87
93
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
94
+ /**
95
+ * @public
96
+ */
88
97
  constructor(input: DetectDocumentTextCommandInput);
89
98
  /**
90
99
  * @internal
91
100
  */
92
101
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DetectDocumentTextCommandInput, DetectDocumentTextCommandOutput>;
102
+ /**
103
+ * @internal
104
+ */
93
105
  private serialize;
106
+ /**
107
+ * @internal
108
+ */
94
109
  private deserialize;
95
110
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetDocumentAnalysisRequest, GetDocumentAnalysisResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDocumentAnalysisCommand}.
8
10
  */
9
11
  export interface GetDocumentAnalysisCommandInput extends GetDocumentAnalysisRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDocumentAnalysisCommand}.
13
17
  */
14
18
  export interface GetDocumentAnalysisCommandOutput extends GetDocumentAnalysisResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a
18
23
  * document.</p>
19
24
  * <p>You start asynchronous text analysis by calling <a>StartDocumentAnalysis</a>,
@@ -57,19 +62,15 @@ export interface GetDocumentAnalysisCommandOutput extends GetDocumentAnalysisRes
57
62
  * score.</p>
58
63
  * </li>
59
64
  * </ul>
60
- *
61
65
  * <note>
62
66
  * <p>While processing a document with queries, look out for
63
67
  * <code>INVALID_REQUEST_PARAMETERS</code> output. This indicates that either the per
64
68
  * page query limit has been exceeded or that the operation is trying to query a page in
65
69
  * the document which doesn’t exist. </p>
66
70
  * </note>
67
- *
68
71
  * <p>Selection elements such as check boxes and option buttons (radio buttons) can be
69
72
  * detected in form data and in tables. A SELECTION_ELEMENT <code>Block</code> object contains
70
73
  * information about a selection element, including the selection status.</p>
71
- *
72
- *
73
74
  * <p>Use the <code>MaxResults</code> parameter to limit the number of blocks that are
74
75
  * returned. If there are more results than specified in <code>MaxResults</code>, the value of
75
76
  * <code>NextToken</code> in the operation response contains a pagination token for getting
@@ -89,6 +90,8 @@ export interface GetDocumentAnalysisCommandOutput extends GetDocumentAnalysisRes
89
90
  * const response = await client.send(command);
90
91
  * ```
91
92
  *
93
+ * @param GetDocumentAnalysisCommandInput - {@link GetDocumentAnalysisCommandInput}
94
+ * @returns {@link GetDocumentAnalysisCommandOutput}
92
95
  * @see {@link GetDocumentAnalysisCommandInput} for command's `input` shape.
93
96
  * @see {@link GetDocumentAnalysisCommandOutput} for command's `response` shape.
94
97
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -132,11 +135,20 @@ export interface GetDocumentAnalysisCommandOutput extends GetDocumentAnalysisRes
132
135
  export declare class GetDocumentAnalysisCommand extends $Command<GetDocumentAnalysisCommandInput, GetDocumentAnalysisCommandOutput, TextractClientResolvedConfig> {
133
136
  readonly input: GetDocumentAnalysisCommandInput;
134
137
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
138
+ /**
139
+ * @public
140
+ */
135
141
  constructor(input: GetDocumentAnalysisCommandInput);
136
142
  /**
137
143
  * @internal
138
144
  */
139
145
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDocumentAnalysisCommandInput, GetDocumentAnalysisCommandOutput>;
146
+ /**
147
+ * @internal
148
+ */
140
149
  private serialize;
150
+ /**
151
+ * @internal
152
+ */
141
153
  private deserialize;
142
154
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetDocumentTextDetectionRequest, GetDocumentTextDetectionResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDocumentTextDetectionCommand}.
8
10
  */
9
11
  export interface GetDocumentTextDetectionCommandInput extends GetDocumentTextDetectionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDocumentTextDetectionCommand}.
13
17
  */
14
18
  export interface GetDocumentTextDetectionCommandOutput extends GetDocumentTextDetectionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
18
23
  * Amazon Textract can detect lines of text and the words that make up a line of text.</p>
19
24
  * <p>You start asynchronous text detection by calling <a>StartDocumentTextDetection</a>, which returns a job identifier
@@ -30,7 +35,6 @@ export interface GetDocumentTextDetectionCommandOutput extends GetDocumentTextDe
30
35
  * <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object
31
36
  * 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
32
37
  * a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>
33
- *
34
38
  * <p>Use the MaxResults parameter to limit the number of blocks that are returned. If there
35
39
  * are more results than specified in <code>MaxResults</code>, the value of
36
40
  * <code>NextToken</code> in the operation response contains a pagination token for getting
@@ -49,6 +53,8 @@ export interface GetDocumentTextDetectionCommandOutput extends GetDocumentTextDe
49
53
  * const response = await client.send(command);
50
54
  * ```
51
55
  *
56
+ * @param GetDocumentTextDetectionCommandInput - {@link GetDocumentTextDetectionCommandInput}
57
+ * @returns {@link GetDocumentTextDetectionCommandOutput}
52
58
  * @see {@link GetDocumentTextDetectionCommandInput} for command's `input` shape.
53
59
  * @see {@link GetDocumentTextDetectionCommandOutput} for command's `response` shape.
54
60
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -92,11 +98,20 @@ export interface GetDocumentTextDetectionCommandOutput extends GetDocumentTextDe
92
98
  export declare class GetDocumentTextDetectionCommand extends $Command<GetDocumentTextDetectionCommandInput, GetDocumentTextDetectionCommandOutput, TextractClientResolvedConfig> {
93
99
  readonly input: GetDocumentTextDetectionCommandInput;
94
100
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
101
+ /**
102
+ * @public
103
+ */
95
104
  constructor(input: GetDocumentTextDetectionCommandInput);
96
105
  /**
97
106
  * @internal
98
107
  */
99
108
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDocumentTextDetectionCommandInput, GetDocumentTextDetectionCommandOutput>;
109
+ /**
110
+ * @internal
111
+ */
100
112
  private serialize;
113
+ /**
114
+ * @internal
115
+ */
101
116
  private deserialize;
102
117
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetExpenseAnalysisRequest, GetExpenseAnalysisResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetExpenseAnalysisCommand}.
8
10
  */
9
11
  export interface GetExpenseAnalysisCommandInput extends GetExpenseAnalysisRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetExpenseAnalysisCommand}.
13
17
  */
14
18
  export interface GetExpenseAnalysisCommandOutput extends GetExpenseAnalysisResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and
18
23
  * receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input
19
24
  * invoices and receipts.</p>
@@ -41,6 +46,8 @@ export interface GetExpenseAnalysisCommandOutput extends GetExpenseAnalysisRespo
41
46
  * const response = await client.send(command);
42
47
  * ```
43
48
  *
49
+ * @param GetExpenseAnalysisCommandInput - {@link GetExpenseAnalysisCommandInput}
50
+ * @returns {@link GetExpenseAnalysisCommandOutput}
44
51
  * @see {@link GetExpenseAnalysisCommandInput} for command's `input` shape.
45
52
  * @see {@link GetExpenseAnalysisCommandOutput} for command's `response` shape.
46
53
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -84,11 +91,20 @@ export interface GetExpenseAnalysisCommandOutput extends GetExpenseAnalysisRespo
84
91
  export declare class GetExpenseAnalysisCommand extends $Command<GetExpenseAnalysisCommandInput, GetExpenseAnalysisCommandOutput, TextractClientResolvedConfig> {
85
92
  readonly input: GetExpenseAnalysisCommandInput;
86
93
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
94
+ /**
95
+ * @public
96
+ */
87
97
  constructor(input: GetExpenseAnalysisCommandInput);
88
98
  /**
89
99
  * @internal
90
100
  */
91
101
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetExpenseAnalysisCommandInput, GetExpenseAnalysisCommandOutput>;
102
+ /**
103
+ * @internal
104
+ */
92
105
  private serialize;
106
+ /**
107
+ * @internal
108
+ */
93
109
  private deserialize;
94
110
  }