Class: AWS.Textract

var params = {
  Document: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  }
};
textract.analyzeExpense(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Document — (map)

    The input document, either as bytes or as an S3 object.

    You pass image bytes to an Amazon Textract API operation by using the Bytes property. For example, you would use the Bytes property to pass a document loaded from a local file system. Image bytes passed by using the Bytes property must be base64 encoded. Your code might not need to encode document file bytes if you're using an AWS SDK to call Amazon Textract API operations.

    You pass images stored in an S3 bucket to an Amazon Textract API operation by using the S3Object property. Documents stored in an S3 bucket don't need to be base64 encoded.

    The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations.

    If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property.

    For Amazon Textract to process an S3 object, the user must have permission to access the S3 object.

    • Bytes — (Buffer, Typed Array, Blob, String)

      A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.

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

    • S3Object — (map)

      Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

      • 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DocumentMetadata — (map)

      Information about the input document.

      • Pages — (Integer)

        The number of pages that are detected in the document.

    • ExpenseDocuments — (Array<map>)

      The expenses detected by Amazon Textract.

      • ExpenseIndex — (Integer)

        Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.

      • SummaryFields — (Array<map>)

        Any information found outside of a table by Amazon Textract.

        • Type — (map)

          The implied label of a detected element. Present alongside LabelDetection for explicit elements.

          • Text — (String)

            The word or line of text detected by Amazon Textract.

          • Confidence — (Float)

            The confidence of accuracy, as a percentage.

        • LabelDetection — (map)

          The explicitly stated label of a detected element.

          • Text — (String)

            The word or line of text recognized by Amazon Textract

          • Geometry — (map)

            Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

            • BoundingBox — (map)

              An axis-aligned coarse representation of the location of the recognized item on the document page.

              • Width — (Float)

                The width of the bounding box as a ratio of the overall document page width.

              • Height — (Float)

                The height of the bounding box as a ratio of the overall document page height.

              • Left — (Float)

                The left coordinate of the bounding box as a ratio of overall document page width.

              • Top — (Float)

                The top coordinate of the bounding box as a ratio of overall document page height.

            • Polygon — (Array<map>)

              Within the bounding box, a fine-grained polygon around the recognized item.

              • X — (Float)

                The value of the X coordinate for a point on a Polygon.

              • Y — (Float)

                The value of the Y coordinate for a point on a Polygon.

          • Confidence — (Float)

            The confidence in detection, as a percentage

        • ValueDetection — (map)

          The value of a detected element. Present in explicit and implicit elements.

          • Text — (String)

            The word or line of text recognized by Amazon Textract

          • Geometry — (map)

            Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

            • BoundingBox — (map)

              An axis-aligned coarse representation of the location of the recognized item on the document page.

              • Width — (Float)

                The width of the bounding box as a ratio of the overall document page width.

              • Height — (Float)

                The height of the bounding box as a ratio of the overall document page height.

              • Left — (Float)

                The left coordinate of the bounding box as a ratio of overall document page width.

              • Top — (Float)

                The top coordinate of the bounding box as a ratio of overall document page height.

            • Polygon — (Array<map>)

              Within the bounding box, a fine-grained polygon around the recognized item.

              • X — (Float)

                The value of the X coordinate for a point on a Polygon.

              • Y — (Float)

                The value of the Y coordinate for a point on a Polygon.

          • Confidence — (Float)

            The confidence in detection, as a percentage

        • PageNumber — (Integer)

          The page number the value was detected on.

        • Currency — (map)

          Shows the kind of currency, both the code and confidence associated with any monatary value detected.

          • Code — (String)

            Currency code for detected currency. the current supported codes are:

            • USD

            • EUR

            • GBP

            • CAD

            • INR

            • JPY

            • CHF

            • AUD

            • CNY

            • BZR

            • SEK

            • HKD

          • Confidence — (Float)

            Percentage confideence in the detected currency.

        • GroupProperties — (Array<map>)

          Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.

          • Types — (Array<String>)

            Informs you on whether the expense group is a name or an address.

          • Id — (String)

            Provides a group Id number, which will be the same for each in the group.

      • LineItemGroups — (Array<map>)

        Information detected on each table of a document, seperated into LineItems.

        • LineItemGroupIndex — (Integer)

          The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc.

        • LineItems — (Array<map>)

          The breakdown of information on a particular line of a table.

          • LineItemExpenseFields — (Array<map>)

            ExpenseFields used to show information from detected lines on a table.

            • Type — (map)

              The implied label of a detected element. Present alongside LabelDetection for explicit elements.

              • Text — (String)

                The word or line of text detected by Amazon Textract.

              • Confidence — (Float)

                The confidence of accuracy, as a percentage.

            • LabelDetection — (map)

              The explicitly stated label of a detected element.

              • Text — (String)

                The word or line of text recognized by Amazon Textract

              • Geometry — (map)

                Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

                • BoundingBox — (map)

                  An axis-aligned coarse representation of the location of the recognized item on the document page.

                  • Width — (Float)

                    The width of the bounding box as a ratio of the overall document page width.

                  • Height — (Float)

                    The height of the bounding box as a ratio of the overall document page height.

                  • Left — (Float)

                    The left coordinate of the bounding box as a ratio of overall document page width.

                  • Top — (Float)

                    The top coordinate of the bounding box as a ratio of overall document page height.

                • Polygon — (Array<map>)

                  Within the bounding box, a fine-grained polygon around the recognized item.

                  • X — (Float)

                    The value of the X coordinate for a point on a Polygon.

                  • Y — (Float)

                    The value of the Y coordinate for a point on a Polygon.

              • Confidence — (Float)

                The confidence in detection, as a percentage

            • ValueDetection — (map)

              The value of a detected element. Present in explicit and implicit elements.

              • Text — (String)

                The word or line of text recognized by Amazon Textract

              • Geometry — (map)

                Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

                • BoundingBox — (map)

                  An axis-aligned coarse representation of the location of the recognized item on the document page.

                  • Width — (Float)

                    The width of the bounding box as a ratio of the overall document page width.

                  • Height — (Float)

                    The height of the bounding box as a ratio of the overall document page height.

                  • Left — (Float)

                    The left coordinate of the bounding box as a ratio of overall document page width.

                  • Top — (Float)

                    The top coordinate of the bounding box as a ratio of overall document page height.

                • Polygon — (Array<map>)

                  Within the bounding box, a fine-grained polygon around the recognized item.

                  • X — (Float)

                    The value of the X coordinate for a point on a Polygon.

                  • Y — (Float)

                    The value of the Y coordinate for a point on a Polygon.

              • Confidence — (Float)

                The confidence in detection, as a percentage

            • PageNumber — (Integer)

              The page number the value was detected on.

            • Currency — (map)

              Shows the kind of currency, both the code and confidence associated with any monatary value detected.

              • Code — (String)

                Currency code for detected currency. the current supported codes are:

                • USD

                • EUR

                • GBP

                • CAD

                • INR

                • JPY

                • CHF

                • AUD

                • CNY

                • BZR

                • SEK

                • HKD

              • Confidence — (Float)

                Percentage confideence in the detected currency.

            • GroupProperties — (Array<map>)

              Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.

              • Types — (Array<String>)

                Informs you on whether the expense group is a name or an address.

              • Id — (String)

                Provides a group Id number, which will be the same for each in the group.

      • Blocks — (Array<map>)

        This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text.

        • BlockType — (String)

          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 tab-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 VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.

          • WORD - A word that's 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 tab-delimited, contiguous words that are detected on a document page.

          • TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.

          • TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.

          • TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.

          • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

          • MERGED_CELL - A cell in a table whose content spans more than one row or column. The Relationships array for this cell contain data from individual cells.

          • SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

          • SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.

          • QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.

          • QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

          The following BlockTypes are only returned for Amazon Textract Layout.

          • LAYOUT_TITLE - The main title of the document.

          • LAYOUT_HEADER - Text located in the top margin of the document.

          • LAYOUT_FOOTER - Text located in the bottom margin of the document.

          • LAYOUT_SECTION_HEADER - The titles of sections within a document.

          • LAYOUT_PAGE_NUMBER - The page number of the documents.

          • LAYOUT_LIST - Any information grouped together in list form.

          • LAYOUT_FIGURE - Indicates the location of an image in a document.

          • LAYOUT_TABLE - Indicates the location of a table in the document.

          • LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document.

          • LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents.

          Possible values include:
          • "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 — (Float)

          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 — (String)

          The word or line of text that's recognized by Amazon Textract.

        • TextType — (String)

          The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

          Possible values include:
          • "HANDWRITING"
          • "PRINTED"
        • RowIndex — (Integer)

          The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • ColumnIndex — (Integer)

          The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • RowSpan — (Integer)

          The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • ColumnSpan — (Integer)

          The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • Geometry — (map)

          The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.

          • BoundingBox — (map)

            An axis-aligned coarse representation of the location of the recognized item on the document page.

            • Width — (Float)

              The width of the bounding box as a ratio of the overall document page width.

            • Height — (Float)

              The height of the bounding box as a ratio of the overall document page height.

            • Left — (Float)

              The left coordinate of the bounding box as a ratio of overall document page width.

            • Top — (Float)

              The top coordinate of the bounding box as a ratio of overall document page height.

          • Polygon — (Array<map>)

            Within the bounding box, a fine-grained polygon around the recognized item.

            • X — (Float)

              The value of the X coordinate for a point on a Polygon.

            • Y — (Float)

              The value of the Y coordinate for a point on a Polygon.

        • Id — (String)

          The identifier for the recognized text. The identifier is only unique for a single operation.

        • Relationships — (Array<map>)

          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.

          • Type — (String)

            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 the corresponding QUERY block.

            • TABLE - A list of IDs that identify associated TABLE block types.

            • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

            • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

            Possible values include:
            • "VALUE"
            • "CHILD"
            • "COMPLEX_FEATURES"
            • "MERGED_CELL"
            • "TITLE"
            • "ANSWER"
            • "TABLE"
            • "TABLE_TITLE"
            • "TABLE_FOOTER"
          • Ids — (Array<String>)

            An array of IDs for related blocks. You can get the type of the relationship from the Type element.

        • EntityTypes — (Array<String>)

          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 a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.

          • STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.

          • SEMI_STRUCTURED_TABLE - Identifies a non-structured table.

          EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • SelectionStatus — (String)

          The selection status of a selection element, such as an option button or check box.

          Possible values include:
          • "SELECTED"
          • "NOT_SELECTED"
        • Page — (Integer)

          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 — (map)
          • Text — required — (String)

            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 — (Array<String>)

            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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DocumentPages: [ /* required */
    {
      Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      S3Object: {
        Bucket: 'STRING_VALUE',
        Name: 'STRING_VALUE',
        Version: 'STRING_VALUE'
      }
    },
    /* more items */
  ]
};
textract.analyzeID(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DocumentPages — (Array<map>)

    The document being passed to AnalyzeID.

    • Bytes — (Buffer, Typed Array, Blob, String)

      A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.

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

    • S3Object — (map)

      Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

      • 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • IdentityDocuments — (Array<map>)

      The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document.

      • DocumentIndex — (Integer)

        Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

      • IdentityDocumentFields — (Array<map>)

        The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

        • Type — (map)

          Used to contain the information detected by an AnalyzeID operation.

          • Text — required — (String)

            Text of either the normalized field or value associated with it.

          • NormalizedValue — (map)

            Only returned for dates, returns the type of value detected and the date written in a more machine readable way.

            • Value — (String)

              The value of the date, written as Year-Month-DayTHour:Minute:Second.

            • ValueType — (String)

              The normalized type of the value detected. In this case, DATE.

              Possible values include:
              • "DATE"
          • Confidence — (Float)

            The confidence score of the detected text.

        • ValueDetection — (map)

          Used to contain the information detected by an AnalyzeID operation.

          • Text — required — (String)

            Text of either the normalized field or value associated with it.

          • NormalizedValue — (map)

            Only returned for dates, returns the type of value detected and the date written in a more machine readable way.

            • Value — (String)

              The value of the date, written as Year-Month-DayTHour:Minute:Second.

            • ValueType — (String)

              The normalized type of the value detected. In this case, DATE.

              Possible values include:
              • "DATE"
          • Confidence — (Float)

            The confidence score of the detected text.

      • Blocks — (Array<map>)

        Individual word recognition, as returned by document detection.

        • BlockType — (String)

          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 tab-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 VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.

          • WORD - A word that's 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 tab-delimited, contiguous words that are detected on a document page.

          • TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.

          • TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.

          • TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.

          • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

          • MERGED_CELL - A cell in a table whose content spans more than one row or column. The Relationships array for this cell contain data from individual cells.

          • SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

          • SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.

          • QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.

          • QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

          The following BlockTypes are only returned for Amazon Textract Layout.

          • LAYOUT_TITLE - The main title of the document.

          • LAYOUT_HEADER - Text located in the top margin of the document.

          • LAYOUT_FOOTER - Text located in the bottom margin of the document.

          • LAYOUT_SECTION_HEADER - The titles of sections within a document.

          • LAYOUT_PAGE_NUMBER - The page number of the documents.

          • LAYOUT_LIST - Any information grouped together in list form.

          • LAYOUT_FIGURE - Indicates the location of an image in a document.

          • LAYOUT_TABLE - Indicates the location of a table in the document.

          • LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document.

          • LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents.

          Possible values include:
          • "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 — (Float)

          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 — (String)

          The word or line of text that's recognized by Amazon Textract.

        • TextType — (String)

          The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

          Possible values include:
          • "HANDWRITING"
          • "PRINTED"
        • RowIndex — (Integer)

          The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • ColumnIndex — (Integer)

          The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • RowSpan — (Integer)

          The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • ColumnSpan — (Integer)

          The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • Geometry — (map)

          The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.

          • BoundingBox — (map)

            An axis-aligned coarse representation of the location of the recognized item on the document page.

            • Width — (Float)

              The width of the bounding box as a ratio of the overall document page width.

            • Height — (Float)

              The height of the bounding box as a ratio of the overall document page height.

            • Left — (Float)

              The left coordinate of the bounding box as a ratio of overall document page width.

            • Top — (Float)

              The top coordinate of the bounding box as a ratio of overall document page height.

          • Polygon — (Array<map>)

            Within the bounding box, a fine-grained polygon around the recognized item.

            • X — (Float)

              The value of the X coordinate for a point on a Polygon.

            • Y — (Float)

              The value of the Y coordinate for a point on a Polygon.

        • Id — (String)

          The identifier for the recognized text. The identifier is only unique for a single operation.

        • Relationships — (Array<map>)

          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.

          • Type — (String)

            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 the corresponding QUERY block.

            • TABLE - A list of IDs that identify associated TABLE block types.

            • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

            • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

            Possible values include:
            • "VALUE"
            • "CHILD"
            • "COMPLEX_FEATURES"
            • "MERGED_CELL"
            • "TITLE"
            • "ANSWER"
            • "TABLE"
            • "TABLE_TITLE"
            • "TABLE_FOOTER"
          • Ids — (Array<String>)

            An array of IDs for related blocks. You can get the type of the relationship from the Type element.

        • EntityTypes — (Array<String>)

          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 a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.

          • STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.

          • SEMI_STRUCTURED_TABLE - Identifies a non-structured table.

          EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • SelectionStatus — (String)

          The selection status of a selection element, such as an option button or check box.

          Possible values include:
          • "SELECTED"
          • "NOT_SELECTED"
        • Page — (Integer)

          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 — (map)
          • Text — required — (String)

            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 — (Array<String>)

            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.

    • DocumentMetadata — (map)

      Information about the input document.

      • Pages — (Integer)

        The number of pages that are detected in the document.

    • AnalyzeIDModelVersion — (String)

      The version of the AnalyzeIdentity API being used to process documents.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AdapterName: 'STRING_VALUE', /* required */
  FeatureTypes: [ /* required */
    TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT,
    /* more items */
  ],
  AutoUpdate: ENABLED | DISABLED,
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
textract.createAdapter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AdapterName — (String)

    The name to be assigned to the adapter being created.

  • ClientRequestToken — (String)

    Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.

    If a token is not provided, the SDK will use a version 4 UUID.
  • Description — (String)

    The description to be assigned to the adapter being created.

  • FeatureTypes — (Array<String>)

    The type of feature that the adapter is being trained on. Currrenly, supported feature types are: QUERIES

  • AutoUpdate — (String)

    Controls whether or not the adapter should automatically update.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • Tags — (map<String>)

    A list of tags to be added to the adapter.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AdapterId — (String)

      A string containing the unique ID for the adapter that has been created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AdapterId: 'STRING_VALUE', /* required */
  DatasetConfig: { /* required */
    ManifestS3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  OutputConfig: { /* required */
    S3Bucket: 'STRING_VALUE', /* required */
    S3Prefix: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  KMSKeyId: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
textract.createAdapterVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AdapterId — (String)

    A string containing a unique ID for the adapter that will receive a new version.

  • ClientRequestToken — (String)

    Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapterVersion requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.

    If a token is not provided, the SDK will use a version 4 UUID.
  • DatasetConfig — (map)

    Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object as the value.

    • ManifestS3Object — (map)

      The S3 bucket name and file name that identifies the document.

      The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations.

      For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file.

      • 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.

  • KMSKeyId — (String)

    The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.

  • OutputConfig — (map)

    Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.

    OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.

    Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.

    For more information on data privacy, see the Data Privacy FAQ.

    • S3Bucket — required — (String)

      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".

  • Tags — (map<String>)

    A set of tags (key-value pairs) that you want to attach to the adapter version.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AdapterId — (String)

      A string containing the unique ID for the adapter that has received a new version.

    • AdapterVersion — (String)

      A string describing the new version of the adapter.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AdapterId: 'STRING_VALUE' /* required */
};
textract.deleteAdapter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AdapterId — (String)

    A string containing a unique ID for the adapter to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AdapterId: 'STRING_VALUE', /* required */
  AdapterVersion: 'STRING_VALUE' /* required */
};
textract.deleteAdapterVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AdapterId — (String)

    A string containing a unique ID for the adapter version that will be deleted.

  • AdapterVersion — (String)

    Specifies the adapter version to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Document: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  }
};
textract.detectDocumentText(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Document — (map)

    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 or PNG 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.

    • Bytes — (Buffer, Typed Array, Blob, String)

      A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.

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

    • S3Object — (map)

      Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

      • 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DocumentMetadata — (map)

      Metadata about the document. It contains the number of pages that are detected in the document.

      • Pages — (Integer)

        The number of pages that are detected in the document.

    • Blocks — (Array<map>)

      An array of Block objects that contain the text that's detected in the document.

      • BlockType — (String)

        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 tab-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 VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.

        • WORD - A word that's 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 tab-delimited, contiguous words that are detected on a document page.

        • TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.

        • TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.

        • TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.

        • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

        • MERGED_CELL - A cell in a table whose content spans more than one row or column. The Relationships array for this cell contain data from individual cells.

        • SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

        • SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.

        • QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.

        • QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

        The following BlockTypes are only returned for Amazon Textract Layout.

        • LAYOUT_TITLE - The main title of the document.

        • LAYOUT_HEADER - Text located in the top margin of the document.

        • LAYOUT_FOOTER - Text located in the bottom margin of the document.

        • LAYOUT_SECTION_HEADER - The titles of sections within a document.

        • LAYOUT_PAGE_NUMBER - The page number of the documents.

        • LAYOUT_LIST - Any information grouped together in list form.

        • LAYOUT_FIGURE - Indicates the location of an image in a document.

        • LAYOUT_TABLE - Indicates the location of a table in the document.

        • LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document.

        • LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents.

        Possible values include:
        • "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 — (Float)

        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 — (String)

        The word or line of text that's recognized by Amazon Textract.

      • TextType — (String)

        The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

        Possible values include:
        • "HANDWRITING"
        • "PRINTED"
      • RowIndex — (Integer)

        The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • ColumnIndex — (Integer)

        The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • RowSpan — (Integer)

        The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • ColumnSpan — (Integer)

        The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • Geometry — (map)

        The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.

        • BoundingBox — (map)

          An axis-aligned coarse representation of the location of the recognized item on the document page.

          • Width — (Float)

            The width of the bounding box as a ratio of the overall document page width.

          • Height — (Float)

            The height of the bounding box as a ratio of the overall document page height.

          • Left — (Float)

            The left coordinate of the bounding box as a ratio of overall document page width.

          • Top — (Float)

            The top coordinate of the bounding box as a ratio of overall document page height.

        • Polygon — (Array<map>)

          Within the bounding box, a fine-grained polygon around the recognized item.

          • X — (Float)

            The value of the X coordinate for a point on a Polygon.

          • Y — (Float)

            The value of the Y coordinate for a point on a Polygon.

      • Id — (String)

        The identifier for the recognized text. The identifier is only unique for a single operation.

      • Relationships — (Array<map>)

        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.

        • Type — (String)

          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 the corresponding QUERY block.

          • TABLE - A list of IDs that identify associated TABLE block types.

          • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

          • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

          Possible values include:
          • "VALUE"
          • "CHILD"
          • "COMPLEX_FEATURES"
          • "MERGED_CELL"
          • "TITLE"
          • "ANSWER"
          • "TABLE"
          • "TABLE_TITLE"
          • "TABLE_FOOTER"
        • Ids — (Array<String>)

          An array of IDs for related blocks. You can get the type of the relationship from the Type element.

      • EntityTypes — (Array<String>)

        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 a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.

        • STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.

        • SEMI_STRUCTURED_TABLE - Identifies a non-structured table.

        EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • SelectionStatus — (String)

        The selection status of a selection element, such as an option button or check box.

        Possible values include:
        • "SELECTED"
        • "NOT_SELECTED"
      • Page — (Integer)

        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 — (map)
        • Text — required — (String)

          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 — (Array<String>)

          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.

    • DetectDocumentTextModelVersion — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AdapterId: 'STRING_VALUE' /* required */
};
textract.getAdapter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AdapterId — (String)

    A string containing a unique ID for the adapter.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AdapterId — (String)

      A string identifying the adapter that information has been retrieved for.

    • AdapterName — (String)

      The name of the requested adapter.

    • CreationTime — (Date)

      The date and time the requested adapter was created at.

    • Description — (String)

      The description for the requested adapter.

    • FeatureTypes — (Array<String>)

      List of the targeted feature types for the requested adapter.

    • AutoUpdate — (String)

      Binary value indicating if the adapter is being automatically updated or not.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • Tags — (map<String>)

      A set of tags (key-value pairs) associated with the adapter that has been retrieved.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AdapterId: 'STRING_VALUE', /* required */
  AdapterVersion: 'STRING_VALUE' /* required */
};
textract.getAdapterVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AdapterId — (String)

    A string specifying a unique ID for the adapter version you want to retrieve information for.

  • AdapterVersion — (String)

    A string specifying the adapter version you want to retrieve information for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AdapterId — (String)

      A string containing a unique ID for the adapter version being retrieved.

    • AdapterVersion — (String)

      A string containing the adapter version that has been retrieved.

    • CreationTime — (Date)

      The time that the adapter version was created.

    • FeatureTypes — (Array<String>)

      List of the targeted feature types for the requested adapter version.

    • Status — (String)

      The status of the adapter version that has been requested.

      Possible values include:
      • "ACTIVE"
      • "AT_RISK"
      • "DEPRECATED"
      • "CREATION_ERROR"
      • "CREATION_IN_PROGRESS"
    • StatusMessage — (String)

      A message that describes the status of the requested adapter version.

    • DatasetConfig — (map)

      Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.

      • ManifestS3Object — (map)

        The S3 bucket name and file name that identifies the document.

        The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations.

        For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file.

        • 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.

    • KMSKeyId — (String)

      The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.

    • OutputConfig — (map)

      Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.

      OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.

      Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.

      For more information on data privacy, see the Data Privacy FAQ.

      • S3Bucket — required — (String)

        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".

    • EvaluationMetrics — (Array<map>)

      The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.

      • Baseline — (map)

        The F1 score, precision, and recall metrics for the baseline model.

        • F1Score — (Float)

          The F1 score for an adapter version.

        • Precision — (Float)

          The Precision score for an adapter version.

        • Recall — (Float)

          The Recall score for an adapter version.

      • AdapterVersion — (map)

        The F1 score, precision, and recall metrics for the baseline model.

        • F1Score — (Float)

          The F1 score for an adapter version.

        • Precision — (Float)

          The Precision score for an adapter version.

        • Recall — (Float)

          The Recall score for an adapter version.

      • FeatureType — (String)

        Indicates the feature type being analyzed by a given adapter version.

        Possible values include:
        • "TABLES"
        • "FORMS"
        • "QUERIES"
        • "SIGNATURES"
        • "LAYOUT"
    • Tags — (map<String>)

      A set of tags (key-value pairs) that are associated with the adapter version.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
textract.getDocumentAnalysis(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

    A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

  • MaxResults — (Integer)

    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 — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DocumentMetadata — (map)

      Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

      • Pages — (Integer)

        The number of pages that are detected in the document.

    • JobStatus — (String)

      The current status of the text detection job.

      Possible values include:
      • "IN_PROGRESS"
      • "SUCCEEDED"
      • "FAILED"
      • "PARTIAL_SUCCESS"
    • NextToken — (String)

      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 — (Array<map>)

      The results of the text-analysis operation.

      • BlockType — (String)

        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 tab-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 VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.

        • WORD - A word that's 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 tab-delimited, contiguous words that are detected on a document page.

        • TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.

        • TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.

        • TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.

        • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

        • MERGED_CELL - A cell in a table whose content spans more than one row or column. The Relationships array for this cell contain data from individual cells.

        • SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

        • SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.

        • QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.

        • QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

        The following BlockTypes are only returned for Amazon Textract Layout.

        • LAYOUT_TITLE - The main title of the document.

        • LAYOUT_HEADER - Text located in the top margin of the document.

        • LAYOUT_FOOTER - Text located in the bottom margin of the document.

        • LAYOUT_SECTION_HEADER - The titles of sections within a document.

        • LAYOUT_PAGE_NUMBER - The page number of the documents.

        • LAYOUT_LIST - Any information grouped together in list form.

        • LAYOUT_FIGURE - Indicates the location of an image in a document.

        • LAYOUT_TABLE - Indicates the location of a table in the document.

        • LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document.

        • LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents.

        Possible values include:
        • "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 — (Float)

        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 — (String)

        The word or line of text that's recognized by Amazon Textract.

      • TextType — (String)

        The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

        Possible values include:
        • "HANDWRITING"
        • "PRINTED"
      • RowIndex — (Integer)

        The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • ColumnIndex — (Integer)

        The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • RowSpan — (Integer)

        The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • ColumnSpan — (Integer)

        The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • Geometry — (map)

        The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.

        • BoundingBox — (map)

          An axis-aligned coarse representation of the location of the recognized item on the document page.

          • Width — (Float)

            The width of the bounding box as a ratio of the overall document page width.

          • Height — (Float)

            The height of the bounding box as a ratio of the overall document page height.

          • Left — (Float)

            The left coordinate of the bounding box as a ratio of overall document page width.

          • Top — (Float)

            The top coordinate of the bounding box as a ratio of overall document page height.

        • Polygon — (Array<map>)

          Within the bounding box, a fine-grained polygon around the recognized item.

          • X — (Float)

            The value of the X coordinate for a point on a Polygon.

          • Y — (Float)

            The value of the Y coordinate for a point on a Polygon.

      • Id — (String)

        The identifier for the recognized text. The identifier is only unique for a single operation.

      • Relationships — (Array<map>)

        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.

        • Type — (String)

          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 the corresponding QUERY block.

          • TABLE - A list of IDs that identify associated TABLE block types.

          • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

          • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

          Possible values include:
          • "VALUE"
          • "CHILD"
          • "COMPLEX_FEATURES"
          • "MERGED_CELL"
          • "TITLE"
          • "ANSWER"
          • "TABLE"
          • "TABLE_TITLE"
          • "TABLE_FOOTER"
        • Ids — (Array<String>)

          An array of IDs for related blocks. You can get the type of the relationship from the Type element.

      • EntityTypes — (Array<String>)

        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 a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.

        • STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.

        • SEMI_STRUCTURED_TABLE - Identifies a non-structured table.

        EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • SelectionStatus — (String)

        The selection status of a selection element, such as an option button or check box.

        Possible values include:
        • "SELECTED"
        • "NOT_SELECTED"
      • Page — (Integer)

        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 — (map)
        • Text — required — (String)

          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 — (Array<String>)

          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.

    • Warnings — (Array<map>)

      A list of warnings that occurred during the document-analysis operation.

      • ErrorCode — (String)

        The error code for the warning.

      • Pages — (Array<Integer>)

        A list of the pages that the warning applies to.

    • StatusMessage — (String)

      Returns if the detection job could not be completed. Contains explanation for what error occured.

    • AnalyzeDocumentModelVersion — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
textract.getDocumentTextDetection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

    A unique identifier for the text detection job. The JobId is returned from StartDocumentTextDetection. A JobId value is only valid for 7 days.

  • MaxResults — (Integer)

    The maximum number of results to return per paginated call. The largest value 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 — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DocumentMetadata — (map)

      Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

      • Pages — (Integer)

        The number of pages that are detected in the document.

    • JobStatus — (String)

      The current status of the text detection job.

      Possible values include:
      • "IN_PROGRESS"
      • "SUCCEEDED"
      • "FAILED"
      • "PARTIAL_SUCCESS"
    • NextToken — (String)

      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 — (Array<map>)

      The results of the text-detection operation.

      • BlockType — (String)

        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 tab-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 VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.

        • WORD - A word that's 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 tab-delimited, contiguous words that are detected on a document page.

        • TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.

        • TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.

        • TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.

        • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

        • MERGED_CELL - A cell in a table whose content spans more than one row or column. The Relationships array for this cell contain data from individual cells.

        • SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

        • SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.

        • QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.

        • QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

        The following BlockTypes are only returned for Amazon Textract Layout.

        • LAYOUT_TITLE - The main title of the document.

        • LAYOUT_HEADER - Text located in the top margin of the document.

        • LAYOUT_FOOTER - Text located in the bottom margin of the document.

        • LAYOUT_SECTION_HEADER - The titles of sections within a document.

        • LAYOUT_PAGE_NUMBER - The page number of the documents.

        • LAYOUT_LIST - Any information grouped together in list form.

        • LAYOUT_FIGURE - Indicates the location of an image in a document.

        • LAYOUT_TABLE - Indicates the location of a table in the document.

        • LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document.

        • LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents.

        Possible values include:
        • "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 — (Float)

        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 — (String)

        The word or line of text that's recognized by Amazon Textract.

      • TextType — (String)

        The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

        Possible values include:
        • "HANDWRITING"
        • "PRINTED"
      • RowIndex — (Integer)

        The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • ColumnIndex — (Integer)

        The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • RowSpan — (Integer)

        The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • ColumnSpan — (Integer)

        The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • Geometry — (map)

        The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.

        • BoundingBox — (map)

          An axis-aligned coarse representation of the location of the recognized item on the document page.

          • Width — (Float)

            The width of the bounding box as a ratio of the overall document page width.

          • Height — (Float)

            The height of the bounding box as a ratio of the overall document page height.

          • Left — (Float)

            The left coordinate of the bounding box as a ratio of overall document page width.

          • Top — (Float)

            The top coordinate of the bounding box as a ratio of overall document page height.

        • Polygon — (Array<map>)

          Within the bounding box, a fine-grained polygon around the recognized item.

          • X — (Float)

            The value of the X coordinate for a point on a Polygon.

          • Y — (Float)

            The value of the Y coordinate for a point on a Polygon.

      • Id — (String)

        The identifier for the recognized text. The identifier is only unique for a single operation.

      • Relationships — (Array<map>)

        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.

        • Type — (String)

          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 the corresponding QUERY block.

          • TABLE - A list of IDs that identify associated TABLE block types.

          • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

          • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

          Possible values include:
          • "VALUE"
          • "CHILD"
          • "COMPLEX_FEATURES"
          • "MERGED_CELL"
          • "TITLE"
          • "ANSWER"
          • "TABLE"
          • "TABLE_TITLE"
          • "TABLE_FOOTER"
        • Ids — (Array<String>)

          An array of IDs for related blocks. You can get the type of the relationship from the Type element.

      • EntityTypes — (Array<String>)

        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 a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.

        • STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.

        • SEMI_STRUCTURED_TABLE - Identifies a non-structured table.

        EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

      • SelectionStatus — (String)

        The selection status of a selection element, such as an option button or check box.

        Possible values include:
        • "SELECTED"
        • "NOT_SELECTED"
      • Page — (Integer)

        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 — (map)
        • Text — required — (String)

          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 — (Array<String>)

          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.

    • Warnings — (Array<map>)

      A list of warnings that occurred during the text-detection operation for the document.

      • ErrorCode — (String)

        The error code for the warning.

      • Pages — (Array<Integer>)

        A list of the pages that the warning applies to.

    • StatusMessage — (String)

      Returns if the detection job could not be completed. Contains explanation for what error occured.

    • DetectDocumentTextModelVersion — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
textract.getExpenseAnalysis(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

    A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis. A JobId value is only valid for 7 days.

  • MaxResults — (Integer)

    The maximum number of results to return per paginated call. The largest value you can specify is 20. If you specify a value greater than 20, a maximum of 20 results is returned. The default value is 20.

  • NextToken — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DocumentMetadata — (map)

      Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract operation.

      • Pages — (Integer)

        The number of pages that are detected in the document.

    • JobStatus — (String)

      The current status of the text detection job.

      Possible values include:
      • "IN_PROGRESS"
      • "SUCCEEDED"
      • "FAILED"
      • "PARTIAL_SUCCESS"
    • NextToken — (String)

      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.

    • ExpenseDocuments — (Array<map>)

      The expenses detected by Amazon Textract.

      • ExpenseIndex — (Integer)

        Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.

      • SummaryFields — (Array<map>)

        Any information found outside of a table by Amazon Textract.

        • Type — (map)

          The implied label of a detected element. Present alongside LabelDetection for explicit elements.

          • Text — (String)

            The word or line of text detected by Amazon Textract.

          • Confidence — (Float)

            The confidence of accuracy, as a percentage.

        • LabelDetection — (map)

          The explicitly stated label of a detected element.

          • Text — (String)

            The word or line of text recognized by Amazon Textract

          • Geometry — (map)

            Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

            • BoundingBox — (map)

              An axis-aligned coarse representation of the location of the recognized item on the document page.

              • Width — (Float)

                The width of the bounding box as a ratio of the overall document page width.

              • Height — (Float)

                The height of the bounding box as a ratio of the overall document page height.

              • Left — (Float)

                The left coordinate of the bounding box as a ratio of overall document page width.

              • Top — (Float)

                The top coordinate of the bounding box as a ratio of overall document page height.

            • Polygon — (Array<map>)

              Within the bounding box, a fine-grained polygon around the recognized item.

              • X — (Float)

                The value of the X coordinate for a point on a Polygon.

              • Y — (Float)

                The value of the Y coordinate for a point on a Polygon.

          • Confidence — (Float)

            The confidence in detection, as a percentage

        • ValueDetection — (map)

          The value of a detected element. Present in explicit and implicit elements.

          • Text — (String)

            The word or line of text recognized by Amazon Textract

          • Geometry — (map)

            Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

            • BoundingBox — (map)

              An axis-aligned coarse representation of the location of the recognized item on the document page.

              • Width — (Float)

                The width of the bounding box as a ratio of the overall document page width.

              • Height — (Float)

                The height of the bounding box as a ratio of the overall document page height.

              • Left — (Float)

                The left coordinate of the bounding box as a ratio of overall document page width.

              • Top — (Float)

                The top coordinate of the bounding box as a ratio of overall document page height.

            • Polygon — (Array<map>)

              Within the bounding box, a fine-grained polygon around the recognized item.

              • X — (Float)

                The value of the X coordinate for a point on a Polygon.

              • Y — (Float)

                The value of the Y coordinate for a point on a Polygon.

          • Confidence — (Float)

            The confidence in detection, as a percentage

        • PageNumber — (Integer)

          The page number the value was detected on.

        • Currency — (map)

          Shows the kind of currency, both the code and confidence associated with any monatary value detected.

          • Code — (String)

            Currency code for detected currency. the current supported codes are:

            • USD

            • EUR

            • GBP

            • CAD

            • INR

            • JPY

            • CHF

            • AUD

            • CNY

            • BZR

            • SEK

            • HKD

          • Confidence — (Float)

            Percentage confideence in the detected currency.

        • GroupProperties — (Array<map>)

          Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.

          • Types — (Array<String>)

            Informs you on whether the expense group is a name or an address.

          • Id — (String)

            Provides a group Id number, which will be the same for each in the group.

      • LineItemGroups — (Array<map>)

        Information detected on each table of a document, seperated into LineItems.

        • LineItemGroupIndex — (Integer)

          The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc.

        • LineItems — (Array<map>)

          The breakdown of information on a particular line of a table.

          • LineItemExpenseFields — (Array<map>)

            ExpenseFields used to show information from detected lines on a table.

            • Type — (map)

              The implied label of a detected element. Present alongside LabelDetection for explicit elements.

              • Text — (String)

                The word or line of text detected by Amazon Textract.

              • Confidence — (Float)

                The confidence of accuracy, as a percentage.

            • LabelDetection — (map)

              The explicitly stated label of a detected element.

              • Text — (String)

                The word or line of text recognized by Amazon Textract

              • Geometry — (map)

                Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

                • BoundingBox — (map)

                  An axis-aligned coarse representation of the location of the recognized item on the document page.

                  • Width — (Float)

                    The width of the bounding box as a ratio of the overall document page width.

                  • Height — (Float)

                    The height of the bounding box as a ratio of the overall document page height.

                  • Left — (Float)

                    The left coordinate of the bounding box as a ratio of overall document page width.

                  • Top — (Float)

                    The top coordinate of the bounding box as a ratio of overall document page height.

                • Polygon — (Array<map>)

                  Within the bounding box, a fine-grained polygon around the recognized item.

                  • X — (Float)

                    The value of the X coordinate for a point on a Polygon.

                  • Y — (Float)

                    The value of the Y coordinate for a point on a Polygon.

              • Confidence — (Float)

                The confidence in detection, as a percentage

            • ValueDetection — (map)

              The value of a detected element. Present in explicit and implicit elements.

              • Text — (String)

                The word or line of text recognized by Amazon Textract

              • Geometry — (map)

                Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

                • BoundingBox — (map)

                  An axis-aligned coarse representation of the location of the recognized item on the document page.

                  • Width — (Float)

                    The width of the bounding box as a ratio of the overall document page width.

                  • Height — (Float)

                    The height of the bounding box as a ratio of the overall document page height.

                  • Left — (Float)

                    The left coordinate of the bounding box as a ratio of overall document page width.

                  • Top — (Float)

                    The top coordinate of the bounding box as a ratio of overall document page height.

                • Polygon — (Array<map>)

                  Within the bounding box, a fine-grained polygon around the recognized item.

                  • X — (Float)

                    The value of the X coordinate for a point on a Polygon.

                  • Y — (Float)

                    The value of the Y coordinate for a point on a Polygon.

              • Confidence — (Float)

                The confidence in detection, as a percentage

            • PageNumber — (Integer)

              The page number the value was detected on.

            • Currency — (map)

              Shows the kind of currency, both the code and confidence associated with any monatary value detected.

              • Code — (String)

                Currency code for detected currency. the current supported codes are:

                • USD

                • EUR

                • GBP

                • CAD

                • INR

                • JPY

                • CHF

                • AUD

                • CNY

                • BZR

                • SEK

                • HKD

              • Confidence — (Float)

                Percentage confideence in the detected currency.

            • GroupProperties — (Array<map>)

              Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.

              • Types — (Array<String>)

                Informs you on whether the expense group is a name or an address.

              • Id — (String)

                Provides a group Id number, which will be the same for each in the group.

      • Blocks — (Array<map>)

        This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text.

        • BlockType — (String)

          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 tab-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 VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.

          • WORD - A word that's 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 tab-delimited, contiguous words that are detected on a document page.

          • TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.

          • TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.

          • TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.

          • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

          • MERGED_CELL - A cell in a table whose content spans more than one row or column. The Relationships array for this cell contain data from individual cells.

          • SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

          • SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.

          • QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.

          • QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

          The following BlockTypes are only returned for Amazon Textract Layout.

          • LAYOUT_TITLE - The main title of the document.

          • LAYOUT_HEADER - Text located in the top margin of the document.

          • LAYOUT_FOOTER - Text located in the bottom margin of the document.

          • LAYOUT_SECTION_HEADER - The titles of sections within a document.

          • LAYOUT_PAGE_NUMBER - The page number of the documents.

          • LAYOUT_LIST - Any information grouped together in list form.

          • LAYOUT_FIGURE - Indicates the location of an image in a document.

          • LAYOUT_TABLE - Indicates the location of a table in the document.

          • LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document.

          • LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents.

          Possible values include:
          • "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 — (Float)

          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 — (String)

          The word or line of text that's recognized by Amazon Textract.

        • TextType — (String)

          The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

          Possible values include:
          • "HANDWRITING"
          • "PRINTED"
        • RowIndex — (Integer)

          The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • ColumnIndex — (Integer)

          The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • RowSpan — (Integer)

          The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • ColumnSpan — (Integer)

          The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • Geometry — (map)

          The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.

          • BoundingBox — (map)

            An axis-aligned coarse representation of the location of the recognized item on the document page.

            • Width — (Float)

              The width of the bounding box as a ratio of the overall document page width.

            • Height — (Float)

              The height of the bounding box as a ratio of the overall document page height.

            • Left — (Float)

              The left coordinate of the bounding box as a ratio of overall document page width.

            • Top — (Float)

              The top coordinate of the bounding box as a ratio of overall document page height.

          • Polygon — (Array<map>)

            Within the bounding box, a fine-grained polygon around the recognized item.

            • X — (Float)

              The value of the X coordinate for a point on a Polygon.

            • Y — (Float)

              The value of the Y coordinate for a point on a Polygon.

        • Id — (String)

          The identifier for the recognized text. The identifier is only unique for a single operation.

        • Relationships — (Array<map>)

          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.

          • Type — (String)

            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 the corresponding QUERY block.

            • TABLE - A list of IDs that identify associated TABLE block types.

            • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

            • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

            Possible values include:
            • "VALUE"
            • "CHILD"
            • "COMPLEX_FEATURES"
            • "MERGED_CELL"
            • "TITLE"
            • "ANSWER"
            • "TABLE"
            • "TABLE_TITLE"
            • "TABLE_FOOTER"
          • Ids — (Array<String>)

            An array of IDs for related blocks. You can get the type of the relationship from the Type element.

        • EntityTypes — (Array<String>)

          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 a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.

          • STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.

          • SEMI_STRUCTURED_TABLE - Identifies a non-structured table.

          EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

        • SelectionStatus — (String)

          The selection status of a selection element, such as an option button or check box.

          Possible values include:
          • "SELECTED"
          • "NOT_SELECTED"
        • Page — (Integer)

          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 — (map)
          • Text — required — (String)

            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 — (Array<String>)

            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.

    • Warnings — (Array<map>)

      A list of warnings that occurred during the text-detection operation for the document.

      • ErrorCode — (String)

        The error code for the warning.

      • Pages — (Array<Integer>)

        A list of the pages that the warning applies to.

    • StatusMessage — (String)

      Returns if the detection job could not be completed. Contains explanation for what error occured.

    • AnalyzeExpenseModelVersion — (String)

      The current model version of AnalyzeExpense.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
textract.getLendingAnalysis(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

    A unique identifier for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. A JobId value is only valid for 7 days.

  • MaxResults — (Integer)

    The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.

  • NextToken — (String)

    If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DocumentMetadata — (map)

      Information about the input document.

      • Pages — (Integer)

        The number of pages that are detected in the document.

    • JobStatus — (String)

      The current status of the lending analysis job.

      Possible values include:
      • "IN_PROGRESS"
      • "SUCCEEDED"
      • "FAILED"
      • "PARTIAL_SUCCESS"
    • NextToken — (String)

      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 lending results.

    • Results — (Array<map>)

      Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.

      • Page — (Integer)

        The page number for a page, with regard to whole submission.

      • PageClassification — (map)

        The classifier result for a given page.

        • PageType — required — (Array<map>)

          The class, or document type, assigned to a detected Page object. The class, or document type, assigned to a detected Page object.

          • Value — (String)

            The predicted value of a detected object.

          • Confidence — (Float)

            Amazon Textract's confidence in its predicted value.

        • PageNumber — required — (Array<map>)

          The page number the value was detected on, relative to Amazon Textract's starting position.

          • Value — (String)

            The predicted value of a detected object.

          • Confidence — (Float)

            Amazon Textract's confidence in its predicted value.

      • Extractions — (Array<map>)

        An array of Extraction to hold structured data. e.g. normalized key value pairs instead of raw OCR detections .

        • LendingDocument — (map)

          Holds the structured data returned by AnalyzeDocument for lending documents.

          • LendingFields — (Array<map>)

            An array of LendingField objects.

            • Type — (String)

              The type of the lending document.

            • KeyDetection — (map)

              The results extracted for a lending document.

              • Text — (String)

                The text extracted for a detected value in a lending document.

              • SelectionStatus — (String)

                The selection status of a selection element, such as an option button or check box.

                Possible values include:
                • "SELECTED"
                • "NOT_SELECTED"
              • Geometry — (map)

                Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

                • BoundingBox — (map)

                  An axis-aligned coarse representation of the location of the recognized item on the document page.

                  • Width — (Float)

                    The width of the bounding box as a ratio of the overall document page width.

                  • Height — (Float)

                    The height of the bounding box as a ratio of the overall document page height.

                  • Left — (Float)

                    The left coordinate of the bounding box as a ratio of overall document page width.

                  • Top — (Float)

                    The top coordinate of the bounding box as a ratio of overall document page height.

                • Polygon — (Array<map>)

                  Within the bounding box, a fine-grained polygon around the recognized item.

                  • X — (Float)

                    The value of the X coordinate for a point on a Polygon.

                  • Y — (Float)

                    The value of the Y coordinate for a point on a Polygon.

              • Confidence — (Float)

                The confidence level for the text of a detected value in a lending document.

            • ValueDetections — (Array<map>)

              An array of LendingDetection objects.

              • Text — (String)

                The text extracted for a detected value in a lending document.

              • SelectionStatus — (String)

                The selection status of a selection element, such as an option button or check box.

                Possible values include:
                • "SELECTED"
                • "NOT_SELECTED"
              • Geometry — (map)

                Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

                • BoundingBox — (map)

                  An axis-aligned coarse representation of the location of the recognized item on the document page.

                  • Width — (Float)

                    The width of the bounding box as a ratio of the overall document page width.

                  • Height — (Float)

                    The height of the bounding box as a ratio of the overall document page height.

                  • Left — (Float)

                    The left coordinate of the bounding box as a ratio of overall document page width.

                  • Top — (Float)

                    The top coordinate of the bounding box as a ratio of overall document page height.

                • Polygon — (Array<map>)

                  Within the bounding box, a fine-grained polygon around the recognized item.

                  • X — (Float)

                    The value of the X coordinate for a point on a Polygon.

                  • Y — (Float)

                    The value of the Y coordinate for a point on a Polygon.

              • Confidence — (Float)

                The confidence level for the text of a detected value in a lending document.

          • SignatureDetections — (Array<map>)

            A list of signatures detected in a lending document.

            • Confidence — (Float)

              The confidence, from 0 to 100, in the predicted values for a detected signature.

            • Geometry — (map)

              Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

              • BoundingBox — (map)

                An axis-aligned coarse representation of the location of the recognized item on the document page.

                • Width — (Float)

                  The width of the bounding box as a ratio of the overall document page width.

                • Height — (Float)

                  The height of the bounding box as a ratio of the overall document page height.

                • Left — (Float)

                  The left coordinate of the bounding box as a ratio of overall document page width.

                • Top — (Float)

                  The top coordinate of the bounding box as a ratio of overall document page height.

              • Polygon — (Array<map>)

                Within the bounding box, a fine-grained polygon around the recognized item.

                • X — (Float)

                  The value of the X coordinate for a point on a Polygon.

                • Y — (Float)

                  The value of the Y coordinate for a point on a Polygon.

        • ExpenseDocument — (map)

          The structure holding all the information returned by AnalyzeExpense

          • ExpenseIndex — (Integer)

            Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.

          • SummaryFields — (Array<map>)

            Any information found outside of a table by Amazon Textract.

            • Type — (map)

              The implied label of a detected element. Present alongside LabelDetection for explicit elements.

              • Text — (String)

                The word or line of text detected by Amazon Textract.

              • Confidence — (Float)

                The confidence of accuracy, as a percentage.

            • LabelDetection — (map)

              The explicitly stated label of a detected element.

              • Text — (String)

                The word or line of text recognized by Amazon Textract

              • Geometry — (map)

                Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

                • BoundingBox — (map)

                  An axis-aligned coarse representation of the location of the recognized item on the document page.

                  • Width — (Float)

                    The width of the bounding box as a ratio of the overall document page width.

                  • Height — (Float)

                    The height of the bounding box as a ratio of the overall document page height.

                  • Left — (Float)

                    The left coordinate of the bounding box as a ratio of overall document page width.

                  • Top — (Float)

                    The top coordinate of the bounding box as a ratio of overall document page height.

                • Polygon — (Array<map>)

                  Within the bounding box, a fine-grained polygon around the recognized item.

                  • X — (Float)

                    The value of the X coordinate for a point on a Polygon.

                  • Y — (Float)

                    The value of the Y coordinate for a point on a Polygon.

              • Confidence — (Float)

                The confidence in detection, as a percentage

            • ValueDetection — (map)

              The value of a detected element. Present in explicit and implicit elements.

              • Text — (String)

                The word or line of text recognized by Amazon Textract

              • Geometry — (map)

                Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

                • BoundingBox — (map)

                  An axis-aligned coarse representation of the location of the recognized item on the document page.

                  • Width — (Float)

                    The width of the bounding box as a ratio of the overall document page width.

                  • Height — (Float)

                    The height of the bounding box as a ratio of the overall document page height.

                  • Left — (Float)

                    The left coordinate of the bounding box as a ratio of overall document page width.

                  • Top — (Float)

                    The top coordinate of the bounding box as a ratio of overall document page height.

                • Polygon — (Array<map>)

                  Within the bounding box, a fine-grained polygon around the recognized item.

                  • X — (Float)

                    The value of the X coordinate for a point on a Polygon.

                  • Y — (Float)

                    The value of the Y coordinate for a point on a Polygon.

              • Confidence — (Float)

                The confidence in detection, as a percentage

            • PageNumber — (Integer)

              The page number the value was detected on.

            • Currency — (map)

              Shows the kind of currency, both the code and confidence associated with any monatary value detected.

              • Code — (String)

                Currency code for detected currency. the current supported codes are:

                • USD

                • EUR

                • GBP

                • CAD

                • INR

                • JPY

                • CHF

                • AUD

                • CNY

                • BZR

                • SEK

                • HKD

              • Confidence — (Float)

                Percentage confideence in the detected currency.

            • GroupProperties — (Array<map>)

              Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.

              • Types — (Array<String>)

                Informs you on whether the expense group is a name or an address.

              • Id — (String)

                Provides a group Id number, which will be the same for each in the group.

          • LineItemGroups — (Array<map>)

            Information detected on each table of a document, seperated into LineItems.

            • LineItemGroupIndex — (Integer)

              The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc.

            • LineItems — (Array<map>)

              The breakdown of information on a particular line of a table.

              • LineItemExpenseFields — (Array<map>)

                ExpenseFields used to show information from detected lines on a table.

                • Type — (map)

                  The implied label of a detected element. Present alongside LabelDetection for explicit elements.

                  • Text — (String)

                    The word or line of text detected by Amazon Textract.

                  • Confidence — (Float)

                    The confidence of accuracy, as a percentage.

                • LabelDetection — (map)

                  The explicitly stated label of a detected element.

                  • Text — (String)

                    The word or line of text recognized by Amazon Textract

                  • Geometry — (map)

                    Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

                    • BoundingBox — (map)

                      An axis-aligned coarse representation of the location of the recognized item on the document page.

                      • Width — (Float)

                        The width of the bounding box as a ratio of the overall document page width.

                      • Height — (Float)

                        The height of the bounding box as a ratio of the overall document page height.

                      • Left — (Float)

                        The left coordinate of the bounding box as a ratio of overall document page width.

                      • Top — (Float)

                        The top coordinate of the bounding box as a ratio of overall document page height.

                    • Polygon — (Array<map>)

                      Within the bounding box, a fine-grained polygon around the recognized item.

                      • X — (Float)

                        The value of the X coordinate for a point on a Polygon.

                      • Y — (Float)

                        The value of the Y coordinate for a point on a Polygon.

                  • Confidence — (Float)

                    The confidence in detection, as a percentage

                • ValueDetection — (map)

                  The value of a detected element. Present in explicit and implicit elements.

                  • Text — (String)

                    The word or line of text recognized by Amazon Textract

                  • Geometry — (map)

                    Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

                    • BoundingBox — (map)

                      An axis-aligned coarse representation of the location of the recognized item on the document page.

                      • Width — (Float)

                        The width of the bounding box as a ratio of the overall document page width.

                      • Height — (Float)

                        The height of the bounding box as a ratio of the overall document page height.

                      • Left — (Float)

                        The left coordinate of the bounding box as a ratio of overall document page width.

                      • Top — (Float)

                        The top coordinate of the bounding box as a ratio of overall document page height.

                    • Polygon — (Array<map>)

                      Within the bounding box, a fine-grained polygon around the recognized item.

                      • X — (Float)

                        The value of the X coordinate for a point on a Polygon.

                      • Y — (Float)

                        The value of the Y coordinate for a point on a Polygon.

                  • Confidence — (Float)

                    The confidence in detection, as a percentage

                • PageNumber — (Integer)

                  The page number the value was detected on.

                • Currency — (map)

                  Shows the kind of currency, both the code and confidence associated with any monatary value detected.

                  • Code — (String)

                    Currency code for detected currency. the current supported codes are:

                    • USD

                    • EUR

                    • GBP

                    • CAD

                    • INR

                    • JPY

                    • CHF

                    • AUD

                    • CNY

                    • BZR

                    • SEK

                    • HKD

                  • Confidence — (Float)

                    Percentage confideence in the detected currency.

                • GroupProperties — (Array<map>)

                  Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.

                  • Types — (Array<String>)

                    Informs you on whether the expense group is a name or an address.

                  • Id — (String)

                    Provides a group Id number, which will be the same for each in the group.

          • Blocks — (Array<map>)

            This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text.

            • BlockType — (String)

              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 tab-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 VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.

              • WORD - A word that's 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 tab-delimited, contiguous words that are detected on a document page.

              • TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.

              • TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.

              • TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.

              • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

              • MERGED_CELL - A cell in a table whose content spans more than one row or column. The Relationships array for this cell contain data from individual cells.

              • SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

              • SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.

              • QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.

              • QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

              The following BlockTypes are only returned for Amazon Textract Layout.

              • LAYOUT_TITLE - The main title of the document.

              • LAYOUT_HEADER - Text located in the top margin of the document.

              • LAYOUT_FOOTER - Text located in the bottom margin of the document.

              • LAYOUT_SECTION_HEADER - The titles of sections within a document.

              • LAYOUT_PAGE_NUMBER - The page number of the documents.

              • LAYOUT_LIST - Any information grouped together in list form.

              • LAYOUT_FIGURE - Indicates the location of an image in a document.

              • LAYOUT_TABLE - Indicates the location of a table in the document.

              • LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document.

              • LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents.

              Possible values include:
              • "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 — (Float)

              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 — (String)

              The word or line of text that's recognized by Amazon Textract.

            • TextType — (String)

              The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

              Possible values include:
              • "HANDWRITING"
              • "PRINTED"
            • RowIndex — (Integer)

              The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

            • ColumnIndex — (Integer)

              The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

            • RowSpan — (Integer)

              The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

            • ColumnSpan — (Integer)

              The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

            • Geometry — (map)

              The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.

              • BoundingBox — (map)

                An axis-aligned coarse representation of the location of the recognized item on the document page.

                • Width — (Float)

                  The width of the bounding box as a ratio of the overall document page width.

                • Height — (Float)

                  The height of the bounding box as a ratio of the overall document page height.

                • Left — (Float)

                  The left coordinate of the bounding box as a ratio of overall document page width.

                • Top — (Float)

                  The top coordinate of the bounding box as a ratio of overall document page height.

              • Polygon — (Array<map>)

                Within the bounding box, a fine-grained polygon around the recognized item.

                • X — (Float)

                  The value of the X coordinate for a point on a Polygon.

                • Y — (Float)

                  The value of the Y coordinate for a point on a Polygon.

            • Id — (String)

              The identifier for the recognized text. The identifier is only unique for a single operation.

            • Relationships — (Array<map>)

              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.

              • Type — (String)

                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 the corresponding QUERY block.

                • TABLE - A list of IDs that identify associated TABLE block types.

                • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

                • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

                Possible values include:
                • "VALUE"
                • "CHILD"
                • "COMPLEX_FEATURES"
                • "MERGED_CELL"
                • "TITLE"
                • "ANSWER"
                • "TABLE"
                • "TABLE_TITLE"
                • "TABLE_FOOTER"
              • Ids — (Array<String>)

                An array of IDs for related blocks. You can get the type of the relationship from the Type element.

            • EntityTypes — (Array<String>)

              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 a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.

              • STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.

              • SEMI_STRUCTURED_TABLE - Identifies a non-structured table.

              EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

            • SelectionStatus — (String)

              The selection status of a selection element, such as an option button or check box.

              Possible values include:
              • "SELECTED"
              • "NOT_SELECTED"
            • Page — (Integer)

              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 — (map)
              • Text — required — (String)

                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 — (Array<String>)

                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.

        • IdentityDocument — (map)

          The structure that lists each document processed in an AnalyzeID operation.

          • DocumentIndex — (Integer)

            Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

          • IdentityDocumentFields — (Array<map>)

            The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

            • Type — (map)

              Used to contain the information detected by an AnalyzeID operation.

              • Text — required — (String)

                Text of either the normalized field or value associated with it.

              • NormalizedValue — (map)

                Only returned for dates, returns the type of value detected and the date written in a more machine readable way.

                • Value — (String)

                  The value of the date, written as Year-Month-DayTHour:Minute:Second.

                • ValueType — (String)

                  The normalized type of the value detected. In this case, DATE.

                  Possible values include:
                  • "DATE"
              • Confidence — (Float)

                The confidence score of the detected text.

            • ValueDetection — (map)

              Used to contain the information detected by an AnalyzeID operation.

              • Text — required — (String)

                Text of either the normalized field or value associated with it.

              • NormalizedValue — (map)

                Only returned for dates, returns the type of value detected and the date written in a more machine readable way.

                • Value — (String)

                  The value of the date, written as Year-Month-DayTHour:Minute:Second.

                • ValueType — (String)

                  The normalized type of the value detected. In this case, DATE.

                  Possible values include:
                  • "DATE"
              • Confidence — (Float)

                The confidence score of the detected text.

          • Blocks — (Array<map>)

            Individual word recognition, as returned by document detection.

            • BlockType — (String)

              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 tab-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 VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.

              • WORD - A word that's 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 tab-delimited, contiguous words that are detected on a document page.

              • TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.

              • TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.

              • TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.

              • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

              • MERGED_CELL - A cell in a table whose content spans more than one row or column. The Relationships array for this cell contain data from individual cells.

              • SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

              • SIGNATURE - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.

              • QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.

              • QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

              The following BlockTypes are only returned for Amazon Textract Layout.

              • LAYOUT_TITLE - The main title of the document.

              • LAYOUT_HEADER - Text located in the top margin of the document.

              • LAYOUT_FOOTER - Text located in the bottom margin of the document.

              • LAYOUT_SECTION_HEADER - The titles of sections within a document.

              • LAYOUT_PAGE_NUMBER - The page number of the documents.

              • LAYOUT_LIST - Any information grouped together in list form.

              • LAYOUT_FIGURE - Indicates the location of an image in a document.

              • LAYOUT_TABLE - Indicates the location of a table in the document.

              • LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document.

              • LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents.

              Possible values include:
              • "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 — (Float)

              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 — (String)

              The word or line of text that's recognized by Amazon Textract.

            • TextType — (String)

              The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

              Possible values include:
              • "HANDWRITING"
              • "PRINTED"
            • RowIndex — (Integer)

              The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

            • ColumnIndex — (Integer)

              The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

            • RowSpan — (Integer)

              The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

            • ColumnSpan — (Integer)

              The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

            • Geometry — (map)

              The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.

              • BoundingBox — (map)

                An axis-aligned coarse representation of the location of the recognized item on the document page.

                • Width — (Float)

                  The width of the bounding box as a ratio of the overall document page width.

                • Height — (Float)

                  The height of the bounding box as a ratio of the overall document page height.

                • Left — (Float)

                  The left coordinate of the bounding box as a ratio of overall document page width.

                • Top — (Float)

                  The top coordinate of the bounding box as a ratio of overall document page height.

              • Polygon — (Array<map>)

                Within the bounding box, a fine-grained polygon around the recognized item.

                • X — (Float)

                  The value of the X coordinate for a point on a Polygon.

                • Y — (Float)

                  The value of the Y coordinate for a point on a Polygon.

            • Id — (String)

              The identifier for the recognized text. The identifier is only unique for a single operation.

            • Relationships — (Array<map>)

              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.

              • Type — (String)

                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 the corresponding QUERY block.

                • TABLE - A list of IDs that identify associated TABLE block types.

                • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

                • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

                Possible values include:
                • "VALUE"
                • "CHILD"
                • "COMPLEX_FEATURES"
                • "MERGED_CELL"
                • "TITLE"
                • "ANSWER"
                • "TABLE"
                • "TABLE_TITLE"
                • "TABLE_FOOTER"
              • Ids — (Array<String>)

                An array of IDs for related blocks. You can get the type of the relationship from the Type element.

            • EntityTypes — (Array<String>)

              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 a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.

              • STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.

              • SEMI_STRUCTURED_TABLE - Identifies a non-structured table.

              EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

            • SelectionStatus — (String)

              The selection status of a selection element, such as an option button or check box.

              Possible values include:
              • "SELECTED"
              • "NOT_SELECTED"
            • Page — (Integer)

              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 — (map)
              • Text — required — (String)

                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 — (Array<String>)

                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.

    • Warnings — (Array<map>)

      A list of warnings that occurred during the lending analysis operation.

      • ErrorCode — (String)

        The error code for the warning.

      • Pages — (Array<Integer>)

        A list of the pages that the warning applies to.

    • StatusMessage — (String)

      Returns if the lending analysis job could not be completed. Contains explanation for what error occurred.

    • AnalyzeLendingModelVersion — (String)

      The current model version of the Analyze Lending API.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE' /* required */
};
textract.getLendingAnalysisSummary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

    A unique identifier for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. A JobId value is only valid for 7 days.