aws-sdk-textract 1.42.0 → 1.43.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-textract/client.rb +445 -1
- data/lib/aws-sdk-textract/client_api.rb +200 -0
- data/lib/aws-sdk-textract/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-textract/endpoint_provider.rb +76 -76
- data/lib/aws-sdk-textract/endpoints.rb +42 -0
- data/lib/aws-sdk-textract/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-textract/types.rb +577 -7
- data/lib/aws-sdk-textract.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6d7c8e395c8d4e7aa7f2b97e3e9b8115db3fd38dab0c3a18b4c459dd9b659bee
|
4
|
+
data.tar.gz: 8aec72017e4b7894c7c40d987f1a8543f5e6084e0e19dfecdae3b99aab3e101f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 57b83ac505c43cdcf86038e27e5b1b4714ff6bfaea83ca754ee37a54139f14806ebf6ff1a952fc7567fa9316cfd4339d91fe3270162a2e3e84420d3c139b978d
|
7
|
+
data.tar.gz: e4d909d5bb66c53edd0172146ed0729ea45ec0dd35b16d20f064de21fbe3a9f3d7ab3a48c9b8b5a14210298b3412696670687ef559d1879a05b9316c6597b691
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.43.0 (2022-11-28)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds support for classifying and splitting lending documents by type, and extracting information by using the Analyze Lending APIs. This release also includes support for summarized information of the processed lending document package, in addition to per document results.
|
8
|
+
|
4
9
|
1.42.0 (2022-11-17)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.43.0
|
@@ -1323,6 +1323,316 @@ module Aws::Textract
|
|
1323
1323
|
req.send_request(options)
|
1324
1324
|
end
|
1325
1325
|
|
1326
|
+
# Gets the results for an Amazon Textract asynchronous operation that
|
1327
|
+
# analyzes text in a lending document.
|
1328
|
+
#
|
1329
|
+
# You start asynchronous text analysis by calling
|
1330
|
+
# `StartLendingAnalysis`, which returns a job identifier (`JobId`). When
|
1331
|
+
# the text analysis operation finishes, Amazon Textract publishes a
|
1332
|
+
# completion status to the Amazon Simple Notification Service (Amazon
|
1333
|
+
# SNS) topic that's registered in the initial call to
|
1334
|
+
# `StartLendingAnalysis`.
|
1335
|
+
#
|
1336
|
+
# To get the results of the text analysis operation, first check that
|
1337
|
+
# the status value published to the Amazon SNS topic is SUCCEEDED. If
|
1338
|
+
# so, call GetLendingAnalysis, and pass the job identifier (`JobId`)
|
1339
|
+
# from the initial call to `StartLendingAnalysis`.
|
1340
|
+
#
|
1341
|
+
# @option params [required, String] :job_id
|
1342
|
+
# A unique identifier for the lending or text-detection job. The `JobId`
|
1343
|
+
# is returned from `StartLendingAnalysis`. A `JobId` value is only valid
|
1344
|
+
# for 7 days.
|
1345
|
+
#
|
1346
|
+
# @option params [Integer] :max_results
|
1347
|
+
# The maximum number of results to return per paginated call. The
|
1348
|
+
# largest value that you can specify is 30. If you specify a value
|
1349
|
+
# greater than 30, a maximum of 30 results is returned. The default
|
1350
|
+
# value is 30.
|
1351
|
+
#
|
1352
|
+
# @option params [String] :next_token
|
1353
|
+
# If the previous response was incomplete, Amazon Textract returns a
|
1354
|
+
# pagination token in the response. You can use this pagination token to
|
1355
|
+
# retrieve the next set of lending results.
|
1356
|
+
#
|
1357
|
+
# @return [Types::GetLendingAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1358
|
+
#
|
1359
|
+
# * {Types::GetLendingAnalysisResponse#document_metadata #document_metadata} => Types::DocumentMetadata
|
1360
|
+
# * {Types::GetLendingAnalysisResponse#job_status #job_status} => String
|
1361
|
+
# * {Types::GetLendingAnalysisResponse#next_token #next_token} => String
|
1362
|
+
# * {Types::GetLendingAnalysisResponse#results #results} => Array<Types::LendingResult>
|
1363
|
+
# * {Types::GetLendingAnalysisResponse#warnings #warnings} => Array<Types::Warning>
|
1364
|
+
# * {Types::GetLendingAnalysisResponse#status_message #status_message} => String
|
1365
|
+
# * {Types::GetLendingAnalysisResponse#analyze_lending_model_version #analyze_lending_model_version} => String
|
1366
|
+
#
|
1367
|
+
# @example Request syntax with placeholder values
|
1368
|
+
#
|
1369
|
+
# resp = client.get_lending_analysis({
|
1370
|
+
# job_id: "JobId", # required
|
1371
|
+
# max_results: 1,
|
1372
|
+
# next_token: "PaginationToken",
|
1373
|
+
# })
|
1374
|
+
#
|
1375
|
+
# @example Response structure
|
1376
|
+
#
|
1377
|
+
# resp.document_metadata.pages #=> Integer
|
1378
|
+
# resp.job_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED", "PARTIAL_SUCCESS"
|
1379
|
+
# resp.next_token #=> String
|
1380
|
+
# resp.results #=> Array
|
1381
|
+
# resp.results[0].page #=> Integer
|
1382
|
+
# resp.results[0].page_classification.page_type #=> Array
|
1383
|
+
# resp.results[0].page_classification.page_type[0].value #=> String
|
1384
|
+
# resp.results[0].page_classification.page_type[0].confidence #=> Float
|
1385
|
+
# resp.results[0].page_classification.page_number #=> Array
|
1386
|
+
# resp.results[0].page_classification.page_number[0].value #=> String
|
1387
|
+
# resp.results[0].page_classification.page_number[0].confidence #=> Float
|
1388
|
+
# resp.results[0].extractions #=> Array
|
1389
|
+
# resp.results[0].extractions[0].lending_document.lending_fields #=> Array
|
1390
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].type #=> String
|
1391
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].key_detection.text #=> String
|
1392
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].key_detection.selection_status #=> String, one of "SELECTED", "NOT_SELECTED"
|
1393
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].key_detection.geometry.bounding_box.width #=> Float
|
1394
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].key_detection.geometry.bounding_box.height #=> Float
|
1395
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].key_detection.geometry.bounding_box.left #=> Float
|
1396
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].key_detection.geometry.bounding_box.top #=> Float
|
1397
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].key_detection.geometry.polygon #=> Array
|
1398
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].key_detection.geometry.polygon[0].x #=> Float
|
1399
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].key_detection.geometry.polygon[0].y #=> Float
|
1400
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].key_detection.confidence #=> Float
|
1401
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].value_detections #=> Array
|
1402
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].value_detections[0].text #=> String
|
1403
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].value_detections[0].selection_status #=> String, one of "SELECTED", "NOT_SELECTED"
|
1404
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].value_detections[0].geometry.bounding_box.width #=> Float
|
1405
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].value_detections[0].geometry.bounding_box.height #=> Float
|
1406
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].value_detections[0].geometry.bounding_box.left #=> Float
|
1407
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].value_detections[0].geometry.bounding_box.top #=> Float
|
1408
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].value_detections[0].geometry.polygon #=> Array
|
1409
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].value_detections[0].geometry.polygon[0].x #=> Float
|
1410
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].value_detections[0].geometry.polygon[0].y #=> Float
|
1411
|
+
# resp.results[0].extractions[0].lending_document.lending_fields[0].value_detections[0].confidence #=> Float
|
1412
|
+
# resp.results[0].extractions[0].lending_document.signature_detections #=> Array
|
1413
|
+
# resp.results[0].extractions[0].lending_document.signature_detections[0].confidence #=> Float
|
1414
|
+
# resp.results[0].extractions[0].lending_document.signature_detections[0].geometry.bounding_box.width #=> Float
|
1415
|
+
# resp.results[0].extractions[0].lending_document.signature_detections[0].geometry.bounding_box.height #=> Float
|
1416
|
+
# resp.results[0].extractions[0].lending_document.signature_detections[0].geometry.bounding_box.left #=> Float
|
1417
|
+
# resp.results[0].extractions[0].lending_document.signature_detections[0].geometry.bounding_box.top #=> Float
|
1418
|
+
# resp.results[0].extractions[0].lending_document.signature_detections[0].geometry.polygon #=> Array
|
1419
|
+
# resp.results[0].extractions[0].lending_document.signature_detections[0].geometry.polygon[0].x #=> Float
|
1420
|
+
# resp.results[0].extractions[0].lending_document.signature_detections[0].geometry.polygon[0].y #=> Float
|
1421
|
+
# resp.results[0].extractions[0].expense_document.expense_index #=> Integer
|
1422
|
+
# resp.results[0].extractions[0].expense_document.summary_fields #=> Array
|
1423
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].type.text #=> String
|
1424
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].type.confidence #=> Float
|
1425
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].label_detection.text #=> String
|
1426
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].label_detection.geometry.bounding_box.width #=> Float
|
1427
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].label_detection.geometry.bounding_box.height #=> Float
|
1428
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].label_detection.geometry.bounding_box.left #=> Float
|
1429
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].label_detection.geometry.bounding_box.top #=> Float
|
1430
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].label_detection.geometry.polygon #=> Array
|
1431
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].label_detection.geometry.polygon[0].x #=> Float
|
1432
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].label_detection.geometry.polygon[0].y #=> Float
|
1433
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].label_detection.confidence #=> Float
|
1434
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].value_detection.text #=> String
|
1435
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].value_detection.geometry.bounding_box.width #=> Float
|
1436
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].value_detection.geometry.bounding_box.height #=> Float
|
1437
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].value_detection.geometry.bounding_box.left #=> Float
|
1438
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].value_detection.geometry.bounding_box.top #=> Float
|
1439
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].value_detection.geometry.polygon #=> Array
|
1440
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].value_detection.geometry.polygon[0].x #=> Float
|
1441
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].value_detection.geometry.polygon[0].y #=> Float
|
1442
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].value_detection.confidence #=> Float
|
1443
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].page_number #=> Integer
|
1444
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].currency.code #=> String
|
1445
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].currency.confidence #=> Float
|
1446
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].group_properties #=> Array
|
1447
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].group_properties[0].types #=> Array
|
1448
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].group_properties[0].types[0] #=> String
|
1449
|
+
# resp.results[0].extractions[0].expense_document.summary_fields[0].group_properties[0].id #=> String
|
1450
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups #=> Array
|
1451
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_item_group_index #=> Integer
|
1452
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items #=> Array
|
1453
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields #=> Array
|
1454
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].type.text #=> String
|
1455
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].type.confidence #=> Float
|
1456
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.text #=> String
|
1457
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.geometry.bounding_box.width #=> Float
|
1458
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.geometry.bounding_box.height #=> Float
|
1459
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.geometry.bounding_box.left #=> Float
|
1460
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.geometry.bounding_box.top #=> Float
|
1461
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.geometry.polygon #=> Array
|
1462
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.geometry.polygon[0].x #=> Float
|
1463
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.geometry.polygon[0].y #=> Float
|
1464
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.confidence #=> Float
|
1465
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.text #=> String
|
1466
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.geometry.bounding_box.width #=> Float
|
1467
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.geometry.bounding_box.height #=> Float
|
1468
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.geometry.bounding_box.left #=> Float
|
1469
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.geometry.bounding_box.top #=> Float
|
1470
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.geometry.polygon #=> Array
|
1471
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.geometry.polygon[0].x #=> Float
|
1472
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.geometry.polygon[0].y #=> Float
|
1473
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.confidence #=> Float
|
1474
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].page_number #=> Integer
|
1475
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].currency.code #=> String
|
1476
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].currency.confidence #=> Float
|
1477
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].group_properties #=> Array
|
1478
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].group_properties[0].types #=> Array
|
1479
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].group_properties[0].types[0] #=> String
|
1480
|
+
# resp.results[0].extractions[0].expense_document.line_item_groups[0].line_items[0].line_item_expense_fields[0].group_properties[0].id #=> String
|
1481
|
+
# resp.results[0].extractions[0].expense_document.blocks #=> Array
|
1482
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT", "SIGNATURE"
|
1483
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].confidence #=> Float
|
1484
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].text #=> String
|
1485
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
|
1486
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].row_index #=> Integer
|
1487
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].column_index #=> Integer
|
1488
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].row_span #=> Integer
|
1489
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].column_span #=> Integer
|
1490
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].geometry.bounding_box.width #=> Float
|
1491
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].geometry.bounding_box.height #=> Float
|
1492
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].geometry.bounding_box.left #=> Float
|
1493
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].geometry.bounding_box.top #=> Float
|
1494
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].geometry.polygon #=> Array
|
1495
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].geometry.polygon[0].x #=> Float
|
1496
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].geometry.polygon[0].y #=> Float
|
1497
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].id #=> String
|
1498
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].relationships #=> Array
|
1499
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD", "COMPLEX_FEATURES", "MERGED_CELL", "TITLE", "ANSWER"
|
1500
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].relationships[0].ids #=> Array
|
1501
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].relationships[0].ids[0] #=> String
|
1502
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].entity_types #=> Array
|
1503
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].entity_types[0] #=> String, one of "KEY", "VALUE", "COLUMN_HEADER"
|
1504
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].selection_status #=> String, one of "SELECTED", "NOT_SELECTED"
|
1505
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].page #=> Integer
|
1506
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].query.text #=> String
|
1507
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].query.alias #=> String
|
1508
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].query.pages #=> Array
|
1509
|
+
# resp.results[0].extractions[0].expense_document.blocks[0].query.pages[0] #=> String
|
1510
|
+
# resp.results[0].extractions[0].identity_document.document_index #=> Integer
|
1511
|
+
# resp.results[0].extractions[0].identity_document.identity_document_fields #=> Array
|
1512
|
+
# resp.results[0].extractions[0].identity_document.identity_document_fields[0].type.text #=> String
|
1513
|
+
# resp.results[0].extractions[0].identity_document.identity_document_fields[0].type.normalized_value.value #=> String
|
1514
|
+
# resp.results[0].extractions[0].identity_document.identity_document_fields[0].type.normalized_value.value_type #=> String, one of "DATE"
|
1515
|
+
# resp.results[0].extractions[0].identity_document.identity_document_fields[0].type.confidence #=> Float
|
1516
|
+
# resp.results[0].extractions[0].identity_document.identity_document_fields[0].value_detection.text #=> String
|
1517
|
+
# resp.results[0].extractions[0].identity_document.identity_document_fields[0].value_detection.normalized_value.value #=> String
|
1518
|
+
# resp.results[0].extractions[0].identity_document.identity_document_fields[0].value_detection.normalized_value.value_type #=> String, one of "DATE"
|
1519
|
+
# resp.results[0].extractions[0].identity_document.identity_document_fields[0].value_detection.confidence #=> Float
|
1520
|
+
# resp.results[0].extractions[0].identity_document.blocks #=> Array
|
1521
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT", "SIGNATURE"
|
1522
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].confidence #=> Float
|
1523
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].text #=> String
|
1524
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
|
1525
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].row_index #=> Integer
|
1526
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].column_index #=> Integer
|
1527
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].row_span #=> Integer
|
1528
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].column_span #=> Integer
|
1529
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].geometry.bounding_box.width #=> Float
|
1530
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].geometry.bounding_box.height #=> Float
|
1531
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].geometry.bounding_box.left #=> Float
|
1532
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].geometry.bounding_box.top #=> Float
|
1533
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].geometry.polygon #=> Array
|
1534
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].geometry.polygon[0].x #=> Float
|
1535
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].geometry.polygon[0].y #=> Float
|
1536
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].id #=> String
|
1537
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].relationships #=> Array
|
1538
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD", "COMPLEX_FEATURES", "MERGED_CELL", "TITLE", "ANSWER"
|
1539
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].relationships[0].ids #=> Array
|
1540
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].relationships[0].ids[0] #=> String
|
1541
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].entity_types #=> Array
|
1542
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].entity_types[0] #=> String, one of "KEY", "VALUE", "COLUMN_HEADER"
|
1543
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].selection_status #=> String, one of "SELECTED", "NOT_SELECTED"
|
1544
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].page #=> Integer
|
1545
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].query.text #=> String
|
1546
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].query.alias #=> String
|
1547
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].query.pages #=> Array
|
1548
|
+
# resp.results[0].extractions[0].identity_document.blocks[0].query.pages[0] #=> String
|
1549
|
+
# resp.warnings #=> Array
|
1550
|
+
# resp.warnings[0].error_code #=> String
|
1551
|
+
# resp.warnings[0].pages #=> Array
|
1552
|
+
# resp.warnings[0].pages[0] #=> Integer
|
1553
|
+
# resp.status_message #=> String
|
1554
|
+
# resp.analyze_lending_model_version #=> String
|
1555
|
+
#
|
1556
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetLendingAnalysis AWS API Documentation
|
1557
|
+
#
|
1558
|
+
# @overload get_lending_analysis(params = {})
|
1559
|
+
# @param [Hash] params ({})
|
1560
|
+
def get_lending_analysis(params = {}, options = {})
|
1561
|
+
req = build_request(:get_lending_analysis, params)
|
1562
|
+
req.send_request(options)
|
1563
|
+
end
|
1564
|
+
|
1565
|
+
# Gets summarized results for the `StartLendingAnalysis` operation,
|
1566
|
+
# which analyzes text in a lending document. The returned summary
|
1567
|
+
# consists of information about documents grouped together by a common
|
1568
|
+
# document type. Information like detected signatures, page numbers, and
|
1569
|
+
# split documents is returned with respect to the type of grouped
|
1570
|
+
# document.
|
1571
|
+
#
|
1572
|
+
# You start asynchronous text analysis by calling
|
1573
|
+
# `StartLendingAnalysis`, which returns a job identifier (`JobId`). When
|
1574
|
+
# the text analysis operation finishes, Amazon Textract publishes a
|
1575
|
+
# completion status to the Amazon Simple Notification Service (Amazon
|
1576
|
+
# SNS) topic that's registered in the initial call to
|
1577
|
+
# `StartLendingAnalysis`.
|
1578
|
+
#
|
1579
|
+
# To get the results of the text analysis operation, first check that
|
1580
|
+
# the status value published to the Amazon SNS topic is SUCCEEDED. If
|
1581
|
+
# so, call `GetLendingAnalysisSummary`, and pass the job identifier
|
1582
|
+
# (`JobId`) from the initial call to `StartLendingAnalysis`.
|
1583
|
+
#
|
1584
|
+
# @option params [required, String] :job_id
|
1585
|
+
# A unique identifier for the lending or text-detection job. The `JobId`
|
1586
|
+
# is returned from StartLendingAnalysis. A `JobId` value is only valid
|
1587
|
+
# for 7 days.
|
1588
|
+
#
|
1589
|
+
# @return [Types::GetLendingAnalysisSummaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1590
|
+
#
|
1591
|
+
# * {Types::GetLendingAnalysisSummaryResponse#document_metadata #document_metadata} => Types::DocumentMetadata
|
1592
|
+
# * {Types::GetLendingAnalysisSummaryResponse#job_status #job_status} => String
|
1593
|
+
# * {Types::GetLendingAnalysisSummaryResponse#summary #summary} => Types::LendingSummary
|
1594
|
+
# * {Types::GetLendingAnalysisSummaryResponse#warnings #warnings} => Array<Types::Warning>
|
1595
|
+
# * {Types::GetLendingAnalysisSummaryResponse#status_message #status_message} => String
|
1596
|
+
# * {Types::GetLendingAnalysisSummaryResponse#analyze_lending_model_version #analyze_lending_model_version} => String
|
1597
|
+
#
|
1598
|
+
# @example Request syntax with placeholder values
|
1599
|
+
#
|
1600
|
+
# resp = client.get_lending_analysis_summary({
|
1601
|
+
# job_id: "JobId", # required
|
1602
|
+
# })
|
1603
|
+
#
|
1604
|
+
# @example Response structure
|
1605
|
+
#
|
1606
|
+
# resp.document_metadata.pages #=> Integer
|
1607
|
+
# resp.job_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED", "PARTIAL_SUCCESS"
|
1608
|
+
# resp.summary.document_groups #=> Array
|
1609
|
+
# resp.summary.document_groups[0].type #=> String
|
1610
|
+
# resp.summary.document_groups[0].split_documents #=> Array
|
1611
|
+
# resp.summary.document_groups[0].split_documents[0].index #=> Integer
|
1612
|
+
# resp.summary.document_groups[0].split_documents[0].pages #=> Array
|
1613
|
+
# resp.summary.document_groups[0].split_documents[0].pages[0] #=> Integer
|
1614
|
+
# resp.summary.document_groups[0].detected_signatures #=> Array
|
1615
|
+
# resp.summary.document_groups[0].detected_signatures[0].page #=> Integer
|
1616
|
+
# resp.summary.document_groups[0].undetected_signatures #=> Array
|
1617
|
+
# resp.summary.document_groups[0].undetected_signatures[0].page #=> Integer
|
1618
|
+
# resp.summary.undetected_document_types #=> Array
|
1619
|
+
# resp.summary.undetected_document_types[0] #=> String
|
1620
|
+
# resp.warnings #=> Array
|
1621
|
+
# resp.warnings[0].error_code #=> String
|
1622
|
+
# resp.warnings[0].pages #=> Array
|
1623
|
+
# resp.warnings[0].pages[0] #=> Integer
|
1624
|
+
# resp.status_message #=> String
|
1625
|
+
# resp.analyze_lending_model_version #=> String
|
1626
|
+
#
|
1627
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetLendingAnalysisSummary AWS API Documentation
|
1628
|
+
#
|
1629
|
+
# @overload get_lending_analysis_summary(params = {})
|
1630
|
+
# @param [Hash] params ({})
|
1631
|
+
def get_lending_analysis_summary(params = {}, options = {})
|
1632
|
+
req = build_request(:get_lending_analysis_summary, params)
|
1633
|
+
req.send_request(options)
|
1634
|
+
end
|
1635
|
+
|
1326
1636
|
# Starts the asynchronous analysis of an input document for
|
1327
1637
|
# relationships between detected items such as key-value pairs, tables,
|
1328
1638
|
# and selection elements.
|
@@ -1648,6 +1958,140 @@ module Aws::Textract
|
|
1648
1958
|
req.send_request(options)
|
1649
1959
|
end
|
1650
1960
|
|
1961
|
+
# Starts the classification and analysis of an input document.
|
1962
|
+
# `StartLendingAnalysis` initiates the classification and analysis of a
|
1963
|
+
# packet of lending documents. `StartLendingAnalysis` operates on a
|
1964
|
+
# document file located in an Amazon S3 bucket.
|
1965
|
+
#
|
1966
|
+
# `StartLendingAnalysis` can analyze text in documents that are in one
|
1967
|
+
# of the following formats: JPEG, PNG, TIFF, PDF. Use `DocumentLocation`
|
1968
|
+
# to specify the bucket name and the file name of the document.
|
1969
|
+
#
|
1970
|
+
# `StartLendingAnalysis` returns a job identifier (`JobId`) that you use
|
1971
|
+
# to get the results of the operation. When the text analysis is
|
1972
|
+
# finished, Amazon Textract publishes a completion status to the Amazon
|
1973
|
+
# Simple Notification Service (Amazon SNS) topic that you specify in
|
1974
|
+
# `NotificationChannel`. To get the results of the text analysis
|
1975
|
+
# operation, first check that the status value published to the Amazon
|
1976
|
+
# SNS topic is SUCCEEDED. If the status is SUCCEEDED you can call either
|
1977
|
+
# `GetLendingAnalysis` or `GetLendingAnalysisSummary` and provide the
|
1978
|
+
# `JobId` to obtain the results of the analysis.
|
1979
|
+
#
|
1980
|
+
# If using `OutputConfig` to specify an Amazon S3 bucket, the output
|
1981
|
+
# will be contained within the specified prefix in a directory labeled
|
1982
|
+
# with the job-id. In the directory there are 3 sub-directories:
|
1983
|
+
#
|
1984
|
+
# * detailedResponse (contains the GetLendingAnalysis response)
|
1985
|
+
#
|
1986
|
+
# * summaryResponse (for the GetLendingAnalysisSummary response)
|
1987
|
+
#
|
1988
|
+
# * splitDocuments (documents split across logical boundaries)
|
1989
|
+
#
|
1990
|
+
# @option params [required, Types::DocumentLocation] :document_location
|
1991
|
+
# The Amazon S3 bucket that contains the document to be processed. It's
|
1992
|
+
# used by asynchronous operations.
|
1993
|
+
#
|
1994
|
+
# The input document can be an image file in JPEG or PNG format. It can
|
1995
|
+
# also be a file in PDF format.
|
1996
|
+
#
|
1997
|
+
# @option params [String] :client_request_token
|
1998
|
+
# The idempotent token that you use to identify the start request. If
|
1999
|
+
# you use the same token with multiple `StartLendingAnalysis` requests,
|
2000
|
+
# the same `JobId` is returned. Use `ClientRequestToken` to prevent the
|
2001
|
+
# same job from being accidentally started more than once. For more
|
2002
|
+
# information, see [Calling Amazon Textract Asynchronous Operations][1].
|
2003
|
+
#
|
2004
|
+
#
|
2005
|
+
#
|
2006
|
+
# [1]: https://docs.aws.amazon.com/textract/latest/dg/api-sync.html
|
2007
|
+
#
|
2008
|
+
# @option params [String] :job_tag
|
2009
|
+
# An identifier that you specify to be included in the completion
|
2010
|
+
# notification published to the Amazon SNS topic. For example, you can
|
2011
|
+
# use `JobTag` to identify the type of document that the completion
|
2012
|
+
# notification corresponds to (such as a tax form or a receipt).
|
2013
|
+
#
|
2014
|
+
# @option params [Types::NotificationChannel] :notification_channel
|
2015
|
+
# The Amazon Simple Notification Service (Amazon SNS) topic to which
|
2016
|
+
# Amazon Textract publishes the completion status of an asynchronous
|
2017
|
+
# document operation.
|
2018
|
+
#
|
2019
|
+
# @option params [Types::OutputConfig] :output_config
|
2020
|
+
# Sets whether or not your output will go to a user created bucket. Used
|
2021
|
+
# to set the name of the bucket, and the prefix on the output file.
|
2022
|
+
#
|
2023
|
+
# `OutputConfig` is an optional parameter which lets you adjust where
|
2024
|
+
# your output will be placed. By default, Amazon Textract will store the
|
2025
|
+
# results internally and can only be accessed by the Get API operations.
|
2026
|
+
# With `OutputConfig` enabled, you can set the name of the bucket the
|
2027
|
+
# output will be sent to the file prefix of the results where you can
|
2028
|
+
# download your results. Additionally, you can set the `KMSKeyID`
|
2029
|
+
# parameter to a customer master key (CMK) to encrypt your output.
|
2030
|
+
# Without this parameter set Amazon Textract will encrypt server-side
|
2031
|
+
# using the AWS managed CMK for Amazon S3.
|
2032
|
+
#
|
2033
|
+
# Decryption of Customer Content is necessary for processing of the
|
2034
|
+
# documents by Amazon Textract. If your account is opted out under an AI
|
2035
|
+
# services opt out policy then all unencrypted Customer Content is
|
2036
|
+
# immediately and permanently deleted after the Customer Content has
|
2037
|
+
# been processed by the service. No copy of of the output is retained by
|
2038
|
+
# Amazon Textract. For information about how to opt out, see [ Managing
|
2039
|
+
# AI services opt-out policy. ][1]
|
2040
|
+
#
|
2041
|
+
# For more information on data privacy, see the [Data Privacy FAQ][2].
|
2042
|
+
#
|
2043
|
+
#
|
2044
|
+
#
|
2045
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html
|
2046
|
+
# [2]: https://aws.amazon.com/compliance/data-privacy-faq/
|
2047
|
+
#
|
2048
|
+
# @option params [String] :kms_key_id
|
2049
|
+
# The KMS key used to encrypt the inference results. This can be in
|
2050
|
+
# either Key ID or Key Alias format. When a KMS key is provided, the KMS
|
2051
|
+
# key will be used for server-side encryption of the objects in the
|
2052
|
+
# customer bucket. When this parameter is not enabled, the result will
|
2053
|
+
# be encrypted server side, using SSE-S3.
|
2054
|
+
#
|
2055
|
+
# @return [Types::StartLendingAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2056
|
+
#
|
2057
|
+
# * {Types::StartLendingAnalysisResponse#job_id #job_id} => String
|
2058
|
+
#
|
2059
|
+
# @example Request syntax with placeholder values
|
2060
|
+
#
|
2061
|
+
# resp = client.start_lending_analysis({
|
2062
|
+
# document_location: { # required
|
2063
|
+
# s3_object: {
|
2064
|
+
# bucket: "S3Bucket",
|
2065
|
+
# name: "S3ObjectName",
|
2066
|
+
# version: "S3ObjectVersion",
|
2067
|
+
# },
|
2068
|
+
# },
|
2069
|
+
# client_request_token: "ClientRequestToken",
|
2070
|
+
# job_tag: "JobTag",
|
2071
|
+
# notification_channel: {
|
2072
|
+
# sns_topic_arn: "SNSTopicArn", # required
|
2073
|
+
# role_arn: "RoleArn", # required
|
2074
|
+
# },
|
2075
|
+
# output_config: {
|
2076
|
+
# s3_bucket: "S3Bucket", # required
|
2077
|
+
# s3_prefix: "S3ObjectName",
|
2078
|
+
# },
|
2079
|
+
# kms_key_id: "KMSKeyId",
|
2080
|
+
# })
|
2081
|
+
#
|
2082
|
+
# @example Response structure
|
2083
|
+
#
|
2084
|
+
# resp.job_id #=> String
|
2085
|
+
#
|
2086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartLendingAnalysis AWS API Documentation
|
2087
|
+
#
|
2088
|
+
# @overload start_lending_analysis(params = {})
|
2089
|
+
# @param [Hash] params ({})
|
2090
|
+
def start_lending_analysis(params = {}, options = {})
|
2091
|
+
req = build_request(:start_lending_analysis, params)
|
2092
|
+
req.send_request(options)
|
2093
|
+
end
|
2094
|
+
|
1651
2095
|
# @!endgroup
|
1652
2096
|
|
1653
2097
|
# @param params ({})
|
@@ -1661,7 +2105,7 @@ module Aws::Textract
|
|
1661
2105
|
params: params,
|
1662
2106
|
config: config)
|
1663
2107
|
context[:gem_name] = 'aws-sdk-textract'
|
1664
|
-
context[:gem_version] = '1.
|
2108
|
+
context[:gem_version] = '1.43.0'
|
1665
2109
|
Seahorse::Client::Request.new(handlers, context)
|
1666
2110
|
end
|
1667
2111
|
|