cloudmersive-image-recognition-api-client 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28d47f3b97ad2eb1de71ef4973102482bd9ce25fcc57f5317bd63fe6f79b1b23
-  data.tar.gz: 1deafa860293ddf923f7ea597778a2424a13c8e3dd4dcd6ea725da744d8f6219
+  metadata.gz: ea70ccc435e1f0ee8a2b269f8a0c363576d3198ce354015ccb5b4ef0d96e22e8
+  data.tar.gz: fa0146a4a8c4232cd558fcc9ece0eac20437f39ed12dafe8628d26357a22bf1f
 SHA512:
-  metadata.gz: 85885ad1774529b094f81a7e091df07ed60b22a9e1ee0796900741d5205c787cb79bbb46945d42c1fc0578bba7c42339ae3512c304324e7b9354202126a163da
-  data.tar.gz: 89bab982050f215252ac237a0fcba21fe0085caf865d280e433a54e19100b0084967b1e09d96663496cb42efb8329bc5a9ae6a27cc0bd460a082b8825488f8b9
+  metadata.gz: f03f2300a42454d1b0b39dfa9a91cdf3be4487d0e32c1e5e33209288285a7b0f7c74509ca4ecba9575dcb590ef75533166731063b87de7c06de884e4ae4f78de
+  data.tar.gz: 340623f2a202ef9894f9ec812ebe59da6118f5e0358400e34d1058472c3130f5e15b7063b1372e250592ba4849dfebce2d3d72e546a7b2a5b4aec0a3138a676f

data/README.md

@@ -7,7 +7,7 @@ Image Recognition and Processing APIs let you use Machine Learning to recognize
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 1.3.0
+- Package version: 1.3.1
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-image-recognition-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-image-recognition-api-client-1.3.0.gem
+gem install ./cloudmersive-image-recognition-api-client-1.3.1.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-image-recognition-api-client-1.3.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-image-recognition-api-client-1.3.1.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-image-recognition-api-client', '~> 1.3.0'
+    gem 'cloudmersive-image-recognition-api-client', '~> 1.3.1'
 
 ### Install from Git
 
@@ -100,6 +100,8 @@ Class | Method | HTTP request | Description
 *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_and_unskew_document**](docs/RecognizeApi.md#recognize_detect_and_unskew_document) | **POST** /image/recognize/detect-document/unskew | Detect and unskew a photo of a document
 *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_objects**](docs/RecognizeApi.md#recognize_detect_objects) | **POST** /image/recognize/detect-objects | Detect objects, including types and locations, in an image
 *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_people**](docs/RecognizeApi.md#recognize_detect_people) | **POST** /image/recognize/detect-people | Detect people, including locations, in an image
+*CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_text_fine**](docs/RecognizeApi.md#recognize_detect_text_fine) | **POST** /image/recognize/detect-text/fine | Detect fine text in a photo of a document
+*CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_text_large**](docs/RecognizeApi.md#recognize_detect_text_large) | **POST** /image/recognize/detect-text/large | Detect large text in a photo
 *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_vehicle_license_plates**](docs/RecognizeApi.md#recognize_detect_vehicle_license_plates) | **POST** /image/recognize/detect-vehicle-license-plates | Detect vehicle license plates in an image
 *CloudmersiveImageRecognitionApiClient::ResizeApi* | [**resize_post**](docs/ResizeApi.md#resize_post) | **POST** /image/resize/preserveAspectRatio/{maxWidth}/{maxHeight} | Resize an image with parameters
 
@@ -120,11 +122,15 @@ Class | Method | HTTP request | Description
  - [CloudmersiveImageRecognitionApiClient::FaceMatch](docs/FaceMatch.md)
  - [CloudmersiveImageRecognitionApiClient::FacePoint](docs/FacePoint.md)
  - [CloudmersiveImageRecognitionApiClient::FaceWithLandmarks](docs/FaceWithLandmarks.md)
+ - [CloudmersiveImageRecognitionApiClient::FineTextDetectionResult](docs/FineTextDetectionResult.md)
+ - [CloudmersiveImageRecognitionApiClient::FineTextItem](docs/FineTextItem.md)
  - [CloudmersiveImageRecognitionApiClient::ImageDescriptionResponse](docs/ImageDescriptionResponse.md)
  - [CloudmersiveImageRecognitionApiClient::NsfwResult](docs/NsfwResult.md)
  - [CloudmersiveImageRecognitionApiClient::ObjectDetectionResult](docs/ObjectDetectionResult.md)
  - [CloudmersiveImageRecognitionApiClient::PersonWithAge](docs/PersonWithAge.md)
  - [CloudmersiveImageRecognitionApiClient::RecognitionOutcome](docs/RecognitionOutcome.md)
+ - [CloudmersiveImageRecognitionApiClient::TextDetectionResult](docs/TextDetectionResult.md)
+ - [CloudmersiveImageRecognitionApiClient::TextItem](docs/TextItem.md)
  - [CloudmersiveImageRecognitionApiClient::VehicleLicensePlateDetectionResult](docs/VehicleLicensePlateDetectionResult.md)
 
 

data/cloudmersive-image-recognition-api-client.gemspec

@@ -8,7 +8,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 

data/docs/FineTextDetectionResult.md

@@ -0,0 +1,10 @@
+# CloudmersiveImageRecognitionApiClient::FineTextDetectionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**text_items** | [**Array<FineTextItem>**](FineTextItem.md) | Text items found in the input image | [optional] 
+**text_items_count** | **Integer** | Count of text items found in the input image | [optional] 
+
+

data/docs/FineTextItem.md

@@ -0,0 +1,15 @@
+# CloudmersiveImageRecognitionApiClient::FineTextItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**top_left_x** | **Integer** | X coordinate of the top/left text location; 0 represents the left edge of the input image | [optional] 
+**top_left_y** | **Integer** | Y coordinate of the top/left text location; 0 represents the top edge of the input image | [optional] 
+**top_right_x** | **Integer** | X coordinate of the top/right text location; 0 represents the left edge of the input image | [optional] 
+**top_right_y** | **Integer** | Y coordinate of the top/right text location; 0 represents the top edge of the input image | [optional] 
+**bottom_left_x** | **Integer** | X coordinate of the bottom/left text location; 0 represents the left edge of the input image | [optional] 
+**bottom_left_y** | **Integer** | Y coordinate of the bottom/left text location; 0 represents the top edge of the input image | [optional] 
+**bottom_right_x** | **Integer** | X coordinate of the bottom/right text location; 0 represents the left edge of the input image | [optional] 
+**bottom_right_y** | **Integer** | Y coordinate of the bottom/right text location; 0 represents the top edge of the input image | [optional] 
+
+

data/docs/RecognizeApi.md

@@ -8,6 +8,8 @@ Method | HTTP request | Description
 [**recognize_detect_and_unskew_document**](RecognizeApi.md#recognize_detect_and_unskew_document) | **POST** /image/recognize/detect-document/unskew | Detect and unskew a photo of a document
 [**recognize_detect_objects**](RecognizeApi.md#recognize_detect_objects) | **POST** /image/recognize/detect-objects | Detect objects, including types and locations, in an image
 [**recognize_detect_people**](RecognizeApi.md#recognize_detect_people) | **POST** /image/recognize/detect-people | Detect people, including locations, in an image
+[**recognize_detect_text_fine**](RecognizeApi.md#recognize_detect_text_fine) | **POST** /image/recognize/detect-text/fine | Detect fine text in a photo of a document
+[**recognize_detect_text_large**](RecognizeApi.md#recognize_detect_text_large) | **POST** /image/recognize/detect-text/large | Detect large text in a photo
 [**recognize_detect_vehicle_license_plates**](RecognizeApi.md#recognize_detect_vehicle_license_plates) | **POST** /image/recognize/detect-vehicle-license-plates | Detect vehicle license plates in an image
 
 
@@ -231,6 +233,108 @@ Name | Type | Description  | Notes
 
 
 
+# **recognize_detect_text_fine**
+> FineTextDetectionResult recognize_detect_text_fine(image_file)
+
+Detect fine text in a photo of a document
+
+Identify the position, and size of small/fine text within a photograph of a document.  Identify the location of small text in a photo - such as words and other forms of high density text.  Can be used on a scan of a document or a photograph (e.g. smartphone camera) of a document, page or receipt.  For OCR purposes - please see our Deep Learning OCR APIs.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-image-recognition-api-client'
+# setup authorization
+CloudmersiveImageRecognitionApiClient.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 = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
+
+image_file = File.new("/path/to/file.txt") # File | Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
+
+
+begin
+  #Detect fine text in a photo of a document
+  result = api_instance.recognize_detect_text_fine(image_file)
+  p result
+rescue CloudmersiveImageRecognitionApiClient::ApiError => e
+  puts "Exception when calling RecognizeApi->recognize_detect_text_fine: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **image_file** | **File**| Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported. | 
+
+### Return type
+
+[**FineTextDetectionResult**](FineTextDetectionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **recognize_detect_text_large**
+> TextDetectionResult recognize_detect_text_large
+
+Detect large text in a photo
+
+Identify the position, and size of large text within a photograph.  Identify the location of large text in a photo - such as signs, titles, etc. and other forms of large, low-density text.  Not suitable for high-density text (e.g. scans of documents, receipts, etc.) for OCR purposes - for OCR, please see our Deep Learning OCR APIs.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-image-recognition-api-client'
+# setup authorization
+CloudmersiveImageRecognitionApiClient.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 = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
+
+begin
+  #Detect large text in a photo
+  result = api_instance.recognize_detect_text_large
+  p result
+rescue CloudmersiveImageRecognitionApiClient::ApiError => e
+  puts "Exception when calling RecognizeApi->recognize_detect_text_large: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**TextDetectionResult**](TextDetectionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **recognize_detect_vehicle_license_plates**
 > VehicleLicensePlateDetectionResult recognize_detect_vehicle_license_plates(image_file)
 

data/docs/TextDetectionResult.md

@@ -0,0 +1,10 @@
+# CloudmersiveImageRecognitionApiClient::TextDetectionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**text_items** | [**Array<TextItem>**](TextItem.md) | Text items found in the input image | [optional] 
+**text_items_count** | **Integer** | Count of text items found in the input image | [optional] 
+
+

data/docs/TextItem.md

@@ -0,0 +1,11 @@
+# CloudmersiveImageRecognitionApiClient::TextItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**left_x** | **Integer** | Left X coordinate of the text location; 0 represents the left edge of the input image | [optional] 
+**top_y** | **Integer** | Top Y coordinate of the text location; 0 represents the top edge of the input image | [optional] 
+**width** | **Integer** | Width in pixels of the text item | [optional] 
+**height** | **Integer** | Height in pixels of the text item | [optional] 
+
+

data/lib/cloudmersive-image-recognition-api-client.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -31,11 +31,15 @@ require 'cloudmersive-image-recognition-api-client/models/face_locate_with_landm
 require 'cloudmersive-image-recognition-api-client/models/face_match'
 require 'cloudmersive-image-recognition-api-client/models/face_point'
 require 'cloudmersive-image-recognition-api-client/models/face_with_landmarks'
+require 'cloudmersive-image-recognition-api-client/models/fine_text_detection_result'
+require 'cloudmersive-image-recognition-api-client/models/fine_text_item'
 require 'cloudmersive-image-recognition-api-client/models/image_description_response'
 require 'cloudmersive-image-recognition-api-client/models/nsfw_result'
 require 'cloudmersive-image-recognition-api-client/models/object_detection_result'
 require 'cloudmersive-image-recognition-api-client/models/person_with_age'
 require 'cloudmersive-image-recognition-api-client/models/recognition_outcome'
+require 'cloudmersive-image-recognition-api-client/models/text_detection_result'
+require 'cloudmersive-image-recognition-api-client/models/text_item'
 require 'cloudmersive-image-recognition-api-client/models/vehicle_license_plate_detection_result'
 
 # APIs

data/lib/cloudmersive-image-recognition-api-client/api/artistic_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 

data/lib/cloudmersive-image-recognition-api-client/api/edit_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 

data/lib/cloudmersive-image-recognition-api-client/api/face_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 

data/lib/cloudmersive-image-recognition-api-client/api/nsfw_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 

data/lib/cloudmersive-image-recognition-api-client/api/recognize_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -247,6 +247,109 @@ module CloudmersiveImageRecognitionApiClient
       return data, status_code, headers
     end
 
+    # Detect fine text in a photo of a document
+    # Identify the position, and size of small/fine text within a photograph of a document.  Identify the location of small text in a photo - such as words and other forms of high density text.  Can be used on a scan of a document or a photograph (e.g. smartphone camera) of a document, page or receipt.  For OCR purposes - please see our Deep Learning OCR APIs.
+    # @param image_file Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
+    # @param [Hash] opts the optional parameters
+    # @return [FineTextDetectionResult]
+    def recognize_detect_text_fine(image_file, opts = {})
+      data, _status_code, _headers = recognize_detect_text_fine_with_http_info(image_file, opts)
+      return data
+    end
+
+    # Detect fine text in a photo of a document
+    # Identify the position, and size of small/fine text within a photograph of a document.  Identify the location of small text in a photo - such as words and other forms of high density text.  Can be used on a scan of a document or a photograph (e.g. smartphone camera) of a document, page or receipt.  For OCR purposes - please see our Deep Learning OCR APIs.
+    # @param image_file Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FineTextDetectionResult, Fixnum, Hash)>] FineTextDetectionResult data, response status code and response headers
+    def recognize_detect_text_fine_with_http_info(image_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RecognizeApi.recognize_detect_text_fine ..."
+      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 RecognizeApi.recognize_detect_text_fine"
+      end
+      # resource path
+      local_var_path = "/image/recognize/detect-text/fine"
+
+      # 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 => 'FineTextDetectionResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecognizeApi#recognize_detect_text_fine\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Detect large text in a photo
+    # Identify the position, and size of large text within a photograph.  Identify the location of large text in a photo - such as signs, titles, etc. and other forms of large, low-density text.  Not suitable for high-density text (e.g. scans of documents, receipts, etc.) for OCR purposes - for OCR, please see our Deep Learning OCR APIs.
+    # @param [Hash] opts the optional parameters
+    # @return [TextDetectionResult]
+    def recognize_detect_text_large(opts = {})
+      data, _status_code, _headers = recognize_detect_text_large_with_http_info(opts)
+      return data
+    end
+
+    # Detect large text in a photo
+    # Identify the position, and size of large text within a photograph.  Identify the location of large text in a photo - such as signs, titles, etc. and other forms of large, low-density text.  Not suitable for high-density text (e.g. scans of documents, receipts, etc.) for OCR purposes - for OCR, please see our Deep Learning OCR APIs.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TextDetectionResult, Fixnum, Hash)>] TextDetectionResult data, response status code and response headers
+    def recognize_detect_text_large_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RecognizeApi.recognize_detect_text_large ..."
+      end
+      # resource path
+      local_var_path = "/image/recognize/detect-text/large"
+
+      # 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'])
+
+      # form parameters
+      form_params = {}
+
+      # 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 => 'TextDetectionResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecognizeApi#recognize_detect_text_large\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Detect vehicle license plates in an image
     # Identify the position, and size, and content of vehicle license plates in an image.  License plates should be within 15-20 degrees on-axis to the camera.
     # @param image_file Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.

data/lib/cloudmersive-image-recognition-api-client/api/resize_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 

data/lib/cloudmersive-image-recognition-api-client/api_client.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end