Skip to content

Commit 26b4368

Browse files
more decription of enumerations
1 parent 3e9b9a3 commit 26b4368

1 file changed

Lines changed: 42 additions & 40 deletions

File tree

content/en/docs/appstore/connectors/aws/aws-textract.md

Lines changed: 42 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -146,11 +146,11 @@ The domain model is a data model that describes the information in your applicat
146146

147147
| Name | Description |
148148
| --- | --- |
149-
| `Block` | This generalization entity holds information for items that are recognized in a document within a group of pixels close to each other.<br><br>The attribute it contains are `BlockType`, `ColumnIndex`, `ColumnSpan`, `Confidence`, `EntityTypes`, `_Id`, `Page`, `RowIndex`, `RowSpan`, `SelectionStatus`, `Text` and `TextType`. The `BlockType` describes the type of text item that's recognized, the `ColumnIndex` describes the column in which a table appears the first column position is 1, the second column position is 2 and so on), the `ColumnSpan` describes the number of columns that a table cell spans, the Confidence describes the score that Amazon Textract has in the accuracy of the recognized text, the `EntityTypes` describes the type of entity, the `Page` describes the page on which a block was detected, the `RowIndex` describes the row in which a table cell is located (the first row position is 1, the second row position is 2, and so on), the `RowSpan` describes the number of rows that a table cell spans, the `SelectionStatus` describes the selection status of a selection element (such as an option, radio or checkbox), the `Text` describes the word or line of text that is recognized by Amazon Textract and `TextType` describes the kind of text that Amazon Textract has detected (handwritten/printed).<br><br>Additionally, this entity contains a list of `Relationship` objects, a specialized `Geometry` object (`BlockGeometry`) and if the action involved a query a `QueryBlock` object. |
149+
| `Block` | This generalization entity holds information for items that are recognized in a document within a group of pixels close to each other. The attribute it contains are `BlockType`, `ColumnIndex`, `ColumnSpan`, `Confidence`, `EntityTypes`, `_Id`, `Page`, `RowIndex`, `RowSpan`, `SelectionStatus`, `Text` and `TextType`. The `BlockType` describes the type of text item that's recognized, the `ColumnIndex` describes the column in which a table appears the first column position is 1, the second column position is 2 and so on), the `ColumnSpan` describes the number of columns that a table cell spans, the Confidence describes the score that Amazon Textract has in the accuracy of the recognized text, the `EntityTypes` describes the type of entity, the `Page` describes the page on which a block was detected, the `RowIndex` describes the row in which a table cell is located (the first row position is 1, the second row position is 2, and so on), the `RowSpan` describes the number of rows that a table cell spans, the `SelectionStatus` describes the selection status of a selection element (such as an option, radio or checkbox), the `Text` describes the word or line of text that is recognized by Amazon Textract and `TextType` describes the kind of text that Amazon Textract has detected (handwritten/printed). Additionally, this entity contains a list of `Relationship` objects, a specialized `Geometry` object (`BlockGeometry`) and if the action involved a query a `QueryBlock` object. |
150150
| `Geometry` | This generalization entity holds information for the location of identified information on a document page: detected page, text, key-value pairs, tables, table cells and selection elements. Additionally, it contains a list of `Point` objects and a `BoundingBox` object. |
151151
| `Point` | This entity holds information of the location of a fine-grained polygon of a recognized item. The attribute it contains are X and Y. The X describes the X-coordinate for a point on a polygon and the Y describes the Y-coordinate for a point on a polygon. |
152152
| `BoundingBox` | This entity holds information for an axis-aligned coarse representation of the location of the recognized item on the document page. The attribute it contains are `Height`, `Left`, `Top` and `Width`. The `Height` describes height of the bounding box as a ratio of the overall document page height, the `Left` describes the left coordinate of the bounding box as a ratio of the overall document page width, the `Top` describes the top coordinate of the bounding box as a ratio of the overall document page height and `Width` describes the width of the bounding box as a ratio of the overall document page width. |
153-
| `Relationship` | Contains the relationship type of a block entity to another block entity<br><br>This entity holds information about how blocks are related to each other. The attribute it contains is `RelationshipType` which describes the type of relationships for all blocks in the `BlockId`'s array. This is represented as a list of `BlockId` objects. |
153+
| `Relationship` | Contains the relationship type of a block entity to another block entity This entity holds information about how blocks are related to each other. The attribute it contains is `RelationshipType` which describes the type of relationships for all blocks in the `BlockId`'s array. This is represented as a list of `BlockId` objects. |
154154
| `BlockId` | This entity holds information for blocks that are related by each other. The attribute it contains is `_Id` which reflects the identification of the block. |
155155
| `QueryBlock` | This entity holds information for the results of the search query. The attribute it contains is `Text` which describes the value matched to the search query. Additionally, it contains a list of `PagesSearched` objects. |
156156
| `PagesSearched` | This entity holds information for identifying which pages have been searched. |
@@ -163,33 +163,35 @@ The domain model is a data model that describes the information in your applicat
163163

164164
### 4.2 Enumerations {#enumerations}
165165

166-
An enumeration is a predefined list of values that can be used as an attribute type.
166+
An enumeration is a predefined list of values that can be used as an attribute type. For more information, see [Enumerations](/refguide/enumerations/).
167167

168168
#### 4.2.1 RelationshipType
169169

170-
| Name | Caption |
171-
| --- | --- |
172-
| `VALUE` | VALUE |
173-
| `CHILD` | CHILD |
174-
| `COMPLEX_FEATURES` | COMPLEX_FEATURES |
175-
| `MERGED_CELL` | MERGED_CELL |
176-
| `TITLE` | TITLE |
177-
| `ANSWER` | ANSWER |
170+
This enumeration indicates the relationship between the current block and the other blocks in the array.
171+
172+
| Name | Caption | Description |
173+
| --- | --- | --- |
174+
| `VALUE` | VALUE | |
175+
| `CHILD` | CHILD | |
176+
| `COMPLEX_FEATURES` | COMPLEX_FEATURES | |
177+
| `MERGED_CELL` | MERGED_CELL | |
178+
| `TITLE` | TITLE | |
179+
| `ANSWER` | ANSWER | |
178180

179181
#### 4.2.2 TextType
180182

181-
| Name | Caption |
182-
| --- | --- |
183-
| `PRINTED` | PRINTED |
184-
| `HANDWRITING` | HANDWRITING |
183+
| Name | Caption | Description |
184+
| --- | --- | --- |
185+
| `PRINTED` | PRINTED | Indicates that the text is printed. |
186+
| `HANDWRITING` | HANDWRITING | Indicates that the text is handwritten. |
185187

186188
#### 4.2.3 EntityTypes
187189

188-
| Name | Caption |
189-
| --- | --- |
190-
| `KEY` | KEY |
191-
| `VALUE` | VALUE |
192-
| `COLUMN_HEADER` | COLUMN_HEADER |
190+
| Name | Caption | Description |
191+
| --- | --- | --- |
192+
| `KEY` | KEY | |
193+
| `VALUE` | VALUE | |
194+
| `COLUMN_HEADER` | COLUMN_HEADER | |
193195

194196
#### 4.2.4 AWS_Region
195197

@@ -222,30 +224,30 @@ This enumeration contains a list of supported AWS regions. For more information,
222224

223225
#### 4.2.5 BlockType
224226

225-
| Name | Caption |
226-
| --- | --- |
227-
| `CELL` | CELL |
228-
| `KEY_VALUE_SET` | KEY_VALUE_SET |
229-
| `LINE` | LINE |
230-
| `MERGED_CELL` | MERGED_CELL |
231-
| `PAGE` | PAGE |
232-
| `QUERY` | QUERY |
233-
| `QUERY_RESULT` | QUERY_RESULT |
234-
| `SELECTION_ELEMENT` | SELECTION_ELEMENT |
235-
| `TABLE` | TABLE |
236-
| `TITLE` | TITLE |
237-
| `WORD` | WORD |
227+
| Name | Caption | Description |
228+
| --- | --- | --- |
229+
| `CELL` | CELL | |
230+
| `KEY_VALUE_SET` | KEY_VALUE_SET | |
231+
| `LINE` | LINE | |
232+
| `MERGED_CELL` | MERGED_CELL | |
233+
| `PAGE` | PAGE | |
234+
| `QUERY` | QUERY | |
235+
| `QUERY_RESULT` | QUERY_RESULT | |
236+
| `SELECTION_ELEMENT` | SELECTION_ELEMENT | |
237+
| `TABLE` | TABLE | |
238+
| `TITLE` | TITLE | |
239+
| `WORD` | WORD | |
238240

239241
#### 4.2.6 SelectionStatus
240242

241-
| Name | Caption |
242-
| --- | --- |
243-
| `SELECTED` | SELECTED |
244-
| `NOT_SELECTED` | NOT_SELECTED |
243+
| Name | Caption | Description |
244+
| --- | --- | --- |
245+
| `SELECTED` | SELECTED | |
246+
| `NOT_SELECTED` | NOT_SELECTED | |
245247

246248
### 4.3 Activities {#activities}
247249

248-
Activities define the actions that are executed in a microflow or a nanoflow. For the Amazon Textract connector, they represent actions such as analyzing a document or expense.
250+
Activities define the actions that are executed in a microflow or a nanoflow. For the Amazon Textract connector, they represent actions such as analyzing a document or expense. For more information, see [Activities](/refguide/activities/).
249251

250252
#### 4.3.1 AnalyzeDocument {#analyzedocument}
251253

@@ -266,7 +268,7 @@ This activity returns a `AnalyzeDocumentResponse` object with objects from the f
266268
| Name | Generalization | Documentation |
267269
| --- | --- | --- |
268270
| `AnalyzeDocumentResponse` | | This entity is the response for the Amazon Textract `AnalyzeDocument` action. It contains a list of specialized Block objects (`AnalyzeDocumentBlock`). |
269-
| `AnalyzeDocumentBlock` | `AmazonTextractConnector.Block` | This entity holds information for items that are recognized in a document within a group of pixels close to each other.<br><br>The attribute it contains are `BlockType`, `ColumnIndex`, `ColumnSpan`, `Confidence`, `EntityTypes`, `_Id`, `Page`, `RowIndex`, `RowSpan`, `SelectionStatus`, `Text` and `TextType`. The `BlockType` describes the type of text item that's recognized, the `ColumnIndex` describes the column in which a table appears the first column position is 1, the second column position is 2 and so on), the `ColumnSpan` describes the number of columns that a table cell spans, the `Confidence` describes the score that Amazon Textract has in the accuracy of the recognized text, the `EntityTypes` describes the type of entity, the `Page` describes the page on which a block was detected, the `RowIndex` describes the row in which a table cell is located (the first row position is 1, the second row position is 2, and so on), the `RowSpan` describes the number of rows that a table cell spans, the `SelectionStatus` describes the selection status of a selection element (such as an option, radio or checkbox), the Text describes the word or line of text that's recognized by Amazon Textract and `TextType` describes the kind of text that Amazon Textract has detected (handwritten/printed).<br><br>Additionally, this entity contains a list of `Relationship` objects, a `QueryBlock` object and a specialized `Geometry` object (`BlockGeometry`). |
271+
| `AnalyzeDocumentBlock` | `AmazonTextractConnector.Block` | This entity holds information for items that are recognized in a document within a group of pixels close to each other. The attribute it contains are `BlockType`, `ColumnIndex`, `ColumnSpan`, `Confidence`, `EntityTypes`, `_Id`, `Page`, `RowIndex`, `RowSpan`, `SelectionStatus`, `Text` and `TextType`. The `BlockType` describes the type of text item that's recognized, the `ColumnIndex` describes the column in which a table appears the first column position is 1, the second column position is 2 and so on), the `ColumnSpan` describes the number of columns that a table cell spans, the `Confidence` describes the score that Amazon Textract has in the accuracy of the recognized text, the `EntityTypes` describes the type of entity, the `Page` describes the page on which a block was detected, the `RowIndex` describes the row in which a table cell is located (the first row position is 1, the second row position is 2, and so on), the `RowSpan` describes the number of rows that a table cell spans, the `SelectionStatus` describes the selection status of a selection element (such as an option, radio or checkbox), the Text describes the word or line of text that's recognized by Amazon Textract and `TextType` describes the kind of text that Amazon Textract has detected (handwritten/printed). Additionally, this entity contains a list of `Relationship` objects, a `QueryBlock` object and a specialized `Geometry` object (`BlockGeometry`). |
270272

271273
#### 4.3.2 AnalyzeExpense
272274

@@ -289,4 +291,4 @@ This activity returns an `AnalyzeExpenseResponse` object with objects from the f
289291
| `LineItemGroup` | | This entity holds information for a grouping of tables which contain `LineItems`. The attribute it contains is `LineItemGroupIndex` which describes which table was detected (1 represents the first encountered table, 2 represent the second encountered table, and so on). |
290292
| `LineItemField` | | This entity holds information for a line within the given document's table. |
291293
| `LineItemExpenseField` | `AmazonTextractConnector.ExpenseField` | This specialized entity holds information for the detected expense-related information, separated into categories `Type`, `LabelDetection` and `ValueDetection`. The attribute it contains is `PageNumber`, which describes the page number on which the value was detected. Additionally, it contains a list of `GroupProperty` objects, a specialized `ExpenseDetection` object (both `ExpenseDetectionLabel` and `ExpenseDetectionValue`), an `ExpenseType` object, and a `Currency` object. |
292-
| `AnalyzeExpenseBlock` | `AmazonTextractConnector.Block` | This entity holds information for items that are recognized in a document within a group of pixels close to each other.<br><br>The attributea it contains are `BlockType`, `ColumnIndex`, `ColumnSpan`, `Confidence`, `EntityTypes`, `_Id`, `Page`, `RowIndex`, `RowSpan`, `SelectionStatus`, `Text` and `TextType`. The `BlockType` describes the type of text item that's recognized, the `ColumnIndex` describes the column in which a table appears the first column position is 1, the second column position is 2 and so on), the `ColumnSpan` describes the number of columns that a table cell spans, the `Confidence` describes the score that Amazon Textract has in the accuracy of the recognized text, the `EntityTypes` describes the type of entity, the `Page` describes the page on which a block was detected, the `RowIndex` describes the row in which a table cell is located (the first row position is 1, the second row position is 2, and so on), the `RowSpan` describes the number of rows that a table cell spans, the `SelectionStatus` describes the selection status of a selection element (such as an option, radio or checkbox), the `Text` describes the word or line of text that's recognized by Amazon Textract and `TextType` describes the kind of text that Amazon Textract has detected (handwritten or printed).<br><br>Additionally, this entity contains a list of `Relationship` objects and a specialized Geometry object (`BlockGeometry`). |
294+
| `AnalyzeExpenseBlock` | `AmazonTextractConnector.Block` | This entity holds information for items that are recognized in a document within a group of pixels close to each other. The attributea it contains are `BlockType`, `ColumnIndex`, `ColumnSpan`, `Confidence`, `EntityTypes`, `_Id`, `Page`, `RowIndex`, `RowSpan`, `SelectionStatus`, `Text` and `TextType`. The `BlockType` describes the type of text item that's recognized, the `ColumnIndex` describes the column in which a table appears the first column position is 1, the second column position is 2 and so on), the `ColumnSpan` describes the number of columns that a table cell spans, the `Confidence` describes the score that Amazon Textract has in the accuracy of the recognized text, the `EntityTypes` describes the type of entity, the `Page` describes the page on which a block was detected, the `RowIndex` describes the row in which a table cell is located (the first row position is 1, the second row position is 2, and so on), the `RowSpan` describes the number of rows that a table cell spans, the `SelectionStatus` describes the selection status of a selection element (such as an option, radio or checkbox), the `Text` describes the word or line of text that's recognized by Amazon Textract and `TextType` describes the kind of text that Amazon Textract has detected (handwritten or printed). Additionally, this entity contains a list of `Relationship` objects and a specialized Geometry object (`BlockGeometry`). |

0 commit comments

Comments
 (0)