@aws-sdk/client-textract 3.296.0 → 3.297.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.
@@ -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>
@@ -74,6 +76,7 @@ export declare class Textract extends TextractClient {
74
76
  analyzeDocument(args: AnalyzeDocumentCommandInput, cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void): void;
75
77
  analyzeDocument(args: AnalyzeDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void): void;
76
78
  /**
79
+ * @public
77
80
  * <p>
78
81
  * <code>AnalyzeExpense</code> synchronously analyzes an input document for financially
79
82
  * related relationships between text.</p>
@@ -97,6 +100,7 @@ export declare class Textract extends TextractClient {
97
100
  analyzeExpense(args: AnalyzeExpenseCommandInput, cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void): void;
98
101
  analyzeExpense(args: AnalyzeExpenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void): void;
99
102
  /**
103
+ * @public
100
104
  * <p>Analyzes identity documents for relevant information. This information is extracted and
101
105
  * returned as <code>IdentityDocumentFields</code>, which records both the normalized field
102
106
  * and value of the extracted text.Unlike other Amazon Textract operations,
@@ -106,6 +110,7 @@ export declare class Textract extends TextractClient {
106
110
  analyzeID(args: AnalyzeIDCommandInput, cb: (err: any, data?: AnalyzeIDCommandOutput) => void): void;
107
111
  analyzeID(args: AnalyzeIDCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AnalyzeIDCommandOutput) => void): void;
108
112
  /**
113
+ * @public
109
114
  * <p>Detects text in the input document. Amazon Textract can detect lines of text and the
110
115
  * words that make up a line of text. The input document must be in one of the following image
111
116
  * formats: JPEG, PNG, PDF, or TIFF. <code>DetectDocumentText</code> returns the detected
@@ -123,6 +128,7 @@ export declare class Textract extends TextractClient {
123
128
  detectDocumentText(args: DetectDocumentTextCommandInput, cb: (err: any, data?: DetectDocumentTextCommandOutput) => void): void;
124
129
  detectDocumentText(args: DetectDocumentTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectDocumentTextCommandOutput) => void): void;
125
130
  /**
131
+ * @public
126
132
  * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a
127
133
  * document.</p>
128
134
  * <p>You start asynchronous text analysis by calling <a>StartDocumentAnalysis</a>,
@@ -193,6 +199,7 @@ export declare class Textract extends TextractClient {
193
199
  getDocumentAnalysis(args: GetDocumentAnalysisCommandInput, cb: (err: any, data?: GetDocumentAnalysisCommandOutput) => void): void;
194
200
  getDocumentAnalysis(args: GetDocumentAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentAnalysisCommandOutput) => void): void;
195
201
  /**
202
+ * @public
196
203
  * <p>Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
197
204
  * Amazon Textract can detect lines of text and the words that make up a line of text.</p>
198
205
  * <p>You start asynchronous text detection by calling <a>StartDocumentTextDetection</a>, which returns a job identifier
@@ -223,6 +230,7 @@ export declare class Textract extends TextractClient {
223
230
  getDocumentTextDetection(args: GetDocumentTextDetectionCommandInput, cb: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void): void;
224
231
  getDocumentTextDetection(args: GetDocumentTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void): void;
225
232
  /**
233
+ * @public
226
234
  * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and
227
235
  * receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input
228
236
  * invoices and receipts.</p>
@@ -245,6 +253,7 @@ export declare class Textract extends TextractClient {
245
253
  getExpenseAnalysis(args: GetExpenseAnalysisCommandInput, cb: (err: any, data?: GetExpenseAnalysisCommandOutput) => void): void;
246
254
  getExpenseAnalysis(args: GetExpenseAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExpenseAnalysisCommandOutput) => void): void;
247
255
  /**
256
+ * @public
248
257
  * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a
249
258
  * lending document. </p>
250
259
  * <p>You start asynchronous text analysis by calling <code>StartLendingAnalysis</code>,
@@ -261,6 +270,7 @@ export declare class Textract extends TextractClient {
261
270
  getLendingAnalysis(args: GetLendingAnalysisCommandInput, cb: (err: any, data?: GetLendingAnalysisCommandOutput) => void): void;
262
271
  getLendingAnalysis(args: GetLendingAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLendingAnalysisCommandOutput) => void): void;
263
272
  /**
273
+ * @public
264
274
  * <p>Gets summarized results for the <code>StartLendingAnalysis</code> operation, which analyzes
265
275
  * text in a lending document. The returned summary consists of information about documents grouped
266
276
  * together by a common document type. Information like detected signatures, page numbers, and split
@@ -278,6 +288,7 @@ export declare class Textract extends TextractClient {
278
288
  getLendingAnalysisSummary(args: GetLendingAnalysisSummaryCommandInput, cb: (err: any, data?: GetLendingAnalysisSummaryCommandOutput) => void): void;
279
289
  getLendingAnalysisSummary(args: GetLendingAnalysisSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLendingAnalysisSummaryCommandOutput) => void): void;
280
290
  /**
291
+ * @public
281
292
  * <p>Starts the asynchronous analysis of an input document for relationships between detected
282
293
  * items such as key-value pairs, tables, and selection elements.</p>
283
294
  *
@@ -301,6 +312,7 @@ export declare class Textract extends TextractClient {
301
312
  startDocumentAnalysis(args: StartDocumentAnalysisCommandInput, cb: (err: any, data?: StartDocumentAnalysisCommandOutput) => void): void;
302
313
  startDocumentAnalysis(args: StartDocumentAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDocumentAnalysisCommandOutput) => void): void;
303
314
  /**
315
+ * @public
304
316
  * <p>Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of
305
317
  * text and the words that make up a line of text.</p>
306
318
  * <p>
@@ -323,6 +335,7 @@ export declare class Textract extends TextractClient {
323
335
  startDocumentTextDetection(args: StartDocumentTextDetectionCommandInput, cb: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void): void;
324
336
  startDocumentTextDetection(args: StartDocumentTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void): void;
325
337
  /**
338
+ * @public
326
339
  * <p>Starts the asynchronous analysis of invoices or receipts for data like contact information,
327
340
  * items purchased, and vendor names.</p>
328
341
  *
@@ -344,6 +357,7 @@ export declare class Textract extends TextractClient {
344
357
  startExpenseAnalysis(args: StartExpenseAnalysisCommandInput, cb: (err: any, data?: StartExpenseAnalysisCommandOutput) => void): void;
345
358
  startExpenseAnalysis(args: StartExpenseAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExpenseAnalysisCommandOutput) => void): void;
346
359
  /**
360
+ * @public
347
361
  * <p>Starts the classification and analysis of an input document.
348
362
  * <code>StartLendingAnalysis</code> initiates the classification and analysis of a packet of
349
363
  * 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>
@@ -73,6 +78,8 @@ export interface AnalyzeDocumentCommandOutput extends AnalyzeDocumentResponse, _
73
78
  * const response = await client.send(command);
74
79
  * ```
75
80
  *
81
+ * @param AnalyzeDocumentCommandInput - {@link AnalyzeDocumentCommandInput}
82
+ * @returns {@link AnalyzeDocumentCommandOutput}
76
83
  * @see {@link AnalyzeDocumentCommandInput} for command's `input` shape.
77
84
  * @see {@link AnalyzeDocumentCommandOutput} for command's `response` shape.
78
85
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -125,11 +132,20 @@ export interface AnalyzeDocumentCommandOutput extends AnalyzeDocumentResponse, _
125
132
  export declare class AnalyzeDocumentCommand extends $Command<AnalyzeDocumentCommandInput, AnalyzeDocumentCommandOutput, TextractClientResolvedConfig> {
126
133
  readonly input: AnalyzeDocumentCommandInput;
127
134
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
135
+ /**
136
+ * @public
137
+ */
128
138
  constructor(input: AnalyzeDocumentCommandInput);
129
139
  /**
130
140
  * @internal
131
141
  */
132
142
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AnalyzeDocumentCommandInput, AnalyzeDocumentCommandOutput>;
143
+ /**
144
+ * @internal
145
+ */
133
146
  private serialize;
147
+ /**
148
+ * @internal
149
+ */
134
150
  private deserialize;
135
151
  }
@@ -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,16 +4,21 @@ 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
24
  * and value of the extracted text.Unlike other Amazon Textract operations,
@@ -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
@@ -36,6 +41,8 @@ export interface DetectDocumentTextCommandOutput extends DetectDocumentTextRespo
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param DetectDocumentTextCommandInput - {@link DetectDocumentTextCommandInput}
45
+ * @returns {@link DetectDocumentTextCommandOutput}
39
46
  * @see {@link DetectDocumentTextCommandInput} for command's `input` shape.
40
47
  * @see {@link DetectDocumentTextCommandOutput} for command's `response` shape.
41
48
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -85,11 +92,20 @@ export interface DetectDocumentTextCommandOutput extends DetectDocumentTextRespo
85
92
  export declare class DetectDocumentTextCommand extends $Command<DetectDocumentTextCommandInput, DetectDocumentTextCommandOutput, TextractClientResolvedConfig> {
86
93
  readonly input: DetectDocumentTextCommandInput;
87
94
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
95
+ /**
96
+ * @public
97
+ */
88
98
  constructor(input: DetectDocumentTextCommandInput);
89
99
  /**
90
100
  * @internal
91
101
  */
92
102
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DetectDocumentTextCommandInput, DetectDocumentTextCommandOutput>;
103
+ /**
104
+ * @internal
105
+ */
93
106
  private serialize;
107
+ /**
108
+ * @internal
109
+ */
94
110
  private deserialize;
95
111
  }
@@ -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>,
@@ -89,6 +94,8 @@ export interface GetDocumentAnalysisCommandOutput extends GetDocumentAnalysisRes
89
94
  * const response = await client.send(command);
90
95
  * ```
91
96
  *
97
+ * @param GetDocumentAnalysisCommandInput - {@link GetDocumentAnalysisCommandInput}
98
+ * @returns {@link GetDocumentAnalysisCommandOutput}
92
99
  * @see {@link GetDocumentAnalysisCommandInput} for command's `input` shape.
93
100
  * @see {@link GetDocumentAnalysisCommandOutput} for command's `response` shape.
94
101
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -132,11 +139,20 @@ export interface GetDocumentAnalysisCommandOutput extends GetDocumentAnalysisRes
132
139
  export declare class GetDocumentAnalysisCommand extends $Command<GetDocumentAnalysisCommandInput, GetDocumentAnalysisCommandOutput, TextractClientResolvedConfig> {
133
140
  readonly input: GetDocumentAnalysisCommandInput;
134
141
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
142
+ /**
143
+ * @public
144
+ */
135
145
  constructor(input: GetDocumentAnalysisCommandInput);
136
146
  /**
137
147
  * @internal
138
148
  */
139
149
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDocumentAnalysisCommandInput, GetDocumentAnalysisCommandOutput>;
150
+ /**
151
+ * @internal
152
+ */
140
153
  private serialize;
154
+ /**
155
+ * @internal
156
+ */
141
157
  private deserialize;
142
158
  }
@@ -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
@@ -49,6 +54,8 @@ export interface GetDocumentTextDetectionCommandOutput extends GetDocumentTextDe
49
54
  * const response = await client.send(command);
50
55
  * ```
51
56
  *
57
+ * @param GetDocumentTextDetectionCommandInput - {@link GetDocumentTextDetectionCommandInput}
58
+ * @returns {@link GetDocumentTextDetectionCommandOutput}
52
59
  * @see {@link GetDocumentTextDetectionCommandInput} for command's `input` shape.
53
60
  * @see {@link GetDocumentTextDetectionCommandOutput} for command's `response` shape.
54
61
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -92,11 +99,20 @@ export interface GetDocumentTextDetectionCommandOutput extends GetDocumentTextDe
92
99
  export declare class GetDocumentTextDetectionCommand extends $Command<GetDocumentTextDetectionCommandInput, GetDocumentTextDetectionCommandOutput, TextractClientResolvedConfig> {
93
100
  readonly input: GetDocumentTextDetectionCommandInput;
94
101
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
102
+ /**
103
+ * @public
104
+ */
95
105
  constructor(input: GetDocumentTextDetectionCommandInput);
96
106
  /**
97
107
  * @internal
98
108
  */
99
109
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDocumentTextDetectionCommandInput, GetDocumentTextDetectionCommandOutput>;
110
+ /**
111
+ * @internal
112
+ */
100
113
  private serialize;
114
+ /**
115
+ * @internal
116
+ */
101
117
  private deserialize;
102
118
  }
@@ -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
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetLendingAnalysisRequest, GetLendingAnalysisResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetLendingAnalysisCommand}.
8
10
  */
9
11
  export interface GetLendingAnalysisCommandInput extends GetLendingAnalysisRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetLendingAnalysisCommand}.
13
17
  */
14
18
  export interface GetLendingAnalysisCommandOutput extends GetLendingAnalysisResponse, __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
  * lending document. </p>
19
24
  * <p>You start asynchronous text analysis by calling <code>StartLendingAnalysis</code>,
@@ -35,6 +40,8 @@ export interface GetLendingAnalysisCommandOutput extends GetLendingAnalysisRespo
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param GetLendingAnalysisCommandInput - {@link GetLendingAnalysisCommandInput}
44
+ * @returns {@link GetLendingAnalysisCommandOutput}
38
45
  * @see {@link GetLendingAnalysisCommandInput} for command's `input` shape.
39
46
  * @see {@link GetLendingAnalysisCommandOutput} for command's `response` shape.
40
47
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -78,11 +85,20 @@ export interface GetLendingAnalysisCommandOutput extends GetLendingAnalysisRespo
78
85
  export declare class GetLendingAnalysisCommand extends $Command<GetLendingAnalysisCommandInput, GetLendingAnalysisCommandOutput, TextractClientResolvedConfig> {
79
86
  readonly input: GetLendingAnalysisCommandInput;
80
87
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
81
91
  constructor(input: GetLendingAnalysisCommandInput);
82
92
  /**
83
93
  * @internal
84
94
  */
85
95
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetLendingAnalysisCommandInput, GetLendingAnalysisCommandOutput>;
96
+ /**
97
+ * @internal
98
+ */
86
99
  private serialize;
100
+ /**
101
+ * @internal
102
+ */
87
103
  private deserialize;
88
104
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetLendingAnalysisSummaryRequest, GetLendingAnalysisSummaryResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetLendingAnalysisSummaryCommand}.
8
10
  */
9
11
  export interface GetLendingAnalysisSummaryCommandInput extends GetLendingAnalysisSummaryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetLendingAnalysisSummaryCommand}.
13
17
  */
14
18
  export interface GetLendingAnalysisSummaryCommandOutput extends GetLendingAnalysisSummaryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets summarized results for the <code>StartLendingAnalysis</code> operation, which analyzes
18
23
  * text in a lending document. The returned summary consists of information about documents grouped
19
24
  * together by a common document type. Information like detected signatures, page numbers, and split
@@ -36,6 +41,8 @@ export interface GetLendingAnalysisSummaryCommandOutput extends GetLendingAnalys
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param GetLendingAnalysisSummaryCommandInput - {@link GetLendingAnalysisSummaryCommandInput}
45
+ * @returns {@link GetLendingAnalysisSummaryCommandOutput}
39
46
  * @see {@link GetLendingAnalysisSummaryCommandInput} for command's `input` shape.
40
47
  * @see {@link GetLendingAnalysisSummaryCommandOutput} for command's `response` shape.
41
48
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -79,11 +86,20 @@ export interface GetLendingAnalysisSummaryCommandOutput extends GetLendingAnalys
79
86
  export declare class GetLendingAnalysisSummaryCommand extends $Command<GetLendingAnalysisSummaryCommandInput, GetLendingAnalysisSummaryCommandOutput, TextractClientResolvedConfig> {
80
87
  readonly input: GetLendingAnalysisSummaryCommandInput;
81
88
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
89
+ /**
90
+ * @public
91
+ */
82
92
  constructor(input: GetLendingAnalysisSummaryCommandInput);
83
93
  /**
84
94
  * @internal
85
95
  */
86
96
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetLendingAnalysisSummaryCommandInput, GetLendingAnalysisSummaryCommandOutput>;
97
+ /**
98
+ * @internal
99
+ */
87
100
  private serialize;
101
+ /**
102
+ * @internal
103
+ */
88
104
  private deserialize;
89
105
  }