Amazon Textract Document Analysis API

openapi: 3.2.0
info:
  title: Amazon Textract Document Analysis API
  version: '2018-06-27'
  description: 'Operations tagged Document Analysis across 2 of this provider''s published API definitions: amazon-textract-openapi.yml, amazon-textract-document-analysis-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://textract.amazonaws.com
  description: Amazon Textract API endpoint
- url: https://textract.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
tags:
- name: Document Analysis
  description: Operations for analyzing document structure and content.
paths:
  /#AnalyzeDocument:
    post:
      operationId: AnalyzeDocument
      summary: Amazon Textract Analyze Document
      description: Analyzes an input document for relationships between detected items, including tables, forms, and key-value pairs.
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              properties:
                Document:
                  type: object
                  properties:
                    Bytes:
                      type: string
                      format: byte
                    S3Object:
                      type: object
                      properties:
                        Bucket:
                          type: string
                        Name:
                          type: string
                FeatureTypes:
                  type: array
                  description: A list of the types of analysis to perform.
                  items:
                    type: string
                    enum:
                    - TABLES
                    - FORMS
                    - QUERIES
                    - SIGNATURES
                    - LAYOUT
                QueriesConfig:
                  type: object
                  properties:
                    Queries:
                      type: array
                      items:
                        type: object
                        properties:
                          Text:
                            type: string
                          Alias:
                            type: string
                          Pages:
                            type: array
                            items:
                              type: string
              required:
              - Document
              - FeatureTypes
      responses:
        '200':
          description: Successful document analysis response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentAnalysis'
      tags:
      - Document Analysis
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://textract.amazonaws.com
      description: Amazon Textract API endpoint
  /#GetDocumentAnalysis:
    post:
      operationId: GetDocumentAnalysis
      summary: Get Document Analysis
      description: 'Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document. You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that''s registered in the initial call to StartDocumentAnalysis. To get the results of the text-detection 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. GetDocumentAnalysis returns an array of Block objects. The following types of information are returned: Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value. Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a tabl'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetDocumentAnalysisResponse'
        '400':
          description: AccessDeniedException; InvalidJobIdException; InvalidKMSKeyException; InvalidParameterException; InvalidS3ObjectException; ProvisionedThroughputExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerError; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Textract.GetDocumentAnalysis
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetDocumentAnalysisRequest'
      tags:
      - Document Analysis
      security:
      - sigv4: []
    servers:
    - url: https://textract.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#StartDocumentAnalysis:
    post:
      operationId: StartDocumentAnalysis
      summary: Start Document Analysis
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartDocumentAnalysisResponse'
        '400':
          description: AccessDeniedException; BadDocumentException; DocumentTooLargeException; IdempotentParameterMismatchException; InvalidKMSKeyException; InvalidParameterException; InvalidS3ObjectException; LimitExceededException; ProvisionedThroughputExceededException; UnsupportedDocumentException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerError; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Textract.StartDocumentAnalysis
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartDocumentAnalysisRequest'
      tags:
      - Document Analysis
      security:
      - sigv4: []
    servers:
    - url: https://textract.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    DocumentAnalysis:
      type: object
      description: Response object containing the results of document text detection or analysis, including detected blocks of text, tables, and forms.
      properties:
        DocumentMetadata:
          type: object
          description: Metadata about the document.
          properties:
            Pages:
              type: integer
              description: The number of pages detected in the document.
        Blocks:
          type: array
          description: The items detected in the document.
          items:
            type: object
            properties:
              BlockType:
                type: string
                description: The type of text item detected.
                enum:
                - KEY_VALUE_SET
                - PAGE
                - LINE
                - WORD
                - TABLE
                - CELL
                - SELECTION_ELEMENT
                - MERGED_CELL
                - TITLE
                - QUERY
                - QUERY_RESULT
                - SIGNATURE
                - TABLE_TITLE
                - TABLE_FOOTER
                - LAYOUT_TEXT
                - LAYOUT_TITLE
                - LAYOUT_HEADER
                - LAYOUT_FOOTER
                - LAYOUT_SECTION_HEADER
                - LAYOUT_PAGE_NUMBER
                - LAYOUT_LIST
                - LAYOUT_FIGURE
                - LAYOUT_TABLE
                - LAYOUT_KEY_VALUE
              Confidence:
                type: number
                format: float
                description: The confidence score for the detected block.
              Text:
                type: string
                description: The word or line of text recognized.
              Geometry:
                type: object
                properties:
                  BoundingBox:
                    type: object
                    properties:
                      Width:
                        type: number
                      Height:
                        type: number
                      Left:
                        type: number
                      Top:
                        type: number
                  Polygon:
                    type: array
                    items:
                      type: object
                      properties:
                        X:
                          type: number
                        Y:
                          type: number
              Id:
                type: string
                description: The identifier for the recognized text block.
              Relationships:
                type: array
                items:
                  type: object
                  properties:
                    Type:
                      type: string
                      enum:
                      - VALUE
                      - CHILD
                      - COMPLEX_FEATURES
                      - MERGED_CELL
                      - TITLE
                      - ANSWER
                      - TABLE
                      - TABLE_TITLE
                      - TABLE_FOOTER
                    Ids:
                      type: array
                      items:
                        type: string
              Page:
                type: integer
                description: The page on which the block was detected.
        AnalyzeDocumentModelVersion:
          type: string
          description: The version of the model used to analyze the document.
    BoundingBox:
      type: object
      properties:
        Width:
          type: number
          description: The width of the bounding box as a ratio of the overall document page width.
        Height:
          type: number
          description: The height of the bounding box as a ratio of the overall document page height.
        Left:
          type: number
          description: The left coordinate of the bounding box as a ratio of overall document page width.
        Top:
          type: number
          description: The top coordinate of the bounding box as a ratio of overall document page height.
    Block:
      type: object
      properties:
        BlockType:
          type: string
          enum:
          - KEY_VALUE_SET
          - PAGE
          - LINE
          - WORD
          - TABLE
          - CELL
          - SELECTION_ELEMENT
          - MERGED_CELL
          - TITLE
          - QUERY
          - QUERY_RESULT
          - SIGNATURE
          - TABLE_TITLE
          - TABLE_FOOTER
          - LAYOUT_TEXT
          - LAYOUT_TITLE
          - LAYOUT_HEADER
          - LAYOUT_FOOTER
          - LAYOUT_SECTION_HEADER
          - LAYOUT_PAGE_NUMBER
          - LAYOUT_LIST
          - LAYOUT_FIGURE
          - LAYOUT_TABLE
          - LAYOUT_KEY_VALUE
          description: 'The type of text item that''s recognized. In operations for text detection, the following types are returned: PAGE - Contains a list of the LINE Block objects that are detected on a document page. WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren''t separated by spaces. LINE - A string of space-delimited, contiguous words that are detected on a document page. In text analysis operations, the following types are returned: PAGE - Contains a list of child Block objects that are detected on a document page. KEY_VALUE_SET - Stores the KEY and'
        Confidence:
          type: number
          description: The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
        Text:
          type: string
          description: The word or line of text that's recognized by Amazon Textract.
        TextType:
          type: string
          enum:
          - HANDWRITING
          - PRINTED
          description: The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
        RowIndex:
          type: integer
          description: The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
        ColumnIndex:
          type: integer
          description: The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
        RowSpan:
          type: integer
          description: The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
        ColumnSpan:
          type: integer
          description: The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
        Geometry:
          $ref: '#/components/schemas/Geometry'
        Id:
          type: string
          description: The identifier for the recognized text. The identifier is only unique for a single operation.
        Relationships:
          type: array
          items:
            $ref: '#/components/schemas/Relationship'
          description: A list of relationship objects that describe how blocks are related to each other. For example, a LINE block object contains a CHILD relationship type with the WORD blocks that make up the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks.
        EntityTypes:
          type: array
          items:
            type: string
            enum:
            - KEY
            - VALUE
            - COLUMN_HEADER
            - TABLE_TITLE
            - TABLE_FOOTER
            - TABLE_SECTION_TITLE
            - TABLE_SUMMARY
            - STRUCTURED_TABLE
            - SEMI_STRUCTURED_TABLE
          description: 'The type of entity. The following entity types can be returned by FORMS analysis: KEY - An identifier for a field on the document. VALUE - The field text. The following entity types can be returned by TABLES analysis: COLUMN_HEADER - Identifies a cell that is a header of a column. TABLE_TITLE - Identifies a cell that is a title within the table. TABLE_SECTION_TITLE - Identifies a cell that is a title of a section within a table. A section title is a cell that typically spans an entire row above a section. TABLE_FOOTER - Identifies a cell that is a footer of a table. TABLE_SUMMARY - Identifies '
        SelectionStatus:
          type: string
          enum:
          - SELECTED
          - NOT_SELECTED
          description: The selection status of a selection element, such as an option button or check box.
        Page:
          type: integer
          description: The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an asynchronous operation, even if it contains multiple document pages, is considered a single-page document. This means that for scanned images the value of Page is always 1.
        Query:
          $ref: '#/components/schemas/Query'
    Point:
      type: object
      properties:
        X:
          type: number
          description: The value of the X coordinate for a point on a Polygon.
        Y:
          type: number
          description: The value of the Y coordinate for a point on a Polygon.
    DocumentMetadata:
      type: object
      properties:
        Pages:
          type: integer
          description: The number of pages that are detected in the document.
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    Adapter:
      type: object
      properties:
        AdapterId:
          type: string
          description: A unique identifier for the adapter resource.
        Pages:
          type: array
          items:
            type: string
          description: '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.'
        Version:
          type: string
          description: A string that identifies the version of the adapter.
      required:
      - AdapterId
      - Version
    QueriesConfig:
      type: object
      properties:
        Queries:
          type: array
          items:
            $ref: '#/components/schemas/Query'
      required:
      - Queries
    DocumentLocation:
      type: object
      properties:
        S3Object:
          $ref: '#/components/schemas/S3Object'
    GetDocumentAnalysisRequest:
      type: object
      properties:
        JobId:
          type: string
          description: A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.
        MaxResults:
          type: integer
          description: The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.
        NextToken:
          type: string
          description: If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.
      required:
      - JobId
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    NotificationChannel:
      type: object
      properties:
        SNSTopicArn:
          type: string
          description: The Amazon SNS topic that Amazon Textract posts the completion status to.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
      required:
      - SNSTopicArn
      - RoleArn
    Relationship:
      type: object
      properties:
        Type:
          type: string
          enum:
          - VALUE
          - CHILD
          - COMPLEX_FEATURES
          - MERGED_CELL
          - TITLE
          - ANSWER
          - TABLE
          - TABLE_TITLE
          - TABLE_FOOTER
          description: The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned. VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type. MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table. ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with th
        Ids:
          type: array
          items:
            type: string
          description: An array of IDs for related blocks. You can get the type of the relationship from the Type element.
    OutputConfig:
      type: object
      properties:
        S3Bucket:
          type: string
          description: The name of the bucket your output will go to.
        S3Prefix:
          type: string
          description: The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".
      required:
      - S3Bucket
    AdaptersConfig:
      type: object
      properties:
        Adapters:
          type: array
          items:
            $ref: '#/components/schemas/Adapter'
          description: A list of adapters to be used when analyzing the specified document.
      required:
      - Adapters
    GetDocumentAnalysisResponse:
      type: object
      properties:
        DocumentMetadata:
          $ref: '#/components/schemas/DocumentMetadata'
        JobStatus:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCEEDED
          - FAILED
          - PARTIAL_SUCCESS
          description: The current status of the text detection job.
        NextToken:
          type: string
          description: If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.
        Blocks:
          type: array
          items:
            $ref: '#/components/schemas/Block'
          description: The results of the text-analysis operation.
        Warnings:
          type: array
          items:
            $ref: '#/components/schemas/Warning'
          description: A list of warnings that occurred during the document-analysis operation.
        StatusMessage:
          type: string
          description: Returns if the detection job could not be completed. Contains explanation for what error occured.
        AnalyzeDocumentModelVersion:
          type: string
    S3Object:
      type: object
      properties:
        Bucket:
          type: string
          description: 'The name of the S3 bucket. Note that the # character is not valid in the file name.'
        Name:
          type: string
          description: The file name of the input document. Image files may be in PDF, TIFF, JPEG, or PNG format.
        Version:
          type: string
          description: If the bucket has versioning enabled, you can specify the object version.
    Query:
      type: object
      properties:
        Text:
          type: string
          description: Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
        Alias:
          type: string
          description: Alias attached to the query, for ease of location.
        Pages:
          type: array
          items:
            type: string
          description: '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.'
      required:
      - Text
    Geometry:
      type: object
      properties:
        BoundingBox:
          $ref: '#/components/schemas/BoundingBox'
        Polygon:
          type: array
          items:
            $ref: '#/components/schemas/Point'
          description: Within the bounding box, a fine-grained polygon around the recognized item.
        RotationAngle:
          type: number
          description: Provides a numerical value corresponding to the rotation of the WORD block. Possible values are 0, 90, 180, and 270.
    StartDocumentAnalysisRequest:
      type: object
      properties:
        DocumentLocation:
          $ref: '#/components/schemas/DocumentLocation'
        FeatureTypes:
          type: array
          items:
            type: string
            enum:
            - TABLES
            - FORMS
            - QUERIES
            - SIGNATURES
            - LAYOUT
          description: 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).
        ClientRequestToken:
          type: string
          description: 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:
          type: string
          description: 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:
          $ref: '#/components/schemas/NotificationChannel'
        OutputConfig:
          $ref: '#/components/schemas/OutputConfig'
        KMSKeyId:
          type: string
          description: 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:
          $ref: '#/components/schemas/QueriesConfig'
        AdaptersConfig:
          $ref: '#/components/schemas/AdaptersConfig'
      required:
      - DocumentLocation
      - FeatureTypes
    Warning:
      type: object
      properties:
        ErrorCode:
          type: string
          description: The error code for the warning.
        Pages:
          type: array
          items:
            type: integer
          description: A list of the pages that the warning applies to.
    StartDocumentAnalysisResponse:
      type: object
      properties:
        JobId:
          type: string
          description: 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.
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: textract
x-refined-from:
- amazon-textract-openapi.yml
- amazon-textract-document-analysis-api-openapi.yml