AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Implementation for accessing Textract
Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.Namespace: Amazon.Textract
Assembly: AWSSDK.Textract.dll
Version: 3.x.y.z
public class AmazonTextractClient : AmazonServiceClient IAmazonService, IAmazonTextract, IDisposable
The AmazonTextractClient type exposes the following members
Name | Description | |
---|---|---|
AmazonTextractClient() |
Constructs AmazonTextractClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonTextractClient(RegionEndpoint) |
Constructs AmazonTextractClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonTextractClient(AmazonTextractConfig) |
Constructs AmazonTextractClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonTextractClient(AWSCredentials) |
Constructs AmazonTextractClient with AWS Credentials |
|
AmazonTextractClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonTextractClient with AWS Credentials |
|
AmazonTextractClient(AWSCredentials, AmazonTextractConfig) |
Constructs AmazonTextractClient with AWS Credentials and an AmazonTextractClient Configuration object. |
|
AmazonTextractClient(string, string) |
Constructs AmazonTextractClient with AWS Access Key ID and AWS Secret Key |
|
AmazonTextractClient(string, string, RegionEndpoint) |
Constructs AmazonTextractClient with AWS Access Key ID and AWS Secret Key |
|
AmazonTextractClient(string, string, AmazonTextractConfig) |
Constructs AmazonTextractClient with AWS Access Key ID, AWS Secret Key and an AmazonTextractClient Configuration object. |
|
AmazonTextractClient(string, string, string) |
Constructs AmazonTextractClient with AWS Access Key ID and AWS Secret Key |
|
AmazonTextractClient(string, string, string, RegionEndpoint) |
Constructs AmazonTextractClient with AWS Access Key ID and AWS Secret Key |
|
AmazonTextractClient(string, string, string, AmazonTextractConfig) |
Constructs AmazonTextractClient with AWS Access Key ID, AWS Secret Key and an AmazonTextractClient Configuration object. |
Name | Type | Description | |
---|---|---|---|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. | |
Paginators | Amazon.Textract.Model.ITextractPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
AnalyzeDocument(AnalyzeDocumentRequest) |
Analyzes an input document for relationships between detected items. The types of information returned are as follows:
Selection elements such as check boxes and option buttons (radio buttons) can be detected
in form data and in tables. A SELECTION_ELEMENT
You can choose which type of analysis to perform by specifying the
The output is returned in a list of
For more information, see Document Text Analysis. |
|
AnalyzeDocumentAsync(AnalyzeDocumentRequest, CancellationToken) |
Analyzes an input document for relationships between detected items. The types of information returned are as follows:
Selection elements such as check boxes and option buttons (radio buttons) can be detected
in form data and in tables. A SELECTION_ELEMENT
You can choose which type of analysis to perform by specifying the
The output is returned in a list of
For more information, see Document Text Analysis. |
|
AnalyzeExpense(AnalyzeExpenseRequest) |
Information is returned as
|
|
AnalyzeExpenseAsync(AnalyzeExpenseRequest, CancellationToken) |
Information is returned as
|
|
AnalyzeID(AnalyzeIDRequest) |
Analyzes identity documents for relevant information. This information is extracted
and returned as |
|
AnalyzeIDAsync(AnalyzeIDRequest, CancellationToken) |
Analyzes identity documents for relevant information. This information is extracted
and returned as |
|
CreateAdapter(CreateAdapterRequest) |
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 |
|
CreateAdapterAsync(CreateAdapterRequest, CancellationToken) |
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 |
|
CreateAdapterVersion(CreateAdapterVersionRequest) |
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. |
|
CreateAdapterVersionAsync(CreateAdapterVersionRequest, CancellationToken) |
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. |
|
DeleteAdapter(DeleteAdapterRequest) |
Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID. |
|
DeleteAdapterAsync(DeleteAdapterRequest, CancellationToken) |
Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID. |
|
DeleteAdapterVersion(DeleteAdapterVersionRequest) |
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. |
|
DeleteAdapterVersionAsync(DeleteAdapterVersionRequest, CancellationToken) |
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. |
|
DetectDocumentText(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 in one of the following
image formats: JPEG, PNG, PDF, or TIFF.
Each document page has as an associated
For more information, see Document Text Detection. |
|
DetectDocumentTextAsync(DetectDocumentTextRequest, CancellationToken) |
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.
Each document page has as an associated
For more information, see Document Text Detection. |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
GetAdapter(GetAdapterRequest) |
Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes. |
|
GetAdapterAsync(GetAdapterRequest, CancellationToken) |
Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes. |
|
GetAdapterVersion(GetAdapterVersionRequest) |
Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics. |
|
GetAdapterVersionAsync(GetAdapterVersionRequest, CancellationToken) |
Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics. |
|
GetDocumentAnalysis(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 (
While processing a document with queries, look out for
Selection elements such as check boxes and option buttons (radio buttons) can be detected
in form data and in tables. A SELECTION_ELEMENT
Use the For more information, see Document Text Analysis. |
|
GetDocumentAnalysisAsync(GetDocumentAnalysisRequest, CancellationToken) |
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 (
While processing a document with queries, look out for
Selection elements such as check boxes and option buttons (radio buttons) can be detected
in form data and in tables. A SELECTION_ELEMENT
Use the For more information, see Document Text Analysis. |
|
GetDocumentTextDetection(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 (
Each document page has as an associated
Use the MaxResults parameter to limit the number of blocks that are returned. If there
are more results than specified in For more information, see Document Text Detection. |
|
GetDocumentTextDetectionAsync(GetDocumentTextDetectionRequest, CancellationToken) |
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 (
Each document page has as an associated
Use the MaxResults parameter to limit the number of blocks that are returned. If there
are more results than specified in For more information, see Document Text Detection. |
|
GetExpenseAnalysis(GetExpenseAnalysisRequest) |
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 (
Use the MaxResults parameter to limit the number of blocks that are returned. If there
are more results than specified in For more information, see Analyzing Invoices and Receipts. |
|
GetExpenseAnalysisAsync(GetExpenseAnalysisRequest, CancellationToken) |
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 (
Use the MaxResults parameter to limit the number of blocks that are returned. If there
are more results than specified in For more information, see Analyzing Invoices and Receipts. |
|
GetLendingAnalysis(GetLendingAnalysisRequest) |
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.
You start asynchronous text analysis by calling
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 ( |
|
GetLendingAnalysisAsync(GetLendingAnalysisRequest, CancellationToken) |
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.
You start asynchronous text analysis by calling
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 ( |
|
GetLendingAnalysisSummary(GetLendingAnalysisSummaryRequest) |
Gets summarized results for the
You start asynchronous text analysis by calling
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 |
|
GetLendingAnalysisSummaryAsync(GetLendingAnalysisSummaryRequest, CancellationToken) |
Gets summarized results for the
You start asynchronous text analysis by calling
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 |
|
ListAdapters(ListAdaptersRequest) |
Lists all adapters that match the specified filtration criteria. |
|
ListAdaptersAsync(ListAdaptersRequest, CancellationToken) |
Lists all adapters that match the specified filtration criteria. |
|
ListAdapterVersions(ListAdapterVersionsRequest) |
List all version of an adapter that meet the specified filtration criteria. |
|
ListAdapterVersionsAsync(ListAdapterVersionsRequest, CancellationToken) |
List all version of an adapter that meet the specified filtration criteria. |
|
ListTagsForResource(ListTagsForResourceRequest) |
Lists all tags for an Amazon Textract resource. |
|
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) |
Lists all tags for an Amazon Textract resource. |
|
StartDocumentAnalysis(StartDocumentAnalysisRequest) |
Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
For more information, see Document Text Analysis. |
|
StartDocumentAnalysisAsync(StartDocumentAnalysisRequest, CancellationToken) |
Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
For more information, see Document Text Analysis. |
|
StartDocumentTextDetection(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.
For more information, see Document Text Detection. |
|
StartDocumentTextDetectionAsync(StartDocumentTextDetectionRequest, CancellationToken) |
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.
For more information, see Document Text Detection. |
|
StartExpenseAnalysis(StartExpenseAnalysisRequest) |
Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.
For more information, see Analyzing Invoices and Receipts. |
|
StartExpenseAnalysisAsync(StartExpenseAnalysisRequest, CancellationToken) |
Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.
For more information, see Analyzing Invoices and Receipts. |
|
StartLendingAnalysis(StartLendingAnalysisRequest) |
Starts the classification and analysis of an input document.
If using
|
|
StartLendingAnalysisAsync(StartLendingAnalysisRequest, CancellationToken) |
Starts the classification and analysis of an input document.
If using
|
|
TagResource(TagResourceRequest) |
Adds one or more tags to the specified resource. |
|
TagResourceAsync(TagResourceRequest, CancellationToken) |
Adds one or more tags to the specified resource. |
|
UntagResource(UntagResourceRequest) |
Removes any tags with the specified keys from the specified resource. |
|
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
Removes any tags with the specified keys from the specified resource. |
|
UpdateAdapter(UpdateAdapterRequest) |
Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument. |
|
UpdateAdapterAsync(UpdateAdapterRequest, CancellationToken) |
Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5