Table of Contents
A low-level client representing Amazon Textract
Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.
import boto3
client = boto3.client('textract')
These are the available methods:
Analyzes an input document for relationships between detected items.
The types of information returned are as follows:
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
response = client.analyze_document(
Document={
'Bytes': b'bytes',
'S3Object': {
'Bucket': 'string',
'Name': 'string',
'Version': 'string'
}
},
FeatureTypes=[
'TABLES'|'FORMS',
],
HumanLoopConfig={
'HumanLoopName': 'string',
'FlowDefinitionArn': 'string',
'DataAttributes': {
'ContentClassifiers': [
'FreeOfPersonallyIdentifiableInformation'|'FreeOfAdultContent',
]
}
}
)
[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.
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.
Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.
The name of the S3 bucket.
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 format files.
If the bucket has versioning enabled, you can specify the object version.
[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 ).
Sets the configuration for the human in the loop workflow for analyzing documents.
The name of the human workflow used for this image. This should be kept unique within a region.
The Amazon Resource Name (ARN) of the flow definition.
Sets attributes of the input data.
Sets whether the input image is free of personally identifiable information or adult content.
dict
Response Syntax
{
'DocumentMetadata': {
'Pages': 123
},
'Blocks': [
{
'BlockType': 'KEY_VALUE_SET'|'PAGE'|'LINE'|'WORD'|'TABLE'|'CELL'|'SELECTION_ELEMENT',
'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',
'Ids': [
'string',
]
},
],
'EntityTypes': [
'KEY'|'VALUE',
],
'SelectionStatus': 'SELECTED'|'NOT_SELECTED',
'Page': 123
},
],
'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:
In text analysis operations, the following types are returned:
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:
(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.
EntityTypes (list) --
The type of entity. The following can be returned:
EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection .
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 asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of Page is always 1. Synchronous operations don't return Page because every input document is considered to be a single-page document.
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.
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.
Exceptions
Check if an operation can be paginated.
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 an image in JPEG or PNG format. 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
response = client.detect_document_text(
Document={
'Bytes': b'bytes',
'S3Object': {
'Bucket': 'string',
'Name': 'string',
'Version': 'string'
}
}
)
[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.
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.
Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.
The name of the S3 bucket.
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 format files.
If the bucket has versioning enabled, you can specify the object version.
{
'DocumentMetadata': {
'Pages': 123
},
'Blocks': [
{
'BlockType': 'KEY_VALUE_SET'|'PAGE'|'LINE'|'WORD'|'TABLE'|'CELL'|'SELECTION_ELEMENT',
'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',
'Ids': [
'string',
]
},
],
'EntityTypes': [
'KEY'|'VALUE',
],
'SelectionStatus': 'SELECTED'|'NOT_SELECTED',
'Page': 123
},
],
'DetectDocumentTextModelVersion': 'string'
}
Response Structure
Metadata about the document. It contains the number of pages that are detected in the document.
The number of pages that are detected in the document.
An array of Block objects that contain the text that's detected in the document.
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 .
The type of text item that's recognized. In operations for text detection, the following types are returned:
In text analysis operations, the following types are returned:
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.
The word or line of text that's recognized by Amazon Textract.
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
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 .
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 .
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.
An axis-aligned coarse representation of the location of the recognized item on the document page.
The width of the bounding box as a ratio of the overall document page width.
The height of the bounding box as a ratio of the overall document page height.
The left coordinate of the bounding box as a ratio of overall document page width.
The top coordinate of the bounding box as a ratio of overall document page height.
Within the bounding box, a fine-grained polygon around the recognized item.
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.
The value of the X coordinate for a point on a Polygon .
The value of the Y coordinate for a point on a Polygon .
The identifier for the recognized text. The identifier is only unique for a single operation.
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:
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.
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.
An array of IDs for related blocks. You can get the type of the relationship from the Type element.
The type of entity. The following can be returned:
EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection .
The selection status of a selection element, such as an option button or check box.
The page on which a block was detected. Page is returned by asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of Page is always 1. Synchronous operations don't return Page because every input document is considered to be a single-page document.
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
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:
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
response = client.get_document_analysis(
JobId='string',
MaxResults=123,
NextToken='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.
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',
'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',
'Ids': [
'string',
]
},
],
'EntityTypes': [
'KEY'|'VALUE',
],
'SelectionStatus': 'SELECTED'|'NOT_SELECTED',
'Page': 123
},
],
'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:
In text analysis operations, the following types are returned:
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:
(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.
EntityTypes (list) --
The type of entity. The following can be returned:
EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection .
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 asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of Page is always 1. Synchronous operations don't return Page because every input document is considered to be a single-page document.
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.
StatusMessage (string) --
Returns if the detection job could not be completed. Contains explanation for what error occured.
AnalyzeDocumentModelVersion (string) --
Exceptions
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
response = client.get_document_text_detection(
JobId='string',
MaxResults=123,
NextToken='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.
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',
'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',
'Ids': [
'string',
]
},
],
'EntityTypes': [
'KEY'|'VALUE',
],
'SelectionStatus': 'SELECTED'|'NOT_SELECTED',
'Page': 123
},
],
'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:
In text analysis operations, the following types are returned:
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:
(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.
EntityTypes (list) --
The type of entity. The following can be returned:
EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection .
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 asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of Page is always 1. Synchronous operations don't return Page because every input document is considered to be a single-page document.
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.
StatusMessage (string) --
Returns if the detection job could not be completed. Contains explanation for what error occured.
DetectDocumentTextModelVersion (string) --
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
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, 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
response = client.start_document_analysis(
DocumentLocation={
'S3Object': {
'Bucket': 'string',
'Name': 'string',
'Version': 'string'
}
},
FeatureTypes=[
'TABLES'|'FORMS',
],
ClientRequestToken='string',
JobTag='string',
NotificationChannel={
'SNSTopicArn': 'string',
'RoleArn': 'string'
},
OutputConfig={
'S3Bucket': 'string',
'S3Prefix': 'string'
},
KMSKeyId='string'
)
[REQUIRED]
The location of the document to be processed.
The Amazon S3 bucket that contains the input document.
The name of the S3 bucket.
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 format files.
If the bucket has versioning enabled, you can specify the object version.
[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 ).
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
The Amazon SNS topic that Amazon Textract posts the completion status to.
The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
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.
The name of the bucket your output will go to.
The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".
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.
Exceptions
Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.
StartDocumentTextDetection can analyze text in documents that are in JPEG, PNG, 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.
StartTextDetection returns a job identifier (JobId ) that you use to get the results of the operation. When text detection 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 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 .
For more information, see Document Text Detection .
See also: AWS API Documentation
Request Syntax
response = client.start_document_text_detection(
DocumentLocation={
'S3Object': {
'Bucket': 'string',
'Name': 'string',
'Version': 'string'
}
},
ClientRequestToken='string',
JobTag='string',
NotificationChannel={
'SNSTopicArn': 'string',
'RoleArn': 'string'
},
OutputConfig={
'S3Bucket': 'string',
'S3Prefix': 'string'
},
KMSKeyId='string'
)
[REQUIRED]
The location of the document to be processed.
The Amazon S3 bucket that contains the input document.
The name of the S3 bucket.
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 format files.
If the bucket has versioning enabled, you can specify the object version.
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
The Amazon SNS topic that Amazon Textract posts the completion status to.
The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.
The name of the bucket your output will go to.
The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".
dict
Response Syntax
{
'JobId': 'string'
}
Response Structure
(dict) --
JobId (string) --
The identifier of the text detection job for the document. Use JobId to identify the job in a subsequent call to GetDocumentTextDetection . A JobId value is only valid for 7 days.
Exceptions
The available paginators are: