cloudmersive-ocr-api-client 1.4.0 → 1.4.2

data/docs/TableRowResult.md

@@ -0,0 +1,8 @@
+# CloudmersiveOcrApiClient::TableRowResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**table_row_cells_result** | [**Array<TableCellResult>**](TableCellResult.md) | Table cells in this row result | [optional] 
+
+

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

@@ -22,6 +22,8 @@ require 'cloudmersive-ocr-api-client/models/field_result'
 require 'cloudmersive-ocr-api-client/models/form_definition_template'
 require 'cloudmersive-ocr-api-client/models/form_field_definition'
 require 'cloudmersive-ocr-api-client/models/form_recognition_result'
+require 'cloudmersive-ocr-api-client/models/form_table_column_definition'
+require 'cloudmersive-ocr-api-client/models/form_table_definition'
 require 'cloudmersive-ocr-api-client/models/get_page_angle_result'
 require 'cloudmersive-ocr-api-client/models/image_to_lines_with_location_result'
 require 'cloudmersive-ocr-api-client/models/image_to_text_response'
@@ -36,8 +38,12 @@ require 'cloudmersive-ocr-api-client/models/pdf_to_lines_with_location_result'
 require 'cloudmersive-ocr-api-client/models/pdf_to_text_response'
 require 'cloudmersive-ocr-api-client/models/pdf_to_words_with_location_result'
 require 'cloudmersive-ocr-api-client/models/photo_to_words_with_location_result'
+require 'cloudmersive-ocr-api-client/models/point'
 require 'cloudmersive-ocr-api-client/models/receipt_line_item'
 require 'cloudmersive-ocr-api-client/models/receipt_recognition_result'
+require 'cloudmersive-ocr-api-client/models/table_cell_result'
+require 'cloudmersive-ocr-api-client/models/table_result'
+require 'cloudmersive-ocr-api-client/models/table_row_result'
 
 # APIs
 require 'cloudmersive-ocr-api-client/api/image_ocr_api'

data/lib/cloudmersive-ocr-api-client/api/image_ocr_api.rb

@@ -206,6 +206,7 @@ module CloudmersiveOcrApiClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :form_template_definition Form field definitions
     # @option opts [String] :recognition_mode Optional, enable advanced recognition mode by specifying 'Advanced', enable handwriting recognition by specifying 'EnableHandwriting'.  Default is disabled.
+    # @option opts [String] :preprocessing Optional, preprocessing mode, default is 'Auto'.  Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended).  Set this to 'None' if you do not want to use automatic image unrotation and enhancement.
     # @option opts [String] :language Optional, language of the input document, default is English (ENG).  Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)
     # @return [FormRecognitionResult]
     def image_ocr_photo_recognize_form(image_file, opts = {})
@@ -219,6 +220,7 @@ module CloudmersiveOcrApiClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :form_template_definition Form field definitions
     # @option opts [String] :recognition_mode Optional, enable advanced recognition mode by specifying 'Advanced', enable handwriting recognition by specifying 'EnableHandwriting'.  Default is disabled.
+    # @option opts [String] :preprocessing Optional, preprocessing mode, default is 'Auto'.  Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended).  Set this to 'None' if you do not want to use automatic image unrotation and enhancement.
     # @option opts [String] :language Optional, language of the input document, default is English (ENG).  Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)
     # @return [Array<(FormRecognitionResult, Fixnum, Hash)>] FormRecognitionResult data, response status code and response headers
     def image_ocr_photo_recognize_form_with_http_info(image_file, opts = {})
@@ -243,6 +245,7 @@ module CloudmersiveOcrApiClient
       header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
       header_params[:'formTemplateDefinition'] = opts[:'form_template_definition'] if !opts[:'form_template_definition'].nil?
       header_params[:'recognitionMode'] = opts[:'recognition_mode'] if !opts[:'recognition_mode'].nil?
+      header_params[:'preprocessing'] = opts[:'preprocessing'] if !opts[:'preprocessing'].nil?
       header_params[:'language'] = opts[:'language'] if !opts[:'language'].nil?
 
       # form parameters
@@ -269,9 +272,9 @@ module CloudmersiveOcrApiClient
     # Analyzes a photograph of a receipt as input, and outputs key business information such as the name of the business, the address of the business, the phone number of the business, the total of the receipt, the date of the receipt, and more.
     # @param image_file Image file to perform OCR on.  Common file formats such as PNG, JPEG are supported.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :form_template_definition Form field definitions
     # @option opts [String] :recognition_mode Optional, enable advanced recognition mode by specifying &#39;Advanced&#39;, enable handwriting recognition by specifying &#39;EnableHandwriting&#39;.  Default is disabled.
     # @option opts [String] :language Optional, language of the input document, default is English (ENG).  Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)
+    # @option opts [String] :preprocessing Optional, preprocessing mode, default is &#39;None&#39;.  Possible values are None (no preprocessing of the image), and &#39;Advanced&#39; (automatic image enhancement of the image before OCR is applied; this is recommended and needed to handle rotated receipts).
     # @return [ReceiptRecognitionResult]
     def image_ocr_photo_recognize_receipt(image_file, opts = {})
       data, _status_code, _headers = image_ocr_photo_recognize_receipt_with_http_info(image_file, opts)
@@ -282,9 +285,9 @@ module CloudmersiveOcrApiClient
     # Analyzes a photograph of a receipt as input, and outputs key business information such as the name of the business, the address of the business, the phone number of the business, the total of the receipt, the date of the receipt, and more.
     # @param image_file Image file to perform OCR on.  Common file formats such as PNG, JPEG are supported.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :form_template_definition Form field definitions
     # @option opts [String] :recognition_mode Optional, enable advanced recognition mode by specifying &#39;Advanced&#39;, enable handwriting recognition by specifying &#39;EnableHandwriting&#39;.  Default is disabled.
     # @option opts [String] :language Optional, language of the input document, default is English (ENG).  Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)
+    # @option opts [String] :preprocessing Optional, preprocessing mode, default is &#39;None&#39;.  Possible values are None (no preprocessing of the image), and &#39;Advanced&#39; (automatic image enhancement of the image before OCR is applied; this is recommended and needed to handle rotated receipts).
     # @return [Array<(ReceiptRecognitionResult, Fixnum, Hash)>] ReceiptRecognitionResult data, response status code and response headers
     def image_ocr_photo_recognize_receipt_with_http_info(image_file, opts = {})
       if @api_client.config.debugging
@@ -306,9 +309,9 @@ module CloudmersiveOcrApiClient
       header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
-      header_params[:'formTemplateDefinition'] = opts[:'form_template_definition'] if !opts[:'form_template_definition'].nil?
       header_params[:'recognitionMode'] = opts[:'recognition_mode'] if !opts[:'recognition_mode'].nil?
       header_params[:'language'] = opts[:'language'] if !opts[:'language'].nil?
+      header_params[:'preprocessing'] = opts[:'preprocessing'] if !opts[:'preprocessing'].nil?
 
       # form parameters
       form_params = {}

data/lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb

@@ -244,6 +244,62 @@ module CloudmersiveOcrApiClient
       return data, status_code, headers
     end
 
+    # Detect and unrotate a document image (advanced)
+    # Detect and unrotate an image of a document (e.g. that was scanned at an angle) using deep learning.  Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.
+    # @param image_file Image file to perform OCR on.  Common file formats such as PNG, JPEG are supported.
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def preprocessing_unrotate_advanced(image_file, opts = {})
+      data, _status_code, _headers = preprocessing_unrotate_advanced_with_http_info(image_file, opts)
+      return data
+    end
+
+    # Detect and unrotate a document image (advanced)
+    # Detect and unrotate an image of a document (e.g. that was scanned at an angle) using deep learning.  Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.
+    # @param image_file Image file to perform OCR on.  Common file formats such as PNG, JPEG are supported.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def preprocessing_unrotate_advanced_with_http_info(image_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PreprocessingApi.preprocessing_unrotate_advanced ..."
+      end
+      # verify the required parameter 'image_file' is set
+      if @api_client.config.client_side_validation && image_file.nil?
+        fail ArgumentError, "Missing the required parameter 'image_file' when calling PreprocessingApi.preprocessing_unrotate_advanced"
+      end
+      # resource path
+      local_var_path = "/ocr/preprocessing/image/unrotate/advanced"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params["imageFile"] = image_file
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_unrotate_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Detect and unskew a photo of a document
     # Detect and unskew a photo of a document (e.g. taken on a cell phone) into a perfectly square image.  Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.
     # @param image_file Image file to perform OCR on.  Common file formats such as PNG, JPEG are supported.

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

@@ -15,20 +15,28 @@ require 'date'
 module CloudmersiveOcrApiClient
   # Result of recognizing a business card, to extract the key information from the business card
   class BusinessCardRecognitionResult
+    # True if the operation was successful, false otherwise
     attr_accessor :successful
 
+    # The name of the person printed on the business card (if included on the business card)
     attr_accessor :person_name
 
+    # The title of the person printed on the business card (if included on the business card)
     attr_accessor :person_title
 
+    # The name of the business printed on the business card (if included on the business card)
     attr_accessor :business_name
 
+    # The address printed on the business card (if included on the business card)
     attr_accessor :address_string
 
+    # The phone number printed on the business card (if included on the business card)
     attr_accessor :phone_number
 
+    # The email address printed on the business card (if included on the business card)
     attr_accessor :email_address
 
+    # The date and time printed on the business card (if included on the business card)
     attr_accessor :timestamp
 
 

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

@@ -15,8 +15,10 @@ require 'date'
 module CloudmersiveOcrApiClient
   # A pairing target field and actual value read from form
   class FieldResult
+    # Target field to extract from the form
     attr_accessor :target_field
 
+    # Result field value(s) extracted
     attr_accessor :field_values
 
 

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

@@ -15,20 +15,26 @@ require 'date'
 module CloudmersiveOcrApiClient
   # Definition of a form template; use a form template definition to recognize the fields in a form with Cloudmersive OCR
   class FormDefinitionTemplate
+    # Field definitions in the template; a field is comprised of a key/value pair
     attr_accessor :field_definitions
 
+    # Table definitions in the template; a table is comprised of columns and rows and exists in a 2-dimensional layout; a common example of a table would be an invoice
+    attr_accessor :table_definitions
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'field_definitions' => :'FieldDefinitions'
+        :'field_definitions' => :'FieldDefinitions',
+        :'table_definitions' => :'TableDefinitions'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'field_definitions' => :'Array<FormFieldDefinition>'
+        :'field_definitions' => :'Array<FormFieldDefinition>',
+        :'table_definitions' => :'Array<FormTableDefinition>'
       }
     end
 
@@ -46,6 +52,12 @@ module CloudmersiveOcrApiClient
         end
       end
 
+      if attributes.has_key?(:'TableDefinitions')
+        if (value = attributes[:'TableDefinitions']).is_a?(Array)
+          self.table_definitions = value
+        end
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -66,7 +78,8 @@ module CloudmersiveOcrApiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          field_definitions == o.field_definitions
+          field_definitions == o.field_definitions &&
+          table_definitions == o.table_definitions
     end
 
     # @see the `==` method
@@ -78,7 +91,7 @@ module CloudmersiveOcrApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [field_definitions].hash
+      [field_definitions, table_definitions].hash
     end
 
     # Builds the object from hash

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

@@ -15,30 +15,43 @@ require 'date'
 module CloudmersiveOcrApiClient
   # Definition of a form field for OCR data extraction from images
   class FormFieldDefinition
+    # The identifier of the field; use this to identify which field is being referenced
     attr_accessor :field_id
 
+    # Optional - the left-hand anchor of the field
     attr_accessor :left_anchor
 
+    # Optional - the top anchor of the field
     attr_accessor :top_anchor
 
+    # Optional - the matching mode for the anchor.  Possible values are Complete (requires the entire anchor to match) and Partial (allows only part of the anchor to match).  Default is Partial.
     attr_accessor :anchor_mode
 
+    # The data type of the field; possible values are INTEGER (Integer value), STRING (Arbitrary string value, spaces are permitted), DATE (Date in a structured format), DECIMAL (Decimal number), ALPHANUMERIC (Continuous alphanumeric string with no spaces), STRINGNOWHITESPACE (A string that contains no whitespace characters), SERIALNUMBER (A serial-number style string that contains letters and numbers, and certain symbols; must contain at least one number), ALPHAONLY (Alphabet characters only, no numbers or symbols or whitespace)
     attr_accessor :data_type
 
+    # Optional - the target number of digits in the field; useful for fixed-length fields
     attr_accessor :target_digit_count
 
+    # Optional - the target number of digits in the field; useful for fixed-length fields
     attr_accessor :minimum_character_count
 
+    # Optional - set to false to block values that contain numeric digits, set to true to allow numeric digits
     attr_accessor :allow_numeric_digits
 
+    # Vertical alignment of target value area relative to the field anchor; Possible values are VCenter, Top, Bottom
     attr_accessor :vertical_alignment_type
 
+    # Horizontal alignment of target value area relative to the field anchor; Possible values are Left, Right
     attr_accessor :horizontal_alignment_type
 
+    # Optional - scale factor for target field width - relative to width of field title; a value of 1.0 indicates the target value area has the same width as the field value as occurring in the image; a value of 2.0 would indicate that the target value area has 2 times the width of the field value as occurring in the image.
     attr_accessor :target_field_width_relative
 
+    # Optional - scale factor for target field height - relative to height of field title
     attr_accessor :target_field_height_relative
 
+    # Optional - Ignore any result items that contain a partial or complete match with these text strings
     attr_accessor :ignore
 
 

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

@@ -15,16 +15,22 @@ require 'date'
 module CloudmersiveOcrApiClient
   # The result of extracting form field values
   class FormRecognitionResult
+    # True if the operation was successful, false otherwise
     attr_accessor :successful
 
+    # Result of form field OCR data extraction
     attr_accessor :field_value_extraction_result
 
+    # Result of form table OCR data extraction
+    attr_accessor :table_value_extraction_results
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'successful' => :'Successful',
-        :'field_value_extraction_result' => :'FieldValueExtractionResult'
+        :'field_value_extraction_result' => :'FieldValueExtractionResult',
+        :'table_value_extraction_results' => :'TableValueExtractionResults'
       }
     end
 
@@ -32,7 +38,8 @@ module CloudmersiveOcrApiClient
     def self.swagger_types
       {
         :'successful' => :'BOOLEAN',
-        :'field_value_extraction_result' => :'Array<FieldResult>'
+        :'field_value_extraction_result' => :'Array<FieldResult>',
+        :'table_value_extraction_results' => :'Array<TableResult>'
       }
     end
 
@@ -54,6 +61,12 @@ module CloudmersiveOcrApiClient
         end
       end
 
+      if attributes.has_key?(:'TableValueExtractionResults')
+        if (value = attributes[:'TableValueExtractionResults']).is_a?(Array)
+          self.table_value_extraction_results = value
+        end
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -75,7 +88,8 @@ module CloudmersiveOcrApiClient
       return true if self.equal?(o)
       self.class == o.class &&
           successful == o.successful &&
-          field_value_extraction_result == o.field_value_extraction_result
+          field_value_extraction_result == o.field_value_extraction_result &&
+          table_value_extraction_results == o.table_value_extraction_results
     end
 
     # @see the `==` method
@@ -87,7 +101,7 @@ module CloudmersiveOcrApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [successful, field_value_extraction_result].hash
+      [successful, field_value_extraction_result, table_value_extraction_results].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,239 @@
+=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 column within a table for OCR data extraction from images
+  class FormTableColumnDefinition
+    # The identifier of the field; use this to identify which field is being referenced
+    attr_accessor :column_id
+
+    # Optional - the top anchor of the column heading
+    attr_accessor :top_anchor
+
+    # Optional - the matching mode for the anchor.  Possible values are Complete (requires the entire anchor to match) and Partial (allows only part of the anchor to match).  Default is Partial.
+    attr_accessor :anchor_mode
+
+    # The data type of the field; possible values are INTEGER (Integer value), STRING (Arbitrary string value, spaces are permitted), DATE (Date in a structured format), DECIMAL (Decimal number), ALPHANUMERIC (Continuous alphanumeric string with no spaces), STRINGNOWHITESPACE (A string that contains no whitespace characters), SERIALNUMBER (A serial-number style string that contains letters and numbers, and certain symbols; must contain at least one number), ALPHAONLY (Alphabet characters only, no numbers or symbols or whitespace)
+    attr_accessor :data_type
+
+    # Optional - the target number of digits in the field; useful for fixed-length fields
+    attr_accessor :minimum_character_count
+
+    # Optional - set to false to block values that contain numeric digits, set to true to allow numeric digits
+    attr_accessor :allow_numeric_digits
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'column_id' => :'ColumnID',
+        :'top_anchor' => :'TopAnchor',
+        :'anchor_mode' => :'AnchorMode',
+        :'data_type' => :'DataType',
+        :'minimum_character_count' => :'MinimumCharacterCount',
+        :'allow_numeric_digits' => :'AllowNumericDigits'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'column_id' => :'String',
+        :'top_anchor' => :'String',
+        :'anchor_mode' => :'String',
+        :'data_type' => :'String',
+        :'minimum_character_count' => :'Integer',
+        :'allow_numeric_digits' => :'BOOLEAN'
+      }
+    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?(:'ColumnID')
+        self.column_id = attributes[:'ColumnID']
+      end
+
+      if attributes.has_key?(:'TopAnchor')
+        self.top_anchor = attributes[:'TopAnchor']
+      end
+
+      if attributes.has_key?(:'AnchorMode')
+        self.anchor_mode = attributes[:'AnchorMode']
+      end
+
+      if attributes.has_key?(:'DataType')
+        self.data_type = attributes[:'DataType']
+      end
+
+      if attributes.has_key?(:'MinimumCharacterCount')
+        self.minimum_character_count = attributes[:'MinimumCharacterCount']
+      end
+
+      if attributes.has_key?(:'AllowNumericDigits')
+        self.allow_numeric_digits = attributes[:'AllowNumericDigits']
+      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 &&
+          column_id == o.column_id &&
+          top_anchor == o.top_anchor &&
+          anchor_mode == o.anchor_mode &&
+          data_type == o.data_type &&
+          minimum_character_count == o.minimum_character_count &&
+          allow_numeric_digits == o.allow_numeric_digits
+    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
+      [column_id, top_anchor, anchor_mode, data_type, minimum_character_count, allow_numeric_digits].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