textract/aws.sdk.kotlin.services.textract/TextractClient

TextractClient

interface TextractClient : SdkClient

Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.

Properties

Link copied to clipboard
abstract override val config: TextractClient.Config

TextractClient's configuration

Functions

Link copied to clipboard
abstract suspend fun analyzeDocument(input: AnalyzeDocumentRequest): AnalyzeDocumentResponse

Analyzes an input document for relationships between detected items.

Link copied to clipboard
abstract suspend fun analyzeExpense(input: AnalyzeExpenseRequest): AnalyzeExpenseResponse

AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.

Link copied to clipboard
abstract suspend fun analyzeId(input: AnalyzeIdRequest): 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.

Link copied to clipboard
abstract suspend fun createAdapter(input: CreateAdapterRequest): 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.

Link copied to clipboard
abstract suspend fun createAdapterVersion(input: CreateAdapterVersionRequest): 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.

Link copied to clipboard
abstract suspend fun deleteAdapter(input: DeleteAdapterRequest): DeleteAdapterResponse

Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.

Link copied to clipboard
abstract suspend fun deleteAdapterVersion(input: DeleteAdapterVersionRequest): DeleteAdapterVersionResponse

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.

Link copied to clipboard
abstract suspend fun detectDocumentText(input: DetectDocumentTextRequest): 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.

Link copied to clipboard
abstract suspend fun getAdapter(input: GetAdapterRequest): GetAdapterResponse

Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.

Link copied to clipboard
abstract suspend fun getAdapterVersion(input: GetAdapterVersionRequest): GetAdapterVersionResponse

Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

Link copied to clipboard
abstract suspend fun getDocumentAnalysis(input: GetDocumentAnalysisRequest): GetDocumentAnalysisResponse

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

Link copied to clipboard
abstract suspend fun getDocumentTextDetection(input: GetDocumentTextDetectionRequest): 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.

Link copied to clipboard
abstract suspend fun getExpenseAnalysis(input: GetExpenseAnalysisRequest): 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.

Link copied to clipboard
abstract suspend fun getLendingAnalysis(input: GetLendingAnalysisRequest): GetLendingAnalysisResponse

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

Link copied to clipboard
abstract suspend fun getLendingAnalysisSummary(input: GetLendingAnalysisSummaryRequest): 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.

Link copied to clipboard
abstract suspend fun listAdapters(input: ListAdaptersRequest = ListAdaptersRequest { }): ListAdaptersResponse

Lists all adapters that match the specified filtration criteria.

Link copied to clipboard
abstract suspend fun listAdapterVersions(input: ListAdapterVersionsRequest = ListAdapterVersionsRequest { }): ListAdapterVersionsResponse

List all version of an adapter that meet the specified filtration criteria.

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists all tags for an Amazon Textract resource.

Link copied to clipboard
abstract suspend fun startDocumentAnalysis(input: StartDocumentAnalysisRequest): StartDocumentAnalysisResponse

Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.

Link copied to clipboard
abstract suspend fun startDocumentTextDetection(input: StartDocumentTextDetectionRequest): 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.

Link copied to clipboard
abstract suspend fun startExpenseAnalysis(input: StartExpenseAnalysisRequest): StartExpenseAnalysisResponse

Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.

Link copied to clipboard
abstract suspend fun startLendingAnalysis(input: StartLendingAnalysisRequest): 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.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds one or more tags to the specified resource.

Link copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes any tags with the specified keys from the specified resource.

Link copied to clipboard
abstract suspend fun updateAdapter(input: UpdateAdapterRequest): UpdateAdapterResponse

Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.

Inherited functions

Link copied to clipboard
inline suspend fun TextractClient.analyzeDocument(crossinline block: AnalyzeDocumentRequest.Builder.() -> Unit): AnalyzeDocumentResponse

Analyzes an input document for relationships between detected items.

Link copied to clipboard
inline suspend fun TextractClient.analyzeExpense(crossinline block: AnalyzeExpenseRequest.Builder.() -> Unit): AnalyzeExpenseResponse

AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.

Link copied to clipboard
inline suspend fun TextractClient.analyzeId(crossinline block: AnalyzeIdRequest.Builder.() -> Unit): 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.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun TextractClient.createAdapter(crossinline block: CreateAdapterRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun TextractClient.createAdapterVersion(crossinline block: CreateAdapterVersionRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun TextractClient.deleteAdapter(crossinline block: DeleteAdapterRequest.Builder.() -> Unit): DeleteAdapterResponse

Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.

Link copied to clipboard
inline suspend fun TextractClient.deleteAdapterVersion(crossinline block: DeleteAdapterVersionRequest.Builder.() -> Unit): DeleteAdapterVersionResponse

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.

Link copied to clipboard
inline suspend fun TextractClient.detectDocumentText(crossinline block: DetectDocumentTextRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun TextractClient.getAdapter(crossinline block: GetAdapterRequest.Builder.() -> Unit): GetAdapterResponse

Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.

Link copied to clipboard
inline suspend fun TextractClient.getAdapterVersion(crossinline block: GetAdapterVersionRequest.Builder.() -> Unit): GetAdapterVersionResponse

Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

Link copied to clipboard
inline suspend fun TextractClient.getDocumentAnalysis(crossinline block: GetDocumentAnalysisRequest.Builder.() -> Unit): GetDocumentAnalysisResponse

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

Link copied to clipboard
inline suspend fun TextractClient.getDocumentTextDetection(crossinline block: GetDocumentTextDetectionRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun TextractClient.getExpenseAnalysis(crossinline block: GetExpenseAnalysisRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun TextractClient.getLendingAnalysis(crossinline block: GetLendingAnalysisRequest.Builder.() -> Unit): GetLendingAnalysisResponse

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

Link copied to clipboard
inline suspend fun TextractClient.getLendingAnalysisSummary(crossinline block: GetLendingAnalysisSummaryRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun TextractClient.listAdapters(crossinline block: ListAdaptersRequest.Builder.() -> Unit): ListAdaptersResponse

Lists all adapters that match the specified filtration criteria.

Link copied to clipboard
Link copied to clipboard
inline suspend fun TextractClient.listAdapterVersions(crossinline block: ListAdapterVersionsRequest.Builder.() -> Unit): ListAdapterVersionsResponse

List all version of an adapter that meet the specified filtration criteria.

Link copied to clipboard
Link copied to clipboard
inline suspend fun TextractClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists all tags for an Amazon Textract resource.

Link copied to clipboard
inline suspend fun TextractClient.startDocumentAnalysis(crossinline block: StartDocumentAnalysisRequest.Builder.() -> Unit): StartDocumentAnalysisResponse

Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.

Link copied to clipboard
inline suspend fun TextractClient.startDocumentTextDetection(crossinline block: StartDocumentTextDetectionRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun TextractClient.startExpenseAnalysis(crossinline block: StartExpenseAnalysisRequest.Builder.() -> Unit): StartExpenseAnalysisResponse

Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.

Link copied to clipboard
inline suspend fun TextractClient.startLendingAnalysis(crossinline block: StartLendingAnalysisRequest.Builder.() -> Unit): 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.

Link copied to clipboard
inline suspend fun TextractClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds one or more tags to the specified resource.

Link copied to clipboard
inline suspend fun TextractClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes any tags with the specified keys from the specified resource.

Link copied to clipboard
inline suspend fun TextractClient.updateAdapter(crossinline block: UpdateAdapterRequest.Builder.() -> Unit): UpdateAdapterResponse

Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.

Link copied to clipboard
fun TextractClient.withConfig(block: TextractClient.Config.Builder.() -> Unit): TextractClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.