@aws-sdk/client-textract 3.199.0 → 3.201.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 (19) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/dist-cjs/endpoint/EndpointParameters.js +2 -3
  3. package/dist-cjs/models/models_0.js +10 -2
  4. package/dist-cjs/protocols/Aws_json1_1.js +47 -11
  5. package/dist-cjs/runtimeConfig.browser.js +16 -16
  6. package/dist-cjs/runtimeConfig.js +20 -19
  7. package/dist-cjs/runtimeConfig.native.js +1 -2
  8. package/dist-cjs/runtimeConfig.shared.js +8 -11
  9. package/dist-es/models/models_0.js +6 -0
  10. package/dist-es/protocols/Aws_json1_1.js +40 -0
  11. package/dist-types/Textract.d.ts +80 -51
  12. package/dist-types/commands/AnalyzeDocumentCommand.d.ts +23 -15
  13. package/dist-types/commands/AnalyzeExpenseCommand.d.ts +8 -5
  14. package/dist-types/commands/AnalyzeIDCommand.d.ts +4 -4
  15. package/dist-types/commands/DetectDocumentTextCommand.d.ts +3 -2
  16. package/dist-types/commands/GetDocumentAnalysisCommand.d.ts +42 -25
  17. package/dist-types/models/models_0.d.ts +127 -28
  18. package/dist-types/ts3.4/models/models_0.d.ts +18 -0
  19. package/package.json +33 -33
package/dist-types/Textract.d.ts CHANGED
@@ -17,7 +17,7 @@ import { TextractClient } from "./TextractClient";
17
17
  */
18
18
  export declare class Textract extends TextractClient {
19
19
  /**
20
- * <p>Analyzes an input document for relationships between detected items. </p>
20
+ * <p>Analyzes an input document for relationships between detected items. </p>
21
21
  * <p>The types of information returned are as follows: </p>
22
22
  * <ul>
23
23
  * <li>
@@ -28,49 +28,60 @@ export declare class Textract extends TextractClient {
28
28
  * the value.</p>
29
29
  * </li>
30
30
  * <li>
31
- * <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL
32
- * <code>Block</code> object is returned for each cell in a table.</p>
31
+ * <p>Table and table cell data. A TABLE <code>Block</code> object contains information
32
+ * about a detected table. A CELL <code>Block</code> object is returned for each cell in
33
+ * a table.</p>
33
34
  * </li>
34
35
  * <li>
35
- * <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> objects.
36
- * All lines and words that are detected in the document are returned (including text that doesn't have a
37
- * relationship with the value of <code>FeatureTypes</code>). </p>
36
+ * <p>Lines and words of text. A LINE <code>Block</code> object contains one or more
37
+ * WORD <code>Block</code> objects. All lines and words that are detected in the
38
+ * document are returned (including text that doesn't have a relationship with the value
39
+ * of <code>FeatureTypes</code>). </p>
38
40
  * </li>
39
41
  * <li>
40
- * <p>Queries.A QUERIES_RESULT Block object contains the answer to the query, the alias associated and an ID that
41
- * connect it to the query asked. This Block also contains a location and attached confidence score.</p>
42
+ * <p>Query. A QUERY Block object contains the query text, alias and link to the
43
+ * associated Query results block object.</p>
44
+ * </li>
45
+ * <li>
46
+ * <p>Query Result. A QUERY_RESULT Block object contains the answer to the query and an
47
+ * ID that connects it to the query asked. This Block also contains a confidence
48
+ * score.</p>
42
49
  * </li>
43
50
  * </ul>
44
51
  *
45
- * <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.
46
- * A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,
47
- * including the selection status.</p>
52
+ * <p>Selection elements such as check boxes and option buttons (radio buttons) can be
53
+ * detected in form data and in tables. A SELECTION_ELEMENT <code>Block</code> object contains
54
+ * information about a selection element, including the selection status.</p>
48
55
  *
49
- * <p>You can choose which type of analysis to perform by specifying the <code>FeatureTypes</code> list.
50
- * </p>
56
+ * <p>You can choose which type of analysis to perform by specifying the
57
+ * <code>FeatureTypes</code> list. </p>
51
58
  * <p>The output is returned in a list of <code>Block</code> objects.</p>
52
59
  * <p>
53
60
  * <code>AnalyzeDocument</code> is a synchronous operation. To analyze documents
54
- * asynchronously, use <a>StartDocumentAnalysis</a>.</p>
55
- * <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>
61
+ * asynchronously, use <a>StartDocumentAnalysis</a>.</p>
62
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text
63
+ * Analysis</a>.</p>
56
64
  */
57
65
  analyzeDocument(args: AnalyzeDocumentCommandInput, options?: __HttpHandlerOptions): Promise<AnalyzeDocumentCommandOutput>;
58
66
  analyzeDocument(args: AnalyzeDocumentCommandInput, cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void): void;
59
67
  analyzeDocument(args: AnalyzeDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void): void;
60
68
  /**
61
69
  * <p>
62
- * <code>AnalyzeExpense</code> synchronously analyzes an input document for financially related relationships between text.</p>
63
- * <p>Information is returned as <code>ExpenseDocuments</code> and seperated as follows.</p>
70
+ * <code>AnalyzeExpense</code> synchronously analyzes an input document for financially
71
+ * related relationships between text.</p>
72
+ * <p>Information is returned as <code>ExpenseDocuments</code> and seperated as
73
+ * follows:</p>
64
74
  * <ul>
65
75
  * <li>
66
76
  * <p>
67
77
  * <code>LineItemGroups</code>- A data set containing <code>LineItems</code> which
68
- * store information about the lines of text, such as an item purchased and its price on a receipt.</p>
78
+ * store information about the lines of text, such as an item purchased and its price on
79
+ * a receipt.</p>
69
80
  * </li>
70
81
  * <li>
71
82
  * <p>
72
- * <code>SummaryFields</code>- Contains all other information a receipt, such as header information
73
- * or the vendors name.</p>
83
+ * <code>SummaryFields</code>- Contains all other information a receipt, such as
84
+ * header information or the vendors name.</p>
74
85
  * </li>
75
86
  * </ul>
76
87
  */
@@ -78,18 +89,19 @@ export declare class Textract extends TextractClient {
78
89
  analyzeExpense(args: AnalyzeExpenseCommandInput, cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void): void;
79
90
  analyzeExpense(args: AnalyzeExpenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void): void;
80
91
  /**
81
- * <p>Analyzes identity documents for relevant information. This information is extracted
82
- * and returned as <code>IdentityDocumentFields</code>, which records both the normalized
83
- * field and value of the extracted text.Unlike other Amazon Textract operations, <code>AnalyzeID</code>
84
- * doesn't return any Geometry data.</p>
92
+ * <p>Analyzes identity documents for relevant information. This information is extracted and
93
+ * returned as <code>IdentityDocumentFields</code>, which records both the normalized field
94
+ * and value of the extracted text.Unlike other Amazon Textract operations,
95
+ * <code>AnalyzeID</code> doesn't return any Geometry data.</p>
85
96
  */
86
97
  analyzeID(args: AnalyzeIDCommandInput, options?: __HttpHandlerOptions): Promise<AnalyzeIDCommandOutput>;
87
98
  analyzeID(args: AnalyzeIDCommandInput, cb: (err: any, data?: AnalyzeIDCommandOutput) => void): void;
88
99
  analyzeID(args: AnalyzeIDCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AnalyzeIDCommandOutput) => void): void;
89
100
  /**
90
101
  * <p>Detects text in the input document. Amazon Textract can detect lines of text and the
91
- * words that make up a line of text. The input document must be an image in JPEG, PNG, PDF, or TIFF
92
- * format. <code>DetectDocumentText</code> returns the detected text in an array of <a>Block</a> objects. </p>
102
+ * words that make up a line of text. The input document must be in one of the following image
103
+ * formats: JPEG, PNG, PDF, or TIFF. <code>DetectDocumentText</code> returns the detected
104
+ * text in an array of <a>Block</a> objects. </p>
93
105
  * <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object
94
106
  * 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
95
107
  * a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>
@@ -103,44 +115,60 @@ export declare class Textract extends TextractClient {
103
115
  detectDocumentText(args: DetectDocumentTextCommandInput, cb: (err: any, data?: DetectDocumentTextCommandOutput) => void): void;
104
116
  detectDocumentText(args: DetectDocumentTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectDocumentTextCommandOutput) => void): void;
105
117
  /**
106
- * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.</p>
107
- * <p>You start asynchronous text analysis by calling <a>StartDocumentAnalysis</a>, which returns a job identifier
108
- * (<code>JobId</code>). When the text analysis operation finishes, Amazon Textract publishes a
109
- * completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to
110
- * <code>StartDocumentAnalysis</code>. To get the results of the text-detection operation,
111
- * first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
112
- * If so, call <code>GetDocumentAnalysis</code>, and pass the job identifier
113
- * (<code>JobId</code>) from the initial call to <code>StartDocumentAnalysis</code>.</p>
118
+ * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a
119
+ * document.</p>
120
+ * <p>You start asynchronous text analysis by calling <a>StartDocumentAnalysis</a>,
121
+ * which returns a job identifier (<code>JobId</code>). When the text analysis operation
122
+ * finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic
123
+ * that's registered in the initial call to <code>StartDocumentAnalysis</code>. To get the
124
+ * results of the text-detection operation, first check that the status value published to the
125
+ * Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <code>GetDocumentAnalysis</code>, and
126
+ * pass the job identifier (<code>JobId</code>) from the initial call to
127
+ * <code>StartDocumentAnalysis</code>.</p>
114
128
  * <p>
115
- * <code>GetDocumentAnalysis</code> returns an array of <a>Block</a> objects. The following
116
- * types of information are returned: </p>
129
+ * <code>GetDocumentAnalysis</code> returns an array of <a>Block</a> objects.
130
+ * The following types of information are returned: </p>
117
131
  * <ul>
118
132
  * <li>
119
133
  * <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
120
- * <code>Block</code> object and a VALUE <code>Block</code> object. For example,
121
- * <i>Name: Ana Silva Carolina</i> contains a key and value.
122
- * <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is
123
- * the value.</p>
134
+ * <code>Block</code> object and a VALUE <code>Block</code> object. For example,
135
+ * <i>Name: Ana Silva Carolina</i> contains a key and value.
136
+ * <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is
137
+ * the value.</p>
124
138
  * </li>
125
139
  * <li>
126
- * <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL
127
- * <code>Block</code> object is returned for each cell in a table.</p>
140
+ * <p>Table and table cell data. A TABLE <code>Block</code> object contains information
141
+ * about a detected table. A CELL <code>Block</code> object is returned for each cell in
142
+ * a table.</p>
128
143
  * </li>
129
144
  * <li>
130
- * <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> objects.
131
- * All lines and words that are detected in the document are returned (including text that doesn't have a
132
- * relationship with the value of the <code>StartDocumentAnalysis</code>
145
+ * <p>Lines and words of text. A LINE <code>Block</code> object contains one or more
146
+ * WORD <code>Block</code> objects. All lines and words that are detected in the
147
+ * document are returned (including text that doesn't have a relationship with the value
148
+ * of the <code>StartDocumentAnalysis</code>
133
149
  * <code>FeatureTypes</code> input parameter). </p>
134
150
  * </li>
135
151
  * <li>
136
- * <p>Queries. A QUERIES_RESULT Block object contains the answer to the query, the alias associated and an ID that
137
- * connect it to the query asked. This Block also contains a location and attached confidence score</p>
152
+ * <p>Query. A QUERY Block object contains the query text, alias and link to the
153
+ * associated Query results block object.</p>
154
+ * </li>
155
+ * <li>
156
+ * <p>Query Results. A QUERY_RESULT Block object contains the answer to the query and an
157
+ * ID that connects it to the query asked. This Block also contains a confidence
158
+ * score.</p>
138
159
  * </li>
139
160
  * </ul>
140
161
  *
141
- * <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.
142
- * A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,
143
- * including the selection status.</p>
162
+ * <note>
163
+ * <p>While processing a document with queries, look out for
164
+ * <code>INVALID_REQUEST_PARAMETERS</code> output. This indicates that either the per
165
+ * page query limit has been exceeded or that the operation is trying to query a page in
166
+ * the document which doesn’t exist. </p>
167
+ * </note>
168
+ *
169
+ * <p>Selection elements such as check boxes and option buttons (radio buttons) can be
170
+ * detected in form data and in tables. A SELECTION_ELEMENT <code>Block</code> object contains
171
+ * information about a selection element, including the selection status.</p>
144
172
  *
145
173
  *
146
174
  * <p>Use the <code>MaxResults</code> parameter to limit the number of blocks that are
@@ -150,7 +178,8 @@ export declare class Textract extends TextractClient {
150
178
  * <code>GetDocumentAnalysis</code>, and populate the <code>NextToken</code> request
151
179
  * parameter with the token value that's returned from the previous call to
152
180
  * <code>GetDocumentAnalysis</code>.</p>
153
- * <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>
181
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text
182
+ * Analysis</a>.</p>
154
183
  */
155
184
  getDocumentAnalysis(args: GetDocumentAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<GetDocumentAnalysisCommandOutput>;
156
185
  getDocumentAnalysis(args: GetDocumentAnalysisCommandInput, cb: (err: any, data?: GetDocumentAnalysisCommandOutput) => void): void;
package/dist-types/commands/AnalyzeDocumentCommand.d.ts CHANGED
@@ -8,7 +8,7 @@ export interface AnalyzeDocumentCommandInput extends AnalyzeDocumentRequest {
8
8
  export interface AnalyzeDocumentCommandOutput extends AnalyzeDocumentResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Analyzes an input document for relationships between detected items. </p>
11
+ * <p>Analyzes an input document for relationships between detected items. </p>
12
12
  * <p>The types of information returned are as follows: </p>
13
13
  * <ul>
14
14
  * <li>
@@ -19,31 +19,39 @@ export interface AnalyzeDocumentCommandOutput extends AnalyzeDocumentResponse, _
19
19
  * the value.</p>
20
20
  * </li>
21
21
  * <li>
22
- * <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL
23
- * <code>Block</code> object is returned for each cell in a table.</p>
22
+ * <p>Table and table cell data. A TABLE <code>Block</code> object contains information
23
+ * about a detected table. A CELL <code>Block</code> object is returned for each cell in
24
+ * a table.</p>
24
25
  * </li>
25
26
  * <li>
26
- * <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> objects.
27
- * All lines and words that are detected in the document are returned (including text that doesn't have a
28
- * relationship with the value of <code>FeatureTypes</code>). </p>
27
+ * <p>Lines and words of text. A LINE <code>Block</code> object contains one or more
28
+ * WORD <code>Block</code> objects. All lines and words that are detected in the
29
+ * document are returned (including text that doesn't have a relationship with the value
30
+ * of <code>FeatureTypes</code>). </p>
29
31
  * </li>
30
32
  * <li>
31
- * <p>Queries.A QUERIES_RESULT Block object contains the answer to the query, the alias associated and an ID that
32
- * connect it to the query asked. This Block also contains a location and attached confidence score.</p>
33
+ * <p>Query. A QUERY Block object contains the query text, alias and link to the
34
+ * associated Query results block object.</p>
35
+ * </li>
36
+ * <li>
37
+ * <p>Query Result. A QUERY_RESULT Block object contains the answer to the query and an
38
+ * ID that connects it to the query asked. This Block also contains a confidence
39
+ * score.</p>
33
40
  * </li>
34
41
  * </ul>
35
42
  *
36
- * <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.
37
- * A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,
38
- * including the selection status.</p>
43
+ * <p>Selection elements such as check boxes and option buttons (radio buttons) can be
44
+ * detected in form data and in tables. A SELECTION_ELEMENT <code>Block</code> object contains
45
+ * information about a selection element, including the selection status.</p>
39
46
  *
40
- * <p>You can choose which type of analysis to perform by specifying the <code>FeatureTypes</code> list.
41
- * </p>
47
+ * <p>You can choose which type of analysis to perform by specifying the
48
+ * <code>FeatureTypes</code> list. </p>
42
49
  * <p>The output is returned in a list of <code>Block</code> objects.</p>
43
50
  * <p>
44
51
  * <code>AnalyzeDocument</code> is a synchronous operation. To analyze documents
45
- * asynchronously, use <a>StartDocumentAnalysis</a>.</p>
46
- * <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>
52
+ * asynchronously, use <a>StartDocumentAnalysis</a>.</p>
53
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text
54
+ * Analysis</a>.</p>
47
55
  * @example
48
56
  * Use a bare-bones client and the command you need to make an API call.
49
57
  * ```javascript
package/dist-types/commands/AnalyzeExpenseCommand.d.ts CHANGED
@@ -9,18 +9,21 @@ export interface AnalyzeExpenseCommandOutput extends AnalyzeExpenseResponse, __M
9
9
  }
10
10
  /**
11
11
  * <p>
12
- * <code>AnalyzeExpense</code> synchronously analyzes an input document for financially related relationships between text.</p>
13
- * <p>Information is returned as <code>ExpenseDocuments</code> and seperated as follows.</p>
12
+ * <code>AnalyzeExpense</code> synchronously analyzes an input document for financially
13
+ * related relationships between text.</p>
14
+ * <p>Information is returned as <code>ExpenseDocuments</code> and seperated as
15
+ * follows:</p>
14
16
  * <ul>
15
17
  * <li>
16
18
  * <p>
17
19
  * <code>LineItemGroups</code>- A data set containing <code>LineItems</code> which
18
- * store information about the lines of text, such as an item purchased and its price on a receipt.</p>
20
+ * store information about the lines of text, such as an item purchased and its price on
21
+ * a receipt.</p>
19
22
  * </li>
20
23
  * <li>
21
24
  * <p>
22
- * <code>SummaryFields</code>- Contains all other information a receipt, such as header information
23
- * or the vendors name.</p>
25
+ * <code>SummaryFields</code>- Contains all other information a receipt, such as
26
+ * header information or the vendors name.</p>
24
27
  * </li>
25
28
  * </ul>
26
29
  * @example
package/dist-types/commands/AnalyzeIDCommand.d.ts CHANGED
@@ -8,10 +8,10 @@ export interface AnalyzeIDCommandInput extends AnalyzeIDRequest {
8
8
  export interface AnalyzeIDCommandOutput extends AnalyzeIDResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Analyzes identity documents for relevant information. This information is extracted
12
- * and returned as <code>IdentityDocumentFields</code>, which records both the normalized
13
- * field and value of the extracted text.Unlike other Amazon Textract operations, <code>AnalyzeID</code>
14
- * doesn't return any Geometry data.</p>
11
+ * <p>Analyzes identity documents for relevant information. This information is extracted and
12
+ * returned as <code>IdentityDocumentFields</code>, which records both the normalized field
13
+ * and value of the extracted text.Unlike other Amazon Textract operations,
14
+ * <code>AnalyzeID</code> doesn't return any Geometry data.</p>
15
15
  * @example
16
16
  * Use a bare-bones client and the command you need to make an API call.
17
17
  * ```javascript
package/dist-types/commands/DetectDocumentTextCommand.d.ts CHANGED
@@ -9,8 +9,9 @@ export interface DetectDocumentTextCommandOutput extends DetectDocumentTextRespo
9
9
  }
10
10
  /**
11
11
  * <p>Detects text in the input document. Amazon Textract can detect lines of text and the
12
- * words that make up a line of text. The input document must be an image in JPEG, PNG, PDF, or TIFF
13
- * format. <code>DetectDocumentText</code> returns the detected text in an array of <a>Block</a> objects. </p>
12
+ * words that make up a line of text. The input document must be in one of the following image
13
+ * formats: JPEG, PNG, PDF, or TIFF. <code>DetectDocumentText</code> returns the detected
14
+ * text in an array of <a>Block</a> objects. </p>
14
15
  * <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object
15
16
  * 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
16
17
  * a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>
package/dist-types/commands/GetDocumentAnalysisCommand.d.ts CHANGED
@@ -8,44 +8,60 @@ export interface GetDocumentAnalysisCommandInput extends GetDocumentAnalysisRequ
8
8
  export interface GetDocumentAnalysisCommandOutput extends GetDocumentAnalysisResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.</p>
12
- * <p>You start asynchronous text analysis by calling <a>StartDocumentAnalysis</a>, which returns a job identifier
13
- * (<code>JobId</code>). When the text analysis operation finishes, Amazon Textract publishes a
14
- * completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to
15
- * <code>StartDocumentAnalysis</code>. To get the results of the text-detection operation,
16
- * first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
17
- * If so, call <code>GetDocumentAnalysis</code>, and pass the job identifier
18
- * (<code>JobId</code>) from the initial call to <code>StartDocumentAnalysis</code>.</p>
11
+ * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a
12
+ * document.</p>
13
+ * <p>You start asynchronous text analysis by calling <a>StartDocumentAnalysis</a>,
14
+ * which returns a job identifier (<code>JobId</code>). When the text analysis operation
15
+ * finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic
16
+ * that's registered in the initial call to <code>StartDocumentAnalysis</code>. To get the
17
+ * results of the text-detection operation, first check that the status value published to the
18
+ * Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <code>GetDocumentAnalysis</code>, and
19
+ * pass the job identifier (<code>JobId</code>) from the initial call to
20
+ * <code>StartDocumentAnalysis</code>.</p>
19
21
  * <p>
20
- * <code>GetDocumentAnalysis</code> returns an array of <a>Block</a> objects. The following
21
- * types of information are returned: </p>
22
+ * <code>GetDocumentAnalysis</code> returns an array of <a>Block</a> objects.
23
+ * The following types of information are returned: </p>
22
24
  * <ul>
23
25
  * <li>
24
26
  * <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
25
- * <code>Block</code> object and a VALUE <code>Block</code> object. For example,
26
- * <i>Name: Ana Silva Carolina</i> contains a key and value.
27
- * <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is
28
- * the value.</p>
27
+ * <code>Block</code> object and a VALUE <code>Block</code> object. For example,
28
+ * <i>Name: Ana Silva Carolina</i> contains a key and value.
29
+ * <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is
30
+ * the value.</p>
29
31
  * </li>
30
32
  * <li>
31
- * <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL
32
- * <code>Block</code> object is returned for each cell in a table.</p>
33
+ * <p>Table and table cell data. A TABLE <code>Block</code> object contains information
34
+ * about a detected table. A CELL <code>Block</code> object is returned for each cell in
35
+ * a table.</p>
33
36
  * </li>
34
37
  * <li>
35
- * <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> objects.
36
- * All lines and words that are detected in the document are returned (including text that doesn't have a
37
- * relationship with the value of the <code>StartDocumentAnalysis</code>
38
+ * <p>Lines and words of text. A LINE <code>Block</code> object contains one or more
39
+ * WORD <code>Block</code> objects. All lines and words that are detected in the
40
+ * document are returned (including text that doesn't have a relationship with the value
41
+ * of the <code>StartDocumentAnalysis</code>
38
42
  * <code>FeatureTypes</code> input parameter). </p>
39
43
  * </li>
40
44
  * <li>
41
- * <p>Queries. A QUERIES_RESULT Block object contains the answer to the query, the alias associated and an ID that
42
- * connect it to the query asked. This Block also contains a location and attached confidence score</p>
45
+ * <p>Query. A QUERY Block object contains the query text, alias and link to the
46
+ * associated Query results block object.</p>
47
+ * </li>
48
+ * <li>
49
+ * <p>Query Results. A QUERY_RESULT Block object contains the answer to the query and an
50
+ * ID that connects it to the query asked. This Block also contains a confidence
51
+ * score.</p>
43
52
  * </li>
44
53
  * </ul>
45
54
  *
46
- * <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.
47
- * A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,
48
- * including the selection status.</p>
55
+ * <note>
56
+ * <p>While processing a document with queries, look out for
57
+ * <code>INVALID_REQUEST_PARAMETERS</code> output. This indicates that either the per
58
+ * page query limit has been exceeded or that the operation is trying to query a page in
59
+ * the document which doesn’t exist. </p>
60
+ * </note>
61
+ *
62
+ * <p>Selection elements such as check boxes and option buttons (radio buttons) can be
63
+ * detected in form data and in tables. A SELECTION_ELEMENT <code>Block</code> object contains
64
+ * information about a selection element, including the selection status.</p>
49
65
  *
50
66
  *
51
67
  * <p>Use the <code>MaxResults</code> parameter to limit the number of blocks that are
@@ -55,7 +71,8 @@ export interface GetDocumentAnalysisCommandOutput extends GetDocumentAnalysisRes
55
71
  * <code>GetDocumentAnalysis</code>, and populate the <code>NextToken</code> request
56
72
  * parameter with the token value that's returned from the previous call to
57
73
  * <code>GetDocumentAnalysis</code>.</p>
58
- * <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>
74
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text
75
+ * Analysis</a>.</p>
59
76
  * @example
60
77
  * Use a bare-bones client and the command you need to make an API call.
61
78
  * ```javascript