2022/11/17 - Amazon Textract - 8 updated api methods
Changes This release adds support for specifying and extracting information from documents using the Signatures feature within Analyze Document API
{'FeatureTypes': {'SIGNATURES'}}
Response {'Blocks': {'BlockType': {'SIGNATURE'}}}
Analyzes an input document for relationships between detected items.
The types of information returned are as follows:
Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET : a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of FeatureTypes ).
Signatures. A SIGNATURE Block object contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table.
Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.
Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.
Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.
You can choose which type of analysis to perform by specifying the FeatureTypes list.
The output is returned in a list of Block objects.
AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis .
For more information, see Document Text Analysis .
See also: AWS API Documentation
Request Syntax
client.analyze_document(
Document={
'Bytes': b'bytes',
'S3Object': {
'Bucket': 'string',
'Name': 'string',
'Version': 'string'
}
},
FeatureTypes=[
'TABLES'|'FORMS'|'QUERIES'|'SIGNATURES',
],
HumanLoopConfig={
'HumanLoopName': 'string',
'FlowDefinitionArn': 'string',
'DataAttributes': {
'ContentClassifiers': [
'FreeOfPersonallyIdentifiableInformation'|'FreeOfAdultContent',
]
}
},
QueriesConfig={
'Queries': [
{
'Text': 'string',
'Alias': 'string',
'Pages': [
'string',
]
},
]
}
)
dict
[REQUIRED]
The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.
Bytes (bytes) --
A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.
S3Object (dict) --
Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.
Bucket (string) --
The name of the S3 bucket. Note that the # character is not valid in the file name.
Name (string) --
The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.
Version (string) --
If the bucket has versioning enabled, you can specify the object version.
list
[REQUIRED]
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 ).
(string) --
dict
Sets the configuration for the human in the loop workflow for analyzing documents.
HumanLoopName (string) -- [REQUIRED]
The name of the human workflow used for this image. This should be kept unique within a region.
FlowDefinitionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the flow definition.
DataAttributes (dict) --
Sets attributes of the input data.
ContentClassifiers (list) --
Sets whether the input image is free of personally identifiable information or adult content.
(string) --
dict
Contains Queries and the alias for those Queries, as determined by the input.
Queries (list) -- [REQUIRED]
(dict) --
Each query contains the question you want to ask in the Text and the alias you want to associate.
Text (string) -- [REQUIRED]
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
Alias (string) --
Alias attached to the query, for ease of location.
Pages (list) --
Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.
If a page is not specified, it is set to ["1"] by default.
The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - * . No whitespace is allowed.
When using * to indicate all pages, it must be the only element in the list.
You can use page intervals, such as [“1-3”, “1-1”, “4-*”] . Where * indicates last page of document.
Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
(string) --
dict
Response Syntax
{
'DocumentMetadata': {
'Pages': 123
},
'Blocks': [
{
'BlockType': 'KEY_VALUE_SET'|'PAGE'|'LINE'|'WORD'|'TABLE'|'CELL'|'SELECTION_ELEMENT'|'MERGED_CELL'|'TITLE'|'QUERY'|'QUERY_RESULT'|'SIGNATURE',
'Confidence': ...,
'Text': 'string',
'TextType': 'HANDWRITING'|'PRINTED',
'RowIndex': 123,
'ColumnIndex': 123,
'RowSpan': 123,
'ColumnSpan': 123,
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Id': 'string',
'Relationships': [
{
'Type': 'VALUE'|'CHILD'|'COMPLEX_FEATURES'|'MERGED_CELL'|'TITLE'|'ANSWER',
'Ids': [
'string',
]
},
],
'EntityTypes': [
'KEY'|'VALUE'|'COLUMN_HEADER',
],
'SelectionStatus': 'SELECTED'|'NOT_SELECTED',
'Page': 123,
'Query': {
'Text': 'string',
'Alias': 'string',
'Pages': [
'string',
]
}
},
],
'HumanLoopActivationOutput': {
'HumanLoopArn': 'string',
'HumanLoopActivationReasons': [
'string',
],
'HumanLoopActivationConditionsEvaluationResults': 'string'
},
'AnalyzeDocumentModelVersion': 'string'
}
Response Structure
(dict) --
DocumentMetadata (dict) --
Metadata about the analyzed document. An example is the number of pages.
Pages (integer) --
The number of pages that are detected in the document.
Blocks (list) --
The items that are detected and analyzed by AnalyzeDocument .
(dict) --
A Block represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block object depends on the type of operation. In text detection for documents (for example DetectDocumentText ), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument ), you can also get information about the fields, tables, and selection elements that are detected in the document.
An array of Block objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText , the array of Block objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis , the array is returned over one or more responses.
For more information, see How Amazon Textract Works .
BlockType (string) --
The type of text item that's recognized. In operations for text detection, the following types are returned:
PAGE - Contains a list of the LINE Block objects that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:
PAGE - Contains a list of child Block objects that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
Confidence (float) --
The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
Text (string) --
The word or line of text that's recognized by Amazon Textract.
TextType (string) --
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
RowIndex (integer) --
The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnIndex (integer) --
The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
RowSpan (integer) --
The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnSpan (integer) --
The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
Geometry (dict) --
The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Id (string) --
The identifier for the recognized text. The identifier is only unique for a single operation.
Relationships (list) --
A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
0 - The block has no child blocks.
1 - The block has child blocks.
(dict) --
Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships . For more information, see Block .
The Type element provides the type of the relationship for all blocks in the IDs array.
Type (string) --
The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD . A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
Ids (list) --
An array of IDs for related blocks. You can get the type of the relationship from the Type element.
(string) --
EntityTypes (list) --
The type of entity. The following can be returned:
KEY - An identifier for a field on the document.
VALUE - The field text.
EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection .
(string) --
SelectionStatus (string) --
The selection status of a selection element, such as an option button or check box.
Page (integer) --
The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage 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 operations will also return a Page value of 1 because every input document is considered to be a single-page document.
Query (dict) --
Text (string) --
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
Alias (string) --
Alias attached to the query, for ease of location.
Pages (list) --
Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.
If a page is not specified, it is set to ["1"] by default.
The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - * . No whitespace is allowed.
When using * to indicate all pages, it must be the only element in the list.
You can use page intervals, such as [“1-3”, “1-1”, “4-*”] . Where * indicates last page of document.
Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
(string) --
HumanLoopActivationOutput (dict) --
Shows the results of the human in the loop evaluation.
HumanLoopArn (string) --
The Amazon Resource Name (ARN) of the HumanLoop created.
HumanLoopActivationReasons (list) --
Shows if and why human review was needed.
(string) --
HumanLoopActivationConditionsEvaluationResults (string) --
Shows the result of condition evaluations, including those conditions which activated a human review.
AnalyzeDocumentModelVersion (string) --
The version of the model used to analyze the document.
{'ExpenseDocuments': {'Blocks': {'BlockType': {'SIGNATURE'}}}}
AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.
Information is returned as ExpenseDocuments and seperated as follows:
LineItemGroups - A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt.
SummaryFields - Contains all other information a receipt, such as header information or the vendors name.
See also: AWS API Documentation
Request Syntax
client.analyze_expense(
Document={
'Bytes': b'bytes',
'S3Object': {
'Bucket': 'string',
'Name': 'string',
'Version': 'string'
}
}
)
dict
[REQUIRED]
The input document, either as bytes or as an S3 object.
You pass image bytes to an Amazon Textract API operation by using the Bytes property. For example, you would use the Bytes property to pass a document loaded from a local file system. Image bytes passed by using the Bytes property must be base64 encoded. Your code might not need to encode document file bytes if you're using an AWS SDK to call Amazon Textract API operations.
You pass images stored in an S3 bucket to an Amazon Textract API operation by using the S3Object property. Documents stored in an S3 bucket don't need to be base64 encoded.
The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations.
If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property.
For Amazon Textract to process an S3 object, the user must have permission to access the S3 object.
Bytes (bytes) --
A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.
S3Object (dict) --
Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.
Bucket (string) --
The name of the S3 bucket. Note that the # character is not valid in the file name.
Name (string) --
The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.
Version (string) --
If the bucket has versioning enabled, you can specify the object version.
dict
Response Syntax
{
'DocumentMetadata': {
'Pages': 123
},
'ExpenseDocuments': [
{
'ExpenseIndex': 123,
'SummaryFields': [
{
'Type': {
'Text': 'string',
'Confidence': ...
},
'LabelDetection': {
'Text': 'string',
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Confidence': ...
},
'ValueDetection': {
'Text': 'string',
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Confidence': ...
},
'PageNumber': 123,
'Currency': {
'Code': 'string',
'Confidence': ...
},
'GroupProperties': [
{
'Types': [
'string',
],
'Id': 'string'
},
]
},
],
'LineItemGroups': [
{
'LineItemGroupIndex': 123,
'LineItems': [
{
'LineItemExpenseFields': [
{
'Type': {
'Text': 'string',
'Confidence': ...
},
'LabelDetection': {
'Text': 'string',
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Confidence': ...
},
'ValueDetection': {
'Text': 'string',
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Confidence': ...
},
'PageNumber': 123,
'Currency': {
'Code': 'string',
'Confidence': ...
},
'GroupProperties': [
{
'Types': [
'string',
],
'Id': 'string'
},
]
},
]
},
]
},
],
'Blocks': [
{
'BlockType': 'KEY_VALUE_SET'|'PAGE'|'LINE'|'WORD'|'TABLE'|'CELL'|'SELECTION_ELEMENT'|'MERGED_CELL'|'TITLE'|'QUERY'|'QUERY_RESULT'|'SIGNATURE',
'Confidence': ...,
'Text': 'string',
'TextType': 'HANDWRITING'|'PRINTED',
'RowIndex': 123,
'ColumnIndex': 123,
'RowSpan': 123,
'ColumnSpan': 123,
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Id': 'string',
'Relationships': [
{
'Type': 'VALUE'|'CHILD'|'COMPLEX_FEATURES'|'MERGED_CELL'|'TITLE'|'ANSWER',
'Ids': [
'string',
]
},
],
'EntityTypes': [
'KEY'|'VALUE'|'COLUMN_HEADER',
],
'SelectionStatus': 'SELECTED'|'NOT_SELECTED',
'Page': 123,
'Query': {
'Text': 'string',
'Alias': 'string',
'Pages': [
'string',
]
}
},
]
},
]
}
Response Structure
(dict) --
DocumentMetadata (dict) --
Information about the input document.
Pages (integer) --
The number of pages that are detected in the document.
ExpenseDocuments (list) --
The expenses detected by Amazon Textract.
(dict) --
The structure holding all the information returned by AnalyzeExpense
ExpenseIndex (integer) --
Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.
SummaryFields (list) --
Any information found outside of a table by Amazon Textract.
(dict) --
Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection
Type (dict) --
The implied label of a detected element. Present alongside LabelDetection for explicit elements.
Text (string) --
The word or line of text detected by Amazon Textract.
Confidence (float) --
The confidence of accuracy, as a percentage.
LabelDetection (dict) --
The explicitly stated label of a detected element.
Text (string) --
The word or line of text recognized by Amazon Textract
Geometry (dict) --
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Confidence (float) --
The confidence in detection, as a percentage
ValueDetection (dict) --
The value of a detected element. Present in explicit and implicit elements.
Text (string) --
The word or line of text recognized by Amazon Textract
Geometry (dict) --
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Confidence (float) --
The confidence in detection, as a percentage
PageNumber (integer) --
The page number the value was detected on.
Currency (dict) --
Shows the kind of currency, both the code and confidence associated with any monatary value detected.
Code (string) --
Currency code for detected currency. the current supported codes are:
USD
EUR
GBP
CAD
INR
JPY
CHF
AUD
CNY
BZR
SEK
HKD
Confidence (float) --
Percentage confideence in the detected currency.
GroupProperties (list) --
Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.
(dict) --
Shows the group that a certain key belongs to. This helps differentiate between names and addresses for different organizations, that can be hard to determine via JSON response.
Types (list) --
Informs you on whether the expense group is a name or an address.
(string) --
Id (string) --
Provides a group Id number, which will be the same for each in the group.
LineItemGroups (list) --
Information detected on each table of a document, seperated into LineItems .
(dict) --
A grouping of tables which contain LineItems, with each table identified by the table's LineItemGroupIndex .
LineItemGroupIndex (integer) --
The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc.
LineItems (list) --
The breakdown of information on a particular line of a table.
(dict) --
A structure that holds information about the different lines found in a document's tables.
LineItemExpenseFields (list) --
ExpenseFields used to show information from detected lines on a table.
(dict) --
Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection
Type (dict) --
The implied label of a detected element. Present alongside LabelDetection for explicit elements.
Text (string) --
The word or line of text detected by Amazon Textract.
Confidence (float) --
The confidence of accuracy, as a percentage.
LabelDetection (dict) --
The explicitly stated label of a detected element.
Text (string) --
The word or line of text recognized by Amazon Textract
Geometry (dict) --
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Confidence (float) --
The confidence in detection, as a percentage
ValueDetection (dict) --
The value of a detected element. Present in explicit and implicit elements.
Text (string) --
The word or line of text recognized by Amazon Textract
Geometry (dict) --
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Confidence (float) --
The confidence in detection, as a percentage
PageNumber (integer) --
The page number the value was detected on.
Currency (dict) --
Shows the kind of currency, both the code and confidence associated with any monatary value detected.
Code (string) --
Currency code for detected currency. the current supported codes are:
USD
EUR
GBP
CAD
INR
JPY
CHF
AUD
CNY
BZR
SEK
HKD
Confidence (float) --
Percentage confideence in the detected currency.
GroupProperties (list) --
Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.
(dict) --
Shows the group that a certain key belongs to. This helps differentiate between names and addresses for different organizations, that can be hard to determine via JSON response.
Types (list) --
Informs you on whether the expense group is a name or an address.
(string) --
Id (string) --
Provides a group Id number, which will be the same for each in the group.
Blocks (list) --
This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text.
(dict) --
A Block represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block object depends on the type of operation. In text detection for documents (for example DetectDocumentText ), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument ), you can also get information about the fields, tables, and selection elements that are detected in the document.
An array of Block objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText , the array of Block objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis , the array is returned over one or more responses.
For more information, see How Amazon Textract Works .
BlockType (string) --
The type of text item that's recognized. In operations for text detection, the following types are returned:
PAGE - Contains a list of the LINE Block objects that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:
PAGE - Contains a list of child Block objects that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
Confidence (float) --
The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
Text (string) --
The word or line of text that's recognized by Amazon Textract.
TextType (string) --
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
RowIndex (integer) --
The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnIndex (integer) --
The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
RowSpan (integer) --
The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnSpan (integer) --
The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
Geometry (dict) --
The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Id (string) --
The identifier for the recognized text. The identifier is only unique for a single operation.
Relationships (list) --
A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
0 - The block has no child blocks.
1 - The block has child blocks.
(dict) --
Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships . For more information, see Block .
The Type element provides the type of the relationship for all blocks in the IDs array.
Type (string) --
The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD . A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
Ids (list) --
An array of IDs for related blocks. You can get the type of the relationship from the Type element.
(string) --
EntityTypes (list) --
The type of entity. The following can be returned:
KEY - An identifier for a field on the document.
VALUE - The field text.
EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection .
(string) --
SelectionStatus (string) --
The selection status of a selection element, such as an option button or check box.
Page (integer) --
The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage 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 operations will also return a Page value of 1 because every input document is considered to be a single-page document.
Query (dict) --
Text (string) --
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
Alias (string) --
Alias attached to the query, for ease of location.
Pages (list) --
Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.
If a page is not specified, it is set to ["1"] by default.
The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - * . No whitespace is allowed.
When using * to indicate all pages, it must be the only element in the list.
You can use page intervals, such as [“1-3”, “1-1”, “4-*”] . Where * indicates last page of document.
Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
(string) --
{'IdentityDocuments': {'Blocks': {'BlockType': {'SIGNATURE'}}}}
Analyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields , which records both the normalized field and value of the extracted text.Unlike other Amazon Textract operations, AnalyzeID doesn't return any Geometry data.
See also: AWS API Documentation
Request Syntax
client.analyze_id(
DocumentPages=[
{
'Bytes': b'bytes',
'S3Object': {
'Bucket': 'string',
'Name': 'string',
'Version': 'string'
}
},
]
)
list
[REQUIRED]
The document being passed to AnalyzeID.
(dict) --
The input document, either as bytes or as an S3 object.
You pass image bytes to an Amazon Textract API operation by using the Bytes property. For example, you would use the Bytes property to pass a document loaded from a local file system. Image bytes passed by using the Bytes property must be base64 encoded. Your code might not need to encode document file bytes if you're using an AWS SDK to call Amazon Textract API operations.
You pass images stored in an S3 bucket to an Amazon Textract API operation by using the S3Object property. Documents stored in an S3 bucket don't need to be base64 encoded.
The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations.
If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property.
For Amazon Textract to process an S3 object, the user must have permission to access the S3 object.
Bytes (bytes) --
A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.
S3Object (dict) --
Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.
Bucket (string) --
The name of the S3 bucket. Note that the # character is not valid in the file name.
Name (string) --
The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.
Version (string) --
If the bucket has versioning enabled, you can specify the object version.
dict
Response Syntax
{
'IdentityDocuments': [
{
'DocumentIndex': 123,
'IdentityDocumentFields': [
{
'Type': {
'Text': 'string',
'NormalizedValue': {
'Value': 'string',
'ValueType': 'DATE'
},
'Confidence': ...
},
'ValueDetection': {
'Text': 'string',
'NormalizedValue': {
'Value': 'string',
'ValueType': 'DATE'
},
'Confidence': ...
}
},
],
'Blocks': [
{
'BlockType': 'KEY_VALUE_SET'|'PAGE'|'LINE'|'WORD'|'TABLE'|'CELL'|'SELECTION_ELEMENT'|'MERGED_CELL'|'TITLE'|'QUERY'|'QUERY_RESULT'|'SIGNATURE',
'Confidence': ...,
'Text': 'string',
'TextType': 'HANDWRITING'|'PRINTED',
'RowIndex': 123,
'ColumnIndex': 123,
'RowSpan': 123,
'ColumnSpan': 123,
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Id': 'string',
'Relationships': [
{
'Type': 'VALUE'|'CHILD'|'COMPLEX_FEATURES'|'MERGED_CELL'|'TITLE'|'ANSWER',
'Ids': [
'string',
]
},
],
'EntityTypes': [
'KEY'|'VALUE'|'COLUMN_HEADER',
],
'SelectionStatus': 'SELECTED'|'NOT_SELECTED',
'Page': 123,
'Query': {
'Text': 'string',
'Alias': 'string',
'Pages': [
'string',
]
}
},
]
},
],
'DocumentMetadata': {
'Pages': 123
},
'AnalyzeIDModelVersion': 'string'
}
Response Structure
(dict) --
IdentityDocuments (list) --
The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document.
(dict) --
The structure that lists each document processed in an AnalyzeID operation.
DocumentIndex (integer) --
Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.
IdentityDocumentFields (list) --
The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.
(dict) --
Structure containing both the normalized type of the extracted information and the text associated with it. These are extracted as Type and Value respectively.
Type (dict) --
Used to contain the information detected by an AnalyzeID operation.
Text (string) --
Text of either the normalized field or value associated with it.
NormalizedValue (dict) --
Only returned for dates, returns the type of value detected and the date written in a more machine readable way.
Value (string) --
The value of the date, written as Year-Month-DayTHour:Minute:Second.
ValueType (string) --
The normalized type of the value detected. In this case, DATE.
Confidence (float) --
The confidence score of the detected text.
ValueDetection (dict) --
Used to contain the information detected by an AnalyzeID operation.
Text (string) --
Text of either the normalized field or value associated with it.
NormalizedValue (dict) --
Only returned for dates, returns the type of value detected and the date written in a more machine readable way.
Value (string) --
The value of the date, written as Year-Month-DayTHour:Minute:Second.
ValueType (string) --
The normalized type of the value detected. In this case, DATE.
Confidence (float) --
The confidence score of the detected text.
Blocks (list) --
Individual word recognition, as returned by document detection.
(dict) --
A Block represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block object depends on the type of operation. In text detection for documents (for example DetectDocumentText ), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument ), you can also get information about the fields, tables, and selection elements that are detected in the document.
An array of Block objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText , the array of Block objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis , the array is returned over one or more responses.
For more information, see How Amazon Textract Works .
BlockType (string) --
The type of text item that's recognized. In operations for text detection, the following types are returned:
PAGE - Contains a list of the LINE Block objects that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:
PAGE - Contains a list of child Block objects that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
Confidence (float) --
The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
Text (string) --
The word or line of text that's recognized by Amazon Textract.
TextType (string) --
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
RowIndex (integer) --
The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnIndex (integer) --
The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
RowSpan (integer) --
The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnSpan (integer) --
The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
Geometry (dict) --
The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Id (string) --
The identifier for the recognized text. The identifier is only unique for a single operation.
Relationships (list) --
A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
0 - The block has no child blocks.
1 - The block has child blocks.
(dict) --
Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships . For more information, see Block .
The Type element provides the type of the relationship for all blocks in the IDs array.
Type (string) --
The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD . A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
Ids (list) --
An array of IDs for related blocks. You can get the type of the relationship from the Type element.
(string) --
EntityTypes (list) --
The type of entity. The following can be returned:
KEY - An identifier for a field on the document.
VALUE - The field text.
EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection .
(string) --
SelectionStatus (string) --
The selection status of a selection element, such as an option button or check box.
Page (integer) --
The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage 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 operations will also return a Page value of 1 because every input document is considered to be a single-page document.
Query (dict) --
Text (string) --
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
Alias (string) --
Alias attached to the query, for ease of location.
Pages (list) --
Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.
If a page is not specified, it is set to ["1"] by default.
The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - * . No whitespace is allowed.
When using * to indicate all pages, it must be the only element in the list.
You can use page intervals, such as [“1-3”, “1-1”, “4-*”] . Where * indicates last page of document.
Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
(string) --
DocumentMetadata (dict) --
Information about the input document.
Pages (integer) --
The number of pages that are detected in the document.
AnalyzeIDModelVersion (string) --
The version of the AnalyzeIdentity API being used to process documents.
{'Blocks': {'BlockType': {'SIGNATURE'}}}
Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of the following image formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected text in an array of Block objects.
Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.
DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection .
For more information, see Document Text Detection .
See also: AWS API Documentation
Request Syntax
client.detect_document_text(
Document={
'Bytes': b'bytes',
'S3Object': {
'Bucket': 'string',
'Name': 'string',
'Version': 'string'
}
}
)
dict
[REQUIRED]
The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.
Bytes (bytes) --
A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.
S3Object (dict) --
Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.
Bucket (string) --
The name of the S3 bucket. Note that the # character is not valid in the file name.
Name (string) --
The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.
Version (string) --
If the bucket has versioning enabled, you can specify the object version.
dict
Response Syntax
{
'DocumentMetadata': {
'Pages': 123
},
'Blocks': [
{
'BlockType': 'KEY_VALUE_SET'|'PAGE'|'LINE'|'WORD'|'TABLE'|'CELL'|'SELECTION_ELEMENT'|'MERGED_CELL'|'TITLE'|'QUERY'|'QUERY_RESULT'|'SIGNATURE',
'Confidence': ...,
'Text': 'string',
'TextType': 'HANDWRITING'|'PRINTED',
'RowIndex': 123,
'ColumnIndex': 123,
'RowSpan': 123,
'ColumnSpan': 123,
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Id': 'string',
'Relationships': [
{
'Type': 'VALUE'|'CHILD'|'COMPLEX_FEATURES'|'MERGED_CELL'|'TITLE'|'ANSWER',
'Ids': [
'string',
]
},
],
'EntityTypes': [
'KEY'|'VALUE'|'COLUMN_HEADER',
],
'SelectionStatus': 'SELECTED'|'NOT_SELECTED',
'Page': 123,
'Query': {
'Text': 'string',
'Alias': 'string',
'Pages': [
'string',
]
}
},
],
'DetectDocumentTextModelVersion': 'string'
}
Response Structure
(dict) --
DocumentMetadata (dict) --
Metadata about the document. It contains the number of pages that are detected in the document.
Pages (integer) --
The number of pages that are detected in the document.
Blocks (list) --
An array of Block objects that contain the text that's detected in the document.
(dict) --
A Block represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block object depends on the type of operation. In text detection for documents (for example DetectDocumentText ), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument ), you can also get information about the fields, tables, and selection elements that are detected in the document.
An array of Block objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText , the array of Block objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis , the array is returned over one or more responses.
For more information, see How Amazon Textract Works .
BlockType (string) --
The type of text item that's recognized. In operations for text detection, the following types are returned:
PAGE - Contains a list of the LINE Block objects that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:
PAGE - Contains a list of child Block objects that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
Confidence (float) --
The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
Text (string) --
The word or line of text that's recognized by Amazon Textract.
TextType (string) --
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
RowIndex (integer) --
The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnIndex (integer) --
The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
RowSpan (integer) --
The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnSpan (integer) --
The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
Geometry (dict) --
The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Id (string) --
The identifier for the recognized text. The identifier is only unique for a single operation.
Relationships (list) --
A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
0 - The block has no child blocks.
1 - The block has child blocks.
(dict) --
Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships . For more information, see Block .
The Type element provides the type of the relationship for all blocks in the IDs array.
Type (string) --
The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD . A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
Ids (list) --
An array of IDs for related blocks. You can get the type of the relationship from the Type element.
(string) --
EntityTypes (list) --
The type of entity. The following can be returned:
KEY - An identifier for a field on the document.
VALUE - The field text.
EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection .
(string) --
SelectionStatus (string) --
The selection status of a selection element, such as an option button or check box.
Page (integer) --
The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage 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 operations will also return a Page value of 1 because every input document is considered to be a single-page document.
Query (dict) --
Text (string) --
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
Alias (string) --
Alias attached to the query, for ease of location.
Pages (list) --
Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.
If a page is not specified, it is set to ["1"] by default.
The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - * . No whitespace is allowed.
When using * to indicate all pages, it must be the only element in the list.
You can use page intervals, such as [“1-3”, “1-1”, “4-*”] . Where * indicates last page of document.
Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
(string) --
DetectDocumentTextModelVersion (string) --
{'Blocks': {'BlockType': {'SIGNATURE'}}}
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
You start asynchronous text analysis by calling StartDocumentAnalysis , which returns a job identifier (JobId ). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentAnalysis . To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED . If so, call GetDocumentAnalysis , and pass the job identifier (JobId ) from the initial call to StartDocumentAnalysis .
GetDocumentAnalysis returns an array of Block objects. The following types of information are returned:
Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET : a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of the StartDocumentAnalysis FeatureTypes input parameter).
Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.
Query Results. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.
Note
While processing a document with queries, look out for INVALID_REQUEST_PARAMETERS output. This indicates that either the per page query limit has been exceeded or that the operation is trying to query a page in the document which doesn’t exist.
Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.
Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults , the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis , and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentAnalysis .
For more information, see Document Text Analysis .
See also: AWS API Documentation
Request Syntax
client.get_document_analysis(
JobId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis . A JobId value is only valid for 7 days.
integer
The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.
string
If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.
dict
Response Syntax
{
'DocumentMetadata': {
'Pages': 123
},
'JobStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'PARTIAL_SUCCESS',
'NextToken': 'string',
'Blocks': [
{
'BlockType': 'KEY_VALUE_SET'|'PAGE'|'LINE'|'WORD'|'TABLE'|'CELL'|'SELECTION_ELEMENT'|'MERGED_CELL'|'TITLE'|'QUERY'|'QUERY_RESULT'|'SIGNATURE',
'Confidence': ...,
'Text': 'string',
'TextType': 'HANDWRITING'|'PRINTED',
'RowIndex': 123,
'ColumnIndex': 123,
'RowSpan': 123,
'ColumnSpan': 123,
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Id': 'string',
'Relationships': [
{
'Type': 'VALUE'|'CHILD'|'COMPLEX_FEATURES'|'MERGED_CELL'|'TITLE'|'ANSWER',
'Ids': [
'string',
]
},
],
'EntityTypes': [
'KEY'|'VALUE'|'COLUMN_HEADER',
],
'SelectionStatus': 'SELECTED'|'NOT_SELECTED',
'Page': 123,
'Query': {
'Text': 'string',
'Alias': 'string',
'Pages': [
'string',
]
}
},
],
'Warnings': [
{
'ErrorCode': 'string',
'Pages': [
123,
]
},
],
'StatusMessage': 'string',
'AnalyzeDocumentModelVersion': 'string'
}
Response Structure
(dict) --
DocumentMetadata (dict) --
Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
Pages (integer) --
The number of pages that are detected in the document.
JobStatus (string) --
The current status of the text detection job.
NextToken (string) --
If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.
Blocks (list) --
The results of the text-analysis operation.
(dict) --
A Block represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block object depends on the type of operation. In text detection for documents (for example DetectDocumentText ), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument ), you can also get information about the fields, tables, and selection elements that are detected in the document.
An array of Block objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText , the array of Block objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis , the array is returned over one or more responses.
For more information, see How Amazon Textract Works .
BlockType (string) --
The type of text item that's recognized. In operations for text detection, the following types are returned:
PAGE - Contains a list of the LINE Block objects that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:
PAGE - Contains a list of child Block objects that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
Confidence (float) --
The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
Text (string) --
The word or line of text that's recognized by Amazon Textract.
TextType (string) --
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
RowIndex (integer) --
The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnIndex (integer) --
The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
RowSpan (integer) --
The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnSpan (integer) --
The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
Geometry (dict) --
The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Id (string) --
The identifier for the recognized text. The identifier is only unique for a single operation.
Relationships (list) --
A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
0 - The block has no child blocks.
1 - The block has child blocks.
(dict) --
Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships . For more information, see Block .
The Type element provides the type of the relationship for all blocks in the IDs array.
Type (string) --
The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD . A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
Ids (list) --
An array of IDs for related blocks. You can get the type of the relationship from the Type element.
(string) --
EntityTypes (list) --
The type of entity. The following can be returned:
KEY - An identifier for a field on the document.
VALUE - The field text.
EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection .
(string) --
SelectionStatus (string) --
The selection status of a selection element, such as an option button or check box.
Page (integer) --
The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage 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 operations will also return a Page value of 1 because every input document is considered to be a single-page document.
Query (dict) --
Text (string) --
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
Alias (string) --
Alias attached to the query, for ease of location.
Pages (list) --
Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.
If a page is not specified, it is set to ["1"] by default.
The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - * . No whitespace is allowed.
When using * to indicate all pages, it must be the only element in the list.
You can use page intervals, such as [“1-3”, “1-1”, “4-*”] . Where * indicates last page of document.
Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
(string) --
Warnings (list) --
A list of warnings that occurred during the document-analysis operation.
(dict) --
A warning about an issue that occurred during asynchronous text analysis ( StartDocumentAnalysis ) or asynchronous document text detection ( StartDocumentTextDetection ).
ErrorCode (string) --
The error code for the warning.
Pages (list) --
A list of the pages that the warning applies to.
(integer) --
StatusMessage (string) --
Returns if the detection job could not be completed. Contains explanation for what error occured.
AnalyzeDocumentModelVersion (string) --
{'Blocks': {'BlockType': {'SIGNATURE'}}}
Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.
You start asynchronous text detection by calling StartDocumentTextDetection , which returns a job identifier (JobId ). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentTextDetection . To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED . If so, call GetDocumentTextDetection , and pass the job identifier (JobId ) from the initial call to StartDocumentTextDetection .
GetDocumentTextDetection returns an array of Block objects.
Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.
Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults , the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentTextDetection , and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentTextDetection .
For more information, see Document Text Detection .
See also: AWS API Documentation
Request Syntax
client.get_document_text_detection(
JobId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
A unique identifier for the text detection job. The JobId is returned from StartDocumentTextDetection . A JobId value is only valid for 7 days.
integer
The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.
string
If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.
dict
Response Syntax
{
'DocumentMetadata': {
'Pages': 123
},
'JobStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'PARTIAL_SUCCESS',
'NextToken': 'string',
'Blocks': [
{
'BlockType': 'KEY_VALUE_SET'|'PAGE'|'LINE'|'WORD'|'TABLE'|'CELL'|'SELECTION_ELEMENT'|'MERGED_CELL'|'TITLE'|'QUERY'|'QUERY_RESULT'|'SIGNATURE',
'Confidence': ...,
'Text': 'string',
'TextType': 'HANDWRITING'|'PRINTED',
'RowIndex': 123,
'ColumnIndex': 123,
'RowSpan': 123,
'ColumnSpan': 123,
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Id': 'string',
'Relationships': [
{
'Type': 'VALUE'|'CHILD'|'COMPLEX_FEATURES'|'MERGED_CELL'|'TITLE'|'ANSWER',
'Ids': [
'string',
]
},
],
'EntityTypes': [
'KEY'|'VALUE'|'COLUMN_HEADER',
],
'SelectionStatus': 'SELECTED'|'NOT_SELECTED',
'Page': 123,
'Query': {
'Text': 'string',
'Alias': 'string',
'Pages': [
'string',
]
}
},
],
'Warnings': [
{
'ErrorCode': 'string',
'Pages': [
123,
]
},
],
'StatusMessage': 'string',
'DetectDocumentTextModelVersion': 'string'
}
Response Structure
(dict) --
DocumentMetadata (dict) --
Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
Pages (integer) --
The number of pages that are detected in the document.
JobStatus (string) --
The current status of the text detection job.
NextToken (string) --
If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.
Blocks (list) --
The results of the text-detection operation.
(dict) --
A Block represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block object depends on the type of operation. In text detection for documents (for example DetectDocumentText ), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument ), you can also get information about the fields, tables, and selection elements that are detected in the document.
An array of Block objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText , the array of Block objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis , the array is returned over one or more responses.
For more information, see How Amazon Textract Works .
BlockType (string) --
The type of text item that's recognized. In operations for text detection, the following types are returned:
PAGE - Contains a list of the LINE Block objects that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:
PAGE - Contains a list of child Block objects that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
Confidence (float) --
The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
Text (string) --
The word or line of text that's recognized by Amazon Textract.
TextType (string) --
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
RowIndex (integer) --
The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnIndex (integer) --
The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
RowSpan (integer) --
The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnSpan (integer) --
The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
Geometry (dict) --
The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Id (string) --
The identifier for the recognized text. The identifier is only unique for a single operation.
Relationships (list) --
A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
0 - The block has no child blocks.
1 - The block has child blocks.
(dict) --
Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships . For more information, see Block .
The Type element provides the type of the relationship for all blocks in the IDs array.
Type (string) --
The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD . A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
Ids (list) --
An array of IDs for related blocks. You can get the type of the relationship from the Type element.
(string) --
EntityTypes (list) --
The type of entity. The following can be returned:
KEY - An identifier for a field on the document.
VALUE - The field text.
EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection .
(string) --
SelectionStatus (string) --
The selection status of a selection element, such as an option button or check box.
Page (integer) --
The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage 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 operations will also return a Page value of 1 because every input document is considered to be a single-page document.
Query (dict) --
Text (string) --
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
Alias (string) --
Alias attached to the query, for ease of location.
Pages (list) --
Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.
If a page is not specified, it is set to ["1"] by default.
The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - * . No whitespace is allowed.
When using * to indicate all pages, it must be the only element in the list.
You can use page intervals, such as [“1-3”, “1-1”, “4-*”] . Where * indicates last page of document.
Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
(string) --
Warnings (list) --
A list of warnings that occurred during the text-detection operation for the document.
(dict) --
A warning about an issue that occurred during asynchronous text analysis ( StartDocumentAnalysis ) or asynchronous document text detection ( StartDocumentTextDetection ).
ErrorCode (string) --
The error code for the warning.
Pages (list) --
A list of the pages that the warning applies to.
(integer) --
StatusMessage (string) --
Returns if the detection job could not be completed. Contains explanation for what error occured.
DetectDocumentTextModelVersion (string) --
{'ExpenseDocuments': {'Blocks': {'BlockType': {'SIGNATURE'}}}}
Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts.
You start asynchronous invoice/receipt analysis by calling StartExpenseAnalysis , which returns a job identifier (JobId ). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to StartExpenseAnalysis . To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is SUCCEEDED . If so, call GetExpenseAnalysis , and pass the job identifier (JobId ) from the initial call to StartExpenseAnalysis .
Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults , the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetExpenseAnalysis , and populate the NextToken request parameter with the token value that's returned from the previous call to GetExpenseAnalysis .
For more information, see Analyzing Invoices and Receipts .
See also: AWS API Documentation
Request Syntax
client.get_expense_analysis(
JobId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis . A JobId value is only valid for 7 days.
integer
The maximum number of results to return per paginated call. The largest value you can specify is 20. If you specify a value greater than 20, a maximum of 20 results is returned. The default value is 20.
string
If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.
dict
Response Syntax
{
'DocumentMetadata': {
'Pages': 123
},
'JobStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'PARTIAL_SUCCESS',
'NextToken': 'string',
'ExpenseDocuments': [
{
'ExpenseIndex': 123,
'SummaryFields': [
{
'Type': {
'Text': 'string',
'Confidence': ...
},
'LabelDetection': {
'Text': 'string',
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Confidence': ...
},
'ValueDetection': {
'Text': 'string',
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Confidence': ...
},
'PageNumber': 123,
'Currency': {
'Code': 'string',
'Confidence': ...
},
'GroupProperties': [
{
'Types': [
'string',
],
'Id': 'string'
},
]
},
],
'LineItemGroups': [
{
'LineItemGroupIndex': 123,
'LineItems': [
{
'LineItemExpenseFields': [
{
'Type': {
'Text': 'string',
'Confidence': ...
},
'LabelDetection': {
'Text': 'string',
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Confidence': ...
},
'ValueDetection': {
'Text': 'string',
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Confidence': ...
},
'PageNumber': 123,
'Currency': {
'Code': 'string',
'Confidence': ...
},
'GroupProperties': [
{
'Types': [
'string',
],
'Id': 'string'
},
]
},
]
},
]
},
],
'Blocks': [
{
'BlockType': 'KEY_VALUE_SET'|'PAGE'|'LINE'|'WORD'|'TABLE'|'CELL'|'SELECTION_ELEMENT'|'MERGED_CELL'|'TITLE'|'QUERY'|'QUERY_RESULT'|'SIGNATURE',
'Confidence': ...,
'Text': 'string',
'TextType': 'HANDWRITING'|'PRINTED',
'RowIndex': 123,
'ColumnIndex': 123,
'RowSpan': 123,
'ColumnSpan': 123,
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Id': 'string',
'Relationships': [
{
'Type': 'VALUE'|'CHILD'|'COMPLEX_FEATURES'|'MERGED_CELL'|'TITLE'|'ANSWER',
'Ids': [
'string',
]
},
],
'EntityTypes': [
'KEY'|'VALUE'|'COLUMN_HEADER',
],
'SelectionStatus': 'SELECTED'|'NOT_SELECTED',
'Page': 123,
'Query': {
'Text': 'string',
'Alias': 'string',
'Pages': [
'string',
]
}
},
]
},
],
'Warnings': [
{
'ErrorCode': 'string',
'Pages': [
123,
]
},
],
'StatusMessage': 'string',
'AnalyzeExpenseModelVersion': 'string'
}
Response Structure
(dict) --
DocumentMetadata (dict) --
Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract operation.
Pages (integer) --
The number of pages that are detected in the document.
JobStatus (string) --
The current status of the text detection job.
NextToken (string) --
If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.
ExpenseDocuments (list) --
The expenses detected by Amazon Textract.
(dict) --
The structure holding all the information returned by AnalyzeExpense
ExpenseIndex (integer) --
Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.
SummaryFields (list) --
Any information found outside of a table by Amazon Textract.
(dict) --
Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection
Type (dict) --
The implied label of a detected element. Present alongside LabelDetection for explicit elements.
Text (string) --
The word or line of text detected by Amazon Textract.
Confidence (float) --
The confidence of accuracy, as a percentage.
LabelDetection (dict) --
The explicitly stated label of a detected element.
Text (string) --
The word or line of text recognized by Amazon Textract
Geometry (dict) --
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Confidence (float) --
The confidence in detection, as a percentage
ValueDetection (dict) --
The value of a detected element. Present in explicit and implicit elements.
Text (string) --
The word or line of text recognized by Amazon Textract
Geometry (dict) --
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Confidence (float) --
The confidence in detection, as a percentage
PageNumber (integer) --
The page number the value was detected on.
Currency (dict) --
Shows the kind of currency, both the code and confidence associated with any monatary value detected.
Code (string) --
Currency code for detected currency. the current supported codes are:
USD
EUR
GBP
CAD
INR
JPY
CHF
AUD
CNY
BZR
SEK
HKD
Confidence (float) --
Percentage confideence in the detected currency.
GroupProperties (list) --
Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.
(dict) --
Shows the group that a certain key belongs to. This helps differentiate between names and addresses for different organizations, that can be hard to determine via JSON response.
Types (list) --
Informs you on whether the expense group is a name or an address.
(string) --
Id (string) --
Provides a group Id number, which will be the same for each in the group.
LineItemGroups (list) --
Information detected on each table of a document, seperated into LineItems .
(dict) --
A grouping of tables which contain LineItems, with each table identified by the table's LineItemGroupIndex .
LineItemGroupIndex (integer) --
The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc.
LineItems (list) --
The breakdown of information on a particular line of a table.
(dict) --
A structure that holds information about the different lines found in a document's tables.
LineItemExpenseFields (list) --
ExpenseFields used to show information from detected lines on a table.
(dict) --
Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection
Type (dict) --
The implied label of a detected element. Present alongside LabelDetection for explicit elements.
Text (string) --
The word or line of text detected by Amazon Textract.
Confidence (float) --
The confidence of accuracy, as a percentage.
LabelDetection (dict) --
The explicitly stated label of a detected element.
Text (string) --
The word or line of text recognized by Amazon Textract
Geometry (dict) --
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Confidence (float) --
The confidence in detection, as a percentage
ValueDetection (dict) --
The value of a detected element. Present in explicit and implicit elements.
Text (string) --
The word or line of text recognized by Amazon Textract
Geometry (dict) --
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Confidence (float) --
The confidence in detection, as a percentage
PageNumber (integer) --
The page number the value was detected on.
Currency (dict) --
Shows the kind of currency, both the code and confidence associated with any monatary value detected.
Code (string) --
Currency code for detected currency. the current supported codes are:
USD
EUR
GBP
CAD
INR
JPY
CHF
AUD
CNY
BZR
SEK
HKD
Confidence (float) --
Percentage confideence in the detected currency.
GroupProperties (list) --
Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.
(dict) --
Shows the group that a certain key belongs to. This helps differentiate between names and addresses for different organizations, that can be hard to determine via JSON response.
Types (list) --
Informs you on whether the expense group is a name or an address.
(string) --
Id (string) --
Provides a group Id number, which will be the same for each in the group.
Blocks (list) --
This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text.
(dict) --
A Block represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block object depends on the type of operation. In text detection for documents (for example DetectDocumentText ), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument ), you can also get information about the fields, tables, and selection elements that are detected in the document.
An array of Block objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText , the array of Block objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis , the array is returned over one or more responses.
For more information, see How Amazon Textract Works .
BlockType (string) --
The type of text item that's recognized. In operations for text detection, the following types are returned:
PAGE - Contains a list of the LINE Block objects that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:
PAGE - Contains a list of child Block objects that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
Confidence (float) --
The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
Text (string) --
The word or line of text that's recognized by Amazon Textract.
TextType (string) --
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
RowIndex (integer) --
The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnIndex (integer) --
The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
RowSpan (integer) --
The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
ColumnSpan (integer) --
The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection .
Geometry (dict) --
The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon , is returned by DetectDocumentText . Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
X (float) --
The value of the X coordinate for a point on a Polygon .
Y (float) --
The value of the Y coordinate for a point on a Polygon .
Id (string) --
The identifier for the recognized text. The identifier is only unique for a single operation.
Relationships (list) --
A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
0 - The block has no child blocks.
1 - The block has child blocks.
(dict) --
Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships . For more information, see Block .
The Type element provides the type of the relationship for all blocks in the IDs array.
Type (string) --
The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD . A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
Ids (list) --
An array of IDs for related blocks. You can get the type of the relationship from the Type element.
(string) --
EntityTypes (list) --
The type of entity. The following can be returned:
KEY - An identifier for a field on the document.
VALUE - The field text.
EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection .
(string) --
SelectionStatus (string) --
The selection status of a selection element, such as an option button or check box.
Page (integer) --
The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage 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 operations will also return a Page value of 1 because every input document is considered to be a single-page document.
Query (dict) --
Text (string) --
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
Alias (string) --
Alias attached to the query, for ease of location.
Pages (list) --
Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.
If a page is not specified, it is set to ["1"] by default.
The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - * . No whitespace is allowed.
When using * to indicate all pages, it must be the only element in the list.
You can use page intervals, such as [“1-3”, “1-1”, “4-*”] . Where * indicates last page of document.
Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
(string) --
Warnings (list) --
A list of warnings that occurred during the text-detection operation for the document.
(dict) --
A warning about an issue that occurred during asynchronous text analysis ( StartDocumentAnalysis ) or asynchronous document text detection ( StartDocumentTextDetection ).
ErrorCode (string) --
The error code for the warning.
Pages (list) --
A list of the pages that the warning applies to.
(integer) --
StatusMessage (string) --
Returns if the detection job could not be completed. Contains explanation for what error occured.
AnalyzeExpenseModelVersion (string) --
The current model version of AnalyzeExpense.
{'FeatureTypes': {'SIGNATURES'}}
Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.
StartDocumentAnalysis returns a job identifier (JobId ) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel . To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED . If so, call GetDocumentAnalysis , and pass the job identifier (JobId ) from the initial call to StartDocumentAnalysis .
For more information, see Document Text Analysis .
See also: AWS API Documentation
Request Syntax
client.start_document_analysis(
DocumentLocation={
'S3Object': {
'Bucket': 'string',
'Name': 'string',
'Version': 'string'
}
},
FeatureTypes=[
'TABLES'|'FORMS'|'QUERIES'|'SIGNATURES',
],
ClientRequestToken='string',
JobTag='string',
NotificationChannel={
'SNSTopicArn': 'string',
'RoleArn': 'string'
},
OutputConfig={
'S3Bucket': 'string',
'S3Prefix': 'string'
},
KMSKeyId='string',
QueriesConfig={
'Queries': [
{
'Text': 'string',
'Alias': 'string',
'Pages': [
'string',
]
},
]
}
)
dict
[REQUIRED]
The location of the document to be processed.
S3Object (dict) --
The Amazon S3 bucket that contains the input document.
Bucket (string) --
The name of the S3 bucket. Note that the # character is not valid in the file name.
Name (string) --
The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.
Version (string) --
If the bucket has versioning enabled, you can specify the object version.
list
[REQUIRED]
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. To perform both types of analysis, add TABLES and FORMS to FeatureTypes . All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes ).
(string) --
string
The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations .
string
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).
dict
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
SNSTopicArn (string) -- [REQUIRED]
The Amazon SNS topic that Amazon Textract posts the completion status to.
RoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
dict
Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.
S3Bucket (string) -- [REQUIRED]
The name of the bucket your output will go to.
S3Prefix (string) --
The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".
string
The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.
dict
Queries (list) -- [REQUIRED]
(dict) --
Each query contains the question you want to ask in the Text and the alias you want to associate.
Text (string) -- [REQUIRED]
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
Alias (string) --
Alias attached to the query, for ease of location.
Pages (list) --
Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.
If a page is not specified, it is set to ["1"] by default.
The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - * . No whitespace is allowed.
When using * to indicate all pages, it must be the only element in the list.
You can use page intervals, such as [“1-3”, “1-1”, “4-*”] . Where * indicates last page of document.
Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
(string) --
dict
Response Syntax
{
'JobId': 'string'
}
Response Structure
(dict) --
JobId (string) --
The identifier for the document text detection job. Use JobId to identify the job in a subsequent call to GetDocumentAnalysis . A JobId value is only valid for 7 days.