Get Lending Analysis

textract_get_lending_analysis

R Documentation

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document

Description

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.

You start asynchronous text analysis by calling start_lending_analysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to start_lending_analysis.

To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass the job identifier (JobId) from the initial call to start_lending_analysis.

Usage

textract_get_lending_analysis(JobId, MaxResults, NextToken)

Arguments

JobId

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

MaxResults

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

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.

Value

A list with the following syntax:

list(
  DocumentMetadata = list(
    Pages = 123
  ),
  JobStatus = "IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"PARTIAL_SUCCESS",
  NextToken = "string",
  Results = list(
    list(
      Page = 123,
      PageClassification = list(
        PageType = list(
          list(
            Value = "string",
            Confidence = 123.0
          )
        ),
        PageNumber = list(
          list(
            Value = "string",
            Confidence = 123.0
          )
        )
      ),
      Extractions = list(
        list(
          LendingDocument = list(
            LendingFields = list(
              list(
                Type = "string",
                KeyDetection = list(
                  Text = "string",
                  SelectionStatus = "SELECTED"|"NOT_SELECTED",
                  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
                      )
                    )
                  ),
                  Confidence = 123.0
                ),
                ValueDetections = list(
                  list(
                    Text = "string",
                    SelectionStatus = "SELECTED"|"NOT_SELECTED",
                    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
                        )
                      )
                    ),
                    Confidence = 123.0
                  )
                )
              )
            ),
            SignatureDetections = list(
              list(
                Confidence = 123.0,
                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
                    )
                  )
                )
              )
            )
          ),
          ExpenseDocument = list(
            ExpenseIndex = 123,
            SummaryFields = list(
              list(
                Type = list(
                  Text = "string",
                  Confidence = 123.0
                ),
                LabelDetection = list(
                  Text = "string",
                  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
                      )
                    )
                  ),
                  Confidence = 123.0
                ),
                ValueDetection = list(
                  Text = "string",
                  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
                      )
                    )
                  ),
                  Confidence = 123.0
                ),
                PageNumber = 123,
                Currency = list(
                  Code = "string",
                  Confidence = 123.0
                ),
                GroupProperties = list(
                  list(
                    Types = list(
                      "string"
                    ),
                    Id = "string"
                  )
                )
              )
            ),
            LineItemGroups = list(
              list(
                LineItemGroupIndex = 123,
                LineItems = list(
                  list(
                    LineItemExpenseFields = list(
                      list(
                        Type = list(
                          Text = "string",
                          Confidence = 123.0
                        ),
                        LabelDetection = list(
                          Text = "string",
                          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
                              )
                            )
                          ),
                          Confidence = 123.0
                        ),
                        ValueDetection = list(
                          Text = "string",
                          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
                              )
                            )
                          ),
                          Confidence = 123.0
                        ),
                        PageNumber = 123,
                        Currency = list(
                          Code = "string",
                          Confidence = 123.0
                        ),
                        GroupProperties = list(
                          list(
                            Types = list(
                              "string"
                            ),
                            Id = "string"
                          )
                        )
                      )
                    )
                  )
                )
              )
            ),
            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"
                  )
                )
              )
            )
          ),
          IdentityDocument = 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"
                  )
                )
              )
            )
          )
        )
      )
    )
  ),
  Warnings = list(
    list(
      ErrorCode = "string",
      Pages = list(
        123
      )
    )
  ),
  StatusMessage = "string",
  AnalyzeLendingModelVersion = "string"
)

Request syntax

svc$get_lending_analysis(
  JobId = "string",
  MaxResults = 123,
  NextToken = "string"
)