Class: Aws::Textract::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Textract::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-textract/client.rb
Overview
An API client for Textract. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::Textract::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#analyze_document(params = {}) ⇒ Types::AnalyzeDocumentResponse
Analyzes an input document for relationships between detected items.
-
#analyze_expense(params = {}) ⇒ Types::AnalyzeExpenseResponse
‘AnalyzeExpense` synchronously analyzes an input document for financially related relationships between text.
-
#analyze_id(params = {}) ⇒ Types::AnalyzeIDResponse
Analyzes identity documents for relevant information.
-
#detect_document_text(params = {}) ⇒ Types::DetectDocumentTextResponse
Detects text in the input document.
-
#get_document_analysis(params = {}) ⇒ Types::GetDocumentAnalysisResponse
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
-
#get_document_text_detection(params = {}) ⇒ Types::GetDocumentTextDetectionResponse
Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
-
#get_expense_analysis(params = {}) ⇒ Types::GetExpenseAnalysisResponse
Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts.
-
#get_lending_analysis(params = {}) ⇒ Types::GetLendingAnalysisResponse
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.
-
#get_lending_analysis_summary(params = {}) ⇒ Types::GetLendingAnalysisSummaryResponse
Gets summarized results for the ‘StartLendingAnalysis` operation, which analyzes text in a lending document.
-
#start_document_analysis(params = {}) ⇒ Types::StartDocumentAnalysisResponse
Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
-
#start_document_text_detection(params = {}) ⇒ Types::StartDocumentTextDetectionResponse
Starts the asynchronous detection of text in a document.
-
#start_expense_analysis(params = {}) ⇒ Types::StartExpenseAnalysisResponse
Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.
-
#start_lending_analysis(params = {}) ⇒ Types::StartLendingAnalysisResponse
Starts the classification and analysis of an input document.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
395 396 397 |
# File 'lib/aws-sdk-textract/client.rb', line 395 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2141 2142 2143 |
# File 'lib/aws-sdk-textract/client.rb', line 2141 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2144 2145 2146 |
# File 'lib/aws-sdk-textract/client.rb', line 2144 def errors_module Errors end |
Instance Method Details
#analyze_document(params = {}) ⇒ Types::AnalyzeDocumentResponse
Analyzes an input document for relationships between detected items.
The types of information returned are as follows:
-
Form data (key-value pairs). The related information is returned in two Block objects, each of type ‘KEY_VALUE_SET`: a KEY `Block` object and a VALUE `Block` object. For example, *Name: Ana Silva Carolina* contains a key and value. Name: is the key. *Ana Silva Carolina* is the value.
-
Table and table cell data. A TABLE ‘Block` object contains information about a detected table. A CELL `Block` object is returned for each cell in a table.
-
Lines and words of text. A LINE ‘Block` object contains one or more WORD `Block` objects. All lines and words that are detected in the document are returned (including text that doesn’t have a relationship with the value of ‘FeatureTypes`).
-
Signatures. A SIGNATURE ‘Block` object contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table.
-
Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.
-
Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.
Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT ‘Block` object contains information about a selection element, including the selection status.
You can choose which type of analysis to perform by specifying the ‘FeatureTypes` list.
The output is returned in a list of ‘Block` objects.
‘AnalyzeDocument` is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.
For more information, see [Document Text Analysis].
[1]: docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html
559 560 561 562 |
# File 'lib/aws-sdk-textract/client.rb', line 559 def analyze_document(params = {}, = {}) req = build_request(:analyze_document, params) req.send_request() end |
#analyze_expense(params = {}) ⇒ Types::AnalyzeExpenseResponse
‘AnalyzeExpense` synchronously analyzes an input document for financially related relationships between text.
Information is returned as ‘ExpenseDocuments` and seperated as follows:
-
‘LineItemGroups`- A data set containing `LineItems` which store information about the lines of text, such as an item purchased and its price on a receipt.
-
‘SummaryFields`- Contains all other information a receipt, such as header information or the vendors name.
718 719 720 721 |
# File 'lib/aws-sdk-textract/client.rb', line 718 def analyze_expense(params = {}, = {}) req = build_request(:analyze_expense, params) req.send_request() end |
#analyze_id(params = {}) ⇒ Types::AnalyzeIDResponse
Analyzes identity documents for relevant information. This information is extracted and returned as ‘IdentityDocumentFields`, which records both the normalized field and value of the extracted text. Unlike other Amazon Textract operations, `AnalyzeID` doesn’t return any Geometry data.
802 803 804 805 |
# File 'lib/aws-sdk-textract/client.rb', line 802 def analyze_id(params = {}, = {}) req = build_request(:analyze_id, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 |
# File 'lib/aws-sdk-textract/client.rb', line 2119 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-textract' context[:gem_version] = '1.50.0' Seahorse::Client::Request.new(handlers, context) end |
#detect_document_text(params = {}) ⇒ Types::DetectDocumentTextResponse
Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of the following image formats: JPEG, PNG, PDF, or TIFF. ‘DetectDocumentText` returns the detected text in an array of Block objects.
Each document page has as an associated ‘Block` of type PAGE. Each PAGE `Block` object is the parent of LINE `Block` objects that represent the lines of detected text on a page. A LINE `Block` object is a parent for each word that makes up the line. Words are represented by `Block` objects of type WORD.
‘DetectDocumentText` is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.
For more information, see [Document Text Detection].
[1]: docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html
894 895 896 897 |
# File 'lib/aws-sdk-textract/client.rb', line 894 def detect_document_text(params = {}, = {}) req = build_request(:detect_document_text, params) req.send_request() end |
#get_document_analysis(params = {}) ⇒ Types::GetDocumentAnalysisResponse
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (‘JobId`). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that’s registered in the initial call to ‘StartDocumentAnalysis`. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is `SUCCEEDED`. If so, call `GetDocumentAnalysis`, and pass the job identifier (`JobId`) from the initial call to `StartDocumentAnalysis`.
‘GetDocumentAnalysis` returns an array of Block objects. The following types of information are returned:
-
Form data (key-value pairs). The related information is returned in two Block objects, each of type ‘KEY_VALUE_SET`: a KEY `Block` object and a VALUE `Block` object. For example, *Name: Ana Silva Carolina* contains a key and value. Name: is the key. *Ana Silva Carolina* is the value.
-
Table and table cell data. A TABLE ‘Block` object contains information about a detected table. A CELL `Block` object is returned for each cell in a table.
-
Lines and words of text. A LINE ‘Block` object contains one or more WORD `Block` objects. All lines and words that are detected in the document are returned (including text that doesn’t have a relationship with the value of the ‘StartDocumentAnalysis` `FeatureTypes` input parameter).
-
Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.
-
Query Results. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.
<note markdown=“1”> While processing a document with queries, look out for ‘INVALID_REQUEST_PARAMETERS` output. This indicates that either the per page query limit has been exceeded or that the operation is trying to query a page in the document which doesn’t exist.
</note>
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].
[1]: docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html
1044 1045 1046 1047 |
# File 'lib/aws-sdk-textract/client.rb', line 1044 def get_document_analysis(params = {}, = {}) req = build_request(:get_document_analysis, params) req.send_request() end |
#get_document_text_detection(params = {}) ⇒ Types::GetDocumentTextDetectionResponse
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].
[1]: docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html
1166 1167 1168 1169 |
# File 'lib/aws-sdk-textract/client.rb', line 1166 def get_document_text_detection(params = {}, = {}) req = build_request(:get_document_text_detection, params) req.send_request() end |
#get_expense_analysis(params = {}) ⇒ Types::GetExpenseAnalysisResponse
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].
[1]: docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html
1341 1342 1343 1344 |
# File 'lib/aws-sdk-textract/client.rb', line 1341 def get_expense_analysis(params = {}, = {}) req = build_request(:get_expense_analysis, params) req.send_request() end |
#get_lending_analysis(params = {}) ⇒ Types::GetLendingAnalysisResponse
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`.
1580 1581 1582 1583 |
# File 'lib/aws-sdk-textract/client.rb', line 1580 def get_lending_analysis(params = {}, = {}) req = build_request(:get_lending_analysis, params) req.send_request() end |
#get_lending_analysis_summary(params = {}) ⇒ Types::GetLendingAnalysisSummaryResponse
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`.
1651 1652 1653 1654 |
# File 'lib/aws-sdk-textract/client.rb', line 1651 def get_lending_analysis_summary(params = {}, = {}) req = build_request(:get_lending_analysis_summary, params) req.send_request() end |
#start_document_analysis(params = {}) ⇒ Types::StartDocumentAnalysisResponse
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].
[1]: docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html
1772 1773 1774 1775 |
# File 'lib/aws-sdk-textract/client.rb', line 1772 def start_document_analysis(params = {}, = {}) req = build_request(:start_document_analysis, params) req.send_request() end |
#start_document_text_detection(params = {}) ⇒ Types::StartDocumentTextDetectionResponse
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].
[1]: docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html
1874 1875 1876 1877 |
# File 'lib/aws-sdk-textract/client.rb', line 1874 def start_document_text_detection(params = {}, = {}) req = build_request(:start_document_text_detection, params) req.send_request() end |
#start_expense_analysis(params = {}) ⇒ Types::StartExpenseAnalysisResponse
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].
[1]: docs.aws.amazon.com/textract/latest/dg/invoice-receipts.html
1976 1977 1978 1979 |
# File 'lib/aws-sdk-textract/client.rb', line 1976 def start_expense_analysis(params = {}, = {}) req = build_request(:start_expense_analysis, params) req.send_request() end |
#start_lending_analysis(params = {}) ⇒ Types::StartLendingAnalysisResponse
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)
2110 2111 2112 2113 |
# File 'lib/aws-sdk-textract/client.rb', line 2110 def start_lending_analysis(params = {}, = {}) req = build_request(:start_lending_analysis, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2134 2135 2136 |
# File 'lib/aws-sdk-textract/client.rb', line 2134 def waiter_names [] end |