2022/11/28 - Amazon Textract - 3 new api methods
Changes This release adds support for classifying and splitting lending documents by type, and extracting information by using the Analyze Lending APIs. This release also includes support for summarized information of the processed lending document package, in addition to per document results.
Starts the classification and analysis of an input document. StartLendingAnalysis initiates the classification and analysis of a packet of lending documents. StartLendingAnalysis operates on a document file located in an Amazon S3 bucket.
StartLendingAnalysis can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation to specify the bucket name and the file name of the document.
StartLendingAnalysis returns a job identifier ( JobId) that you use to get the results of the operation. When the 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 the status is SUCCEEDED you can call either GetLendingAnalysis or GetLendingAnalysisSummary and provide the JobId to obtain the results of the analysis.
If using OutputConfig to specify an Amazon S3 bucket, the output will be contained within the specified prefix in a directory labeled with the job-id. In the directory there are 3 sub-directories:
detailedResponse (contains the GetLendingAnalysis response)
summaryResponse (for the GetLendingAnalysisSummary response)
splitDocuments (documents split across logical boundaries)
See also: AWS API Documentation
Request Syntax
client.start_lending_analysis(
DocumentLocation={
'S3Object': {
'Bucket': 'string',
'Name': 'string',
'Version': 'string'
}
},
ClientRequestToken='string',
JobTag='string',
NotificationChannel={
'SNSTopicArn': 'string',
'RoleArn': 'string'
},
OutputConfig={
'S3Bucket': 'string',
'S3Prefix': 'string'
},
KMSKeyId='string'
)
dict
[REQUIRED]
The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations.
The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.
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.
string
The idempotent token that you use to identify the start request. If you use the same token with multiple StartLendingAnalysis 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 to be 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 Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.
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 whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.
OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.
Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.
For more information on data privacy, see the Data Privacy FAQ.
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
Response Syntax
{
'JobId': 'string'
}
Response Structure
(dict) --
JobId (string) --
A unique identifier for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. A JobId value is only valid for 7 days.
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.
You start asynchronous text analysis by calling StartLendingAnalysis, 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 StartLendingAnalysis.
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 GetLendingAnalysis, and pass the job identifier ( JobId) from the initial call to StartLendingAnalysis.
See also: AWS API Documentation
Request Syntax
client.get_lending_analysis(
JobId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
A unique identifier for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. 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 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.
string
If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.
dict
Response Syntax
{
'DocumentMetadata': {
'Pages': 123
},
'JobStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'PARTIAL_SUCCESS',
'NextToken': 'string',
'Results': [
{
'Page': 123,
'PageClassification': {
'PageType': [
{
'Value': 'string',
'Confidence': ...
},
],
'PageNumber': [
{
'Value': 'string',
'Confidence': ...
},
]
},
'Extractions': [
{
'LendingDocument': {
'LendingFields': [
{
'Type': 'string',
'KeyDetection': {
'Text': 'string',
'SelectionStatus': 'SELECTED'|'NOT_SELECTED',
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Confidence': ...
},
'ValueDetections': [
{
'Text': 'string',
'SelectionStatus': 'SELECTED'|'NOT_SELECTED',
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Confidence': ...
},
]
},
],
'SignatureDetections': [
{
'Confidence': ...,
'Geometry': {
'BoundingBox': {
'Width': ...,
'Height': ...,
'Left': ...,
'Top': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
}
},
]
},
'ExpenseDocument': {
'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',
]
}
},
]
},
'IdentityDocument': {
'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',
]
}
},
]
}
},
]
},
],
'Warnings': [
{
'ErrorCode': 'string',
'Pages': [
123,
]
},
],
'StatusMessage': 'string',
'AnalyzeLendingModelVersion': 'string'
}
Response Structure
(dict) --
DocumentMetadata (dict) --
Information about the input document.
Pages (integer) --
The number of pages that are detected in the document.
JobStatus (string) --
The current status of the lending analysis 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 lending results.
Results (list) --
Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.
(dict) --
Contains the detections for each page analyzed through the Analyze Lending API.
Page (integer) --
The page number for a page, with regard to whole submission.
PageClassification (dict) --
The classifier result for a given page.
PageType (list) --
The class, or document type, assigned to a detected Page object. The class, or document type, assigned to a detected Page object.
(dict) --
Contains information regarding predicted values returned by Amazon Textract operations, including the predicted value and the confidence in the predicted value.
Value (string) --
The predicted value of a detected object.
Confidence (float) --
Amazon Textract's confidence in its predicted value.
PageNumber (list) --
The page number the value was detected on, relative to Amazon Textract's starting position.
(dict) --
Contains information regarding predicted values returned by Amazon Textract operations, including the predicted value and the confidence in the predicted value.
Value (string) --
The predicted value of a detected object.
Confidence (float) --
Amazon Textract's confidence in its predicted value.
Extractions (list) --
An array of Extraction to hold structured data. e.g. normalized key value pairs instead of raw OCR detections .
(dict) --
Contains information extracted by an analysis operation after using StartLendingAnalysis.
LendingDocument (dict) --
Holds the structured data returned by AnalyzeDocument for lending documents.
LendingFields (list) --
An array of LendingField objects.
(dict) --
Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and geometry.
Type (string) --
The type of the lending document.
KeyDetection (dict) --
The results extracted for a lending document.
Text (string) --
The text extracted for a detected value in a lending document.
SelectionStatus (string) --
The selection status of a selection element, such as an option button or check box.
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 level for the text of a detected value in a lending document.
ValueDetections (list) --
An array of LendingDetection objects.
(dict) --
The results extracted for a lending document.
Text (string) --
The text extracted for a detected value in a lending document.
SelectionStatus (string) --
The selection status of a selection element, such as an option button or check box.
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 level for the text of a detected value in a lending document.
SignatureDetections (list) --
A list of signatures detected in a lending document.
(dict) --
Information regarding a detected signature on a page.
Confidence (float) --
The confidence, from 0 to 100, in the predicted values for a detected signature.
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.
ExpenseDocument (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) --
IdentityDocument (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) --
Warnings (list) --
A list of warnings that occurred during the lending 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 lending analysis job could not be completed. Contains explanation for what error occurred.
AnalyzeLendingModelVersion (string) --
The current model version of the Analyze Lending API.
Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document.
You start asynchronous text analysis by calling StartLendingAnalysis, 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 StartLendingAnalysis.
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 GetLendingAnalysisSummary, and pass the job identifier ( JobId) from the initial call to StartLendingAnalysis.
See also: AWS API Documentation
Request Syntax
client.get_lending_analysis_summary(
JobId='string'
)
string
[REQUIRED]
A unique identifier for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. A JobId value is only valid for 7 days.
dict
Response Syntax
{
'DocumentMetadata': {
'Pages': 123
},
'JobStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'PARTIAL_SUCCESS',
'Summary': {
'DocumentGroups': [
{
'Type': 'string',
'SplitDocuments': [
{
'Index': 123,
'Pages': [
123,
]
},
],
'DetectedSignatures': [
{
'Page': 123
},
],
'UndetectedSignatures': [
{
'Page': 123
},
]
},
],
'UndetectedDocumentTypes': [
'string',
]
},
'Warnings': [
{
'ErrorCode': 'string',
'Pages': [
123,
]
},
],
'StatusMessage': 'string',
'AnalyzeLendingModelVersion': 'string'
}
Response Structure
(dict) --
DocumentMetadata (dict) --
Information about the input document.
Pages (integer) --
The number of pages that are detected in the document.
JobStatus (string) --
The current status of the lending analysis job.
Summary (dict) --
Contains summary information for documents grouped by type.
DocumentGroups (list) --
Contains an array of all DocumentGroup objects.
(dict) --
Summary information about documents grouped by the same document type.
Type (string) --
The type of document that Amazon Textract has detected. See LINK for a list of all types returned by Textract.
SplitDocuments (list) --
An array that contains information about the pages of a document, defined by logical boundary.
(dict) --
Contains information about the pages of a document, defined by logical boundary.
Index (integer) --
The index for a given document in a DocumentGroup of a specific Type.
Pages (list) --
An array of page numbers for a for a given document, ordered by logical boundary.
(integer) --
DetectedSignatures (list) --
A list of the detected signatures found in a document group.
(dict) --
A structure that holds information regarding a detected signature on a page.
Page (integer) --
The page a detected signature was found on.
UndetectedSignatures (list) --
A list of any expected signatures not found in a document group.
(dict) --
A structure containing information about an undetected signature on a page where it was expected but not found.
Page (integer) --
The page where a signature was expected but not found.
UndetectedDocumentTypes (list) --
UndetectedDocumentTypes.
(string) --
Warnings (list) --
A list of warnings that occurred during the lending 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 lending analysis could not be completed. Contains explanation for what error occurred.
AnalyzeLendingModelVersion (string) --
The current model version of the Analyze Lending API.