AWS.Textract (aws-elixir v0.10.1) View Source
Amazon Textract detects and analyzes text in documents and converts it into machine-readable text.
This is the API reference documentation for Amazon Textract.
Link to this section Summary
Functions
Analyzes an input document for relationships between detected items.
AnalyzeExpense synchronously analyzes an input document for financially
related relationships between text.
Analyzes identity documents for relevant information.
Detects text in the input document.
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts.
Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
Starts the asynchronous detection of text in a document.
Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.
Link to this section Functions
Analyzes an input document for relationships between detected items.
The types of information returned are as follows:
Form data (key-value pairs). The related information is returned in two
Blockobjects, each of typeKEY_VALUE_SET: a KEYBlockobject and a VALUEBlockobject. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.Table and table cell data. A TABLE
Blockobject contains information about a detected table. A CELLBlockobject is returned for each cell in a table.Lines and words of text. A LINE
Blockobject contains one or more WORDBlockobjects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value ofFeatureTypes).
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.
AnalyzeExpense synchronously analyzes an input document for financially
related relationships between text.
Information is returned as ExpenseDocuments and seperated as follows.
LineItemGroups- A data set containingLineItemswhich store information about the lines of text, such as an item purchased and its price on a receipt.SummaryFields- Contains all other information a receipt, such as header information or the vendors name.
Analyzes identity documents for relevant information.
This information is extracted and returned as IdentityDocumentFields, which
records both the normalized field and value of the extracted text.
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.
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
You start asynchronous text analysis by calling StartDocumentAnalysis, which
returns a job identifier (JobId). When the text analysis operation finishes,
Amazon Textract publishes a completion status to the Amazon Simple Notification
Service (Amazon SNS) topic that's registered in the initial call to
StartDocumentAnalysis. To get the results of the text-detection operation,
first check that the status value published to the Amazon SNS topic is
SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier
(JobId) from the initial call to StartDocumentAnalysis.
GetDocumentAnalysis returns an array of Block objects. The following types
of information are returned:
Form data (key-value pairs). The related information is returned in two
Blockobjects, each of typeKEY_VALUE_SET: a KEYBlockobject and a VALUEBlockobject. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.Table and table cell data. A TABLE
Blockobject contains information about a detected table. A CELLBlockobject is returned for each cell in a table.Lines and words of text. A LINE
Blockobject contains one or more WORDBlockobjects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of theStartDocumentAnalysisFeatureTypesinput parameter).
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.
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.
Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts.
Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts.
You start asynchronous invoice/receipt analysis by calling
StartExpenseAnalysis, which returns a job identifier (JobId). Upon
completion of the invoice/receipt analysis, Amazon Textract publishes the
completion status to the Amazon Simple Notification Service (Amazon SNS) topic.
This topic must be registered in the initial call to StartExpenseAnalysis. To
get the results of the invoice/receipt analysis operation, first ensure that the
status value published to the Amazon SNS topic is SUCCEEDED. If so, call
GetExpenseAnalysis, and pass the job identifier (JobId) from the initial
call to StartExpenseAnalysis.
Use the MaxResults parameter to limit the number of blocks that are returned. If
there are more results than specified in MaxResults, the value of NextToken
in the operation response contains a pagination token for getting the next set
of results. To get the next page of results, call GetExpenseAnalysis, and
populate the NextToken request parameter with the token value that's returned
from the previous call to GetExpenseAnalysis.
For more information, see Analyzing Invoices and Receipts.
Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG,
TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use
DocumentLocation to specify the bucket name and file name of the document.
StartDocumentAnalysis returns a job identifier (JobId) that you use to get
the results of the operation. When text analysis is finished, Amazon Textract
publishes a completion status to the Amazon Simple Notification Service (Amazon
SNS) topic that you specify in NotificationChannel. To get the results of the
text analysis operation, first check that the status value published to the
Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the
job identifier (JobId) from the initial call to StartDocumentAnalysis.
For more information, see Document Text Analysis.
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, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use
DocumentLocation to specify the bucket name and file name of the document.
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.
Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.
StartExpenseAnalysis can analyze text in documents that are in JPEG, PNG, and
PDF format. The documents must be stored in an Amazon S3 bucket. Use the
DocumentLocation parameter to specify the name of your S3 bucket and the name
of the document in that bucket.
StartExpenseAnalysis returns a job identifier (JobId) that you will provide
to GetExpenseAnalysis to retrieve the results of the operation. When the
analysis of the input invoices/receipts is finished, Amazon Textract publishes a
completion status to the Amazon Simple Notification Service (Amazon SNS) topic
that you provide to the NotificationChannel. To obtain the results of the
invoice and receipt analysis operation, ensure that the status value published
to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and
pass the job identifier (JobId) that was returned by your call to
StartExpenseAnalysis.
For more information, see Analyzing Invoices and Receipts.