cloudmersive-ocr-api-client 1.4.0 → 1.4.2

data/lib/cloudmersive-ocr-api-client/models/form_table_definition.rb

@@ -0,0 +1,221 @@
+=begin
+#ocrapi
+
+#The powerful Optical Character Recognition (OCR) APIs let you convert scanned images of pages into recognized text.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: unset
+
+=end
+
+require 'date'
+
+module CloudmersiveOcrApiClient
+  # Definition of a form table for OCR data extraction from images
+  class FormTableDefinition
+    # Optional; the ID of the table
+    attr_accessor :table_id
+
+    # Definition of the columns in the table
+    attr_accessor :column_definitions
+
+    # Optional - scale factor for target table height - relative to maximum height of headers of columns
+    attr_accessor :target_table_height_relative
+
+    # Optional - scale factor for target row height - relative to height of column header
+    attr_accessor :target_row_height_relative
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'table_id' => :'TableID',
+        :'column_definitions' => :'ColumnDefinitions',
+        :'target_table_height_relative' => :'TargetTableHeight_Relative',
+        :'target_row_height_relative' => :'TargetRowHeight_Relative'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'table_id' => :'String',
+        :'column_definitions' => :'Array<FormTableColumnDefinition>',
+        :'target_table_height_relative' => :'Float',
+        :'target_row_height_relative' => :'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?(:'TableID')
+        self.table_id = attributes[:'TableID']
+      end
+
+      if attributes.has_key?(:'ColumnDefinitions')
+        if (value = attributes[:'ColumnDefinitions']).is_a?(Array)
+          self.column_definitions = value
+        end
+      end
+
+      if attributes.has_key?(:'TargetTableHeight_Relative')
+        self.target_table_height_relative = attributes[:'TargetTableHeight_Relative']
+      end
+
+      if attributes.has_key?(:'TargetRowHeight_Relative')
+        self.target_row_height_relative = attributes[:'TargetRowHeight_Relative']
+      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
+      return 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?
+      return 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 &&
+          table_id == o.table_id &&
+          column_definitions == o.column_definitions &&
+          target_table_height_relative == o.target_table_height_relative &&
+          target_row_height_relative == o.target_row_height_relative
+    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
+      [table_id, column_definitions, target_table_height_relative, target_row_height_relative].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 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 = CloudmersiveOcrApiClient.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

data/lib/cloudmersive-ocr-api-client/models/image_to_lines_with_location_result.rb

@@ -15,6 +15,7 @@ require 'date'
 module CloudmersiveOcrApiClient
   # Result of an image to lines-with-location OCR operation
   class ImageToLinesWithLocationResult
+    # True if successful, false otherwise
     attr_accessor :successful
 
     # Words in the image

data/lib/cloudmersive-ocr-api-client/models/image_to_words_with_location_result.rb

@@ -15,6 +15,7 @@ require 'date'
 module CloudmersiveOcrApiClient
   # Result of an image to words-with-location OCR operation
   class ImageToWordsWithLocationResult
+    # True if successful, false otherwise
     attr_accessor :successful
 
     # Word elements in the image

data/lib/cloudmersive-ocr-api-client/models/ocr_page_result_with_lines_with_location.rb

@@ -15,11 +15,12 @@ require 'date'
 module CloudmersiveOcrApiClient
   # OCR results of a page, including lines of text and their location
   class OcrPageResultWithLinesWithLocation
-    attr_accessor :successful
-
     # Page number of the page that was OCR-ed, starting with 1 for the first page in the PDF file
     attr_accessor :page_number
 
+    # True if successful, false otherwise
+    attr_accessor :successful
+
     # Word elements in the image
     attr_accessor :lines
 
@@ -27,8 +28,8 @@ module CloudmersiveOcrApiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'successful' => :'Successful',
         :'page_number' => :'PageNumber',
+        :'successful' => :'Successful',
         :'lines' => :'Lines'
       }
     end
@@ -36,8 +37,8 @@ module CloudmersiveOcrApiClient
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'successful' => :'BOOLEAN',
         :'page_number' => :'Integer',
+        :'successful' => :'BOOLEAN',
         :'lines' => :'Array<OcrLineElement>'
       }
     end
@@ -50,14 +51,14 @@ module CloudmersiveOcrApiClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes.has_key?(:'Successful')
-        self.successful = attributes[:'Successful']
-      end
-
       if attributes.has_key?(:'PageNumber')
         self.page_number = attributes[:'PageNumber']
       end
 
+      if attributes.has_key?(:'Successful')
+        self.successful = attributes[:'Successful']
+      end
+
       if attributes.has_key?(:'Lines')
         if (value = attributes[:'Lines']).is_a?(Array)
           self.lines = value
@@ -84,8 +85,8 @@ module CloudmersiveOcrApiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          successful == o.successful &&
           page_number == o.page_number &&
+          successful == o.successful &&
           lines == o.lines
     end
 
@@ -98,7 +99,7 @@ module CloudmersiveOcrApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [successful, page_number, lines].hash
+      [page_number, successful, lines].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-ocr-api-client/models/ocr_page_result_with_words_with_location.rb

@@ -15,11 +15,12 @@ require 'date'
 module CloudmersiveOcrApiClient
   # OCR results of a page, including words of text and their location
   class OcrPageResultWithWordsWithLocation
-    attr_accessor :successful
-
     # Page number of the page that was OCR-ed, starting with 1 for the first page in the PDF file
     attr_accessor :page_number
 
+    # True if successful, false otherwise
+    attr_accessor :successful
+
     # Word elements in the image
     attr_accessor :words
 
@@ -27,8 +28,8 @@ module CloudmersiveOcrApiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'successful' => :'Successful',
         :'page_number' => :'PageNumber',
+        :'successful' => :'Successful',
         :'words' => :'Words'
       }
     end
@@ -36,8 +37,8 @@ module CloudmersiveOcrApiClient
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'successful' => :'BOOLEAN',
         :'page_number' => :'Integer',
+        :'successful' => :'BOOLEAN',
         :'words' => :'Array<OcrWordElement>'
       }
     end
@@ -50,14 +51,14 @@ module CloudmersiveOcrApiClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes.has_key?(:'Successful')
-        self.successful = attributes[:'Successful']
-      end
-
       if attributes.has_key?(:'PageNumber')
         self.page_number = attributes[:'PageNumber']
       end
 
+      if attributes.has_key?(:'Successful')
+        self.successful = attributes[:'Successful']
+      end
+
       if attributes.has_key?(:'Words')
         if (value = attributes[:'Words']).is_a?(Array)
           self.words = value
@@ -84,8 +85,8 @@ module CloudmersiveOcrApiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          successful == o.successful &&
           page_number == o.page_number &&
+          successful == o.successful &&
           words == o.words
     end
 
@@ -98,7 +99,7 @@ module CloudmersiveOcrApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [successful, page_number, words].hash
+      [page_number, successful, words].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-ocr-api-client/models/ocr_photo_text_element.rb

@@ -30,6 +30,9 @@ module CloudmersiveOcrApiClient
     # Height of the word in pixels
     attr_accessor :height
 
+    # Points that form the bounding polygon around the text
+    attr_accessor :bounding_points
+
     # Confidence level of the machine learning result; possible values are 0.0 (lowest accuracy) - 1.0 (highest accuracy)
     attr_accessor :confidence_level
 
@@ -42,6 +45,7 @@ module CloudmersiveOcrApiClient
         :'y_top' => :'YTop',
         :'width' => :'Width',
         :'height' => :'Height',
+        :'bounding_points' => :'BoundingPoints',
         :'confidence_level' => :'ConfidenceLevel'
       }
     end
@@ -54,6 +58,7 @@ module CloudmersiveOcrApiClient
         :'y_top' => :'Integer',
         :'width' => :'Integer',
         :'height' => :'Integer',
+        :'bounding_points' => :'Array<Point>',
         :'confidence_level' => :'Float'
       }
     end
@@ -86,6 +91,12 @@ module CloudmersiveOcrApiClient
         self.height = attributes[:'Height']
       end
 
+      if attributes.has_key?(:'BoundingPoints')
+        if (value = attributes[:'BoundingPoints']).is_a?(Array)
+          self.bounding_points = value
+        end
+      end
+
       if attributes.has_key?(:'ConfidenceLevel')
         self.confidence_level = attributes[:'ConfidenceLevel']
       end
@@ -115,6 +126,7 @@ module CloudmersiveOcrApiClient
           y_top == o.y_top &&
           width == o.width &&
           height == o.height &&
+          bounding_points == o.bounding_points &&
           confidence_level == o.confidence_level
     end
 
@@ -127,7 +139,7 @@ module CloudmersiveOcrApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [text, x_left, y_top, width, height, confidence_level].hash
+      [text, x_left, y_top, width, height, bounding_points, confidence_level].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-ocr-api-client/models/pdf_to_lines_with_location_result.rb

@@ -15,8 +15,10 @@ require 'date'
 module CloudmersiveOcrApiClient
   # Response from an OCR to lines with location operation.  Includes the confience rating and converted text result, along with the locations of the lines in the pages.
   class PdfToLinesWithLocationResult
+    # True if successful, false otherwise
     attr_accessor :successful
 
+    # OCR results for each page
     attr_accessor :ocr_pages
 
 

data/lib/cloudmersive-ocr-api-client/models/pdf_to_text_response.rb

@@ -15,8 +15,10 @@ require 'date'
 module CloudmersiveOcrApiClient
   # Response from an OCR to text operation.  Includes the confidence rating and converted text result.
   class PdfToTextResponse
+    # True if successful, false otherwise
     attr_accessor :successful
 
+    # Page OCR results
     attr_accessor :ocr_pages