Skip to main content
Version: 2.1

ITextractClient

Interface in AWS.Textract

Interface for Amazon Textract service client.

Methods​

AnalyzeDocument​

function AnalyzeDocument( const ARequest: ITextractAnalyzeDocumentRequest): ITextractAnalyzeDocumentResponse;

ITextractAnalyzeDocumentRequest → ITextractAnalyzeDocumentResponse

Analyze an input document for relationships between detected items.

Parameters

NameDescription
ARequestAn AnalyzeDocument request object.

Returns

Response containing AnalyzeDocument results.

AnalyzeExpense​

function AnalyzeExpense( const ARequest: ITextractAnalyzeExpenseRequest): ITextractAnalyzeExpenseResponse;

ITextractAnalyzeExpenseRequest → ITextractAnalyzeExpenseResponse

Analyze an input document for financially related relationships between text.

Parameters

NameDescription
ARequestAn AnalyzeExpense request object.

Returns

Response containing AnalyzeExpense results.

AnalyzeID​

function AnalyzeID( const ARequest: ITextractAnalyzeIDRequest): ITextractAnalyzeIDResponse;

ITextractAnalyzeIDRequest → ITextractAnalyzeIDResponse

Analyze identity documents for relevant information.

Parameters

NameDescription
ARequestAn AnalyzeID request object.

Returns

Response containing AnalyzeID results.

CreateAdapter​

function CreateAdapter( const ARequest: ITextractCreateAdapterRequest): ITextractCreateAdapterResponse;

ITextractCreateAdapterRequest → ITextractCreateAdapterResponse

Create an adapter, which can be fine-tuned for enhanced performance on user provided document.

Parameters

NameDescription
ARequestA CreateAdapter request object.

Returns

Response containing CreateAdapter results.

CreateAdapterVersion​

function CreateAdapterVersion( const ARequest: ITextractCreateAdapterVersionRequest): ITextractCreateAdapterVersionResponse;

ITextractCreateAdapterVersionRequest → ITextractCreateAdapterVersionResponse

Create a new version of an adapter. Specify the adapter, a dataset configuration, and an output configuration.

Parameters

NameDescription
ARequestA CreateAdapterVersion request object.

Returns

Response containing CreateAdapterVersion results.

DeleteAdapter​

function DeleteAdapter( const ARequest: ITextractDeleteAdapterRequest): ITextractDeleteAdapterResponse; overload;

ITextractDeleteAdapterRequest → ITextractDeleteAdapterResponse

Delete an adapter.

Parameters

NameDescription
ARequestA DeleteAdapter request object.

Returns

Response containing DeleteAdapter results.


function DeleteAdapter( const AAdapterId: string): ITextractDeleteAdapterResponse; overload;

ITextractDeleteAdapterResponse

Delete an adapter.

Parameters

NameDescription
AAdapterIdSpecify the unique identifier for the adapter that will be deleted.

Returns

Response containing DeleteAdapter results.

DeleteAdapterVersion​

function DeleteAdapterVersion( const ARequest: ITextractDeleteAdapterVersionRequest): ITextractDeleteAdapterVersionResponse; overload;

ITextractDeleteAdapterVersionRequest → ITextractDeleteAdapterVersionResponse

Delete an adapter version.

Parameters

NameDescription
ARequestA DeleteAdapterVersion request object.

Returns

Response containing DeleteAdapterVersion results.


function DeleteAdapterVersion( const AAdapterId, AAdapterVersion: string): ITextractDeleteAdapterVersionResponse; overload;

ITextractDeleteAdapterVersionResponse

Delete an adapter version.

Parameters

NameDescription
AAdapterIdSpecify the unique identifier for the adapter that will be deleted.
AAdapterVersionSpecify the version of the adapter to be deleted.

Returns

Response containing DeleteAdapterVersion results.

DetectDocumentText​

function DetectDocumentText( const ARequest: ITextractDetectDocumentTextRequest): ITextractDetectDocumentTextResponse;

ITextractDetectDocumentTextRequest → ITextractDetectDocumentTextResponse

Detect text in an input document.

Parameters

NameDescription
ARequestAn DetectDocumentText request object.

Returns

Response containing DetectDocumentText results.

GetAdapter​

function GetAdapter( const ARequest: ITextractGetAdapterRequest): ITextractGetAdapterResponse; overload;

ITextractGetAdapterRequest → ITextractGetAdapterResponse

Fetch configuration information for a given adapter.

Parameters

NameDescription
ARequestA GetAdapter request object.

Returns

Response containing GetAdapter results.


function GetAdapter( const AAdapterId: string): ITextractGetAdapterResponse; overload;

ITextractGetAdapterResponse

Fetch configuration information for a given adapter.

Parameters

NameDescription
AAdapterIdSpecify the unique identifier for the adapter to be fetched.

Returns

Response containing GetAdapter results.

GetAdapterVersion​

function GetAdapterVersion( const ARequest: ITextractGetAdapterVersionRequest): ITextractGetAdapterVersionResponse; overload;

ITextractGetAdapterVersionRequest → ITextractGetAdapterVersionResponse

Fetch configuration information for a given adapter version.

Parameters

NameDescription
ARequestA GetAdapterVersion request object.

Returns

Response containing GetAdapterVersion results.


function GetAdapterVersion( const AAdapterId, AAdapterVersion: string): ITextractGetAdapterVersionResponse; overload;

ITextractGetAdapterVersionResponse

Fetch configuration information for a given adapter version.

Parameters

NameDescription
AAdapterIdSpecify the unique identifier for the adapter version to be fetched.
AAdapterVersionSpecify the version of the adapter to be fetched.

Returns

Response containing GetAdapterVersion results.

GetDocumentAnalysis​

function GetDocumentAnalysis( const ARequest: ITextractGetDocumentAnalysisRequest): ITextractGetDocumentAnalysisResponse;

ITextractGetDocumentAnalysisRequest → ITextractGetDocumentAnalysisResponse

Fetch the results of an Amazon Textract asynchronous operation that analyzes text in a document.

You can start an asynchronous text analysis job by calling StartDocumentAnalysis.

Parameters

NameDescription
ARequestA GetDocumentAnalysis request object.

Returns

A response containing GetDocumentAnalysis results.

GetDocumentTextDetection​

function GetDocumentTextDetection( const ARequest: ITextractGetDocumentTextDetectionRequest): ITextractGetDocumentTextDetectionResponse;

ITextractGetDocumentTextDetectionRequest → ITextractGetDocumentTextDetectionResponse

Fetch the results for an Amazon Textract asynchronous operation that detects text in a document.

You can start an asynchronous text analysis job by calling StartDocumentTextDetection.

Parameters

NameDescription
ARequestA GetDocumentTextDetection request object.

Returns

Response containing GetDocumentTextDetection results.

GetExpenseAnalysis​

function GetExpenseAnalysis( const ARequest: ITextractGetExpenseAnalysisRequest): ITextractGetExpenseAnalysisResponse;

ITextractGetExpenseAnalysisRequest → ITextractGetExpenseAnalysisResponse

Fetch the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts.

You can start an asynchronous invoice/receipt analysis job by calling StartExpenseAnalysis.

Parameters

NameDescription
ARequestA GetExpenseAnalysis request object.

Returns

Response containing GetExpenseAnalysis results.

GetLendingAnalysis​

function GetLendingAnalysis( const ARequest: ITextractGetLendingAnalysisRequest): ITextractGetLendingAnalysisResponse;

ITextractGetLendingAnalysisRequest → ITextractGetLendingAnalysisResponse

Fetch the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.

You can start an asynchronous lending analysis job by calling StartLendingAnalysis.

Parameters

NameDescription
ARequestA GetLendingAnalysis request object.

Returns

Response containing GetLendingAnalysis results.

GetLendingAnalysisSummary​

function GetLendingAnalysisSummary( const ARequest: ITextractGetLendingAnalysisSummaryRequest): ITextractGetLendingAnalysisSummaryResponse;

ITextractGetLendingAnalysisSummaryRequest → ITextractGetLendingAnalysisSummaryResponse

Fetch summarized results for an Amazon Textract asynchronous operation that analyzes text in a lending document.

You can start an asynchronous lending analysis job by calling StartLendingAnalysis.

Parameters

NameDescription
ARequestA GetLendingAnalysisSummary request object.

Returns

Response containing GetLendingAnalysisSummary results.

ListAdapters​

function ListAdapters( const ARequest: ITextractListAdaptersRequest): ITextractListAdaptersResponse;

ITextractListAdaptersRequest → ITextractListAdaptersResponse

List all adapters matching criteria.

Parameters

NameDescription
ARequestA ListAdapters request object.

Returns

Response containing ListAdapters results.

ListAdapterVersions​

function ListAdapterVersions( const ARequest: ITextractListAdapterVersionsRequest): ITextractListAdapterVersionsResponse;

ITextractListAdapterVersionsRequest → ITextractListAdapterVersionsResponse

List all adapter versions matching criteria.

Parameters

NameDescription
ARequestA ListAdapterVersions request object.

Returns

Response containing ListAdapterVersions results.

ListTagsForResource​

function ListTagsForResource( const ARequest: ITextractListTagsForResourceRequest): ITextractListTagsForResourceResponse; overload;

ITextractListTagsForResourceRequest → ITextractListTagsForResourceResponse

List tags attached to an Amazon Textract resource.

Parameters

NameDescription
ARequestA ListTagsForResource request object.

Returns

Response containing ListTagsForResource results.


function ListTagsForResource( const AResourceARN: TARN): ITextractListTagsForResourceResponse; overload;

ITextractListTagsForResourceResponse

List tags attached to an Amazon Textract resource.

Parameters

NameDescription
AResourceARNSpecify the Amazon Resource Name (ARN) of the Amazon Textract resource to list tags for.

Returns

Response containing ListTagsForResource results.

StartDocumentAnalysis​

function StartDocumentAnalysis( const ARequest: ITextractStartDocumentAnalysisRequest): ITextractStartDocumentAnalysisResponse;

ITextractStartDocumentAnalysisRequest → ITextractStartDocumentAnalysisResponse

Start an asynchronous job to analyze an input document for relationships between detected items such as key-value pairs, tables, and selection elements.

Parameters

NameDescription
ARequestA StartDocumentAnalysis request object.

Returns

Response containing StartDocumentAnalysis results.

StartDocumentTextDetection​

function StartDocumentTextDetection( const ARequest: ITextractStartDocumentTextDetectionRequest): ITextractStartDocumentTextDetectionResponse;

ITextractStartDocumentTextDetectionRequest → ITextractStartDocumentTextDetectionResponse

Start an asynchronous job to detect text in an input document.

Parameters

NameDescription
ARequestA StartDocumentTextDetection request object.

Returns

Response containing StartDocumentTextDetection results.

StartExpenseAnalysis​

function StartExpenseAnalysis( const ARequest: ITextractStartExpenseAnalysisRequest): ITextractStartExpenseAnalysisResponse;

ITextractStartExpenseAnalysisRequest → ITextractStartExpenseAnalysisResponse

Start an asynchronous job to analyze invoices or receipts for data like contact information, items purchased, and vendor names.

Parameters

NameDescription
ARequestA StartExpenseAnalysis request object.

Returns

Response containing StartExpenseAnalysis results.

StartLendingAnalysis​

function StartLendingAnalysis( const ARequest: ITextractStartLendingAnalysisRequest): ITextractStartLendingAnalysisResponse;

ITextractStartLendingAnalysisRequest → ITextractStartLendingAnalysisResponse

Start an asynchronous job to analyze and classify an input document.

Parameters

NameDescription
ARequestA StartLendingAnalysis request object.

Returns

Response containing StartLendingAnalysis results.

TagResource​

function TagResource(const ARequest: ITextractTagResourceRequest): ITextractTagResourceResponse;

ITextractTagResourceRequest → ITextractTagResourceResponse

Add one or more tags to an Amazon Textract resource.

Parameters

NameDescription
ARequestA TagResource request object.

Returns

Response containing TagResource results.

UntagResource​

function UntagResource( const ARequest: ITextractUntagResourceRequest): ITextractUntagResourceResponse; overload;

ITextractUntagResourceRequest → ITextractUntagResourceResponse

Remove tags from an Amazon Textract resource.

Parameters

NameDescription
ARequestA UntagResource request object.

Returns

Response containing UntagResource results.


function UntagResource(const AResourceARN: TARN; const ATagKeys: array of string): ITextractUntagResourceResponse; overload;

ITextractUntagResourceResponse

Remove tags from an Amazon Textract resource.

Parameters

NameDescription
AResourceARNSpecify the Amazon Resource Name (ARN) of the Amazon Textract resource to remove tags from.
ATagKeysSpecify the keys of the tags to be removed.

Returns

Response containing UntagResource results.

UpdateAdapter​

function UpdateAdapter(const ARequest: ITextractUpdateAdapterRequest): ITextractUpdateAdapterResponse;

ITextractUpdateAdapterRequest → ITextractUpdateAdapterResponse

Update an adapters configuration.

Parameters

NameDescription
ARequestAn UpdateAdapter request object.

Returns

Response containing UpdateAdapter results.