aws-sdk-textract 1.40.0 → 1.42.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 754294e61f5f0f0e9cb1c875d4cbe5a4e06712a19c4b73a52c7541884626c389
4
- data.tar.gz: 601f69a067b54498668aa5a3abbaef3b9db593dd795e5c3bf007df884efa7025
3
+ metadata.gz: eebbedec0b4bf78bc72386cbf424d474c52cf33465fb73c83da1fb994bcff1b0
4
+ data.tar.gz: d75f1e5629b1149e22dcf9a17eaa141a8b1e7f49c26af7de19f7103841459ecf
5
5
  SHA512:
6
- metadata.gz: 456de2e7293e98f7b235864ff26685aa482900047de89c7f16d854fe4221f358a55b6aa93fb14aa521404034ef4bdb05233aa4f8191f322c95cb2539d87da171
7
- data.tar.gz: 00a3a8cc34f9e3235cc724715d79e4e48c84067e75cc2a721bc41efa8cadc0eed1abeb6e6687f9f9333c51c99a7e6733ddb9bf49858f41a8f36d6b7568683346
6
+ metadata.gz: f3fbec574131ba1187459288605c3ca483069783022d3efa23d2a729073c738057749b9ba83933df5a334c29d3b0eb16d0fa10341d8fcfc878234c1accebbdff
7
+ data.tar.gz: 618c001d6629ee90c46a6bd3f9d16ee2e394d1f76e99d5c0814b5aa2d49a24b233e766242d520d1c4aab3d086b144b017600391749dbc1c0a20c2de960572098
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.42.0 (2022-11-17)
5
+ ------------------
6
+
7
+ * Feature - This release adds support for specifying and extracting information from documents using the Signatures feature within Analyze Document API
8
+
9
+ 1.41.0 (2022-11-01)
10
+ ------------------
11
+
12
+ * Feature - Add ocr results in AnalyzeIDResponse as blocks
13
+
4
14
  1.40.0 (2022-10-31)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.40.0
1
+ 1.42.0
@@ -397,6 +397,11 @@ module Aws::Textract
397
397
  # document are returned (including text that doesn't have a
398
398
  # relationship with the value of `FeatureTypes`).
399
399
  #
400
+ # * Signatures. A SIGNATURE `Block` object contains the location
401
+ # information of a signature in a document. If used in conjunction
402
+ # with forms or tables, a signature can be given a Key-Value pairing
403
+ # or be detected in the cell of a table.
404
+ #
400
405
  # * Query. A QUERY Block object contains the query text, alias and link
401
406
  # to the associated Query results block object.
402
407
  #
@@ -436,10 +441,13 @@ module Aws::Textract
436
441
  # @option params [required, Array<String>] :feature_types
437
442
  # A list of the types of analysis to perform. Add TABLES to the list to
438
443
  # return information about the tables that are detected in the input
439
- # document. Add FORMS to return detected form data. To perform both
440
- # types of analysis, add TABLES and FORMS to `FeatureTypes`. All lines
441
- # and words detected in the document are included in the response
442
- # (including text that isn't related to the value of `FeatureTypes`).
444
+ # document. Add FORMS to return detected form data. Add SIGNATURES to
445
+ # return the locations of detected signatures. To perform both forms and
446
+ # table analysis, add TABLES and FORMS to `FeatureTypes`. To detect
447
+ # signatures within form data and table data, add SIGNATURES to either
448
+ # TABLES or FORMS. All lines and words detected in the document are
449
+ # included in the response (including text that isn't related to the
450
+ # value of `FeatureTypes`).
443
451
  #
444
452
  # @option params [Types::HumanLoopConfig] :human_loop_config
445
453
  # Sets the configuration for the human in the loop workflow for
@@ -467,7 +475,7 @@ module Aws::Textract
467
475
  # version: "S3ObjectVersion",
468
476
  # },
469
477
  # },
470
- # feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES
478
+ # feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES, SIGNATURES
471
479
  # human_loop_config: {
472
480
  # human_loop_name: "HumanLoopName", # required
473
481
  # flow_definition_arn: "FlowDefinitionArn", # required
@@ -490,7 +498,7 @@ module Aws::Textract
490
498
  #
491
499
  # resp.document_metadata.pages #=> Integer
492
500
  # resp.blocks #=> Array
493
- # resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT"
501
+ # resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT", "SIGNATURE"
494
502
  # resp.blocks[0].confidence #=> Float
495
503
  # resp.blocks[0].text #=> String
496
504
  # resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
@@ -654,7 +662,7 @@ module Aws::Textract
654
662
  # resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].group_properties[0].types[0] #=> String
655
663
  # resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].group_properties[0].id #=> String
656
664
  # resp.expense_documents[0].blocks #=> Array
657
- # resp.expense_documents[0].blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT"
665
+ # resp.expense_documents[0].blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT", "SIGNATURE"
658
666
  # resp.expense_documents[0].blocks[0].confidence #=> Float
659
667
  # resp.expense_documents[0].blocks[0].text #=> String
660
668
  # resp.expense_documents[0].blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
@@ -735,6 +743,35 @@ module Aws::Textract
735
743
  # resp.identity_documents[0].identity_document_fields[0].value_detection.normalized_value.value #=> String
736
744
  # resp.identity_documents[0].identity_document_fields[0].value_detection.normalized_value.value_type #=> String, one of "DATE"
737
745
  # resp.identity_documents[0].identity_document_fields[0].value_detection.confidence #=> Float
746
+ # resp.identity_documents[0].blocks #=> Array
747
+ # resp.identity_documents[0].blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT", "SIGNATURE"
748
+ # resp.identity_documents[0].blocks[0].confidence #=> Float
749
+ # resp.identity_documents[0].blocks[0].text #=> String
750
+ # resp.identity_documents[0].blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
751
+ # resp.identity_documents[0].blocks[0].row_index #=> Integer
752
+ # resp.identity_documents[0].blocks[0].column_index #=> Integer
753
+ # resp.identity_documents[0].blocks[0].row_span #=> Integer
754
+ # resp.identity_documents[0].blocks[0].column_span #=> Integer
755
+ # resp.identity_documents[0].blocks[0].geometry.bounding_box.width #=> Float
756
+ # resp.identity_documents[0].blocks[0].geometry.bounding_box.height #=> Float
757
+ # resp.identity_documents[0].blocks[0].geometry.bounding_box.left #=> Float
758
+ # resp.identity_documents[0].blocks[0].geometry.bounding_box.top #=> Float
759
+ # resp.identity_documents[0].blocks[0].geometry.polygon #=> Array
760
+ # resp.identity_documents[0].blocks[0].geometry.polygon[0].x #=> Float
761
+ # resp.identity_documents[0].blocks[0].geometry.polygon[0].y #=> Float
762
+ # resp.identity_documents[0].blocks[0].id #=> String
763
+ # resp.identity_documents[0].blocks[0].relationships #=> Array
764
+ # resp.identity_documents[0].blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD", "COMPLEX_FEATURES", "MERGED_CELL", "TITLE", "ANSWER"
765
+ # resp.identity_documents[0].blocks[0].relationships[0].ids #=> Array
766
+ # resp.identity_documents[0].blocks[0].relationships[0].ids[0] #=> String
767
+ # resp.identity_documents[0].blocks[0].entity_types #=> Array
768
+ # resp.identity_documents[0].blocks[0].entity_types[0] #=> String, one of "KEY", "VALUE", "COLUMN_HEADER"
769
+ # resp.identity_documents[0].blocks[0].selection_status #=> String, one of "SELECTED", "NOT_SELECTED"
770
+ # resp.identity_documents[0].blocks[0].page #=> Integer
771
+ # resp.identity_documents[0].blocks[0].query.text #=> String
772
+ # resp.identity_documents[0].blocks[0].query.alias #=> String
773
+ # resp.identity_documents[0].blocks[0].query.pages #=> Array
774
+ # resp.identity_documents[0].blocks[0].query.pages[0] #=> String
738
775
  # resp.document_metadata.pages #=> Integer
739
776
  # resp.analyze_id_model_version #=> String
740
777
  #
@@ -800,7 +837,7 @@ module Aws::Textract
800
837
  #
801
838
  # resp.document_metadata.pages #=> Integer
802
839
  # resp.blocks #=> Array
803
- # resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT"
840
+ # resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT", "SIGNATURE"
804
841
  # resp.blocks[0].confidence #=> Float
805
842
  # resp.blocks[0].text #=> String
806
843
  # resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
@@ -945,7 +982,7 @@ module Aws::Textract
945
982
  # resp.job_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED", "PARTIAL_SUCCESS"
946
983
  # resp.next_token #=> String
947
984
  # resp.blocks #=> Array
948
- # resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT"
985
+ # resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT", "SIGNATURE"
949
986
  # resp.blocks[0].confidence #=> Float
950
987
  # resp.blocks[0].text #=> String
951
988
  # resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
@@ -1067,7 +1104,7 @@ module Aws::Textract
1067
1104
  # resp.job_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED", "PARTIAL_SUCCESS"
1068
1105
  # resp.next_token #=> String
1069
1106
  # resp.blocks #=> Array
1070
- # resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT"
1107
+ # resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT", "SIGNATURE"
1071
1108
  # resp.blocks[0].confidence #=> Float
1072
1109
  # resp.blocks[0].text #=> String
1073
1110
  # resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
@@ -1242,7 +1279,7 @@ module Aws::Textract
1242
1279
  # resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].group_properties[0].types[0] #=> String
1243
1280
  # resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].group_properties[0].id #=> String
1244
1281
  # resp.expense_documents[0].blocks #=> Array
1245
- # resp.expense_documents[0].blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT"
1282
+ # resp.expense_documents[0].blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT", "SIGNATURE"
1246
1283
  # resp.expense_documents[0].blocks[0].confidence #=> Float
1247
1284
  # resp.expense_documents[0].blocks[0].text #=> String
1248
1285
  # resp.expense_documents[0].blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
@@ -1371,7 +1408,7 @@ module Aws::Textract
1371
1408
  # version: "S3ObjectVersion",
1372
1409
  # },
1373
1410
  # },
1374
- # feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES
1411
+ # feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES, SIGNATURES
1375
1412
  # client_request_token: "ClientRequestToken",
1376
1413
  # job_tag: "JobTag",
1377
1414
  # notification_channel: {
@@ -1624,7 +1661,7 @@ module Aws::Textract
1624
1661
  params: params,
1625
1662
  config: config)
1626
1663
  context[:gem_name] = 'aws-sdk-textract'
1627
- context[:gem_version] = '1.40.0'
1664
+ context[:gem_version] = '1.42.0'
1628
1665
  Seahorse::Client::Request.new(handlers, context)
1629
1666
  end
1630
1667
 
@@ -331,6 +331,7 @@ module Aws::Textract
331
331
 
332
332
  IdentityDocument.add_member(:document_index, Shapes::ShapeRef.new(shape: UInteger, location_name: "DocumentIndex"))
333
333
  IdentityDocument.add_member(:identity_document_fields, Shapes::ShapeRef.new(shape: IdentityDocumentFieldList, location_name: "IdentityDocumentFields"))
334
+ IdentityDocument.add_member(:blocks, Shapes::ShapeRef.new(shape: BlockList, location_name: "Blocks"))
334
335
  IdentityDocument.struct_class = Types::IdentityDocument
335
336
 
336
337
  IdentityDocumentField.add_member(:type, Shapes::ShapeRef.new(shape: AnalyzeIDDetections, location_name: "Type"))
@@ -29,7 +29,7 @@ module Aws::Textract
29
29
  # version: "S3ObjectVersion",
30
30
  # },
31
31
  # },
32
- # feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES
32
+ # feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES, SIGNATURES
33
33
  # human_loop_config: {
34
34
  # human_loop_name: "HumanLoopName", # required
35
35
  # flow_definition_arn: "FlowDefinitionArn", # required
@@ -62,11 +62,13 @@ module Aws::Textract
62
62
  # @!attribute [rw] feature_types
63
63
  # A list of the types of analysis to perform. Add TABLES to the list
64
64
  # to return information about the tables that are detected in the
65
- # input document. Add FORMS to return detected form data. To perform
66
- # both types of analysis, add TABLES and FORMS to `FeatureTypes`. All
67
- # lines and words detected in the document are included in the
68
- # response (including text that isn't related to the value of
69
- # `FeatureTypes`).
65
+ # input document. Add FORMS to return detected form data. Add
66
+ # SIGNATURES to return the locations of detected signatures. To
67
+ # perform both forms and table analysis, add TABLES and FORMS to
68
+ # `FeatureTypes`. To detect signatures within form data and table
69
+ # data, add SIGNATURES to either TABLES or FORMS. All lines and words
70
+ # detected in the document are included in the response (including
71
+ # text that isn't related to the value of `FeatureTypes`).
70
72
  # @return [Array<String>]
71
73
  #
72
74
  # @!attribute [rw] human_loop_config
@@ -331,6 +333,10 @@ module Aws::Textract
331
333
  # document page. Use the value of `SelectionStatus` to determine the
332
334
  # status of the selection element.
333
335
  #
336
+ # * *SIGNATURE* - The location and confidene score of a signature
337
+ # detected on a document page. Can be returned as part of a
338
+ # Key-Value pair or a detected cell.
339
+ #
334
340
  # * *QUERY* - A question asked during the call of AnalyzeDocument.
335
341
  # Contains an alias and an ID that attaches it to its answer.
336
342
  #
@@ -674,7 +680,32 @@ module Aws::Textract
674
680
  # Returns the kind of currency detected.
675
681
  #
676
682
  # @!attribute [rw] code
677
- # Currency code for detected currency.
683
+ # Currency code for detected currency. the current supported codes
684
+ # are:
685
+ #
686
+ # * USD
687
+ #
688
+ # * EUR
689
+ #
690
+ # * GBP
691
+ #
692
+ # * CAD
693
+ #
694
+ # * INR
695
+ #
696
+ # * JPY
697
+ #
698
+ # * CHF
699
+ #
700
+ # * AUD
701
+ #
702
+ # * CNY
703
+ #
704
+ # * BZR
705
+ #
706
+ # * SEK
707
+ #
708
+ # * HKD
678
709
  # @return [String]
679
710
  #
680
711
  # @!attribute [rw] confidence
@@ -795,11 +826,11 @@ module Aws::Textract
795
826
  end
796
827
 
797
828
  # Shows the group that a certain key belongs to. This helps
798
- # differentiate responses like addresses that can appear similar in
799
- # response JSON.
829
+ # differentiate between names and addresses for different organizations,
830
+ # that can be hard to determine via JSON response.
800
831
  #
801
832
  # @!attribute [rw] types
802
- # Informs you on the kind of label associated with the group
833
+ # Informs you on whether the expense group is a name or an address.
803
834
  # @return [Array<String>]
804
835
  #
805
836
  # @!attribute [rw] id
@@ -1253,11 +1284,16 @@ module Aws::Textract
1253
1284
  # text.
1254
1285
  # @return [Array<Types::IdentityDocumentField>]
1255
1286
  #
1287
+ # @!attribute [rw] blocks
1288
+ # Individual word recognition, as returned by document detection.
1289
+ # @return [Array<Types::Block>]
1290
+ #
1256
1291
  # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/IdentityDocument AWS API Documentation
1257
1292
  #
1258
1293
  class IdentityDocument < Struct.new(
1259
1294
  :document_index,
1260
- :identity_document_fields)
1295
+ :identity_document_fields,
1296
+ :blocks)
1261
1297
  SENSITIVE = []
1262
1298
  include Aws::Structure
1263
1299
  end
@@ -1675,7 +1711,7 @@ module Aws::Textract
1675
1711
  # version: "S3ObjectVersion",
1676
1712
  # },
1677
1713
  # },
1678
- # feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES
1714
+ # feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES, SIGNATURES
1679
1715
  # client_request_token: "ClientRequestToken",
1680
1716
  # job_tag: "JobTag",
1681
1717
  # notification_channel: {
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-textract/customizations'
52
52
  # @!group service
53
53
  module Aws::Textract
54
54
 
55
- GEM_VERSION = '1.40.0'
55
+ GEM_VERSION = '1.42.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-textract
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.40.0
4
+ version: 1.42.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-10-31 00:00:00.000000000 Z
11
+ date: 2022-11-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core