Analyze Id

textract_analyze_id

R Documentation

Analyzes identity documents for relevant information

Description

Analyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields, which records both the normalized field and value of the extracted text. Unlike other Amazon Textract operations, analyze_id doesn't return any Geometry data.

Usage

textract_analyze_id(DocumentPages)

Arguments

DocumentPages

[required] The document being passed to AnalyzeID.

Value

A list with the following syntax:

list(
  IdentityDocuments = list(
    list(
      DocumentIndex = 123,
      IdentityDocumentFields = list(
        list(
          Type = list(
            Text = "string",
            NormalizedValue = list(
              Value = "string",
              ValueType = "DATE"
            ),
            Confidence = 123.0
          ),
          ValueDetection = list(
            Text = "string",
            NormalizedValue = list(
              Value = "string",
              ValueType = "DATE"
            ),
            Confidence = 123.0
          )
        )
      ),
      Blocks = list(
        list(
          BlockType = "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 = 123.0,
          Text = "string",
          TextType = "HANDWRITING"|"PRINTED",
          RowIndex = 123,
          ColumnIndex = 123,
          RowSpan = 123,
          ColumnSpan = 123,
          Geometry = list(
            BoundingBox = list(
              Width = 123.0,
              Height = 123.0,
              Left = 123.0,
              Top = 123.0
            ),
            Polygon = list(
              list(
                X = 123.0,
                Y = 123.0
              )
            )
          ),
          Id = "string",
          Relationships = list(
            list(
              Type = "VALUE"|"CHILD"|"COMPLEX_FEATURES"|"MERGED_CELL"|"TITLE"|"ANSWER"|"TABLE"|"TABLE_TITLE"|"TABLE_FOOTER",
              Ids = list(
                "string"
              )
            )
          ),
          EntityTypes = list(
            "KEY"|"VALUE"|"COLUMN_HEADER"|"TABLE_TITLE"|"TABLE_FOOTER"|"TABLE_SECTION_TITLE"|"TABLE_SUMMARY"|"STRUCTURED_TABLE"|"SEMI_STRUCTURED_TABLE"
          ),
          SelectionStatus = "SELECTED"|"NOT_SELECTED",
          Page = 123,
          Query = list(
            Text = "string",
            Alias = "string",
            Pages = list(
              "string"
            )
          )
        )
      )
    )
  ),
  DocumentMetadata = list(
    Pages = 123
  ),
  AnalyzeIDModelVersion = "string"
)

Request syntax

svc$analyze_id(
  DocumentPages = list(
    list(
      Bytes = raw,
      S3Object = list(
        Bucket = "string",
        Name = "string",
        Version = "string"
      )
    )
  )
)