cloudmersive-ocr-api-client 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca2c53e42948b6d1ae8597d4badb4b573fb8e9bdf661319b83bc6a62e7ecaf5f
-  data.tar.gz: c80039f487048c1fd30fb40b9cb61328b00b7a7c080e61a69bfe92b2fdbcc62c
+  metadata.gz: d5daaa7a09ae31d9b73a83371af2dbaecee566850228fa9bf8a14f6d8b33d136
+  data.tar.gz: 1dbf9618622d1d68031a7cafc28561892c4085827e3467521c2c054d4c560285
 SHA512:
-  metadata.gz: 2f0252b2e52b133d8da1ef2a11ddc3d1fa0d828930d7a6c2c53914e5324427d098a6eb9d862d0a909d199db7e382b2a0478c408597cac0c31a457d8297684d50
-  data.tar.gz: c5bac0390c43fbad905cd4f03fc7667444dd76e57aa7373a3c422917bf38b280a301c4775c58745f65504b57dfe4356503ef4c8528a71a397a6745ef05239cd2
+  metadata.gz: fc3ec7df8c1063b3c7047f7a5123e47de7bd90f70c77232ad23ef72689e3811c1c8c89e3c96821ef54c008db3129a84aa23b431e83259166c8eed98410408795
+  data.tar.gz: 1e41349621d3f6e4d65d99280b2ce14d57db759858edd4aff8943c2105fc95a357fd4095e83747d24b751335617bd220301f003b5077b57e2c2cdaeb2228cf79

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.4.2
+- Package version: 1.4.3
 - 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.4.2.gem
+gem install ./cloudmersive-ocr-api-client-1.4.3.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-ocr-api-client-1.4.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-ocr-api-client-1.4.3.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.4.2'
+    gem 'cloudmersive-ocr-api-client', '~> 1.4.3'
 
 ### Install from Git
 
@@ -91,6 +91,7 @@ Class | Method | HTTP request | Description
 *CloudmersiveOcrApiClient::ImageOcrApi* | [**image_ocr_image_words_with_location**](docs/ImageOcrApi.md#image_ocr_image_words_with_location) | **POST** /ocr/image/to/words-with-location | Convert a scanned image into words with location
 *CloudmersiveOcrApiClient::ImageOcrApi* | [**image_ocr_photo_recognize_business_card**](docs/ImageOcrApi.md#image_ocr_photo_recognize_business_card) | **POST** /ocr/photo/recognize/business-card | Recognize a photo of a business card, extract key business information
 *CloudmersiveOcrApiClient::ImageOcrApi* | [**image_ocr_photo_recognize_form**](docs/ImageOcrApi.md#image_ocr_photo_recognize_form) | **POST** /ocr/photo/recognize/form | Recognize a photo of a form, extract key fields and business information
+*CloudmersiveOcrApiClient::ImageOcrApi* | [**image_ocr_photo_recognize_form_advanced**](docs/ImageOcrApi.md#image_ocr_photo_recognize_form_advanced) | **POST** /ocr/photo/recognize/form/advanced | Recognize a photo of a form, extract key fields using stored templates
 *CloudmersiveOcrApiClient::ImageOcrApi* | [**image_ocr_photo_recognize_receipt**](docs/ImageOcrApi.md#image_ocr_photo_recognize_receipt) | **POST** /ocr/photo/recognize/receipt | Recognize a photo of a receipt, extract key business information
 *CloudmersiveOcrApiClient::ImageOcrApi* | [**image_ocr_photo_to_text**](docs/ImageOcrApi.md#image_ocr_photo_to_text) | **POST** /ocr/photo/toText | Convert a photo of a document into text
 *CloudmersiveOcrApiClient::ImageOcrApi* | [**image_ocr_photo_words_with_location**](docs/ImageOcrApi.md#image_ocr_photo_words_with_location) | **POST** /ocr/photo/to/words-with-location | Convert a photo of a document or receipt into words with location

data/docs/ImageOcrApi.md

@@ -8,6 +8,7 @@ Method | HTTP request | Description
 [**image_ocr_image_words_with_location**](ImageOcrApi.md#image_ocr_image_words_with_location) | **POST** /ocr/image/to/words-with-location | Convert a scanned image into words with location
 [**image_ocr_photo_recognize_business_card**](ImageOcrApi.md#image_ocr_photo_recognize_business_card) | **POST** /ocr/photo/recognize/business-card | Recognize a photo of a business card, extract key business information
 [**image_ocr_photo_recognize_form**](ImageOcrApi.md#image_ocr_photo_recognize_form) | **POST** /ocr/photo/recognize/form | Recognize a photo of a form, extract key fields and business information
+[**image_ocr_photo_recognize_form_advanced**](ImageOcrApi.md#image_ocr_photo_recognize_form_advanced) | **POST** /ocr/photo/recognize/form/advanced | Recognize a photo of a form, extract key fields using stored templates
 [**image_ocr_photo_recognize_receipt**](ImageOcrApi.md#image_ocr_photo_recognize_receipt) | **POST** /ocr/photo/recognize/receipt | Recognize a photo of a receipt, extract key business information
 [**image_ocr_photo_to_text**](ImageOcrApi.md#image_ocr_photo_to_text) | **POST** /ocr/photo/toText | Convert a photo of a document into text
 [**image_ocr_photo_words_with_location**](ImageOcrApi.md#image_ocr_photo_words_with_location) | **POST** /ocr/photo/to/words-with-location | Convert a photo of a document or receipt into words with location
@@ -252,6 +253,70 @@ Name | Type | Description  | Notes
 
 
 
+# **image_ocr_photo_recognize_form_advanced**
+> FormRecognitionResult image_ocr_photo_recognize_form_advanced(image_file, opts)
+
+Recognize a photo of a form, extract key fields using stored templates
+
+Analyzes a photograph of a form as input, and outputs key business fields and information.  Customzie data to be extracted by defining fields for the form.  Uses template definitions stored in Cloudmersive Configuration; to configure stored templates in a configuration bucket, log into Cloudmersive Management Portal and navigate to Settings > API Configuration > Create Bucket
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-ocr-api-client'
+# setup authorization
+CloudmersiveOcrApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveOcrApiClient::ImageOcrApi.new
+
+image_file = File.new("/path/to/file.txt") # File | Image file to perform OCR on.  Common file formats such as PNG, JPEG are supported.
+
+opts = { 
+  bucket_id: "bucket_id_example", # String | Bucket ID of the Configuration Bucket storing the form templates
+  bucket_secret_key: "bucket_secret_key_example", # String | Bucket Secret Key of the Configuration Bucket storing the form templates
+  recognition_mode: "recognition_mode_example", # String | Optional, enable advanced recognition mode by specifying 'Advanced', enable handwriting recognition by specifying 'EnableHandwriting'.  Default is disabled.
+  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 - 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.
+}
+
+begin
+  #Recognize a photo of a form, extract key fields using stored templates
+  result = api_instance.image_ocr_photo_recognize_form_advanced(image_file, opts)
+  p result
+rescue CloudmersiveOcrApiClient::ApiError => e
+  puts "Exception when calling ImageOcrApi->image_ocr_photo_recognize_form_advanced: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **image_file** | **File**| Image file to perform OCR on.  Common file formats such as PNG, JPEG are supported. | 
+ **bucket_id** | **String**| Bucket ID of the Configuration Bucket storing the form templates | [optional] 
+ **bucket_secret_key** | **String**| Bucket Secret Key of the Configuration Bucket storing the form templates | [optional] 
+ **recognition_mode** | **String**| Optional, enable advanced recognition mode by specifying 'Advanced', enable handwriting recognition by specifying 'EnableHandwriting'.  Default is disabled. | [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 - 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. | [optional] 
+
+### Return type
+
+[**FormRecognitionResult**](FormRecognitionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **image_ocr_photo_recognize_receipt**
 > ReceiptRecognitionResult image_ocr_photo_recognize_receipt(image_file, opts)
 

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

@@ -268,6 +268,74 @@ module CloudmersiveOcrApiClient
       return data, status_code, headers
     end
 
+    # Recognize a photo of a form, extract key fields using stored templates
+    # Analyzes a photograph of a form as input, and outputs key business fields and information.  Customzie data to be extracted by defining fields for the form.  Uses template definitions stored in Cloudmersive Configuration; to configure stored templates in a configuration bucket, log into Cloudmersive Management Portal and navigate to Settings > API Configuration > Create Bucket
+    # @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] :bucket_id Bucket ID of the Configuration Bucket storing the form templates
+    # @option opts [String] :bucket_secret_key Bucket Secret Key of the Configuration Bucket storing the form templates
+    # @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.
+    # @return [FormRecognitionResult]
+    def image_ocr_photo_recognize_form_advanced(image_file, opts = {})
+      data, _status_code, _headers = image_ocr_photo_recognize_form_advanced_with_http_info(image_file, opts)
+      return data
+    end
+
+    # Recognize a photo of a form, extract key fields using stored templates
+    # Analyzes a photograph of a form as input, and outputs key business fields and information.  Customzie data to be extracted by defining fields for the form.  Uses template definitions stored in Cloudmersive Configuration; to configure stored templates in a configuration bucket, log into Cloudmersive Management Portal and navigate to Settings > API Configuration > Create Bucket
+    # @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] :bucket_id Bucket ID of the Configuration Bucket storing the form templates
+    # @option opts [String] :bucket_secret_key Bucket Secret Key of the Configuration Bucket storing the form templates
+    # @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.
+    # @return [Array<(FormRecognitionResult, Fixnum, Hash)>] FormRecognitionResult data, response status code and response headers
+    def image_ocr_photo_recognize_form_advanced_with_http_info(image_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ImageOcrApi.image_ocr_photo_recognize_form_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 ImageOcrApi.image_ocr_photo_recognize_form_advanced"
+      end
+      # resource path
+      local_var_path = "/ocr/photo/recognize/form/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'])
+      header_params[:'bucketID'] = opts[:'bucket_id'] if !opts[:'bucket_id'].nil?
+      header_params[:'bucketSecretKey'] = opts[:'bucket_secret_key'] if !opts[:'bucket_secret_key'].nil?
+      header_params[:'recognitionMode'] = opts[:'recognition_mode'] if !opts[:'recognition_mode'].nil?
+      header_params[:'preprocessing'] = opts[:'preprocessing'] if !opts[:'preprocessing'].nil?
+
+      # 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 => 'FormRecognitionResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ImageOcrApi#image_ocr_photo_recognize_form_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Recognize a photo of a receipt, extract key business information
     # 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.

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

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

data/spec/api/image_ocr_api_spec.rb

@@ -88,6 +88,22 @@ describe 'ImageOcrApi' do
     end
   end
 
+  # unit tests for image_ocr_photo_recognize_form_advanced
+  # Recognize a photo of a form, extract key fields using stored templates
+  # Analyzes a photograph of a form as input, and outputs key business fields and information.  Customzie data to be extracted by defining fields for the form.  Uses template definitions stored in Cloudmersive Configuration; to configure stored templates in a configuration bucket, log into Cloudmersive Management Portal and navigate to Settings > API Configuration > Create Bucket
+  # @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] :bucket_id Bucket ID of the Configuration Bucket storing the form templates
+  # @option opts [String] :bucket_secret_key Bucket Secret Key of the Configuration Bucket storing the form templates
+  # @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.
+  # @return [FormRecognitionResult]
+  describe 'image_ocr_photo_recognize_form_advanced test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for image_ocr_photo_recognize_receipt
   # Recognize a photo of a receipt, extract key business information
   # 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.

metadata

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