aws-sdk-textract 1.40.0 → 1.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 754294e61f5f0f0e9cb1c875d4cbe5a4e06712a19c4b73a52c7541884626c389
-  data.tar.gz: 601f69a067b54498668aa5a3abbaef3b9db593dd795e5c3bf007df884efa7025
+  metadata.gz: eebbedec0b4bf78bc72386cbf424d474c52cf33465fb73c83da1fb994bcff1b0
+  data.tar.gz: d75f1e5629b1149e22dcf9a17eaa141a8b1e7f49c26af7de19f7103841459ecf
 SHA512:
-  metadata.gz: 456de2e7293e98f7b235864ff26685aa482900047de89c7f16d854fe4221f358a55b6aa93fb14aa521404034ef4bdb05233aa4f8191f322c95cb2539d87da171
-  data.tar.gz: 00a3a8cc34f9e3235cc724715d79e4e48c84067e75cc2a721bc41efa8cadc0eed1abeb6e6687f9f9333c51c99a7e6733ddb9bf49858f41a8f36d6b7568683346
+  metadata.gz: f3fbec574131ba1187459288605c3ca483069783022d3efa23d2a729073c738057749b9ba83933df5a334c29d3b0eb16d0fa10341d8fcfc878234c1accebbdff
+  data.tar.gz: 618c001d6629ee90c46a6bd3f9d16ee2e394d1f76e99d5c0814b5aa2d49a24b233e766242d520d1c4aab3d086b144b017600391749dbc1c0a20c2de960572098

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.42.0 (2022-11-17)
+------------------
+
+* Feature - This release adds support for specifying and extracting information from documents using the Signatures feature within Analyze Document API
+
+1.41.0 (2022-11-01)
+------------------
+
+* Feature - Add ocr results in AnalyzeIDResponse as blocks
+
 1.40.0 (2022-10-31)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.40.0
+1.42.0

data/lib/aws-sdk-textract/client.rb

@@ -397,6 +397,11 @@ module Aws::Textract
     #   document are returned (including text that doesn't have a
     #   relationship with the value of `FeatureTypes`).
     #
+    # * Signatures. A SIGNATURE `Block` object contains the location
+    #   information of a signature in a document. If used in conjunction
+    #   with forms or tables, a signature can be given a Key-Value pairing
+    #   or be detected in the cell of a table.
+    #
     # * Query. A QUERY Block object contains the query text, alias and link
     #   to the associated Query results block object.
     #
@@ -436,10 +441,13 @@ module Aws::Textract
     # @option params [required, Array<String>] :feature_types
     #   A list of the types of analysis to perform. Add TABLES to the list to
     #   return information about the tables that are detected in the input
-    #   document. Add FORMS to return detected form data. To perform both
-    #   types of analysis, add TABLES and FORMS to `FeatureTypes`. All lines
-    #   and words detected in the document are included in the response
-    #   (including text that isn't related to the value of `FeatureTypes`).
+    #   document. Add FORMS to return detected form data. Add SIGNATURES to
+    #   return the locations of detected signatures. To perform both forms and
+    #   table analysis, add TABLES and FORMS to `FeatureTypes`. To detect
+    #   signatures within form data and table data, add SIGNATURES to either
+    #   TABLES or FORMS. All lines and words detected in the document are
+    #   included in the response (including text that isn't related to the
+    #   value of `FeatureTypes`).
     #
     # @option params [Types::HumanLoopConfig] :human_loop_config
     #   Sets the configuration for the human in the loop workflow for
@@ -467,7 +475,7 @@ module Aws::Textract
     #         version: "S3ObjectVersion",
     #       },
     #     },
-    #     feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES
+    #     feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES, SIGNATURES
     #     human_loop_config: {
     #       human_loop_name: "HumanLoopName", # required
     #       flow_definition_arn: "FlowDefinitionArn", # required
@@ -490,7 +498,7 @@ module Aws::Textract
     #
     #   resp.document_metadata.pages #=> Integer
     #   resp.blocks #=> Array
-    #   resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT"
+    #   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"
     #   resp.blocks[0].confidence #=> Float
     #   resp.blocks[0].text #=> String
     #   resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
@@ -654,7 +662,7 @@ module Aws::Textract
     #   resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].group_properties[0].types[0] #=> String
     #   resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].group_properties[0].id #=> String
     #   resp.expense_documents[0].blocks #=> Array
-    #   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"
+    #   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"
     #   resp.expense_documents[0].blocks[0].confidence #=> Float
     #   resp.expense_documents[0].blocks[0].text #=> String
     #   resp.expense_documents[0].blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
@@ -735,6 +743,35 @@ module Aws::Textract
     #   resp.identity_documents[0].identity_document_fields[0].value_detection.normalized_value.value #=> String
     #   resp.identity_documents[0].identity_document_fields[0].value_detection.normalized_value.value_type #=> String, one of "DATE"
     #   resp.identity_documents[0].identity_document_fields[0].value_detection.confidence #=> Float
+    #   resp.identity_documents[0].blocks #=> Array
+    #   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"
+    #   resp.identity_documents[0].blocks[0].confidence #=> Float
+    #   resp.identity_documents[0].blocks[0].text #=> String
+    #   resp.identity_documents[0].blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
+    #   resp.identity_documents[0].blocks[0].row_index #=> Integer
+    #   resp.identity_documents[0].blocks[0].column_index #=> Integer
+    #   resp.identity_documents[0].blocks[0].row_span #=> Integer
+    #   resp.identity_documents[0].blocks[0].column_span #=> Integer
+    #   resp.identity_documents[0].blocks[0].geometry.bounding_box.width #=> Float
+    #   resp.identity_documents[0].blocks[0].geometry.bounding_box.height #=> Float
+    #   resp.identity_documents[0].blocks[0].geometry.bounding_box.left #=> Float
+    #   resp.identity_documents[0].blocks[0].geometry.bounding_box.top #=> Float
+    #   resp.identity_documents[0].blocks[0].geometry.polygon #=> Array
+    #   resp.identity_documents[0].blocks[0].geometry.polygon[0].x #=> Float
+    #   resp.identity_documents[0].blocks[0].geometry.polygon[0].y #=> Float
+    #   resp.identity_documents[0].blocks[0].id #=> String
+    #   resp.identity_documents[0].blocks[0].relationships #=> Array
+    #   resp.identity_documents[0].blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD", "COMPLEX_FEATURES", "MERGED_CELL", "TITLE", "ANSWER"
+    #   resp.identity_documents[0].blocks[0].relationships[0].ids #=> Array
+    #   resp.identity_documents[0].blocks[0].relationships[0].ids[0] #=> String
+    #   resp.identity_documents[0].blocks[0].entity_types #=> Array
+    #   resp.identity_documents[0].blocks[0].entity_types[0] #=> String, one of "KEY", "VALUE", "COLUMN_HEADER"
+    #   resp.identity_documents[0].blocks[0].selection_status #=> String, one of "SELECTED", "NOT_SELECTED"
+    #   resp.identity_documents[0].blocks[0].page #=> Integer
+    #   resp.identity_documents[0].blocks[0].query.text #=> String
+    #   resp.identity_documents[0].blocks[0].query.alias #=> String
+    #   resp.identity_documents[0].blocks[0].query.pages #=> Array
+    #   resp.identity_documents[0].blocks[0].query.pages[0] #=> String
     #   resp.document_metadata.pages #=> Integer
     #   resp.analyze_id_model_version #=> String
     #
@@ -800,7 +837,7 @@ module Aws::Textract
     #
     #   resp.document_metadata.pages #=> Integer
     #   resp.blocks #=> Array
-    #   resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT"
+    #   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"
     #   resp.blocks[0].confidence #=> Float
     #   resp.blocks[0].text #=> String
     #   resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
@@ -945,7 +982,7 @@ module Aws::Textract
     #   resp.job_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED", "PARTIAL_SUCCESS"
     #   resp.next_token #=> String
     #   resp.blocks #=> Array
-    #   resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT"
+    #   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"
     #   resp.blocks[0].confidence #=> Float
     #   resp.blocks[0].text #=> String
     #   resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
@@ -1067,7 +1104,7 @@ module Aws::Textract
     #   resp.job_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED", "PARTIAL_SUCCESS"
     #   resp.next_token #=> String
     #   resp.blocks #=> Array
-    #   resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT", "MERGED_CELL", "TITLE", "QUERY", "QUERY_RESULT"
+    #   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"
     #   resp.blocks[0].confidence #=> Float
     #   resp.blocks[0].text #=> String
     #   resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
@@ -1242,7 +1279,7 @@ module Aws::Textract
     #   resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].group_properties[0].types[0] #=> String
     #   resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].group_properties[0].id #=> String
     #   resp.expense_documents[0].blocks #=> Array
-    #   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"
+    #   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"
     #   resp.expense_documents[0].blocks[0].confidence #=> Float
     #   resp.expense_documents[0].blocks[0].text #=> String
     #   resp.expense_documents[0].blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
@@ -1371,7 +1408,7 @@ module Aws::Textract
     #         version: "S3ObjectVersion",
     #       },
     #     },
-    #     feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES
+    #     feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES, SIGNATURES
     #     client_request_token: "ClientRequestToken",
     #     job_tag: "JobTag",
     #     notification_channel: {
@@ -1624,7 +1661,7 @@ module Aws::Textract
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-textract'
-      context[:gem_version] = '1.40.0'
+      context[:gem_version] = '1.42.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-textract/client_api.rb

@@ -331,6 +331,7 @@ module Aws::Textract
 
     IdentityDocument.add_member(:document_index, Shapes::ShapeRef.new(shape: UInteger, location_name: "DocumentIndex"))
     IdentityDocument.add_member(:identity_document_fields, Shapes::ShapeRef.new(shape: IdentityDocumentFieldList, location_name: "IdentityDocumentFields"))
+    IdentityDocument.add_member(:blocks, Shapes::ShapeRef.new(shape: BlockList, location_name: "Blocks"))
     IdentityDocument.struct_class = Types::IdentityDocument
 
     IdentityDocumentField.add_member(:type, Shapes::ShapeRef.new(shape: AnalyzeIDDetections, location_name: "Type"))

data/lib/aws-sdk-textract/types.rb

@@ -29,7 +29,7 @@ module Aws::Textract
     #             version: "S3ObjectVersion",
     #           },
     #         },
-    #         feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES
+    #         feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES, SIGNATURES
     #         human_loop_config: {
     #           human_loop_name: "HumanLoopName", # required
     #           flow_definition_arn: "FlowDefinitionArn", # required
@@ -62,11 +62,13 @@ module Aws::Textract
     # @!attribute [rw] feature_types
     #   A list of the types of analysis to perform. Add TABLES to the list
     #   to return information about the tables that are detected in the
-    #   input document. Add FORMS to return detected form data. To perform
-    #   both types of analysis, add TABLES and FORMS to `FeatureTypes`. All
-    #   lines and words detected in the document are included in the
-    #   response (including text that isn't related to the value of
-    #   `FeatureTypes`).
+    #   input document. Add FORMS to return detected form data. Add
+    #   SIGNATURES to return the locations of detected signatures. To
+    #   perform both forms and table analysis, add TABLES and FORMS to
+    #   `FeatureTypes`. To detect signatures within form data and table
+    #   data, add SIGNATURES to either TABLES or FORMS. All lines and words
+    #   detected in the document are included in the response (including
+    #   text that isn't related to the value of `FeatureTypes`).
     #   @return [Array<String>]
     #
     # @!attribute [rw] human_loop_config
@@ -331,6 +333,10 @@ module Aws::Textract
     #     document page. Use the value of `SelectionStatus` to determine the
     #     status of the selection element.
     #
+    #   * *SIGNATURE* - The location and confidene 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.
     #
@@ -674,7 +680,32 @@ module Aws::Textract
     # Returns the kind of currency detected.
     #
     # @!attribute [rw] code
-    #   Currency code for detected currency.
+    #   Currency code for detected currency. the current supported codes
+    #   are:
+    #
+    #   * USD
+    #
+    #   * EUR
+    #
+    #   * GBP
+    #
+    #   * CAD
+    #
+    #   * INR
+    #
+    #   * JPY
+    #
+    #   * CHF
+    #
+    #   * AUD
+    #
+    #   * CNY
+    #
+    #   * BZR
+    #
+    #   * SEK
+    #
+    #   * HKD
     #   @return [String]
     #
     # @!attribute [rw] confidence
@@ -795,11 +826,11 @@ module Aws::Textract
     end
 
     # Shows the group that a certain key belongs to. This helps
-    # differentiate responses like addresses that can appear similar in
-    # response JSON.
+    # differentiate between names and addresses for different organizations,
+    # that can be hard to determine via JSON response.
     #
     # @!attribute [rw] types
-    #   Informs you on the kind of label associated with the group
+    #   Informs you on whether the expense group is a name or an address.
     #   @return [Array<String>]
     #
     # @!attribute [rw] id
@@ -1253,11 +1284,16 @@ module Aws::Textract
     #   text.
     #   @return [Array<Types::IdentityDocumentField>]
     #
+    # @!attribute [rw] blocks
+    #   Individual word recognition, as returned by document detection.
+    #   @return [Array<Types::Block>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/IdentityDocument AWS API Documentation
     #
     class IdentityDocument < Struct.new(
       :document_index,
-      :identity_document_fields)
+      :identity_document_fields,
+      :blocks)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1675,7 +1711,7 @@ module Aws::Textract
     #             version: "S3ObjectVersion",
     #           },
     #         },
-    #         feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES
+    #         feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES, SIGNATURES
     #         client_request_token: "ClientRequestToken",
     #         job_tag: "JobTag",
     #         notification_channel: {

data/lib/aws-sdk-textract.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-textract/customizations'
 # @!group service
 module Aws::Textract
 
-  GEM_VERSION = '1.40.0'
+  GEM_VERSION = '1.42.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-textract
 version: !ruby/object:Gem::Version
-  version: 1.40.0
+  version: 1.42.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-31 00:00:00.000000000 Z
+date: 2022-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core