Textract / Client / start_document_analysis

start_document_analysis#

Textract.Client.start_document_analysis(**kwargs)#

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

StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

StartDocumentAnalysis returns a job identifier ( JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. 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 GetDocumentAnalysis, and pass the job identifier ( JobId) from the initial call to StartDocumentAnalysis.

For more information, see Document Text Analysis.

See also: AWS API Documentation

Request Syntax

response = client.start_document_analysis(
    DocumentLocation={
        'S3Object': {
            'Bucket': 'string',
            'Name': 'string',
            'Version': 'string'
        }
    },
    FeatureTypes=[
        'TABLES'|'FORMS'|'QUERIES'|'SIGNATURES'|'LAYOUT',
    ],
    ClientRequestToken='string',
    JobTag='string',
    NotificationChannel={
        'SNSTopicArn': 'string',
        'RoleArn': 'string'
    },
    OutputConfig={
        'S3Bucket': 'string',
        'S3Prefix': 'string'
    },
    KMSKeyId='string',
    QueriesConfig={
        'Queries': [
            {
                'Text': 'string',
                'Alias': 'string',
                'Pages': [
                    'string',
                ]
            },
        ]
    },
    AdaptersConfig={
        'Adapters': [
            {
                'AdapterId': 'string',
                'Pages': [
                    'string',
                ],
                'Version': 'string'
            },
        ]
    }
)
Parameters:

  • DocumentLocation (dict) –

    [REQUIRED]

    The location of the document to be processed.

    • S3Object (dict) –

      The Amazon S3 bucket that contains the input document.

      • Bucket (string) –

        The name of the S3 bucket. Note that the # character is not valid in the file name.

      • Name (string) –

        The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.

      • Version (string) –

        If the bucket has versioning enabled, you can specify the object version.

  • FeatureTypes (list) –

    [REQUIRED]

    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. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn’t related to the value of FeatureTypes).

    • (string) –

  • ClientRequestToken (string) – The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

  • JobTag (string) – An identifier that you specify that’s included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

  • NotificationChannel (dict) –

    The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

    • SNSTopicArn (string) – [REQUIRED]

      The Amazon SNS topic that Amazon Textract posts the completion status to.

    • RoleArn (string) – [REQUIRED]

      The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

  • OutputConfig (dict) –

    Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.

    • S3Bucket (string) – [REQUIRED]

      The name of the bucket your output will go to.

    • S3Prefix (string) –

      The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output”.

  • KMSKeyId (string) – The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

  • QueriesConfig (dict) –

    • Queries (list) – [REQUIRED]

      • (dict) –

        Each query contains the question you want to ask in the Text and the alias you want to associate.

        • Text (string) – [REQUIRED]

          Question that Amazon Textract will apply to the document. An example would be “What is the customer’s SSN?”

        • Alias (string) –

          Alias attached to the query, for ease of location.

        • Pages (list) –

          Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.

          • If a page is not specified, it is set to ["1"] by default.

          • The following characters are allowed in the parameter’s string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.

          • When using * to indicate all pages, it must be the only element in the list.

          • You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page of document.

          • Specified pages must be greater than 0 and less than or equal to the number of pages in the document.

          • (string) –

  • AdaptersConfig (dict) –

    Specifies the adapter to be used when analyzing a document.

    • Adapters (list) – [REQUIRED]

      A list of adapters to be used when analyzing the specified document.

      • (dict) –

        An adapter selected for use when analyzing documents. Contains an adapter ID and a version number. Contains information on pages selected for analysis when analyzing documents asychronously.

        • AdapterId (string) – [REQUIRED]

          A unique identifier for the adapter resource.

        • Pages (list) –

          Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a list of rules for using this parameter.

          • If a page is not specified, it is set to ["1"] by default.

          • The following characters are allowed in the parameter’s string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.

          • When using * to indicate all pages, it must be the only element in the list.

          • You can use page intervals, such as ["1-3", "1-1", "4-*"]. Where * indicates last page of document.

          • Specified pages must be greater than 0 and less than or equal to the number of pages in the document.

          • (string) –

        • Version (string) – [REQUIRED]

          A string that identifies the version of the adapter.

Return type:

dict

Returns:

Response Syntax

{
    'JobId': 'string'
}

Response Structure

  • (dict) –

    • JobId (string) –

      The identifier for the document text detection job. Use JobId to identify the job in a subsequent call to GetDocumentAnalysis. A JobId value is only valid for 7 days.

Exceptions