cloudmersive-image-recognition-api-client 1.4.6 → 2.0.5

data/docs/FaceApi.md

@@ -34,9 +34,9 @@ end
 
 api_instance = CloudmersiveImageRecognitionApiClient::FaceApi.new
 
-input_image = File.new("/path/to/file.txt") # File | Image file to perform the operation on; this image can contain one or more faces which will be matched against face provided in the second image.  Common file formats such as PNG, JPEG are supported.
+input_image = File.new('/path/to/file.txt') # File | Image file to perform the operation on; this image can contain one or more faces which will be matched against face provided in the second image.  Common file formats such as PNG, JPEG are supported.
 
-match_face = File.new("/path/to/file.txt") # File | Image of a single face to compare and match against.
+match_face = File.new('/path/to/file.txt') # File | Image of a single face to compare and match against.
 
 
 begin
@@ -91,7 +91,7 @@ end
 
 api_instance = CloudmersiveImageRecognitionApiClient::FaceApi.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.
+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
@@ -145,7 +145,7 @@ end
 
 api_instance = CloudmersiveImageRecognitionApiClient::FaceApi.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.
+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
@@ -199,7 +199,7 @@ end
 
 api_instance = CloudmersiveImageRecognitionApiClient::FaceApi.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.
+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
@@ -253,7 +253,7 @@ end
 
 api_instance = CloudmersiveImageRecognitionApiClient::FaceApi.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.
+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
@@ -307,7 +307,7 @@ end
 
 api_instance = CloudmersiveImageRecognitionApiClient::FaceApi.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.
+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
@@ -361,7 +361,7 @@ end
 
 api_instance = CloudmersiveImageRecognitionApiClient::FaceApi.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.
+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

data/docs/FilterApi.md

@@ -35,7 +35,7 @@ end
 
 api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.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.
+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
@@ -89,7 +89,7 @@ end
 
 api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.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.
+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
@@ -145,7 +145,7 @@ api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
 
 radius = 56 # Integer | Radius in pixels of the edge detection operation; a larger radius will produce a greater effect
 
-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.
+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
@@ -204,7 +204,7 @@ radius = 56 # Integer | Radius in pixels of the emboss operation; a larger radiu
 
 sigma = 56 # Integer | Sigma, or variance, of the emboss operation
 
-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.
+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
@@ -264,7 +264,7 @@ radius = 56 # Integer | Radius in pixels of the blur operation; a larger radius
 
 sigma = 56 # Integer | Sigma, or variance, of the gaussian blur operation
 
-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.
+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
@@ -326,7 +326,7 @@ sigma = 56 # Integer | Sigma, or variance, of the motion blur operation
 
 angle = 56 # Integer | Angle of the motion blur in degrees
 
-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.
+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
@@ -385,7 +385,7 @@ api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
 
 levels = 56 # Integer | Number of unique colors to retain in the output image
 
-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.
+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
@@ -442,7 +442,7 @@ api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
 
 degrees = 56 # Integer | Degrees of swirl
 
-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.
+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

data/docs/ImageSimilarityComparisonResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveImageRecognitionApiClient::ImageSimilarityComparisonResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**are_images_similar** | **BOOLEAN** | True if images are similar, false otherwise | [optional] 
+**image_similarity_score** | **Float** | Similarity score between 0.0 and 1.0, with 1.0 meaning highly similar and 0.0 meaning highly dissimilar | [optional] 
+
+

data/docs/ImageSimilarityHashDistanceRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveImageRecognitionApiClient::ImageSimilarityHashDistanceRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image_hash1** | **String** | Image hash computed using Cloudmersive Image Hashing API | [optional] 
+**image_hash2** | **String** | Image hash computed using Cloudmersive Image Hashing API | [optional] 
+
+

data/docs/ImageSimilarityHashDistanceResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveImageRecognitionApiClient::ImageSimilarityHashDistanceResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**image_similarity_score** | **Float** | Similarity score between 0.0 and 1.0, with 1.0 meaning highly similar and 0.0 meaning highly dissimilar | [optional] 
+
+

data/docs/ImageSimilarityHashResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveImageRecognitionApiClient::ImageSimilarityHashResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**image_hash** | **String** | String representing image perceptual hash value; values with smaller Hamming Distances are more similar than ones with large Hamming Distances | [optional] 
+
+

data/docs/InfoApi.md

@@ -29,7 +29,7 @@ end
 
 api_instance = CloudmersiveImageRecognitionApiClient::InfoApi.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.
+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
@@ -83,7 +83,7 @@ end
 
 api_instance = CloudmersiveImageRecognitionApiClient::InfoApi.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.
+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

data/docs/NsfwApi.md

@@ -28,7 +28,7 @@ end
 
 api_instance = CloudmersiveImageRecognitionApiClient::NsfwApi.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.
+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

data/docs/RecognizeApi.md

@@ -12,6 +12,9 @@ Method | HTTP request | Description
 [**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
 [**recognize_find_symbol**](RecognizeApi.md#recognize_find_symbol) | **POST** /image/recognize/find/symbol | Find the location of a symbol in an image
+[**recognize_similarity_compare**](RecognizeApi.md#recognize_similarity_compare) | **POST** /image/recognize/similarity/compare | Compare two images for similarity
+[**recognize_similarity_hash**](RecognizeApi.md#recognize_similarity_hash) | **POST** /image/recognize/similarity/hash | Generate a perceptual image hash
+[**recognize_similarity_hash_distance**](RecognizeApi.md#recognize_similarity_hash_distance) | **POST** /image/recognize/similarity/hash/distance | Calculates the similarity between two perceptual image hashes
 
 
 # **recognize_describe**
@@ -35,7 +38,7 @@ 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.
+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
@@ -89,10 +92,10 @@ 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.
+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.
 
 opts = { 
-  post_processing_effect: "post_processing_effect_example" # String | Optional, post-processing effects to apply to the email, default is None.  Possible values are None and BlackAndWhite (force the image into a black and white view to aid in OCR operations).
+  post_processing_effect: 'post_processing_effect_example' # String | Optional, post-processing effects to apply to the email, default is None.  Possible values are None and BlackAndWhite (force the image into a black and white view to aid in OCR operations).
 }
 
 begin
@@ -147,7 +150,7 @@ 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.
+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
@@ -201,7 +204,7 @@ 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.
+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
@@ -255,7 +258,7 @@ 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.
+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
@@ -309,7 +312,7 @@ 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.
+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
@@ -347,7 +350,7 @@ Name | Type | Description  | Notes
 
 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.
+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.  Supported image formats are JPG, PNG and BMP.
 
 ### Example
 ```ruby
@@ -363,7 +366,7 @@ 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.
+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
@@ -417,9 +420,9 @@ end
 
 api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
 
-input_image = File.new("/path/to/file.txt") # File | Image file to search through for the target image.
+input_image = File.new('/path/to/file.txt') # File | Image file to search through for the target image.
 
-target_image = File.new("/path/to/file.txt") # File | Image to find in the input image.
+target_image = File.new('/path/to/file.txt') # File | Image to find in the input image.
 
 
 begin
@@ -453,3 +456,176 @@ Name | Type | Description  | Notes
 
 
 
+# **recognize_similarity_compare**
+> String recognize_similarity_compare(base_image, comparison_image, opts)
+
+Compare two images for similarity
+
+Generates an image similarity score using Deep Learning between 0.0 and 1.0, values closer to 1.0 indicate greater similarity
+
+### 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
+
+base_image = File.new('/path/to/file.txt') # File | Image file to compare against.  Common file formats such as PNG, JPEG are supported.
+
+comparison_image = File.new('/path/to/file.txt') # File | Image to compare to the base image.
+
+opts = { 
+  recognition_mode: 'recognition_mode_example' # String | Optional, specify the recognition mode; possible values are Normal, Basic and Advanced.  Default is Normal.
+}
+
+begin
+  #Compare two images for similarity
+  result = api_instance.recognize_similarity_compare(base_image, comparison_image, opts)
+  p result
+rescue CloudmersiveImageRecognitionApiClient::ApiError => e
+  puts "Exception when calling RecognizeApi->recognize_similarity_compare: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **base_image** | **File**| Image file to compare against.  Common file formats such as PNG, JPEG are supported. | 
+ **comparison_image** | **File**| Image to compare to the base image. | 
+ **recognition_mode** | **String**| Optional, specify the recognition mode; possible values are Normal, Basic and Advanced.  Default is Normal. | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **recognize_similarity_hash**
+> ImageSimilarityHashResponse recognize_similarity_hash(image_file, opts)
+
+Generate a perceptual image hash
+
+Generates a hash value for the image; hash values that are closer together in terms of Hamming Distance are more similar.
+
+### 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.
+
+opts = { 
+  recognition_mode: 'recognition_mode_example' # String | Optional, specify the recognition mode; possible values are Normal, Basic and Advanced.  Default is Normal.
+}
+
+begin
+  #Generate a perceptual image hash
+  result = api_instance.recognize_similarity_hash(image_file, opts)
+  p result
+rescue CloudmersiveImageRecognitionApiClient::ApiError => e
+  puts "Exception when calling RecognizeApi->recognize_similarity_hash: #{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. | 
+ **recognition_mode** | **String**| Optional, specify the recognition mode; possible values are Normal, Basic and Advanced.  Default is Normal. | [optional] 
+
+### Return type
+
+[**ImageSimilarityHashResponse**](ImageSimilarityHashResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **recognize_similarity_hash_distance**
+> ImageSimilarityHashDistanceResponse recognize_similarity_hash_distance(request)
+
+Calculates the similarity between two perceptual image hashes
+
+Calculates the similarity between two perceptual image hashes by computing the Hamming Distance between them.
+
+### 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
+
+request = CloudmersiveImageRecognitionApiClient::ImageSimilarityHashDistanceRequest.new # ImageSimilarityHashDistanceRequest | 
+
+
+begin
+  #Calculates the similarity between two perceptual image hashes
+  result = api_instance.recognize_similarity_hash_distance(request)
+  p result
+rescue CloudmersiveImageRecognitionApiClient::ApiError => e
+  puts "Exception when calling RecognizeApi->recognize_similarity_hash_distance: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**ImageSimilarityHashDistanceRequest**](ImageSimilarityHashDistanceRequest.md)|  | 
+
+### Return type
+
+[**ImageSimilarityHashDistanceResponse**](ImageSimilarityHashDistanceResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+