cloudmersive-ocr-api-client 1.3.5 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37f50fd7764a8a7bc526bea186b74a8d29209bae63a30061a695946775570ee0
-  data.tar.gz: 5056bd844cfa0b6041a81a20577780e605a93fad757c92f3c923f231da535023
+  metadata.gz: f1b5a3699492d2fa535b5173b9607a76c1a754a9d59f0049baadc3f563514dce
+  data.tar.gz: 5e7e7a8ea78364e15871ceb77e70dc93deeeb9acf59dbfc6c17a87fd872bd713
 SHA512:
-  metadata.gz: 1bba5aec42d5498ec2397f9e385749093683c0b96951b3cec3bbd7af8d571f682c880b277e499101b4ed151b60cb34a4c3ec7fe1538d1c2b923f9451a8616283
-  data.tar.gz: b11a833bee4add22b521fbab250822a801fdcef0737dafcb7fb0e7dea8ceea7ebb4f9db44ccd0c1adb7c251a93f058db7e43cdca998661e499523fa993328497
+  metadata.gz: 53f1cad544f7617a7fcd659485d90f0a52fedf533f1acc0d8af3597fa1a8453f79d791fe8f9e42304a87716ba82fc0999aebc30d45836cf2d695c59848e6b1e4
+  data.tar.gz: 79db60a648f53388aa622270ad581df86702759830fd9f5660f1df2b537b45a2f315054cad95f98b8ee9c7ede349b3dfe8327bca827f1d9b7505c1848b4861dc

data/README.md

@@ -7,7 +7,7 @@ The powerful Optical Character Recognition (OCR) APIs let you convert scanned im
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 1.3.5
+- Package version: 1.3.7
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-ocr-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-ocr-api-client-1.3.5.gem
+gem install ./cloudmersive-ocr-api-client-1.3.7.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-ocr-api-client-1.3.5.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-ocr-api-client-1.3.7.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cloudmersive-ocr-api-client', '~> 1.3.5'
+    gem 'cloudmersive-ocr-api-client', '~> 1.3.7'
 
 ### Install from Git
 

data/docs/ImageOcrApi.md

@@ -214,7 +214,8 @@ image_file = File.new("/path/to/file.txt") # File | Image file to perform OCR on
 
 opts = { 
   language: "language_example", # String | 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)
-  preprocessing: "preprocessing_example" # String | Optional, preprocessing mode, default is 'Auto'.  Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended).
+  preprocessing: "preprocessing_example", # String | Optional, preprocessing mode, default is 'Auto'.  Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended).
+  diagnostics: "diagnostics_example" # String | Optional, diagnostics mode, default is 'false'.  Possible values are 'true' (will set DiagnosticImage to a diagnostic PNG image in the result), and 'false' (no diagnostics are enabled; this is recommended for best performance).
 }
 
 begin
@@ -233,6 +234,7 @@ Name | Type | Description  | Notes
  **image_file** | **File**| Image file to perform OCR on.  Common file formats such as PNG, JPEG are supported. | 
  **language** | **String**| 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) | [optional] 
  **preprocessing** | **String**| Optional, preprocessing mode, default is 'Auto'.  Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended). | [optional] 
+ **diagnostics** | **String**| Optional, diagnostics mode, default is 'false'.  Possible values are 'true' (will set DiagnosticImage to a diagnostic PNG image in the result), and 'false' (no diagnostics are enabled; this is recommended for best performance). | [optional] 
 
 ### Return type
 

data/docs/PhotoToWordsWithLocationResult.md

@@ -5,5 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **successful** | **BOOLEAN** |  | [optional] 
 **text_elements** | [**Array<OcrPhotoTextElement>**](OcrPhotoTextElement.md) | Word elements in the image | [optional] 
+**diagnostic_image** | **String** | Typically null.  To analyze OCR performance, enable diagnostic mode by adding the HTTP header \"DiagnosticMode\" with the value \"true\".  When this is true, a diagnostic image showing the details of the OCR result will be set in PNG format into DiagnosticImage. | [optional] 
 
 

data/docs/PreprocessingApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 
 # **preprocessing_binarize**
-> Object preprocessing_binarize(image_file)
+> String preprocessing_binarize(image_file)
 
 Convert an image of text into a binarized (light and dark) view
 
@@ -52,7 +52,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-**Object**
+**String**
 
 ### Authorization
 
@@ -66,7 +66,7 @@ Name | Type | Description  | Notes
 
 
 # **preprocessing_binarize_advanced**
-> Object preprocessing_binarize_advanced(image_file)
+> String preprocessing_binarize_advanced(image_file)
 
 Convert an image of text into a binary (light and dark) view with ML
 
@@ -106,7 +106,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-**Object**
+**String**
 
 ### Authorization
 
@@ -174,7 +174,7 @@ Name | Type | Description  | Notes
 
 
 # **preprocessing_unrotate**
-> Object preprocessing_unrotate(image_file)
+> String preprocessing_unrotate(image_file)
 
 Detect and unrotate a document image
 
@@ -214,7 +214,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-**Object**
+**String**
 
 ### Authorization
 
@@ -228,7 +228,7 @@ Name | Type | Description  | Notes
 
 
 # **preprocessing_unskew**
-> Object preprocessing_unskew(image_file)
+> String preprocessing_unskew(image_file)
 
 Detect and unskew a photo of a document
 
@@ -268,7 +268,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-**Object**
+**String**
 
 ### Authorization
 

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

@@ -209,6 +209,7 @@ module CloudmersiveOcrApiClient
     # @param [Hash] opts the optional parameters
     # @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 'Auto'.  Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended).
+    # @option opts [String] :diagnostics Optional, diagnostics mode, default is 'false'.  Possible values are 'true' (will set DiagnosticImage to a diagnostic PNG image in the result), and 'false' (no diagnostics are enabled; this is recommended for best performance).
     # @return [PhotoToWordsWithLocationResult]
     def image_ocr_photo_words_with_location(image_file, opts = {})
       data, _status_code, _headers = image_ocr_photo_words_with_location_with_http_info(image_file, opts)
@@ -221,6 +222,7 @@ module CloudmersiveOcrApiClient
     # @param [Hash] opts the optional parameters
     # @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 'Auto'.  Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended).
+    # @option opts [String] :diagnostics Optional, diagnostics mode, default is 'false'.  Possible values are 'true' (will set DiagnosticImage to a diagnostic PNG image in the result), and 'false' (no diagnostics are enabled; this is recommended for best performance).
     # @return [Array<(PhotoToWordsWithLocationResult, Fixnum, Hash)>] PhotoToWordsWithLocationResult data, response status code and response headers
     def image_ocr_photo_words_with_location_with_http_info(image_file, opts = {})
       if @api_client.config.debugging
@@ -244,6 +246,7 @@ module CloudmersiveOcrApiClient
       header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
       header_params[:'language'] = opts[:'language'] if !opts[:'language'].nil?
       header_params[:'preprocessing'] = opts[:'preprocessing'] if !opts[:'preprocessing'].nil?
+      header_params[:'diagnostics'] = opts[:'diagnostics'] if !opts[:'diagnostics'].nil?
 
       # form parameters
       form_params = {}

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

@@ -24,7 +24,7 @@ module CloudmersiveOcrApiClient
     # Perform an adaptive binarization algorithm on the input image to prepare it for further OCR operations.
     # @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 [Object]
+    # @return [String]
     def preprocessing_binarize(image_file, opts = {})
       data, _status_code, _headers = preprocessing_binarize_with_http_info(image_file, opts)
       return data
@@ -34,7 +34,7 @@ module CloudmersiveOcrApiClient
     # Perform an adaptive binarization algorithm on the input image to prepare it for further OCR operations.
     # @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<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
     def preprocessing_binarize_with_http_info(image_file, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: PreprocessingApi.preprocessing_binarize ..."
@@ -69,7 +69,7 @@ module CloudmersiveOcrApiClient
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Object')
+        :return_type => 'String')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_binarize\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -80,7 +80,7 @@ module CloudmersiveOcrApiClient
     # Perform an advanced adaptive, Deep Learning-based binarization algorithm on the input image to prepare it for further OCR operations.  Provides enhanced accuracy than adaptive binarization.  Image will be upsampled to 300 DPI if it has a DPI below 300.
     # @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 [Object]
+    # @return [String]
     def preprocessing_binarize_advanced(image_file, opts = {})
       data, _status_code, _headers = preprocessing_binarize_advanced_with_http_info(image_file, opts)
       return data
@@ -90,7 +90,7 @@ module CloudmersiveOcrApiClient
     # Perform an advanced adaptive, Deep Learning-based binarization algorithm on the input image to prepare it for further OCR operations.  Provides enhanced accuracy than adaptive binarization.  Image will be upsampled to 300 DPI if it has a DPI below 300.
     # @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<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
     def preprocessing_binarize_advanced_with_http_info(image_file, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: PreprocessingApi.preprocessing_binarize_advanced ..."
@@ -125,7 +125,7 @@ module CloudmersiveOcrApiClient
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Object')
+        :return_type => 'String')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_binarize_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -192,7 +192,7 @@ module CloudmersiveOcrApiClient
     # Detect and unrotate an image of a document (e.g. that was scanned at an angle).  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 [Object]
+    # @return [String]
     def preprocessing_unrotate(image_file, opts = {})
       data, _status_code, _headers = preprocessing_unrotate_with_http_info(image_file, opts)
       return data
@@ -202,7 +202,7 @@ module CloudmersiveOcrApiClient
     # Detect and unrotate an image of a document (e.g. that was scanned at an angle).  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<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
     def preprocessing_unrotate_with_http_info(image_file, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: PreprocessingApi.preprocessing_unrotate ..."
@@ -237,7 +237,7 @@ module CloudmersiveOcrApiClient
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Object')
+        :return_type => 'String')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_unrotate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -248,7 +248,7 @@ module CloudmersiveOcrApiClient
     # 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.
     # @param [Hash] opts the optional parameters
-    # @return [Object]
+    # @return [String]
     def preprocessing_unskew(image_file, opts = {})
       data, _status_code, _headers = preprocessing_unskew_with_http_info(image_file, opts)
       return data
@@ -258,7 +258,7 @@ module CloudmersiveOcrApiClient
     # 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.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
     def preprocessing_unskew_with_http_info(image_file, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: PreprocessingApi.preprocessing_unskew ..."
@@ -293,7 +293,7 @@ module CloudmersiveOcrApiClient
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Object')
+        :return_type => 'String')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_unskew\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

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

@@ -20,12 +20,16 @@ module CloudmersiveOcrApiClient
     # Word elements in the image
     attr_accessor :text_elements
 
+    # Typically null.  To analyze OCR performance, enable diagnostic mode by adding the HTTP header \"DiagnosticMode\" with the value \"true\".  When this is true, a diagnostic image showing the details of the OCR result will be set in PNG format into DiagnosticImage.
+    attr_accessor :diagnostic_image
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'successful' => :'Successful',
-        :'text_elements' => :'TextElements'
+        :'text_elements' => :'TextElements',
+        :'diagnostic_image' => :'DiagnosticImage'
       }
     end
 
@@ -33,7 +37,8 @@ module CloudmersiveOcrApiClient
     def self.swagger_types
       {
         :'successful' => :'BOOLEAN',
-        :'text_elements' => :'Array<OcrPhotoTextElement>'
+        :'text_elements' => :'Array<OcrPhotoTextElement>',
+        :'diagnostic_image' => :'String'
       }
     end
 
@@ -55,28 +60,49 @@ module CloudmersiveOcrApiClient
         end
       end
 
+      if attributes.has_key?(:'DiagnosticImage')
+        self.diagnostic_image = attributes[:'DiagnosticImage']
+      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
+      if !@diagnostic_image.nil? && @diagnostic_image !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+        invalid_properties.push("invalid value for 'diagnostic_image', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.")
+      end
+
       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 false if !@diagnostic_image.nil? && @diagnostic_image !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
       return true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] diagnostic_image Value to be assigned
+    def diagnostic_image=(diagnostic_image)
+
+      if !diagnostic_image.nil? && diagnostic_image !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+        fail ArgumentError, "invalid value for 'diagnostic_image', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/."
+      end
+
+      @diagnostic_image = diagnostic_image
+    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 &&
           successful == o.successful &&
-          text_elements == o.text_elements
+          text_elements == o.text_elements &&
+          diagnostic_image == o.diagnostic_image
     end
 
     # @see the `==` method
@@ -88,7 +114,7 @@ module CloudmersiveOcrApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [successful, text_elements].hash
+      [successful, text_elements, diagnostic_image].hash
     end
 
     # Builds the object from hash

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

@@ -11,5 +11,5 @@ Swagger Codegen version: unset
 =end
 
 module CloudmersiveOcrApiClient
-  VERSION = "1.3.5"
+  VERSION = "1.3.7"
 end

data/spec/api/image_ocr_api_spec.rb

@@ -80,6 +80,7 @@ describe 'ImageOcrApi' do
   # @param [Hash] opts the optional parameters
   # @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 'Auto'.  Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended).
+  # @option opts [String] :diagnostics Optional, diagnostics mode, default is 'false'.  Possible values are 'true' (will set DiagnosticImage to a diagnostic PNG image in the result), and 'false' (no diagnostics are enabled; this is recommended for best performance).
   # @return [PhotoToWordsWithLocationResult]
   describe 'image_ocr_photo_words_with_location test' do
     it "should work" do

data/spec/api/preprocessing_api_spec.rb

@@ -37,7 +37,7 @@ describe 'PreprocessingApi' do
   # Perform an adaptive binarization algorithm on the input image to prepare it for further OCR operations.
   # @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 [Object]
+  # @return [String]
   describe 'preprocessing_binarize test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -49,7 +49,7 @@ describe 'PreprocessingApi' do
   # Perform an advanced adaptive, Deep Learning-based binarization algorithm on the input image to prepare it for further OCR operations.  Provides enhanced accuracy than adaptive binarization.  Image will be upsampled to 300 DPI if it has a DPI below 300.
   # @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 [Object]
+  # @return [String]
   describe 'preprocessing_binarize_advanced test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -73,7 +73,7 @@ describe 'PreprocessingApi' do
   # Detect and unrotate an image of a document (e.g. that was scanned at an angle).  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 [Object]
+  # @return [String]
   describe 'preprocessing_unrotate test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -85,7 +85,7 @@ describe 'PreprocessingApi' do
   # 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.
   # @param [Hash] opts the optional parameters
-  # @return [Object]
+  # @return [String]
   describe 'preprocessing_unskew test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/photo_to_words_with_location_result_spec.rb

@@ -44,5 +44,11 @@ describe 'PhotoToWordsWithLocationResult' do
     end
   end
 
+  describe 'test attribute "diagnostic_image"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudmersive-ocr-api-client
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.7
 platform: ruby
 authors:
 - Cloudmersive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-06 00:00:00.000000000 Z
+date: 2019-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus