From 10647e5f19a92345980f1f81a65c5003469a8da9 Mon Sep 17 00:00:00 2001
From: awstools
Date: Wed, 27 Sep 2023 18:15:10 +0000
Subject: [PATCH] feat(client-textract): This release adds new feature - Layout
to Analyze Document API which can automatically extract layout elements such
as titles, paragraphs, headers, section headers, lists, page numbers,
footers, table areas, key-value areas and figure areas and order the elements
as a human would read.
---
.../src/commands/AnalyzeDocumentCommand.ts | 4 +-
.../src/commands/AnalyzeExpenseCommand.ts | 2 +-
.../src/commands/AnalyzeIDCommand.ts | 2 +-
.../src/commands/DetectDocumentTextCommand.ts | 2 +-
.../commands/GetDocumentAnalysisCommand.ts | 2 +-
.../GetDocumentTextDetectionCommand.ts | 2 +-
.../src/commands/GetExpenseAnalysisCommand.ts | 2 +-
.../src/commands/GetLendingAnalysisCommand.ts | 4 +-
.../commands/StartDocumentAnalysisCommand.ts | 2 +-
.../client-textract/src/models/models_0.ts | 27 +++++--
codegen/sdk-codegen/aws-models/textract.json | 74 ++++++++++++++++++-
11 files changed, 100 insertions(+), 23 deletions(-)
diff --git a/clients/client-textract/src/commands/AnalyzeDocumentCommand.ts b/clients/client-textract/src/commands/AnalyzeDocumentCommand.ts
index e5b71137baf2..f197ca7c02b8 100644
--- a/clients/client-textract/src/commands/AnalyzeDocumentCommand.ts
+++ b/clients/client-textract/src/commands/AnalyzeDocumentCommand.ts
@@ -100,7 +100,7 @@ export interface AnalyzeDocumentCommandOutput extends AnalyzeDocumentResponse, _
* },
* },
* FeatureTypes: [ // FeatureTypes // required
- * "TABLES" || "FORMS" || "QUERIES" || "SIGNATURES",
+ * "TABLES" || "FORMS" || "QUERIES" || "SIGNATURES" || "LAYOUT",
* ],
* HumanLoopConfig: { // HumanLoopConfig
* HumanLoopName: "STRING_VALUE", // required
@@ -131,7 +131,7 @@ export interface AnalyzeDocumentCommandOutput extends AnalyzeDocumentResponse, _
* // },
* // Blocks: [ // BlockList
* // { // Block
- * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER",
+ * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER" || "LAYOUT_TEXT" || "LAYOUT_TITLE" || "LAYOUT_HEADER" || "LAYOUT_FOOTER" || "LAYOUT_SECTION_HEADER" || "LAYOUT_PAGE_NUMBER" || "LAYOUT_LIST" || "LAYOUT_FIGURE" || "LAYOUT_TABLE" || "LAYOUT_KEY_VALUE",
* // Confidence: Number("float"),
* // Text: "STRING_VALUE",
* // TextType: "HANDWRITING" || "PRINTED",
diff --git a/clients/client-textract/src/commands/AnalyzeExpenseCommand.ts b/clients/client-textract/src/commands/AnalyzeExpenseCommand.ts
index 0825e59de15c..5727c6c4e338 100644
--- a/clients/client-textract/src/commands/AnalyzeExpenseCommand.ts
+++ b/clients/client-textract/src/commands/AnalyzeExpenseCommand.ts
@@ -205,7 +205,7 @@ export interface AnalyzeExpenseCommandOutput extends AnalyzeExpenseResponse, __M
* // ],
* // Blocks: [ // BlockList
* // { // Block
- * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER",
+ * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER" || "LAYOUT_TEXT" || "LAYOUT_TITLE" || "LAYOUT_HEADER" || "LAYOUT_FOOTER" || "LAYOUT_SECTION_HEADER" || "LAYOUT_PAGE_NUMBER" || "LAYOUT_LIST" || "LAYOUT_FIGURE" || "LAYOUT_TABLE" || "LAYOUT_KEY_VALUE",
* // Confidence: Number("float"),
* // Text: "STRING_VALUE",
* // TextType: "HANDWRITING" || "PRINTED",
diff --git a/clients/client-textract/src/commands/AnalyzeIDCommand.ts b/clients/client-textract/src/commands/AnalyzeIDCommand.ts
index f6cc59e5211c..876a68ec0a1c 100644
--- a/clients/client-textract/src/commands/AnalyzeIDCommand.ts
+++ b/clients/client-textract/src/commands/AnalyzeIDCommand.ts
@@ -87,7 +87,7 @@ export interface AnalyzeIDCommandOutput extends AnalyzeIDResponse, __MetadataBea
* // ],
* // Blocks: [ // BlockList
* // { // Block
- * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER",
+ * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER" || "LAYOUT_TEXT" || "LAYOUT_TITLE" || "LAYOUT_HEADER" || "LAYOUT_FOOTER" || "LAYOUT_SECTION_HEADER" || "LAYOUT_PAGE_NUMBER" || "LAYOUT_LIST" || "LAYOUT_FIGURE" || "LAYOUT_TABLE" || "LAYOUT_KEY_VALUE",
* // Confidence: Number("float"),
* // Text: "STRING_VALUE",
* // TextType: "HANDWRITING" || "PRINTED",
diff --git a/clients/client-textract/src/commands/DetectDocumentTextCommand.ts b/clients/client-textract/src/commands/DetectDocumentTextCommand.ts
index 105b7cb9f0d7..0bbc4272850e 100644
--- a/clients/client-textract/src/commands/DetectDocumentTextCommand.ts
+++ b/clients/client-textract/src/commands/DetectDocumentTextCommand.ts
@@ -72,7 +72,7 @@ export interface DetectDocumentTextCommandOutput extends DetectDocumentTextRespo
* // },
* // Blocks: [ // BlockList
* // { // Block
- * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER",
+ * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER" || "LAYOUT_TEXT" || "LAYOUT_TITLE" || "LAYOUT_HEADER" || "LAYOUT_FOOTER" || "LAYOUT_SECTION_HEADER" || "LAYOUT_PAGE_NUMBER" || "LAYOUT_LIST" || "LAYOUT_FIGURE" || "LAYOUT_TABLE" || "LAYOUT_KEY_VALUE",
* // Confidence: Number("float"),
* // Text: "STRING_VALUE",
* // TextType: "HANDWRITING" || "PRINTED",
diff --git a/clients/client-textract/src/commands/GetDocumentAnalysisCommand.ts b/clients/client-textract/src/commands/GetDocumentAnalysisCommand.ts
index 76940ef6aaed..869d8a4ad305 100644
--- a/clients/client-textract/src/commands/GetDocumentAnalysisCommand.ts
+++ b/clients/client-textract/src/commands/GetDocumentAnalysisCommand.ts
@@ -119,7 +119,7 @@ export interface GetDocumentAnalysisCommandOutput extends GetDocumentAnalysisRes
* // NextToken: "STRING_VALUE",
* // Blocks: [ // BlockList
* // { // Block
- * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER",
+ * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER" || "LAYOUT_TEXT" || "LAYOUT_TITLE" || "LAYOUT_HEADER" || "LAYOUT_FOOTER" || "LAYOUT_SECTION_HEADER" || "LAYOUT_PAGE_NUMBER" || "LAYOUT_LIST" || "LAYOUT_FIGURE" || "LAYOUT_TABLE" || "LAYOUT_KEY_VALUE",
* // Confidence: Number("float"),
* // Text: "STRING_VALUE",
* // TextType: "HANDWRITING" || "PRINTED",
diff --git a/clients/client-textract/src/commands/GetDocumentTextDetectionCommand.ts b/clients/client-textract/src/commands/GetDocumentTextDetectionCommand.ts
index e10b7a2fbf52..35f9a3cbd014 100644
--- a/clients/client-textract/src/commands/GetDocumentTextDetectionCommand.ts
+++ b/clients/client-textract/src/commands/GetDocumentTextDetectionCommand.ts
@@ -82,7 +82,7 @@ export interface GetDocumentTextDetectionCommandOutput extends GetDocumentTextDe
* // NextToken: "STRING_VALUE",
* // Blocks: [ // BlockList
* // { // Block
- * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER",
+ * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER" || "LAYOUT_TEXT" || "LAYOUT_TITLE" || "LAYOUT_HEADER" || "LAYOUT_FOOTER" || "LAYOUT_SECTION_HEADER" || "LAYOUT_PAGE_NUMBER" || "LAYOUT_LIST" || "LAYOUT_FIGURE" || "LAYOUT_TABLE" || "LAYOUT_KEY_VALUE",
* // Confidence: Number("float"),
* // Text: "STRING_VALUE",
* // TextType: "HANDWRITING" || "PRINTED",
diff --git a/clients/client-textract/src/commands/GetExpenseAnalysisCommand.ts b/clients/client-textract/src/commands/GetExpenseAnalysisCommand.ts
index 3893d6852cbb..cc05480297cd 100644
--- a/clients/client-textract/src/commands/GetExpenseAnalysisCommand.ts
+++ b/clients/client-textract/src/commands/GetExpenseAnalysisCommand.ts
@@ -201,7 +201,7 @@ export interface GetExpenseAnalysisCommandOutput extends GetExpenseAnalysisRespo
* // ],
* // Blocks: [ // BlockList
* // { // Block
- * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER",
+ * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER" || "LAYOUT_TEXT" || "LAYOUT_TITLE" || "LAYOUT_HEADER" || "LAYOUT_FOOTER" || "LAYOUT_SECTION_HEADER" || "LAYOUT_PAGE_NUMBER" || "LAYOUT_LIST" || "LAYOUT_FIGURE" || "LAYOUT_TABLE" || "LAYOUT_KEY_VALUE",
* // Confidence: Number("float"),
* // Text: "STRING_VALUE",
* // TextType: "HANDWRITING" || "PRINTED",
diff --git a/clients/client-textract/src/commands/GetLendingAnalysisCommand.ts b/clients/client-textract/src/commands/GetLendingAnalysisCommand.ts
index b03bb35f7564..a6a7a57ebc5b 100644
--- a/clients/client-textract/src/commands/GetLendingAnalysisCommand.ts
+++ b/clients/client-textract/src/commands/GetLendingAnalysisCommand.ts
@@ -214,7 +214,7 @@ export interface GetLendingAnalysisCommandOutput extends GetLendingAnalysisRespo
* // ],
* // Blocks: [ // BlockList
* // { // Block
- * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER",
+ * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER" || "LAYOUT_TEXT" || "LAYOUT_TITLE" || "LAYOUT_HEADER" || "LAYOUT_FOOTER" || "LAYOUT_SECTION_HEADER" || "LAYOUT_PAGE_NUMBER" || "LAYOUT_LIST" || "LAYOUT_FIGURE" || "LAYOUT_TABLE" || "LAYOUT_KEY_VALUE",
* // Confidence: Number("float"),
* // Text: "STRING_VALUE",
* // TextType: "HANDWRITING" || "PRINTED",
@@ -271,7 +271,7 @@ export interface GetLendingAnalysisCommandOutput extends GetLendingAnalysisRespo
* // ],
* // Blocks: [
* // {
- * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER",
+ * // BlockType: "KEY_VALUE_SET" || "PAGE" || "LINE" || "WORD" || "TABLE" || "CELL" || "SELECTION_ELEMENT" || "MERGED_CELL" || "TITLE" || "QUERY" || "QUERY_RESULT" || "SIGNATURE" || "TABLE_TITLE" || "TABLE_FOOTER" || "LAYOUT_TEXT" || "LAYOUT_TITLE" || "LAYOUT_HEADER" || "LAYOUT_FOOTER" || "LAYOUT_SECTION_HEADER" || "LAYOUT_PAGE_NUMBER" || "LAYOUT_LIST" || "LAYOUT_FIGURE" || "LAYOUT_TABLE" || "LAYOUT_KEY_VALUE",
* // Confidence: Number("float"),
* // Text: "STRING_VALUE",
* // TextType: "HANDWRITING" || "PRINTED",
diff --git a/clients/client-textract/src/commands/StartDocumentAnalysisCommand.ts b/clients/client-textract/src/commands/StartDocumentAnalysisCommand.ts
index dfcb8a5b14b5..77b5832691c4 100644
--- a/clients/client-textract/src/commands/StartDocumentAnalysisCommand.ts
+++ b/clients/client-textract/src/commands/StartDocumentAnalysisCommand.ts
@@ -69,7 +69,7 @@ export interface StartDocumentAnalysisCommandOutput extends StartDocumentAnalysi
* },
* },
* FeatureTypes: [ // FeatureTypes // required
- * "TABLES" || "FORMS" || "QUERIES" || "SIGNATURES",
+ * "TABLES" || "FORMS" || "QUERIES" || "SIGNATURES" || "LAYOUT",
* ],
* ClientRequestToken: "STRING_VALUE",
* JobTag: "STRING_VALUE",
diff --git a/clients/client-textract/src/models/models_0.ts b/clients/client-textract/src/models/models_0.ts
index 30706a54244a..3c8100e453fc 100644
--- a/clients/client-textract/src/models/models_0.ts
+++ b/clients/client-textract/src/models/models_0.ts
@@ -106,6 +106,7 @@ export interface Document {
*/
export const FeatureType = {
FORMS: "FORMS",
+ LAYOUT: "LAYOUT",
QUERIES: "QUERIES",
SIGNATURES: "SIGNATURES",
TABLES: "TABLES",
@@ -244,11 +245,12 @@ export interface AnalyzeDocumentRequest {
* @public
* A list of the types of analysis to perform. Add TABLES to the list to return information
* about the tables that are detected in the input document. Add FORMS to return detected form
- * data. Add SIGNATURES to return the locations of detected signatures. To perform both forms
- * and table analysis, add TABLES and FORMS to FeatureTypes
. To detect signatures within
- * form data and table data, add SIGNATURES to either TABLES or FORMS.
- * All lines and words detected in the document are included in the response (including text
- * that isn't related to the value of FeatureTypes
).
+ * data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list
+ * to return information about the layout of the document. To perform both forms
+ * and table analysis, add TABLES and FORMS to FeatureTypes
. To detect signatures
+ * within the document and within form data and table data, add SIGNATURES to either TABLES or
+ * FORMS. All lines and words detected in the document are included in the response (including
+ * text that isn't related to the value of FeatureTypes
).
*/
FeatureTypes: (FeatureType | string)[] | undefined;
@@ -273,6 +275,16 @@ export interface AnalyzeDocumentRequest {
export const BlockType = {
CELL: "CELL",
KEY_VALUE_SET: "KEY_VALUE_SET",
+ LAYOUT_FIGURE: "LAYOUT_FIGURE",
+ LAYOUT_FOOTER: "LAYOUT_FOOTER",
+ LAYOUT_HEADER: "LAYOUT_HEADER",
+ LAYOUT_KEY_VALUE: "LAYOUT_KEY_VALUE",
+ LAYOUT_LIST: "LAYOUT_LIST",
+ LAYOUT_PAGE_NUMBER: "LAYOUT_PAGE_NUMBER",
+ LAYOUT_SECTION_HEADER: "LAYOUT_SECTION_HEADER",
+ LAYOUT_TABLE: "LAYOUT_TABLE",
+ LAYOUT_TEXT: "LAYOUT_TEXT",
+ LAYOUT_TITLE: "LAYOUT_TITLE",
LINE: "LINE",
MERGED_CELL: "MERGED_CELL",
PAGE: "PAGE",
@@ -613,7 +625,7 @@ export interface Block {
*
*
*
- * SIGNATURE - The location and confidene score of a signature detected on a
+ * SIGNATURE - The location and confidence score of a signature detected on a
* document page. Can be returned as part of a Key-Value pair or a detected cell.
*
*
@@ -776,8 +788,7 @@ export interface Block {
* documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an
* asynchronous operation, even if it contains multiple document pages, is considered a
* single-page document. This means that for scanned images the value of Page
is
- * always 1. Synchronous operations will also return a Page
value of 1
- * because every input document is considered to be a single-page document.
+ * always 1.
*/
Page?: number;
diff --git a/codegen/sdk-codegen/aws-models/textract.json b/codegen/sdk-codegen/aws-models/textract.json
index 316e396c9b53..c47db2414faf 100644
--- a/codegen/sdk-codegen/aws-models/textract.json
+++ b/codegen/sdk-codegen/aws-models/textract.json
@@ -101,7 +101,7 @@
"FeatureTypes": {
"target": "com.amazonaws.textract#FeatureTypes",
"traits": {
- "smithy.api#documentation": "A list of the types of analysis to perform. Add TABLES to the list to return information\n about the tables that are detected in the input document. Add FORMS to return detected form\n data. Add SIGNATURES to return the locations of detected signatures. To perform both forms \n and table analysis, add TABLES and FORMS to FeatureTypes
. To detect signatures within\n form data and table data, add SIGNATURES to either TABLES or FORMS.\n All lines and words detected in the document are included in the response (including text\n that isn't related to the value of FeatureTypes
).
",
+ "smithy.api#documentation": "A list of the types of analysis to perform. Add TABLES to the list to return information\n about the tables that are detected in the input document. Add FORMS to return detected form\n data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list\n to return information about the layout of the document. To perform both forms\n and table analysis, add TABLES and FORMS to FeatureTypes
. To detect signatures\n within the document and within form data and table data, add SIGNATURES to either TABLES or\n FORMS. All lines and words detected in the document are included in the response (including\n text that isn't related to the value of FeatureTypes
).
",
"smithy.api#required": {}
}
},
@@ -353,7 +353,7 @@
"BlockType": {
"target": "com.amazonaws.textract#BlockType",
"traits": {
- "smithy.api#documentation": "The type of text item that's recognized. In operations for text detection, the following\n types are returned:
\n \n - \n
\n PAGE - Contains a list of the LINE Block
objects\n that are detected on a document page.
\n \n - \n
\n WORD - A word detected on a document page. A word is one or\n more ISO basic Latin script characters that aren't separated by spaces.
\n \n - \n
\n LINE - A string of tab-delimited, contiguous words that are\n detected on a document page.
\n \n
\n In text analysis operations, the following types are returned:
\n \n - \n
\n PAGE - Contains a list of child Block
objects\n that are detected on a document page.
\n \n - \n
\n KEY_VALUE_SET - Stores the KEY and VALUE Block
\n objects for linked text that's detected on a document page. Use the\n EntityType
field to determine if a KEY_VALUE_SET object is a KEY\n Block
object or a VALUE Block
object.
\n \n - \n
\n WORD - A word that's detected on a document page. A word is\n one or more ISO basic Latin script characters that aren't separated by spaces.
\n \n - \n
\n LINE - A string of tab-delimited, contiguous words that are\n detected on a document page.
\n \n - \n
\n TABLE - A table that's detected on a document page. A table\n is grid-based information with two or more rows or columns, with a cell span of one\n row and one column each.
\n \n - \n
\n TABLE_TITLE - The title of a table. A title is typically a\n line of text above or below a table, or embedded as the first row of a table.
\n \n - \n
\n TABLE_FOOTER - The footer associated with a table. A footer\n is typically a line or lines of text below a table or embedded as the last row of a\n table.
\n \n - \n
\n CELL - A cell within a detected table. The cell is the parent\n of the block that contains the text in the cell.
\n \n - \n
\n MERGED_CELL - A cell in a table whose content spans more than\n one row or column. The Relationships
array for this cell contain data\n from individual cells.
\n \n - \n
\n SELECTION_ELEMENT - A selection element such as an option\n button (radio button) or a check box that's detected on a document page. Use the\n value of SelectionStatus
to determine the status of the selection\n element.
\n \n - \n
\n SIGNATURE - The location and confidene score of a signature detected on a\n document page. Can be returned as part of a Key-Value pair or a detected cell.
\n \n - \n
\n QUERY - A question asked during the call of AnalyzeDocument. Contains an\n alias and an ID that attaches it to its answer.
\n \n - \n
\n QUERY_RESULT - A response to a question asked during the call\n of analyze document. Comes with an alias and ID for ease of locating in a \n response. Also contains location and confidence score.
\n \n
"
+ "smithy.api#documentation": "The type of text item that's recognized. In operations for text detection, the following\n types are returned:
\n \n - \n
\n PAGE - Contains a list of the LINE Block
objects\n that are detected on a document page.
\n \n - \n
\n WORD - A word detected on a document page. A word is one or\n more ISO basic Latin script characters that aren't separated by spaces.
\n \n - \n
\n LINE - A string of tab-delimited, contiguous words that are\n detected on a document page.
\n \n
\n In text analysis operations, the following types are returned:
\n \n - \n
\n PAGE - Contains a list of child Block
objects\n that are detected on a document page.
\n \n - \n
\n KEY_VALUE_SET - Stores the KEY and VALUE Block
\n objects for linked text that's detected on a document page. Use the\n EntityType
field to determine if a KEY_VALUE_SET object is a KEY\n Block
object or a VALUE Block
object.
\n \n - \n
\n WORD - A word that's detected on a document page. A word is\n one or more ISO basic Latin script characters that aren't separated by spaces.
\n \n - \n
\n LINE - A string of tab-delimited, contiguous words that are\n detected on a document page.
\n \n - \n
\n TABLE - A table that's detected on a document page. A table\n is grid-based information with two or more rows or columns, with a cell span of one\n row and one column each.
\n \n - \n
\n TABLE_TITLE - The title of a table. A title is typically a\n line of text above or below a table, or embedded as the first row of a table.
\n \n - \n
\n TABLE_FOOTER - The footer associated with a table. A footer\n is typically a line or lines of text below a table or embedded as the last row of a\n table.
\n \n - \n
\n CELL - A cell within a detected table. The cell is the parent\n of the block that contains the text in the cell.
\n \n - \n
\n MERGED_CELL - A cell in a table whose content spans more than\n one row or column. The Relationships
array for this cell contain data\n from individual cells.
\n \n - \n
\n SELECTION_ELEMENT - A selection element such as an option\n button (radio button) or a check box that's detected on a document page. Use the\n value of SelectionStatus
to determine the status of the selection\n element.
\n \n - \n
\n SIGNATURE - The location and confidence score of a signature detected on a\n document page. Can be returned as part of a Key-Value pair or a detected cell.
\n \n - \n
\n QUERY - A question asked during the call of AnalyzeDocument. Contains an\n alias and an ID that attaches it to its answer.
\n \n - \n
\n QUERY_RESULT - A response to a question asked during the call\n of analyze document. Comes with an alias and ID for ease of locating in a \n response. Also contains location and confidence score.
\n \n
"
}
},
"Confidence": {
@@ -431,7 +431,7 @@
"Page": {
"target": "com.amazonaws.textract#UInteger",
"traits": {
- "smithy.api#documentation": "The page on which a block was detected. Page
is returned by synchronous and\n asynchronous operations. Page values greater than 1 are only returned for multipage\n documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an\n asynchronous operation, even if it contains multiple document pages, is considered a\n single-page document. This means that for scanned images the value of Page
is\n always 1. Synchronous operations will also return a Page
value of 1\n because every input document is considered to be a single-page document.
"
+ "smithy.api#documentation": "The page on which a block was detected. Page
is returned by synchronous and\n asynchronous operations. Page values greater than 1 are only returned for multipage\n documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an\n asynchronous operation, even if it contains multiple document pages, is considered a\n single-page document. This means that for scanned images the value of Page
is\n always 1.
"
}
},
"Query": {
@@ -537,6 +537,66 @@
"traits": {
"smithy.api#enumValue": "TABLE_FOOTER"
}
+ },
+ "LAYOUT_TEXT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "LAYOUT_TEXT"
+ }
+ },
+ "LAYOUT_TITLE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "LAYOUT_TITLE"
+ }
+ },
+ "LAYOUT_HEADER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "LAYOUT_HEADER"
+ }
+ },
+ "LAYOUT_FOOTER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "LAYOUT_FOOTER"
+ }
+ },
+ "LAYOUT_SECTION_HEADER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "LAYOUT_SECTION_HEADER"
+ }
+ },
+ "LAYOUT_PAGE_NUMBER": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "LAYOUT_PAGE_NUMBER"
+ }
+ },
+ "LAYOUT_LIST": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "LAYOUT_LIST"
+ }
+ },
+ "LAYOUT_FIGURE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "LAYOUT_FIGURE"
+ }
+ },
+ "LAYOUT_TABLE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "LAYOUT_TABLE"
+ }
+ },
+ "LAYOUT_KEY_VALUE": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "LAYOUT_KEY_VALUE"
+ }
}
}
},
@@ -1127,6 +1187,12 @@
"traits": {
"smithy.api#enumValue": "SIGNATURES"
}
+ },
+ "LAYOUT": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "LAYOUT"
+ }
}
}
},
@@ -4282,4 +4348,4 @@
}
}
}
-}
\ No newline at end of file
+}