aws-sdk-textract 1.31.0 → 1.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 146350b4bc9ecb2c715e74c84a0d9490a722b86435165d1b14fc56f470b60203
-  data.tar.gz: 3093e0a174b32d9bd8a1760dab6168a9e3ea2248bde39300af77efc62c530feb
+  metadata.gz: df6666495294f9fc6b74bf03c15386b3a277793bf493429cf654bc6b886cdffb
+  data.tar.gz: fa9f0fc72726ac3ce66b790a1c44bf648457676464f35719d71222e3b1e35b37
 SHA512:
-  metadata.gz: 6117a6cb2d44f1102304221e6eb1a7401f8bd7191b45dc6a39fcfb3a54e84f04392bdf8fd95cfdcb387d36914ced0f432480cf09d541d1df567ff4a253056f6e
-  data.tar.gz: a81d1716f67ea9babf365c24f36cdac5fe2ec8e3ea0761f3721489181ac9874541f3d0aa238b96a2f71481e8fb870cd9425c109cfd40e3685e455c263c184521
+  metadata.gz: 67e9dfbb0d26731400082b00878c216ab4e31910a4cbaf1c2304d52c75408a9699441f0ba2a209db9955f1ec803becbf7074d1680de6703f5f23592f745c8f30
+  data.tar.gz: e56227ef0f6aea46e6c419bd7a762cee042baa430668712086e9b6096cf123380ff055604758ed7deb1860dda77448b7da33b79a76fa250ad0747aeda07216d9

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.32.0 (2021-11-29)
+------------------
+
+* Feature - This release adds support for synchronously analyzing identity documents through a new API: AnalyzeID
+
 1.31.0 (2021-11-04)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.31.0
+1.32.0

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

@@ -476,8 +476,8 @@ module Aws::Textract
       req.send_request(options)
     end
 
-    # Analyzes an input document for financially related relationships
-    # between text.
+    # `AnalyzeExpense` synchronously analyzes an input document for
+    # financially related relationships between text.
     #
     # Information is returned as `ExpenseDocuments` and seperated as
     # follows.
@@ -594,6 +594,59 @@ module Aws::Textract
       req.send_request(options)
     end
 
+    # 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.
+    #
+    # @option params [required, Array<Types::Document>] :document_pages
+    #   The document being passed to AnalyzeID.
+    #
+    # @return [Types::AnalyzeIDResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::AnalyzeIDResponse#identity_documents #identity_documents} => Array&lt;Types::IdentityDocument&gt;
+    #   * {Types::AnalyzeIDResponse#document_metadata #document_metadata} => Types::DocumentMetadata
+    #   * {Types::AnalyzeIDResponse#analyze_id_model_version #analyze_id_model_version} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.analyze_id({
+    #     document_pages: [ # required
+    #       {
+    #         bytes: "data",
+    #         s3_object: {
+    #           bucket: "S3Bucket",
+    #           name: "S3ObjectName",
+    #           version: "S3ObjectVersion",
+    #         },
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.identity_documents #=> Array
+    #   resp.identity_documents[0].document_index #=> Integer
+    #   resp.identity_documents[0].identity_document_fields #=> Array
+    #   resp.identity_documents[0].identity_document_fields[0].type.text #=> String
+    #   resp.identity_documents[0].identity_document_fields[0].type.normalized_value.value #=> String
+    #   resp.identity_documents[0].identity_document_fields[0].type.normalized_value.value_type #=> String, one of "DATE"
+    #   resp.identity_documents[0].identity_document_fields[0].type.confidence #=> Float
+    #   resp.identity_documents[0].identity_document_fields[0].value_detection.text #=> String
+    #   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.document_metadata.pages #=> Integer
+    #   resp.analyze_id_model_version #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeID AWS API Documentation
+    #
+    # @overload analyze_id(params = {})
+    # @param [Hash] params ({})
+    def analyze_id(params = {}, options = {})
+      req = build_request(:analyze_id, params)
+      req.send_request(options)
+    end
+
     # Detects text in the input document. Amazon Textract can detect lines
     # of text and the words that make up a line of text. The input document
     # must be an image in JPEG or PNG format. `DetectDocumentText` returns
@@ -1392,7 +1445,7 @@ module Aws::Textract
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-textract'
-      context[:gem_version] = '1.31.0'
+      context[:gem_version] = '1.32.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -18,6 +18,9 @@ module Aws::Textract
     AnalyzeDocumentResponse = Shapes::StructureShape.new(name: 'AnalyzeDocumentResponse')
     AnalyzeExpenseRequest = Shapes::StructureShape.new(name: 'AnalyzeExpenseRequest')
     AnalyzeExpenseResponse = Shapes::StructureShape.new(name: 'AnalyzeExpenseResponse')
+    AnalyzeIDDetections = Shapes::StructureShape.new(name: 'AnalyzeIDDetections')
+    AnalyzeIDRequest = Shapes::StructureShape.new(name: 'AnalyzeIDRequest')
+    AnalyzeIDResponse = Shapes::StructureShape.new(name: 'AnalyzeIDResponse')
     BadDocumentException = Shapes::StructureShape.new(name: 'BadDocumentException')
     Block = Shapes::StructureShape.new(name: 'Block')
     BlockList = Shapes::ListShape.new(name: 'BlockList')
@@ -31,6 +34,7 @@ module Aws::Textract
     Document = Shapes::StructureShape.new(name: 'Document')
     DocumentLocation = Shapes::StructureShape.new(name: 'DocumentLocation')
     DocumentMetadata = Shapes::StructureShape.new(name: 'DocumentMetadata')
+    DocumentPages = Shapes::ListShape.new(name: 'DocumentPages')
     DocumentTooLargeException = Shapes::StructureShape.new(name: 'DocumentTooLargeException')
     EntityType = Shapes::StringShape.new(name: 'EntityType')
     EntityTypes = Shapes::ListShape.new(name: 'EntityTypes')
@@ -63,6 +67,10 @@ module Aws::Textract
     HumanLoopQuotaExceededException = Shapes::StructureShape.new(name: 'HumanLoopQuotaExceededException')
     IdList = Shapes::ListShape.new(name: 'IdList')
     IdempotentParameterMismatchException = Shapes::StructureShape.new(name: 'IdempotentParameterMismatchException')
+    IdentityDocument = Shapes::StructureShape.new(name: 'IdentityDocument')
+    IdentityDocumentField = Shapes::StructureShape.new(name: 'IdentityDocumentField')
+    IdentityDocumentFieldList = Shapes::ListShape.new(name: 'IdentityDocumentFieldList')
+    IdentityDocumentList = Shapes::ListShape.new(name: 'IdentityDocumentList')
     ImageBlob = Shapes::BlobShape.new(name: 'ImageBlob')
     InternalServerError = Shapes::StructureShape.new(name: 'InternalServerError')
     InvalidJobIdException = Shapes::StructureShape.new(name: 'InvalidJobIdException')
@@ -80,6 +88,7 @@ module Aws::Textract
     LineItemList = Shapes::ListShape.new(name: 'LineItemList')
     MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
     NonEmptyString = Shapes::StringShape.new(name: 'NonEmptyString')
+    NormalizedValue = Shapes::StructureShape.new(name: 'NormalizedValue')
     NotificationChannel = Shapes::StructureShape.new(name: 'NotificationChannel')
     OutputConfig = Shapes::StructureShape.new(name: 'OutputConfig')
     Pages = Shapes::ListShape.new(name: 'Pages')
@@ -110,6 +119,7 @@ module Aws::Textract
     ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
     UInteger = Shapes::IntegerShape.new(name: 'UInteger')
     UnsupportedDocumentException = Shapes::StructureShape.new(name: 'UnsupportedDocumentException')
+    ValueType = Shapes::StringShape.new(name: 'ValueType')
     Warning = Shapes::StructureShape.new(name: 'Warning')
     Warnings = Shapes::ListShape.new(name: 'Warnings')
 
@@ -133,6 +143,19 @@ module Aws::Textract
     AnalyzeExpenseResponse.add_member(:expense_documents, Shapes::ShapeRef.new(shape: ExpenseDocumentList, location_name: "ExpenseDocuments"))
     AnalyzeExpenseResponse.struct_class = Types::AnalyzeExpenseResponse
 
+    AnalyzeIDDetections.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Text"))
+    AnalyzeIDDetections.add_member(:normalized_value, Shapes::ShapeRef.new(shape: NormalizedValue, location_name: "NormalizedValue"))
+    AnalyzeIDDetections.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
+    AnalyzeIDDetections.struct_class = Types::AnalyzeIDDetections
+
+    AnalyzeIDRequest.add_member(:document_pages, Shapes::ShapeRef.new(shape: DocumentPages, required: true, location_name: "DocumentPages"))
+    AnalyzeIDRequest.struct_class = Types::AnalyzeIDRequest
+
+    AnalyzeIDResponse.add_member(:identity_documents, Shapes::ShapeRef.new(shape: IdentityDocumentList, location_name: "IdentityDocuments"))
+    AnalyzeIDResponse.add_member(:document_metadata, Shapes::ShapeRef.new(shape: DocumentMetadata, location_name: "DocumentMetadata"))
+    AnalyzeIDResponse.add_member(:analyze_id_model_version, Shapes::ShapeRef.new(shape: String, location_name: "AnalyzeIDModelVersion"))
+    AnalyzeIDResponse.struct_class = Types::AnalyzeIDResponse
+
     BadDocumentException.struct_class = Types::BadDocumentException
 
     Block.add_member(:block_type, Shapes::ShapeRef.new(shape: BlockType, location_name: "BlockType"))
@@ -179,6 +202,8 @@ module Aws::Textract
     DocumentMetadata.add_member(:pages, Shapes::ShapeRef.new(shape: UInteger, location_name: "Pages"))
     DocumentMetadata.struct_class = Types::DocumentMetadata
 
+    DocumentPages.member = Shapes::ShapeRef.new(shape: Document)
+
     DocumentTooLargeException.struct_class = Types::DocumentTooLargeException
 
     EntityTypes.member = Shapes::ShapeRef.new(shape: EntityType)
@@ -279,6 +304,18 @@ module Aws::Textract
 
     IdempotentParameterMismatchException.struct_class = Types::IdempotentParameterMismatchException
 
+    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.struct_class = Types::IdentityDocument
+
+    IdentityDocumentField.add_member(:type, Shapes::ShapeRef.new(shape: AnalyzeIDDetections, location_name: "Type"))
+    IdentityDocumentField.add_member(:value_detection, Shapes::ShapeRef.new(shape: AnalyzeIDDetections, location_name: "ValueDetection"))
+    IdentityDocumentField.struct_class = Types::IdentityDocumentField
+
+    IdentityDocumentFieldList.member = Shapes::ShapeRef.new(shape: IdentityDocumentField)
+
+    IdentityDocumentList.member = Shapes::ShapeRef.new(shape: IdentityDocument)
+
     InternalServerError.struct_class = Types::InternalServerError
 
     InvalidJobIdException.struct_class = Types::InvalidJobIdException
@@ -302,6 +339,10 @@ module Aws::Textract
 
     LineItemList.member = Shapes::ShapeRef.new(shape: LineItemFields)
 
+    NormalizedValue.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "Value"))
+    NormalizedValue.add_member(:value_type, Shapes::ShapeRef.new(shape: ValueType, location_name: "ValueType"))
+    NormalizedValue.struct_class = Types::NormalizedValue
+
     NotificationChannel.add_member(:sns_topic_arn, Shapes::ShapeRef.new(shape: SNSTopicArn, required: true, location_name: "SNSTopicArn"))
     NotificationChannel.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
     NotificationChannel.struct_class = Types::NotificationChannel
@@ -428,6 +469,23 @@ module Aws::Textract
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
       end)
 
+      api.add_operation(:analyze_id, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "AnalyzeID"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: AnalyzeIDRequest)
+        o.output = Shapes::ShapeRef.new(shape: AnalyzeIDResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
+        o.errors << Shapes::ShapeRef.new(shape: UnsupportedDocumentException)
+        o.errors << Shapes::ShapeRef.new(shape: DocumentTooLargeException)
+        o.errors << Shapes::ShapeRef.new(shape: BadDocumentException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: ProvisionedThroughputExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+      end)
+
       api.add_operation(:detect_document_text, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DetectDocumentText"
         o.http_method = "POST"

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

@@ -168,6 +168,84 @@ module Aws::Textract
       include Aws::Structure
     end
 
+    # Used to contain the information detected by an AnalyzeID operation.
+    #
+    # @!attribute [rw] text
+    #   Text of either the normalized field or value associated with it.
+    #   @return [String]
+    #
+    # @!attribute [rw] normalized_value
+    #   Only returned for dates, returns the type of value detected and the
+    #   date written in a more machine readable way.
+    #   @return [Types::NormalizedValue]
+    #
+    # @!attribute [rw] confidence
+    #   The confidence score of the detected text.
+    #   @return [Float]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeIDDetections AWS API Documentation
+    #
+    class AnalyzeIDDetections < Struct.new(
+      :text,
+      :normalized_value,
+      :confidence)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass AnalyzeIDRequest
+    #   data as a hash:
+    #
+    #       {
+    #         document_pages: [ # required
+    #           {
+    #             bytes: "data",
+    #             s3_object: {
+    #               bucket: "S3Bucket",
+    #               name: "S3ObjectName",
+    #               version: "S3ObjectVersion",
+    #             },
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] document_pages
+    #   The document being passed to AnalyzeID.
+    #   @return [Array<Types::Document>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeIDRequest AWS API Documentation
+    #
+    class AnalyzeIDRequest < Struct.new(
+      :document_pages)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] identity_documents
+    #   The list of documents processed by AnalyzeID. Includes a number
+    #   denoting their place in the list and the response structure for the
+    #   document.
+    #   @return [Array<Types::IdentityDocument>]
+    #
+    # @!attribute [rw] document_metadata
+    #   Information about the input document.
+    #   @return [Types::DocumentMetadata]
+    #
+    # @!attribute [rw] analyze_id_model_version
+    #   The version of the AnalyzeIdentity API being used to process
+    #   documents.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeIDResponse AWS API Documentation
+    #
+    class AnalyzeIDResponse < Struct.new(
+      :identity_documents,
+      :document_metadata,
+      :analyze_id_model_version)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Amazon Textract isn't able to read the document. For more information
     # on the document limits in Amazon Textract, see limits.
     #
@@ -619,7 +697,7 @@ module Aws::Textract
     end
 
     # Breakdown of detected information, seperated into the catagories Type,
-    # LableDetection, and ValueDetection
+    # LabelDetection, and ValueDetection
     #
     # @!attribute [rw] type
     #   The implied label of a detected element. Present alongside
@@ -1073,6 +1151,50 @@ module Aws::Textract
     #
     class IdempotentParameterMismatchException < Aws::EmptyStructure; end
 
+    # The structure that lists each document processed in an AnalyzeID
+    # operation.
+    #
+    # @!attribute [rw] document_index
+    #   Denotes the placement of a document in the IdentityDocument list.
+    #   The first document is marked 1, the second 2 and so on.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] identity_document_fields
+    #   The structure used to record information extracted from identity
+    #   documents. Contains both normalized field and value of the extracted
+    #   text.
+    #   @return [Array<Types::IdentityDocumentField>]
+    #
+    # @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)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Structure containing both the normalized type of the extracted
+    # information and the text associated with it. These are extracted as
+    # Type and Value respectively.
+    #
+    # @!attribute [rw] type
+    #   Used to contain the information detected by an AnalyzeID operation.
+    #   @return [Types::AnalyzeIDDetections]
+    #
+    # @!attribute [rw] value_detection
+    #   Used to contain the information detected by an AnalyzeID operation.
+    #   @return [Types::AnalyzeIDDetections]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/IdentityDocumentField AWS API Documentation
+    #
+    class IdentityDocumentField < Struct.new(
+      :type,
+      :value_detection)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Amazon Textract experienced a service issue. Try your call again.
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/InternalServerError AWS API Documentation
@@ -1165,6 +1287,26 @@ module Aws::Textract
       include Aws::Structure
     end
 
+    # Contains information relating to dates in a document, including the
+    # type of value, and the value.
+    #
+    # @!attribute [rw] value
+    #   The value of the date, written as Year-Month-DayTHour:Minute:Second.
+    #   @return [String]
+    #
+    # @!attribute [rw] value_type
+    #   The normalized type of the value detected. In this case, DATE.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/NormalizedValue AWS API Documentation
+    #
+    class NormalizedValue < Struct.new(
+      :value,
+      :value_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The Amazon Simple Notification Service (Amazon SNS) topic to which
     # Amazon Textract publishes the completion status of an asynchronous
     # document operation, such as StartDocumentTextDetection.
@@ -1662,8 +1804,8 @@ module Aws::Textract
     class ThrottlingException < Aws::EmptyStructure; end
 
     # The format of the input document isn't supported. Documents for
-    # synchronous operations can be in PNG or JPEG format. Documents for
-    # asynchronous operations can also be in PDF format.
+    # synchronous operations can be in PNG or JPEG format only. Documents
+    # for asynchronous operations can be in PDF format.
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/UnsupportedDocumentException AWS API Documentation
     #

data/lib/aws-sdk-textract.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-textract/customizations'
 # @!group service
 module Aws::Textract
 
-  GEM_VERSION = '1.31.0'
+  GEM_VERSION = '1.32.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-textract
 version: !ruby/object:Gem::Version
-  version: 1.31.0
+  version: 1.32.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core