# Amazon Textract API Reference

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

- [Welcome](https://docs.aws.amazon.com/textract/latest/APIReference/Welcome.md)
- [Common Parameters](https://docs.aws.amazon.com/textract/latest/APIReference/CommonParameters.md)
- [Common Error Types](https://docs.aws.amazon.com/textract/latest/APIReference/CommonErrors.md)

## [Actions](https://docs.aws.amazon.com/textract/latest/APIReference/API_Operations.md)

- [AnalyzeDocument](https://docs.aws.amazon.com/textract/latest/APIReference/API_AnalyzeDocument.md): Analyzes an input document for relationships between detected items.
- [AnalyzeExpense](https://docs.aws.amazon.com/textract/latest/APIReference/API_AnalyzeExpense.md): AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.
- [AnalyzeID](https://docs.aws.amazon.com/textract/latest/APIReference/API_AnalyzeID.md): Analyzes identity documents for relevant information.
- [CreateAdapter](https://docs.aws.amazon.com/textract/latest/APIReference/API_CreateAdapter.md): Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents.
- [CreateAdapterVersion](https://docs.aws.amazon.com/textract/latest/APIReference/API_CreateAdapterVersion.md): Creates a new version of an adapter.
- [DeleteAdapter](https://docs.aws.amazon.com/textract/latest/APIReference/API_DeleteAdapter.md): Deletes an Amazon Textract adapter.
- [DeleteAdapterVersion](https://docs.aws.amazon.com/textract/latest/APIReference/API_DeleteAdapterVersion.md): Deletes an Amazon Textract adapter version.
- [DetectDocumentText](https://docs.aws.amazon.com/textract/latest/APIReference/API_DetectDocumentText.md): Detects text in the input document.
- [GetAdapter](https://docs.aws.amazon.com/textract/latest/APIReference/API_GetAdapter.md): Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.
- [GetAdapterVersion](https://docs.aws.amazon.com/textract/latest/APIReference/API_GetAdapterVersion.md): Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.
- [GetDocumentAnalysis](https://docs.aws.amazon.com/textract/latest/APIReference/API_GetDocumentAnalysis.md): Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
- [GetDocumentTextDetection](https://docs.aws.amazon.com/textract/latest/APIReference/API_GetDocumentTextDetection.md): Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
- [GetExpenseAnalysis](https://docs.aws.amazon.com/textract/latest/APIReference/API_GetExpenseAnalysis.md): Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts.
- [GetLendingAnalysis](https://docs.aws.amazon.com/textract/latest/APIReference/API_GetLendingAnalysis.md): Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.
- [GetLendingAnalysisSummary](https://docs.aws.amazon.com/textract/latest/APIReference/API_GetLendingAnalysisSummary.md): Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document.
- [ListAdapters](https://docs.aws.amazon.com/textract/latest/APIReference/API_ListAdapters.md): Lists all adapters that match the specified filtration criteria.
- [ListAdapterVersions](https://docs.aws.amazon.com/textract/latest/APIReference/API_ListAdapterVersions.md): List all version of an adapter that meet the specified filtration criteria.
- [ListTagsForResource](https://docs.aws.amazon.com/textract/latest/APIReference/API_ListTagsForResource.md): Lists all tags for an Amazon Textract resource.
- [StartDocumentAnalysis](https://docs.aws.amazon.com/textract/latest/APIReference/API_StartDocumentAnalysis.md): Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
- [StartDocumentTextDetection](https://docs.aws.amazon.com/textract/latest/APIReference/API_StartDocumentTextDetection.md): Starts the asynchronous detection of text in a document.
- [StartExpenseAnalysis](https://docs.aws.amazon.com/textract/latest/APIReference/API_StartExpenseAnalysis.md): Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.
- [StartLendingAnalysis](https://docs.aws.amazon.com/textract/latest/APIReference/API_StartLendingAnalysis.md): Starts the classification and analysis of an input document.
- [TagResource](https://docs.aws.amazon.com/textract/latest/APIReference/API_TagResource.md): Adds one or more tags to the specified resource.
- [UntagResource](https://docs.aws.amazon.com/textract/latest/APIReference/API_UntagResource.md): Removes any tags with the specified keys from the specified resource.
- [UpdateAdapter](https://docs.aws.amazon.com/textract/latest/APIReference/API_UpdateAdapter.md): Update the configuration for an adapter.


## [Data Types](https://docs.aws.amazon.com/textract/latest/APIReference/API_Types.md)

- [Adapter](https://docs.aws.amazon.com/textract/latest/APIReference/API_Adapter.md): An adapter selected for use when analyzing documents.
- [AdapterOverview](https://docs.aws.amazon.com/textract/latest/APIReference/API_AdapterOverview.md): Contains information on the adapter, including the adapter ID, Name, Creation time, and feature types.
- [AdaptersConfig](https://docs.aws.amazon.com/textract/latest/APIReference/API_AdaptersConfig.md): Contains information about adapters used when analyzing a document, with each adapter specified using an AdapterId and version
- [AdapterVersionDatasetConfig](https://docs.aws.amazon.com/textract/latest/APIReference/API_AdapterVersionDatasetConfig.md): The dataset configuration options for a given version of an adapter.
- [AdapterVersionEvaluationMetric](https://docs.aws.amazon.com/textract/latest/APIReference/API_AdapterVersionEvaluationMetric.md): Contains information on the metrics used to evalute the peformance of a given adapter version.
- [AdapterVersionOverview](https://docs.aws.amazon.com/textract/latest/APIReference/API_AdapterVersionOverview.md): Summary info for an adapter version.
- [AnalyzeIDDetections](https://docs.aws.amazon.com/textract/latest/APIReference/API_AnalyzeIDDetections.md): Used to contain the information detected by an AnalyzeID operation.
- [Block](https://docs.aws.amazon.com/textract/latest/APIReference/API_Block.md): A Block represents items that are recognized in a document within a group of pixels close to each other.
- [BoundingBox](https://docs.aws.amazon.com/textract/latest/APIReference/API_BoundingBox.md): The bounding box around the detected page, text, key-value pair, table, table cell, or selection element on a document page.
- [DetectedSignature](https://docs.aws.amazon.com/textract/latest/APIReference/API_DetectedSignature.md): A structure that holds information regarding a detected signature on a page.
- [Document](https://docs.aws.amazon.com/textract/latest/APIReference/API_Document.md): The input document, either as bytes or as an S3 object.
- [DocumentGroup](https://docs.aws.amazon.com/textract/latest/APIReference/API_DocumentGroup.md): Summary information about documents grouped by the same document type.
- [DocumentLocation](https://docs.aws.amazon.com/textract/latest/APIReference/API_DocumentLocation.md): The Amazon S3 bucket that contains the document to be processed.
- [DocumentMetadata](https://docs.aws.amazon.com/textract/latest/APIReference/API_DocumentMetadata.md): Information about the input document.
- [EvaluationMetric](https://docs.aws.amazon.com/textract/latest/APIReference/API_EvaluationMetric.md): The evaluation metrics (F1 score, Precision, and Recall) for an adapter version.
- [ExpenseCurrency](https://docs.aws.amazon.com/textract/latest/APIReference/API_ExpenseCurrency.md): Returns the kind of currency detected.
- [ExpenseDetection](https://docs.aws.amazon.com/textract/latest/APIReference/API_ExpenseDetection.md): An object used to store information about the Value or Label detected by Amazon Textract.
- [ExpenseDocument](https://docs.aws.amazon.com/textract/latest/APIReference/API_ExpenseDocument.md): The structure holding all the information returned by AnalyzeExpense
- [ExpenseField](https://docs.aws.amazon.com/textract/latest/APIReference/API_ExpenseField.md): Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection
- [ExpenseGroupProperty](https://docs.aws.amazon.com/textract/latest/APIReference/API_ExpenseGroupProperty.md): Shows the group that a certain key belongs to.
- [ExpenseType](https://docs.aws.amazon.com/textract/latest/APIReference/API_ExpenseType.md): An object used to store information about the Type detected by Amazon Textract.
- [Extraction](https://docs.aws.amazon.com/textract/latest/APIReference/API_Extraction.md): Contains information extracted by an analysis operation after using StartLendingAnalysis.
- [Geometry](https://docs.aws.amazon.com/textract/latest/APIReference/API_Geometry.md): Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
- [HumanLoopActivationOutput](https://docs.aws.amazon.com/textract/latest/APIReference/API_HumanLoopActivationOutput.md): Shows the results of the human in the loop evaluation.
- [HumanLoopConfig](https://docs.aws.amazon.com/textract/latest/APIReference/API_HumanLoopConfig.md): Sets up the human review workflow the document will be sent to if one of the conditions is met.
- [HumanLoopDataAttributes](https://docs.aws.amazon.com/textract/latest/APIReference/API_HumanLoopDataAttributes.md): Allows you to set attributes of the image.
- [IdentityDocument](https://docs.aws.amazon.com/textract/latest/APIReference/API_IdentityDocument.md): The structure that lists each document processed in an AnalyzeID operation.
- [IdentityDocumentField](https://docs.aws.amazon.com/textract/latest/APIReference/API_IdentityDocumentField.md): Structure containing both the normalized type of the extracted information and the text associated with it.
- [LendingDetection](https://docs.aws.amazon.com/textract/latest/APIReference/API_LendingDetection.md): The results extracted for a lending document.
- [LendingDocument](https://docs.aws.amazon.com/textract/latest/APIReference/API_LendingDocument.md): Holds the structured data returned by AnalyzeDocument for lending documents.
- [LendingField](https://docs.aws.amazon.com/textract/latest/APIReference/API_LendingField.md): Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and geometry.
- [LendingResult](https://docs.aws.amazon.com/textract/latest/APIReference/API_LendingResult.md): Contains the detections for each page analyzed through the Analyze Lending API.
- [LendingSummary](https://docs.aws.amazon.com/textract/latest/APIReference/API_LendingSummary.md): Contains information regarding DocumentGroups and UndetectedDocumentTypes.
- [LineItemFields](https://docs.aws.amazon.com/textract/latest/APIReference/API_LineItemFields.md): A structure that holds information about the different lines found in a document's tables.
- [LineItemGroup](https://docs.aws.amazon.com/textract/latest/APIReference/API_LineItemGroup.md): A grouping of tables which contain LineItems, with each table identified by the table's LineItemGroupIndex.
- [NormalizedValue](https://docs.aws.amazon.com/textract/latest/APIReference/API_NormalizedValue.md): Contains information relating to dates in a document, including the type of value, and the value.
- [NotificationChannel](https://docs.aws.amazon.com/textract/latest/APIReference/API_NotificationChannel.md): The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.
- [OutputConfig](https://docs.aws.amazon.com/textract/latest/APIReference/API_OutputConfig.md): Sets whether or not your output will go to a user created bucket.
- [PageClassification](https://docs.aws.amazon.com/textract/latest/APIReference/API_PageClassification.md): The class assigned to a Page object detected in an input document.
- [Point](https://docs.aws.amazon.com/textract/latest/APIReference/API_Point.md): The X and Y coordinates of a point on a document page.
- [Prediction](https://docs.aws.amazon.com/textract/latest/APIReference/API_Prediction.md): Contains information regarding predicted values returned by Amazon Textract operations, including the predicted value and the confidence in the predicted value.
- [QueriesConfig](https://docs.aws.amazon.com/textract/latest/APIReference/API_QueriesConfig.md)
- [Query](https://docs.aws.amazon.com/textract/latest/APIReference/API_Query.md): Each query contains the question you want to ask in the Text and the alias you want to associate.
- [Relationship](https://docs.aws.amazon.com/textract/latest/APIReference/API_Relationship.md): Information about how blocks are related to each other.
- [S3Object](https://docs.aws.amazon.com/textract/latest/APIReference/API_S3Object.md): The S3 bucket name and file name that identifies the document.
- [SignatureDetection](https://docs.aws.amazon.com/textract/latest/APIReference/API_SignatureDetection.md): Information regarding a detected signature on a page.
- [SplitDocument](https://docs.aws.amazon.com/textract/latest/APIReference/API_SplitDocument.md): Contains information about the pages of a document, defined by logical boundary.
- [UndetectedSignature](https://docs.aws.amazon.com/textract/latest/APIReference/API_UndetectedSignature.md): A structure containing information about an undetected signature on a page where it was expected but not found.
- [Warning](https://docs.aws.amazon.com/textract/latest/APIReference/API_Warning.md): A warning about an issue that occurred during asynchronous text analysis () or asynchronous document text detection ().


## Full content

The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass:

- [Complete guide (single file)](https://docs.aws.amazon.com/textract/latest/APIReference/full.md)