cloudmersive-documentai-api-client 2.2.0 → 2.2.1

data/lib/cloudmersive-documentai-api-client/configuration.rb

@@ -1,10 +1,10 @@
 =begin
 #Document AI API
 
-#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+#Extract structured data including named fields, tables, barcodes, classifications, and summaries from common document formats, scanned documents, and photos of documents using AI.  Also supports handwriting and low quality photos and scans, as well as digital document input.  Supports a wide range of languages, and is able to analyze and infer semantic structure from the visual layout for documents.
 
 OpenAPI spec version: v1
-
+Contact: support@cloudmersive.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.14
 
@@ -129,7 +129,7 @@ module CloudmersiveDocumentaiApiClient
 
     def initialize
       @scheme = 'https'
-      @host = ''
+      @host = 'api.cloudmersive.com'
       @base_path = ''
       @api_key = {}
       @api_key_prefix = {}

data/lib/cloudmersive-documentai-api-client/models/advanced_extract_classification_request.rb

@@ -1,10 +1,10 @@
 =begin
 #Document AI API
 
-#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+#Extract structured data including named fields, tables, barcodes, classifications, and summaries from common document formats, scanned documents, and photos of documents using AI.  Also supports handwriting and low quality photos and scans, as well as digital document input.  Supports a wide range of languages, and is able to analyze and infer semantic structure from the visual layout for documents.
 
 OpenAPI spec version: v1
-
+Contact: support@cloudmersive.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.14
 
@@ -21,15 +21,27 @@ module CloudmersiveDocumentaiApiClient
     # Possible categories for the document
     attr_accessor :categories
 
+    # Optional: Set the level of image pre-processing to enhance accuracy.  Possible values are 'Auto', 'SmoothEdges', 'SmoothEdgesPlus', 'Compatability' and 'None'.  Default is Auto.  Set to SmoothEdges to smooth harsh edges in the input image to enhance recognition accuracy.  Set to SmoothEdgesPlus to smooth harsh edges to a higher degree.  Set to Compatability for maximum PDF feature compatability.
+    attr_accessor :preprocessing
+
+    # Optional: Set the level of output accuracy cross-checking to perform on the input.  Possible values are 'None', 'Advanced', 'Ultra' and 'Hyper'.  Default is None.  Ultra and Hyper will produce the highest accuracy but at the cost of longer processing times.
+    attr_accessor :result_cross_check
+
     # Optional: Limit the number of pages processed
     attr_accessor :maximum_pages_processed
 
+    # Optional: Rotate the input image before recognition by the specified number of degrees; valid values range from -360 to +360.
+    attr_accessor :rotate_image_degrees
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'input_file' => :'InputFile',
         :'categories' => :'Categories',
-        :'maximum_pages_processed' => :'MaximumPagesProcessed'
+        :'preprocessing' => :'Preprocessing',
+        :'result_cross_check' => :'ResultCrossCheck',
+        :'maximum_pages_processed' => :'MaximumPagesProcessed',
+        :'rotate_image_degrees' => :'RotateImageDegrees'
       }
     end
 
@@ -38,7 +50,10 @@ module CloudmersiveDocumentaiApiClient
       {
         :'input_file' => :'String',
         :'categories' => :'Array<DocumentCategories>',
-        :'maximum_pages_processed' => :'Integer'
+        :'preprocessing' => :'String',
+        :'result_cross_check' => :'String',
+        :'maximum_pages_processed' => :'Integer',
+        :'rotate_image_degrees' => :'Float'
       }
     end
 
@@ -60,9 +75,21 @@ module CloudmersiveDocumentaiApiClient
         end
       end
 
+      if attributes.has_key?(:'Preprocessing')
+        self.preprocessing = attributes[:'Preprocessing']
+      end
+
+      if attributes.has_key?(:'ResultCrossCheck')
+        self.result_cross_check = attributes[:'ResultCrossCheck']
+      end
+
       if attributes.has_key?(:'MaximumPagesProcessed')
         self.maximum_pages_processed = attributes[:'MaximumPagesProcessed']
       end
+
+      if attributes.has_key?(:'RotateImageDegrees')
+        self.rotate_image_degrees = attributes[:'RotateImageDegrees']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -100,7 +127,10 @@ module CloudmersiveDocumentaiApiClient
       self.class == o.class &&
           input_file == o.input_file &&
           categories == o.categories &&
-          maximum_pages_processed == o.maximum_pages_processed
+          preprocessing == o.preprocessing &&
+          result_cross_check == o.result_cross_check &&
+          maximum_pages_processed == o.maximum_pages_processed &&
+          rotate_image_degrees == o.rotate_image_degrees
     end
 
     # @see the `==` method
@@ -112,7 +142,7 @@ module CloudmersiveDocumentaiApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [input_file, categories, maximum_pages_processed].hash
+      [input_file, categories, preprocessing, result_cross_check, maximum_pages_processed, rotate_image_degrees].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-documentai-api-client/models/advanced_extract_fields_request.rb

@@ -1,10 +1,10 @@
 =begin
 #Document AI API
 
-#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+#Extract structured data including named fields, tables, barcodes, classifications, and summaries from common document formats, scanned documents, and photos of documents using AI.  Also supports handwriting and low quality photos and scans, as well as digital document input.  Supports a wide range of languages, and is able to analyze and infer semantic structure from the visual layout for documents.
 
 OpenAPI spec version: v1
-
+Contact: support@cloudmersive.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.14
 
@@ -24,12 +24,24 @@ module CloudmersiveDocumentaiApiClient
     # Optional: Limit the number of pages processed
     attr_accessor :maximum_pages_processed
 
+    # Optional: Set the level of image pre-processing to enhance accuracy.  Possible values are 'Auto', 'SmoothEdges', 'SmoothEdgesPlus', 'ContrastEdges', 'ContrastEdgesPlus', 'Invert', 'Binarize', 'Compatability' and 'None'.  Default is Auto.  Set to SmoothEdges to smooth harsh edges in the input image to enhance recognition accuracy.  Set to SmoothEdgesPlus to smooth harsh edges to a higher degree.  Set to ContrastEdges and ContrastEdgesPlus to enhance contrast and readability for low quality black and white or grayscale images.  Set to Invert to invert the input image.  Set to Binarize to binarize the input image.  Set to Compatability for maximum PDF feature compatability.
+    attr_accessor :preprocessing
+
+    # Optional: Set the level of output accuracy cross-checking to perform on the input.  Possible values are 'None', 'Advanced' and 'Ultra'.  Default is None.  Ultra will produce the highest accuracy but at the cost of longer processing times.
+    attr_accessor :result_cross_check
+
+    # Optional: Rotate the input image before recognition by the specified number of degrees; valid values range from -360 to +360.
+    attr_accessor :rotate_image_degrees
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'input_file' => :'InputFile',
         :'fields_to_extract' => :'FieldsToExtract',
-        :'maximum_pages_processed' => :'MaximumPagesProcessed'
+        :'maximum_pages_processed' => :'MaximumPagesProcessed',
+        :'preprocessing' => :'Preprocessing',
+        :'result_cross_check' => :'ResultCrossCheck',
+        :'rotate_image_degrees' => :'RotateImageDegrees'
       }
     end
 
@@ -38,7 +50,10 @@ module CloudmersiveDocumentaiApiClient
       {
         :'input_file' => :'String',
         :'fields_to_extract' => :'Array<FieldToExtract>',
-        :'maximum_pages_processed' => :'Integer'
+        :'maximum_pages_processed' => :'Integer',
+        :'preprocessing' => :'String',
+        :'result_cross_check' => :'String',
+        :'rotate_image_degrees' => :'Float'
       }
     end
 
@@ -63,6 +78,18 @@ module CloudmersiveDocumentaiApiClient
       if attributes.has_key?(:'MaximumPagesProcessed')
         self.maximum_pages_processed = attributes[:'MaximumPagesProcessed']
       end
+
+      if attributes.has_key?(:'Preprocessing')
+        self.preprocessing = attributes[:'Preprocessing']
+      end
+
+      if attributes.has_key?(:'ResultCrossCheck')
+        self.result_cross_check = attributes[:'ResultCrossCheck']
+      end
+
+      if attributes.has_key?(:'RotateImageDegrees')
+        self.rotate_image_degrees = attributes[:'RotateImageDegrees']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -100,7 +127,10 @@ module CloudmersiveDocumentaiApiClient
       self.class == o.class &&
           input_file == o.input_file &&
           fields_to_extract == o.fields_to_extract &&
-          maximum_pages_processed == o.maximum_pages_processed
+          maximum_pages_processed == o.maximum_pages_processed &&
+          preprocessing == o.preprocessing &&
+          result_cross_check == o.result_cross_check &&
+          rotate_image_degrees == o.rotate_image_degrees
     end
 
     # @see the `==` method
@@ -112,7 +142,7 @@ module CloudmersiveDocumentaiApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [input_file, fields_to_extract, maximum_pages_processed].hash
+      [input_file, fields_to_extract, maximum_pages_processed, preprocessing, result_cross_check, rotate_image_degrees].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-documentai-api-client/models/document_advanced_classification_result.rb

@@ -1,10 +1,10 @@
 =begin
 #Document AI API
 
-#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+#Extract structured data including named fields, tables, barcodes, classifications, and summaries from common document formats, scanned documents, and photos of documents using AI.  Also supports handwriting and low quality photos and scans, as well as digital document input.  Supports a wide range of languages, and is able to analyze and infer semantic structure from the visual layout for documents.
 
 OpenAPI spec version: v1
-
+Contact: support@cloudmersive.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.14
 
@@ -21,11 +21,15 @@ module CloudmersiveDocumentaiApiClient
     # Category applied to the document; if a category could not be identified then \"other\" will be used.  Spaces are replaced with underscores.
     attr_accessor :document_category_result
 
+    # Confidence score between 0.0 and 1.0, where values > 0.8 indicate high confidence
+    attr_accessor :confidence_score
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'successful' => :'Successful',
-        :'document_category_result' => :'DocumentCategoryResult'
+        :'document_category_result' => :'DocumentCategoryResult',
+        :'confidence_score' => :'ConfidenceScore'
       }
     end
 
@@ -33,7 +37,8 @@ module CloudmersiveDocumentaiApiClient
     def self.swagger_types
       {
         :'successful' => :'BOOLEAN',
-        :'document_category_result' => :'String'
+        :'document_category_result' => :'String',
+        :'confidence_score' => :'Float'
       }
     end
 
@@ -52,6 +57,10 @@ module CloudmersiveDocumentaiApiClient
       if attributes.has_key?(:'DocumentCategoryResult')
         self.document_category_result = attributes[:'DocumentCategoryResult']
       end
+
+      if attributes.has_key?(:'ConfidenceScore')
+        self.confidence_score = attributes[:'ConfidenceScore']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -73,7 +82,8 @@ module CloudmersiveDocumentaiApiClient
       return true if self.equal?(o)
       self.class == o.class &&
           successful == o.successful &&
-          document_category_result == o.document_category_result
+          document_category_result == o.document_category_result &&
+          confidence_score == o.confidence_score
     end
 
     # @see the `==` method
@@ -85,7 +95,7 @@ module CloudmersiveDocumentaiApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [successful, document_category_result].hash
+      [successful, document_category_result, confidence_score].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-documentai-api-client/models/document_categories.rb

@@ -1,10 +1,10 @@
 =begin
 #Document AI API
 
-#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+#Extract structured data including named fields, tables, barcodes, classifications, and summaries from common document formats, scanned documents, and photos of documents using AI.  Also supports handwriting and low quality photos and scans, as well as digital document input.  Supports a wide range of languages, and is able to analyze and infer semantic structure from the visual layout for documents.
 
 OpenAPI spec version: v1
-
+Contact: support@cloudmersive.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.14
 

data/lib/cloudmersive-documentai-api-client/models/document_classification_result.rb

@@ -1,10 +1,10 @@
 =begin
 #Document AI API
 
-#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+#Extract structured data including named fields, tables, barcodes, classifications, and summaries from common document formats, scanned documents, and photos of documents using AI.  Also supports handwriting and low quality photos and scans, as well as digital document input.  Supports a wide range of languages, and is able to analyze and infer semantic structure from the visual layout for documents.
 
 OpenAPI spec version: v1
-
+Contact: support@cloudmersive.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.14
 

data/lib/cloudmersive-documentai-api-client/models/document_policy_request.rb

@@ -1,10 +1,10 @@
 =begin
 #Document AI API
 
-#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+#Extract structured data including named fields, tables, barcodes, classifications, and summaries from common document formats, scanned documents, and photos of documents using AI.  Also supports handwriting and low quality photos and scans, as well as digital document input.  Supports a wide range of languages, and is able to analyze and infer semantic structure from the visual layout for documents.
 
 OpenAPI spec version: v1
-
+Contact: support@cloudmersive.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.14
 
@@ -21,11 +21,15 @@ module CloudmersiveDocumentaiApiClient
     # Rules to apply to the document
     attr_accessor :rules
 
+    # Optional; Recognition mode - Normal (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+    attr_accessor :recognition_mode
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'input_file' => :'InputFile',
-        :'rules' => :'Rules'
+        :'rules' => :'Rules',
+        :'recognition_mode' => :'RecognitionMode'
       }
     end
 
@@ -33,7 +37,8 @@ module CloudmersiveDocumentaiApiClient
     def self.swagger_types
       {
         :'input_file' => :'String',
-        :'rules' => :'Array<PolicyRule>'
+        :'rules' => :'Array<PolicyRule>',
+        :'recognition_mode' => :'String'
       }
     end
 
@@ -54,6 +59,10 @@ module CloudmersiveDocumentaiApiClient
           self.rules = value
         end
       end
+
+      if attributes.has_key?(:'RecognitionMode')
+        self.recognition_mode = attributes[:'RecognitionMode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -90,7 +99,8 @@ module CloudmersiveDocumentaiApiClient
       return true if self.equal?(o)
       self.class == o.class &&
           input_file == o.input_file &&
-          rules == o.rules
+          rules == o.rules &&
+          recognition_mode == o.recognition_mode
     end
 
     # @see the `==` method
@@ -102,7 +112,7 @@ module CloudmersiveDocumentaiApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [input_file, rules].hash
+      [input_file, rules, recognition_mode].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-documentai-api-client/models/document_policy_result.rb

@@ -1,10 +1,10 @@
 =begin
 #Document AI API
 
-#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+#Extract structured data including named fields, tables, barcodes, classifications, and summaries from common document formats, scanned documents, and photos of documents using AI.  Also supports handwriting and low quality photos and scans, as well as digital document input.  Supports a wide range of languages, and is able to analyze and infer semantic structure from the visual layout for documents.
 
 OpenAPI spec version: v1
-
+Contact: support@cloudmersive.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.14
 

data/lib/cloudmersive-documentai-api-client/models/document_question_answer_item.rb

@@ -0,0 +1,216 @@
+=begin
+#Document AI API
+
+#Extract structured data including named fields, tables, barcodes, classifications, and summaries from common document formats, scanned documents, and photos of documents using AI.  Also supports handwriting and low quality photos and scans, as well as digital document input.  Supports a wide range of languages, and is able to analyze and infer semantic structure from the visual layout for documents.
+
+OpenAPI spec version: v1
+Contact: support@cloudmersive.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersiveDocumentaiApiClient
+  # Answer to an input question
+  class DocumentQuestionAnswerItem
+    # ID of the input question
+    attr_accessor :question_id
+
+    # Answer response value, formatted as a string, for this question.  Boolean questions will return YES or NO.
+    attr_accessor :answer_value
+
+    # Rationale explaining why this answer was given
+    attr_accessor :answer_rationale
+
+    # Confidence score between 0.0 and 1.0 where values above 0.8 indicate high confidence
+    attr_accessor :confidence_score
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'question_id' => :'QuestionId',
+        :'answer_value' => :'AnswerValue',
+        :'answer_rationale' => :'AnswerRationale',
+        :'confidence_score' => :'ConfidenceScore'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'question_id' => :'String',
+        :'answer_value' => :'String',
+        :'answer_rationale' => :'String',
+        :'confidence_score' => :'Float'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'QuestionId')
+        self.question_id = attributes[:'QuestionId']
+      end
+
+      if attributes.has_key?(:'AnswerValue')
+        self.answer_value = attributes[:'AnswerValue']
+      end
+
+      if attributes.has_key?(:'AnswerRationale')
+        self.answer_rationale = attributes[:'AnswerRationale']
+      end
+
+      if attributes.has_key?(:'ConfidenceScore')
+        self.confidence_score = attributes[:'ConfidenceScore']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          question_id == o.question_id &&
+          answer_value == o.answer_value &&
+          answer_rationale == o.answer_rationale &&
+          confidence_score == o.confidence_score
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [question_id, answer_value, answer_rationale, confidence_score].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CloudmersiveDocumentaiApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end