Skip to content

AnalyzeDocumentRequest

Source code in docs_src/capo_textract/types/analyze_document_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class AnalyzeDocumentRequest(TypedDict, closed=True):
    document: "capo_textract.types.document.Document"
    """<p>The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.</p> <p>If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the <code>Bytes</code> field. </p>"""
    feature_types: "capo_textract.types.feature_types.FeatureTypes"
    """<p>A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of <code>FeatureTypes</code>). </p>"""
    human_loop_config: NotRequired[
        "capo_textract.types.human_loop_config.HumanLoopConfig"
    ]
    """<p>Sets the configuration for the human in the loop workflow for analyzing documents.</p> <note> <p>Amazon Textract uses Amazon Augmented AI (A2I) to run the human review workflows that you specify in <code>HumanLoopConfig</code>. A2I entered maintenance mode in July 2026 and no longer accepts new customers. If your account is not an existing A2I customer, requests fail with an <code>InvalidParameterException</code>. For more information, see <a href="https://aws.amazon.com/about-aws/whats-new/2026/06/aws-service-availability/">AWS service availability</a>. If you're an existing A2I customer but receive this error, contact AWS Support and request assistance from the A2I team.</p> </note>"""
    queries_config: NotRequired["capo_textract.types.queries_config.QueriesConfig"]
    """<p>Contains Queries and the alias for those Queries, as determined by the input. </p>"""
    adapters_config: NotRequired["capo_textract.types.adapters_config.AdaptersConfig"]
    """<p>Specifies the adapter to be used when analyzing a document.</p>"""

adapters_config instance-attribute 

adapters_config: NotRequired[AdaptersConfig]

Specifies the adapter to be used when analyzing a document.

document instance-attribute 

document: Document

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

feature_types instance-attribute 

feature_types: FeatureTypes

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

human_loop_config instance-attribute 

human_loop_config: NotRequired[HumanLoopConfig]

Sets the configuration for the human in the loop workflow for analyzing documents.

Amazon Textract uses Amazon Augmented AI (A2I) to run the human review workflows that you specify in HumanLoopConfig. A2I entered maintenance mode in July 2026 and no longer accepts new customers. If your account is not an existing A2I customer, requests fail with an InvalidParameterException. For more information, see AWS service availability. If you're an existing A2I customer but receive this error, contact AWS Support and request assistance from the A2I team.

queries_config instance-attribute 

queries_config: NotRequired[QueriesConfig]

Contains Queries and the alias for those Queries, as determined by the input.