cloudmersive-ocr-api-client 1.3.9 → 1.4.0

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

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

data/spec/api/image_ocr_api_spec.rb

@@ -72,11 +72,28 @@ describe 'ImageOcrApi' do
     end
   end
 
+  # unit tests for image_ocr_photo_recognize_form
+  # Recognize a photo of a form, extract key fields and business information
+  # 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.
+  # @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 'Advanced', enable handwriting recognition by specifying 'EnableHandwriting'.  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)
+  # @return [FormRecognitionResult]
+  describe 'image_ocr_photo_recognize_form 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.
   # @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 'Advanced', enable handwriting recognition by specifying 'EnableHandwriting'.  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)
   # @return [ReceiptRecognitionResult]
   describe 'image_ocr_photo_recognize_receipt test' do

data/spec/models/field_result_spec.rb

@@ -0,0 +1,48 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveOcrApiClient::FieldResult
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'FieldResult' do
+  before do
+    # run before each test
+    @instance = CloudmersiveOcrApiClient::FieldResult.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FieldResult' do
+    it 'should create an instance of FieldResult' do
+      expect(@instance).to be_instance_of(CloudmersiveOcrApiClient::FieldResult)
+    end
+  end
+  describe 'test attribute "target_field"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "field_values"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end
+

data/spec/models/form_definition_template_spec.rb

@@ -0,0 +1,42 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveOcrApiClient::FormDefinitionTemplate
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'FormDefinitionTemplate' do
+  before do
+    # run before each test
+    @instance = CloudmersiveOcrApiClient::FormDefinitionTemplate.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FormDefinitionTemplate' do
+    it 'should create an instance of FormDefinitionTemplate' do
+      expect(@instance).to be_instance_of(CloudmersiveOcrApiClient::FormDefinitionTemplate)
+    end
+  end
+  describe 'test attribute "field_definitions"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end
+

data/spec/models/form_field_definition_spec.rb

@@ -0,0 +1,114 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveOcrApiClient::FormFieldDefinition
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'FormFieldDefinition' do
+  before do
+    # run before each test
+    @instance = CloudmersiveOcrApiClient::FormFieldDefinition.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FormFieldDefinition' do
+    it 'should create an instance of FormFieldDefinition' do
+      expect(@instance).to be_instance_of(CloudmersiveOcrApiClient::FormFieldDefinition)
+    end
+  end
+  describe 'test attribute "field_id"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "left_anchor"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "top_anchor"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "anchor_mode"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "data_type"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "target_digit_count"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "minimum_character_count"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "allow_numeric_digits"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "vertical_alignment_type"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "horizontal_alignment_type"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "target_field_width_relative"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "target_field_height_relative"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "ignore"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end
+

data/spec/models/form_recognition_result_spec.rb

@@ -0,0 +1,48 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveOcrApiClient::FormRecognitionResult
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'FormRecognitionResult' do
+  before do
+    # run before each test
+    @instance = CloudmersiveOcrApiClient::FormRecognitionResult.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FormRecognitionResult' do
+    it 'should create an instance of FormRecognitionResult' do
+      expect(@instance).to be_instance_of(CloudmersiveOcrApiClient::FormRecognitionResult)
+    end
+  end
+  describe 'test attribute "successful"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "field_value_extraction_result"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end
+

data/spec/models/receipt_line_item_spec.rb

@@ -0,0 +1,48 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveOcrApiClient::ReceiptLineItem
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ReceiptLineItem' do
+  before do
+    # run before each test
+    @instance = CloudmersiveOcrApiClient::ReceiptLineItem.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ReceiptLineItem' do
+    it 'should create an instance of ReceiptLineItem' do
+      expect(@instance).to be_instance_of(CloudmersiveOcrApiClient::ReceiptLineItem)
+    end
+  end
+  describe 'test attribute "item_description"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "item_price"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end
+

data/spec/models/receipt_recognition_result_spec.rb

@@ -50,6 +50,12 @@ describe 'ReceiptRecognitionResult' do
     end
   end
 
+  describe 'test attribute "business_website"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "address_string"' do
     it 'should work' do
        # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -62,6 +68,12 @@ describe 'ReceiptRecognitionResult' do
     end
   end
 
+  describe 'test attribute "receipt_items"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "receipt_total"' do
     it 'should work' do
        # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudmersive-ocr-api-client
 version: !ruby/object:Gem::Version
-  version: 1.3.9
+  version: 1.4.0
 platform: ruby
 authors:
 - Cloudmersive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-21 00:00:00.000000000 Z
+date: 2019-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -202,6 +202,10 @@ files:
 - "./Rakefile"
 - "./cloudmersive-ocr-api-client.gemspec"
 - "./docs/BusinessCardRecognitionResult.md"
+- "./docs/FieldResult.md"
+- "./docs/FormDefinitionTemplate.md"
+- "./docs/FormFieldDefinition.md"
+- "./docs/FormRecognitionResult.md"
 - "./docs/GetPageAngleResult.md"
 - "./docs/ImageOcrApi.md"
 - "./docs/ImageToLinesWithLocationResult.md"
@@ -219,6 +223,7 @@ files:
 - "./docs/PdfToWordsWithLocationResult.md"
 - "./docs/PhotoToWordsWithLocationResult.md"
 - "./docs/PreprocessingApi.md"
+- "./docs/ReceiptLineItem.md"
 - "./docs/ReceiptRecognitionResult.md"
 - "./docs/ReceiptsApi.md"
 - "./git_push.sh"
@@ -231,6 +236,10 @@ files:
 - "./lib/cloudmersive-ocr-api-client/api_error.rb"
 - "./lib/cloudmersive-ocr-api-client/configuration.rb"
 - "./lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb"
+- "./lib/cloudmersive-ocr-api-client/models/field_result.rb"
+- "./lib/cloudmersive-ocr-api-client/models/form_definition_template.rb"
+- "./lib/cloudmersive-ocr-api-client/models/form_field_definition.rb"
+- "./lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb"
 - "./lib/cloudmersive-ocr-api-client/models/get_page_angle_result.rb"
 - "./lib/cloudmersive-ocr-api-client/models/image_to_lines_with_location_result.rb"
 - "./lib/cloudmersive-ocr-api-client/models/image_to_text_response.rb"
@@ -245,6 +254,7 @@ files:
 - "./lib/cloudmersive-ocr-api-client/models/pdf_to_text_response.rb"
 - "./lib/cloudmersive-ocr-api-client/models/pdf_to_words_with_location_result.rb"
 - "./lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb"
+- "./lib/cloudmersive-ocr-api-client/models/receipt_line_item.rb"
 - "./lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb"
 - "./lib/cloudmersive-ocr-api-client/version.rb"
 - "./spec/api/image_ocr_api_spec.rb"
@@ -254,6 +264,10 @@ files:
 - "./spec/api_client_spec.rb"
 - "./spec/configuration_spec.rb"
 - "./spec/models/business_card_recognition_result_spec.rb"
+- "./spec/models/field_result_spec.rb"
+- "./spec/models/form_definition_template_spec.rb"
+- "./spec/models/form_field_definition_spec.rb"
+- "./spec/models/form_recognition_result_spec.rb"
 - "./spec/models/get_page_angle_result_spec.rb"
 - "./spec/models/image_to_lines_with_location_result_spec.rb"
 - "./spec/models/image_to_text_response_spec.rb"
@@ -268,6 +282,7 @@ files:
 - "./spec/models/pdf_to_text_response_spec.rb"
 - "./spec/models/pdf_to_words_with_location_result_spec.rb"
 - "./spec/models/photo_to_words_with_location_result_spec.rb"
+- "./spec/models/receipt_line_item_spec.rb"
 - "./spec/models/receipt_recognition_result_spec.rb"
 - "./spec/spec_helper.rb"
 homepage: https://www.cloudmersive.com/ocr-api