Class: Aws::Textract::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Textract::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-textract/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#analyze_document(params = {}) ⇒ Types::AnalyzeDocumentResponse
Analyzes an input document for relationships between detected items.
-
#analyze_expense(params = {}) ⇒ Types::AnalyzeExpenseResponse
AnalyzeExpensesynchronously analyzes an input document for financially related relationships between text. -
#analyze_id(params = {}) ⇒ Types::AnalyzeIDResponse
Analyzes identity documents for relevant information.
-
#create_adapter(params = {}) ⇒ Types::CreateAdapterResponse
Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents.
-
#create_adapter_version(params = {}) ⇒ Types::CreateAdapterVersionResponse
Creates a new version of an adapter.
-
#create_blueprint(params = {}) ⇒ Types::CreateBlueprintResponse
Creates a blueprint that defines the schema Amazon Textract uses to extract structured data from a document during a document insights job.
-
#create_blueprint_version(params = {}) ⇒ Types::CreateBlueprintVersionResponse
Creates a new, immutable version of an existing blueprint so that projects can pin to a specific version.
-
#create_project(params = {}) ⇒ Types::CreateProjectResponse
Creates a project that groups the configuration used to run document insights jobs.
-
#delete_adapter(params = {}) ⇒ Struct
Deletes an Amazon Textract adapter.
-
#delete_adapter_version(params = {}) ⇒ Struct
Deletes an Amazon Textract adapter version.
-
#delete_blueprint(params = {}) ⇒ Struct
Deletes a blueprint, or a specific version of a blueprint.
-
#delete_project(params = {}) ⇒ Struct
Deletes a project.
-
#detect_document_text(params = {}) ⇒ Types::DetectDocumentTextResponse
Detects text in the input document.
-
#get_adapter(params = {}) ⇒ Types::GetAdapterResponse
Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.
-
#get_adapter_version(params = {}) ⇒ Types::GetAdapterVersionResponse
Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.
-
#get_blueprint(params = {}) ⇒ Types::GetBlueprintResponse
Gets the details of a blueprint, including its schema, encryption settings, and timestamps.
-
#get_document_analysis(params = {}) ⇒ Types::GetDocumentAnalysisResponse
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
-
#get_document_insights(params = {}) ⇒ Types::GetDocumentInsightsResponse
Gets the status and results of a document insights job that was started by StartDocumentInsights.
-
#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
StartLendingAnalysisoperation, which analyzes text in a lending document. -
#get_project(params = {}) ⇒ Types::GetProjectResponse
Gets the details of a project, including its configuration, status, and timestamps.
-
#list_adapter_versions(params = {}) ⇒ Types::ListAdapterVersionsResponse
List all version of an adapter that meet the specified filtration criteria.
-
#list_adapters(params = {}) ⇒ Types::ListAdaptersResponse
Lists all adapters that match the specified filtration criteria.
-
#list_blueprints(params = {}) ⇒ Types::ListBlueprintsResponse
Lists the blueprints that are available to the caller, with optional filtering by project and resource owner.
-
#list_projects(params = {}) ⇒ Types::ListProjectsResponse
Lists the projects that are available to the caller, with optional filtering by blueprint.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags for an Amazon Textract resource.
-
#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_insights(params = {}) ⇒ Types::StartDocumentInsightsResponse
Starts an asynchronous job that analyzes a document using the configuration defined by a project or a set of blueprints.
-
#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.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes any tags with the specified keys from the specified resource.
-
#update_adapter(params = {}) ⇒ Types::UpdateAdapterResponse
Update the configuration for an adapter.
-
#update_blueprint(params = {}) ⇒ Types::UpdateBlueprintResponse
Updates an existing blueprint, replacing its schema and, optionally, its encryption configuration.
-
#update_project(params = {}) ⇒ Types::UpdateProjectResponse
Updates the configuration of an existing project.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
486 487 488 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 486 def initialize(*args) super 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 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).Signatures. A SIGNATURE
Blockobject 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.
675 676 677 678 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 675 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 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.
839 840 841 842 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 839 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.
924 925 926 927 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 924 def analyze_id(params = {}, = {}) req = build_request(:analyze_id, params) req.send_request() end |
#create_adapter(params = {}) ⇒ Types::CreateAdapterResponse
Creates an adapter, which can be fine-tuned for enhanced performance
on user provided documents. Takes an AdapterName and FeatureType.
Currently the only supported feature type is QUERIES. You can also
provide a Description, Tags, and a ClientRequestToken. You can choose
whether or not the adapter should be AutoUpdated with the AutoUpdate
argument. By default, AutoUpdate is set to DISABLED.
986 987 988 989 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 986 def create_adapter(params = {}, = {}) req = build_request(:create_adapter, params) req.send_request() end |
#create_adapter_version(params = {}) ⇒ Types::CreateAdapterVersionResponse
Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags.
1087 1088 1089 1090 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1087 def create_adapter_version(params = {}, = {}) req = build_request(:create_adapter_version, params) req.send_request() end |
#create_blueprint(params = {}) ⇒ Types::CreateBlueprintResponse
Creates a blueprint that defines the schema Amazon Textract uses to extract structured data from a document during a document insights job. A blueprint describes the fields to extract and how to normalize them.
1149 1150 1151 1152 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1149 def create_blueprint(params = {}, = {}) req = build_request(:create_blueprint, params) req.send_request() end |
#create_blueprint_version(params = {}) ⇒ Types::CreateBlueprintVersionResponse
Creates a new, immutable version of an existing blueprint so that projects can pin to a specific version.
1191 1192 1193 1194 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1191 def create_blueprint_version(params = {}, = {}) req = build_request(:create_blueprint_version, params) req.send_request() end |
#create_project(params = {}) ⇒ Types::CreateProjectResponse
Creates a project that groups the configuration used to run document insights jobs.
1322 1323 1324 1325 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1322 def create_project(params = {}, = {}) req = build_request(:create_project, params) req.send_request() end |
#delete_adapter(params = {}) ⇒ Struct
Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.
1345 1346 1347 1348 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1345 def delete_adapter(params = {}, = {}) req = build_request(:delete_adapter, params) req.send_request() end |
#delete_adapter_version(params = {}) ⇒ Struct
Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion.
1374 1375 1376 1377 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1374 def delete_adapter_version(params = {}, = {}) req = build_request(:delete_adapter_version, params) req.send_request() end |
#delete_blueprint(params = {}) ⇒ Struct
Deletes a blueprint, or a specific version of a blueprint.
1401 1402 1403 1404 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1401 def delete_blueprint(params = {}, = {}) req = build_request(:delete_blueprint, params) req.send_request() end |
#delete_project(params = {}) ⇒ Struct
Deletes a project.
1423 1424 1425 1426 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1423 def delete_project(params = {}, = {}) req = build_request(:delete_project, params) req.send_request() 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.
1516 1517 1518 1519 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1516 def detect_document_text(params = {}, = {}) req = build_request(:detect_document_text, params) req.send_request() end |
#get_adapter(params = {}) ⇒ Types::GetAdapterResponse
Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.
1560 1561 1562 1563 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1560 def get_adapter(params = {}, = {}) req = build_request(:get_adapter, params) req.send_request() end |
#get_adapter_version(params = {}) ⇒ Types::GetAdapterVersionResponse
Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.
1629 1630 1631 1632 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1629 def get_adapter_version(params = {}, = {}) req = build_request(:get_adapter_version, params) req.send_request() end |
#get_blueprint(params = {}) ⇒ Types::GetBlueprintResponse
Gets the details of a blueprint, including its schema, encryption settings, and timestamps.
1678 1679 1680 1681 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1678 def get_blueprint(params = {}, = {}) req = build_request(:get_blueprint, 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 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).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.
INVALID_REQUEST_PARAMETERS output. This indicates that either the
per page query limit has been exceeded or that the operation is trying
to query a page in the document which doesn’t exist.
Selection elements such as check boxes and option buttons (radio
buttons) can be detected in form data and in tables. A
SELECTION_ELEMENT Block object contains information about a
selection element, including the selection status.
Use the MaxResults parameter to limit the number of blocks that are
returned. If there are more results than specified in MaxResults,
the value of NextToken in the operation response contains a
pagination token for getting the next set of results. To get the next
page of results, call GetDocumentAnalysis, and populate the
NextToken request parameter with the token value that's returned
from the previous call to GetDocumentAnalysis.
For more information, see Document Text Analysis.
1829 1830 1831 1832 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1829 def get_document_analysis(params = {}, = {}) req = build_request(:get_document_analysis, params) req.send_request() end |
#get_document_insights(params = {}) ⇒ Types::GetDocumentInsightsResponse
Gets the status and results of a document insights job that was started by StartDocumentInsights.
1865 1866 1867 1868 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1865 def get_document_insights(params = {}, = {}) req = build_request(:get_document_insights, 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.
1988 1989 1990 1991 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 1988 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.
2168 2169 2170 2171 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 2168 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.
2416 2417 2418 2419 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 2416 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.
2487 2488 2489 2490 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 2487 def get_lending_analysis_summary(params = {}, = {}) req = build_request(:get_lending_analysis_summary, params) req.send_request() end |
#get_project(params = {}) ⇒ Types::GetProjectResponse
Gets the details of a project, including its configuration, status, and timestamps.
2554 2555 2556 2557 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 2554 def get_project(params = {}, = {}) req = build_request(:get_project, params) req.send_request() end |
#list_adapter_versions(params = {}) ⇒ Types::ListAdapterVersionsResponse
List all version of an adapter that meet the specified filtration criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2616 2617 2618 2619 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 2616 def list_adapter_versions(params = {}, = {}) req = build_request(:list_adapter_versions, params) req.send_request() end |
#list_adapters(params = {}) ⇒ Types::ListAdaptersResponse
Lists all adapters that match the specified filtration criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2669 2670 2671 2672 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 2669 def list_adapters(params = {}, = {}) req = build_request(:list_adapters, params) req.send_request() end |
#list_blueprints(params = {}) ⇒ Types::ListBlueprintsResponse
Lists the blueprints that are available to the caller, with optional
filtering by project and resource owner. The results are paginated. If
the response includes a NextToken value, pass it in a subsequent
call to retrieve the next page of results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2735 2736 2737 2738 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 2735 def list_blueprints(params = {}, = {}) req = build_request(:list_blueprints, params) req.send_request() end |
#list_projects(params = {}) ⇒ Types::ListProjectsResponse
Lists the projects that are available to the caller, with optional
filtering by blueprint. The results are paginated. If the response
includes a NextToken value, pass it in a subsequent call to retrieve
the next page of results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2790 2791 2792 2793 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 2790 def list_projects(params = {}, = {}) req = build_request(:list_projects, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags for an Amazon Textract resource.
2820 2821 2822 2823 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 2820 def (params = {}, = {}) req = build_request(:list_tags_for_resource, 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.
2953 2954 2955 2956 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 2953 def start_document_analysis(params = {}, = {}) req = build_request(:start_document_analysis, params) req.send_request() end |
#start_document_insights(params = {}) ⇒ Types::StartDocumentInsightsResponse
Starts an asynchronous job that analyzes a document using the configuration defined by a project or a set of blueprints. Use GetDocumentInsights to retrieve the results of the job.
3032 3033 3034 3035 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 3032 def start_document_insights(params = {}, = {}) req = build_request(:start_document_insights, 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.
StartDocumentTextDetection 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.
3134 3135 3136 3137 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 3134 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.
3236 3237 3238 3239 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 3236 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)
3370 3371 3372 3373 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 3370 def start_lending_analysis(params = {}, = {}) req = build_request(:start_lending_analysis, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to the specified resource.
3400 3401 3402 3403 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 3400 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes any tags with the specified keys from the specified resource.
3428 3429 3430 3431 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 3428 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_adapter(params = {}) ⇒ Types::UpdateAdapterResponse
Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.
3481 3482 3483 3484 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 3481 def update_adapter(params = {}, = {}) req = build_request(:update_adapter, params) req.send_request() end |
#update_blueprint(params = {}) ⇒ Types::UpdateBlueprintResponse
Updates an existing blueprint, replacing its schema and, optionally, its encryption configuration.
3525 3526 3527 3528 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 3525 def update_blueprint(params = {}, = {}) req = build_request(:update_blueprint, params) req.send_request() end |
#update_project(params = {}) ⇒ Types::UpdateProjectResponse
Updates the configuration of an existing project. If you omit a configuration, UpdateProject leaves it unchanged. A configuration that you supply replaces the stored one, so include every setting that you want to keep.
3646 3647 3648 3649 |
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/client.rb', line 3646 def update_project(params = {}, = {}) req = build_request(:update_project, params) req.send_request() end |