@Generated(value="software.amazon.awssdk:codegen") public interface TextractAsyncClient extends SdkClient
builder()
method.
Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AnalyzeDocumentResponse> |
analyzeDocument(AnalyzeDocumentRequest analyzeDocumentRequest)
Analyzes an input document for relationships between detected items.
|
default CompletableFuture<AnalyzeDocumentResponse> |
analyzeDocument(Consumer<AnalyzeDocumentRequest.Builder> analyzeDocumentRequest)
Analyzes an input document for relationships between detected items.
|
static TextractAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
TextractAsyncClient. |
static TextractAsyncClient |
create()
Create a
TextractAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<DetectDocumentTextResponse> |
detectDocumentText(Consumer<DetectDocumentTextRequest.Builder> detectDocumentTextRequest)
Detects text in the input document.
|
default CompletableFuture<DetectDocumentTextResponse> |
detectDocumentText(DetectDocumentTextRequest detectDocumentTextRequest)
Detects text in the input document.
|
default CompletableFuture<GetDocumentAnalysisResponse> |
getDocumentAnalysis(Consumer<GetDocumentAnalysisRequest.Builder> getDocumentAnalysisRequest)
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
|
default CompletableFuture<GetDocumentAnalysisResponse> |
getDocumentAnalysis(GetDocumentAnalysisRequest getDocumentAnalysisRequest)
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
|
default CompletableFuture<GetDocumentTextDetectionResponse> |
getDocumentTextDetection(Consumer<GetDocumentTextDetectionRequest.Builder> getDocumentTextDetectionRequest)
Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
|
default CompletableFuture<GetDocumentTextDetectionResponse> |
getDocumentTextDetection(GetDocumentTextDetectionRequest getDocumentTextDetectionRequest)
Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
|
default CompletableFuture<StartDocumentAnalysisResponse> |
startDocumentAnalysis(Consumer<StartDocumentAnalysisRequest.Builder> startDocumentAnalysisRequest)
Starts the asynchronous analysis of an input document for relationships between detected items such as key-value
pairs, tables, and selection elements.
|
default CompletableFuture<StartDocumentAnalysisResponse> |
startDocumentAnalysis(StartDocumentAnalysisRequest startDocumentAnalysisRequest)
Starts the asynchronous analysis of an input document for relationships between detected items such as key-value
pairs, tables, and selection elements.
|
default CompletableFuture<StartDocumentTextDetectionResponse> |
startDocumentTextDetection(Consumer<StartDocumentTextDetectionRequest.Builder> startDocumentTextDetectionRequest)
Starts the asynchronous detection of text in a document.
|
default CompletableFuture<StartDocumentTextDetectionResponse> |
startDocumentTextDetection(StartDocumentTextDetectionRequest startDocumentTextDetectionRequest)
Starts the asynchronous detection of text in a document.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static TextractAsyncClient create()
TextractAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static TextractAsyncClientBuilder builder()
TextractAsyncClient.default CompletableFuture<AnalyzeDocumentResponse> analyzeDocument(AnalyzeDocumentRequest analyzeDocumentRequest)
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).
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.
analyzeDocumentRequest - InvalidParameterException exception occurs when neither of the
S3Object or Bytes values are supplied in the Document request
parameter. Validate your parameter before calling the API operation again.default CompletableFuture<AnalyzeDocumentResponse> analyzeDocument(Consumer<AnalyzeDocumentRequest.Builder> analyzeDocumentRequest)
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).
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.
This is a convenience which creates an instance of the AnalyzeDocumentRequest.Builder avoiding the need
to create one manually via AnalyzeDocumentRequest.builder()
analyzeDocumentRequest - A Consumer that will call methods on AnalyzeDocumentRequest.Builder to create a request.InvalidParameterException exception occurs when neither of the
S3Object or Bytes values are supplied in the Document request
parameter. Validate your parameter before calling the API operation again.default CompletableFuture<DetectDocumentTextResponse> detectDocumentText(DetectDocumentTextRequest detectDocumentTextRequest)
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.
detectDocumentTextRequest - InvalidParameterException exception occurs when neither of the
S3Object or Bytes values are supplied in the Document request
parameter. Validate your parameter before calling the API operation again.default CompletableFuture<DetectDocumentTextResponse> detectDocumentText(Consumer<DetectDocumentTextRequest.Builder> detectDocumentTextRequest)
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.
This is a convenience which creates an instance of the DetectDocumentTextRequest.Builder avoiding the
need to create one manually via DetectDocumentTextRequest.builder()
detectDocumentTextRequest - A Consumer that will call methods on DetectDocumentTextRequest.Builder to create a
request.InvalidParameterException exception occurs when neither of the
S3Object or Bytes values are supplied in the Document request
parameter. Validate your parameter before calling the API operation again.default CompletableFuture<GetDocumentAnalysisResponse> getDocumentAnalysis(GetDocumentAnalysisRequest getDocumentAnalysisRequest)
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).
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.
getDocumentAnalysisRequest - InvalidParameterException exception occurs when neither of the
S3Object or Bytes values are supplied in the Document request
parameter. Validate your parameter before calling the API operation again.default CompletableFuture<GetDocumentAnalysisResponse> getDocumentAnalysis(Consumer<GetDocumentAnalysisRequest.Builder> getDocumentAnalysisRequest)
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).
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.
This is a convenience which creates an instance of the GetDocumentAnalysisRequest.Builder avoiding the
need to create one manually via GetDocumentAnalysisRequest.builder()
getDocumentAnalysisRequest - A Consumer that will call methods on GetDocumentAnalysisRequest.Builder to create a
request.InvalidParameterException exception occurs when neither of the
S3Object or Bytes values are supplied in the Document request
parameter. Validate your parameter before calling the API operation again.default CompletableFuture<GetDocumentTextDetectionResponse> getDocumentTextDetection(GetDocumentTextDetectionRequest getDocumentTextDetectionRequest)
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.
getDocumentTextDetectionRequest - InvalidParameterException exception occurs when neither of the
S3Object or Bytes values are supplied in the Document request
parameter. Validate your parameter before calling the API operation again.default CompletableFuture<GetDocumentTextDetectionResponse> getDocumentTextDetection(Consumer<GetDocumentTextDetectionRequest.Builder> getDocumentTextDetectionRequest)
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.
This is a convenience which creates an instance of the GetDocumentTextDetectionRequest.Builder avoiding
the need to create one manually via GetDocumentTextDetectionRequest.builder()
getDocumentTextDetectionRequest - A Consumer that will call methods on GetDocumentTextDetectionRequest.Builder to create a
request.InvalidParameterException exception occurs when neither of the
S3Object or Bytes values are supplied in the Document request
parameter. Validate your parameter before calling the API operation again.default CompletableFuture<StartDocumentAnalysisResponse> startDocumentAnalysis(StartDocumentAnalysisRequest startDocumentAnalysisRequest)
Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, and PDF format. The
documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name
of the document.
StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results
of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon
Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the
results of the text analysis operation, first check that the status value published to the Amazon SNS topic is
SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId)
from the initial call to StartDocumentAnalysis.
For more information, see Document Text Analysis.
startDocumentAnalysisRequest - InvalidParameterException exception occurs when neither of the
S3Object or Bytes values are supplied in the Document request
parameter. Validate your parameter before calling the API operation again.ClientRequestToken input parameter was reused
with an operation, but at least one of the other input parameters is different from the previous call to
the operation.StartDocumentTextDetection,
for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Textract service limit.default CompletableFuture<StartDocumentAnalysisResponse> startDocumentAnalysis(Consumer<StartDocumentAnalysisRequest.Builder> startDocumentAnalysisRequest)
Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, and PDF format. The
documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name
of the document.
StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results
of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon
Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the
results of the text analysis operation, first check that the status value published to the Amazon SNS topic is
SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId)
from the initial call to StartDocumentAnalysis.
For more information, see Document Text Analysis.
This is a convenience which creates an instance of the StartDocumentAnalysisRequest.Builder avoiding the
need to create one manually via StartDocumentAnalysisRequest.builder()
startDocumentAnalysisRequest - A Consumer that will call methods on StartDocumentAnalysisRequest.Builder to create a
request.InvalidParameterException exception occurs when neither of the
S3Object or Bytes values are supplied in the Document request
parameter. Validate your parameter before calling the API operation again.ClientRequestToken input parameter was reused
with an operation, but at least one of the other input parameters is different from the previous call to
the operation.StartDocumentTextDetection,
for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Textract service limit.default CompletableFuture<StartDocumentTextDetectionResponse> startDocumentTextDetection(StartDocumentTextDetectionRequest startDocumentTextDetectionRequest)
Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.
StartDocumentTextDetection can analyze text in documents that are in JPEG, PNG, and PDF format. The
documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name
of the document.
StartTextDetection returns a job identifier (JobId) that you use to get the results of
the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon
Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the
results of the text detection operation, first check that the status value published to the Amazon SNS topic is
SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (
JobId) from the initial call to StartDocumentTextDetection.
For more information, see Document Text Detection.
startDocumentTextDetectionRequest - InvalidParameterException exception occurs when neither of the
S3Object or Bytes values are supplied in the Document request
parameter. Validate your parameter before calling the API operation again.ClientRequestToken input parameter was reused
with an operation, but at least one of the other input parameters is different from the previous call to
the operation.StartDocumentTextDetection,
for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Textract service limit.default CompletableFuture<StartDocumentTextDetectionResponse> startDocumentTextDetection(Consumer<StartDocumentTextDetectionRequest.Builder> startDocumentTextDetectionRequest)
Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.
StartDocumentTextDetection can analyze text in documents that are in JPEG, PNG, and PDF format. The
documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name
of the document.
StartTextDetection returns a job identifier (JobId) that you use to get the results of
the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon
Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the
results of the text detection operation, first check that the status value published to the Amazon SNS topic is
SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (
JobId) from the initial call to StartDocumentTextDetection.
For more information, see Document Text Detection.
This is a convenience which creates an instance of the StartDocumentTextDetectionRequest.Builder avoiding
the need to create one manually via StartDocumentTextDetectionRequest.builder()
startDocumentTextDetectionRequest - A Consumer that will call methods on StartDocumentTextDetectionRequest.Builder to create a
request.InvalidParameterException exception occurs when neither of the
S3Object or Bytes values are supplied in the Document request
parameter. Validate your parameter before calling the API operation again.ClientRequestToken input parameter was reused
with an operation, but at least one of the other input parameters is different from the previous call to
the operation.StartDocumentTextDetection,
for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of
concurrently running jobs is below the Amazon Textract service limit.Copyright © 2021. All rights reserved.