cloudmersive-image-recognition-api-client 1.3.7 → 1.4.0

data/docs/FindSymbolResult.md

@@ -0,0 +1,12 @@
+# CloudmersiveImageRecognitionApiClient::FindSymbolResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**x_left** | **Integer** | X location of the left edge of the found location in pixels | [optional] 
+**y_top** | **Integer** | Y location of the top edge of the found location in pixels | [optional] 
+**width** | **Integer** | Width of the found location in pixels | [optional] 
+**height** | **Integer** | Height of the found location in pixels | [optional] 
+
+

data/docs/GenderDetectionResult.md

@@ -0,0 +1,10 @@
+# CloudmersiveImageRecognitionApiClient::GenderDetectionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**person_with_gender** | [**Array<PersonWithGender>**](PersonWithGender.md) | People in the image annotated with gender information | [optional] 
+**people_identified** | **Integer** | Number of people identified in the image with a gender | [optional] 
+
+

data/docs/InfoApi.md

@@ -0,0 +1,63 @@
+# CloudmersiveImageRecognitionApiClient::InfoApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**info_get_dominant_color**](InfoApi.md#info_get_dominant_color) | **POST** /image/get-info/dominant-color | Returns the dominant colors of the image
+
+
+# **info_get_dominant_color**
+> DominantColorResult info_get_dominant_color(image_file)
+
+Returns the dominant colors of the image
+
+Uses advanced image processing to extract the top 5 dominant colors in the image, returned in the order of dominance with the most-dominant color first.  These are the primary perceptual colors used in the image as perceived by a viewer.
+
+### 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::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.
+
+
+begin
+  #Returns the dominant colors of the image
+  result = api_instance.info_get_dominant_color(image_file)
+  p result
+rescue CloudmersiveImageRecognitionApiClient::ApiError => e
+  puts "Exception when calling InfoApi->info_get_dominant_color: #{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
+
+[**DominantColorResult**](DominantColorResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/PersonWithAge.md

@@ -6,5 +6,6 @@ Name | Type | Description | Notes
 **face_location** | [**Face**](Face.md) | Location and other information about the person's face corresponding to this age classification | [optional] 
 **age_classification_confidence** | **Float** | Confidence level of age classification; possible values are between 0.0 and 1.0; higher is better, with values > 0.50 being high confidence results | [optional] 
 **age_class** | **String** | The person's age range classification result in years; possible values are \"0-2\", \"4-6\", \"8-13\", \"15-20\", \"25-32\", \"38-43\", \"48-53\", \"60+\" | [optional] 
+**age** | **Float** |  | [optional] 
 
 

data/docs/PersonWithGender.md

@@ -0,0 +1,10 @@
+# CloudmersiveImageRecognitionApiClient::PersonWithGender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**face_location** | [**Face**](Face.md) | Location and other information about the person's face corresponding to this age classification | [optional] 
+**gender_classification_confidence** | **Float** | Confidence level of gender classification; possible values are between 0.0 and 1.0; higher is better, with values > 0.50 being high confidence results | [optional] 
+**gender_class** | **String** | The person's identified gender; possible values are \"Male\", \"Female\" and \"Unknown\" | [optional] 
+
+

data/docs/RecognizeApi.md

@@ -11,6 +11,7 @@ Method | HTTP request | Description
 [**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
+[**recognize_find_symbol**](RecognizeApi.md#recognize_find_symbol) | **POST** /image/recognize/find/symbol | Find the location of a symbol in an image
 
 
 # **recognize_describe**
@@ -288,7 +289,7 @@ Name | Type | Description  | Notes
 
 
 # **recognize_detect_text_large**
-> TextDetectionResult recognize_detect_text_large
+> TextDetectionResult recognize_detect_text_large(image_file)
 
 Detect large text in a photo
 
@@ -308,9 +309,12 @@ 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 large text in a photo
-  result = api_instance.recognize_detect_text_large
+  result = api_instance.recognize_detect_text_large(image_file)
   p result
 rescue CloudmersiveImageRecognitionApiClient::ApiError => e
   puts "Exception when calling RecognizeApi->recognize_detect_text_large: #{e}"
@@ -318,7 +322,10 @@ end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+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
 
@@ -330,7 +337,7 @@ This endpoint does not need any parameter.
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: multipart/form-data
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 
@@ -389,3 +396,60 @@ Name | Type | Description  | Notes
 
 
 
+# **recognize_find_symbol**
+> FindSymbolResult recognize_find_symbol(input_image, target_image)
+
+Find the location of a symbol in an image
+
+Determine if an image contains a symbol, and if so, the location of that symbol in the image.
+
+### 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
+
+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.
+
+
+begin
+  #Find the location of a symbol in an image
+  result = api_instance.recognize_find_symbol(input_image, target_image)
+  p result
+rescue CloudmersiveImageRecognitionApiClient::ApiError => e
+  puts "Exception when calling RecognizeApi->recognize_find_symbol: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_image** | **File**| Image file to search through for the target image. | 
+ **target_image** | **File**| Image to find in the input image. | 
+
+### Return type
+
+[**FindSymbolResult**](FindSymbolResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/ResizeApi.md

@@ -4,13 +4,14 @@ All URIs are relative to *https://api.cloudmersive.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**resize_post**](ResizeApi.md#resize_post) | **POST** /image/resize/preserveAspectRatio/{maxWidth}/{maxHeight} | Resize an image with parameters
+[**resize_post**](ResizeApi.md#resize_post) | **POST** /image/resize/preserveAspectRatio/{maxWidth}/{maxHeight} | Resize an image while preserving aspect ratio
+[**resize_resize_simple**](ResizeApi.md#resize_resize_simple) | **POST** /image/resize/target/{width}/{height} | Resize an image
 
 
 # **resize_post**
 > String resize_post(max_width, max_height, image_file)
 
-Resize an image with parameters
+Resize an image while preserving aspect ratio
 
 Resize an image to a maximum width and maximum height, while preserving the image's original aspect ratio
 
@@ -36,7 +37,7 @@ image_file = File.new("/path/to/file.txt") # File | Image file to perform the op
 
 
 begin
-  #Resize an image with parameters
+  #Resize an image while preserving aspect ratio
   result = api_instance.resize_post(max_width, max_height, image_file)
   p result
 rescue CloudmersiveImageRecognitionApiClient::ApiError => e
@@ -67,3 +68,63 @@ Name | Type | Description  | Notes
 
 
 
+# **resize_resize_simple**
+> String resize_resize_simple(width, height, image_file)
+
+Resize an image
+
+Resize an image to a specific width and specific height
+
+### 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::ResizeApi.new
+
+width = 56 # Integer | 
+
+height = 56 # Integer | 
+
+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
+  #Resize an image
+  result = api_instance.resize_resize_simple(width, height, image_file)
+  p result
+rescue CloudmersiveImageRecognitionApiClient::ApiError => e
+  puts "Exception when calling ResizeApi->resize_resize_simple: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **width** | **Integer**|  | 
+ **height** | **Integer**|  | 
+ **image_file** | **File**| Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported. | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: image/png
+
+
+

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
 
@@ -18,8 +18,10 @@ require 'cloudmersive-image-recognition-api-client/configuration'
 
 # Models
 require 'cloudmersive-image-recognition-api-client/models/age_detection_result'
+require 'cloudmersive-image-recognition-api-client/models/color_result'
 require 'cloudmersive-image-recognition-api-client/models/detected_license_plate'
 require 'cloudmersive-image-recognition-api-client/models/detected_object'
+require 'cloudmersive-image-recognition-api-client/models/dominant_color_result'
 require 'cloudmersive-image-recognition-api-client/models/draw_polygon_instance'
 require 'cloudmersive-image-recognition-api-client/models/draw_polygon_request'
 require 'cloudmersive-image-recognition-api-client/models/draw_rectangle_instance'
@@ -33,12 +35,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/find_symbol_result'
 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/gender_detection_result'
 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/person_with_gender'
 require 'cloudmersive-image-recognition-api-client/models/polygon_point'
 require 'cloudmersive-image-recognition-api-client/models/recognition_outcome'
 require 'cloudmersive-image-recognition-api-client/models/text_detection_result'
@@ -49,6 +54,8 @@ require 'cloudmersive-image-recognition-api-client/models/vehicle_license_plate_
 require 'cloudmersive-image-recognition-api-client/api/artistic_api'
 require 'cloudmersive-image-recognition-api-client/api/edit_api'
 require 'cloudmersive-image-recognition-api-client/api/face_api'
+require 'cloudmersive-image-recognition-api-client/api/filter_api'
+require 'cloudmersive-image-recognition-api-client/api/info_api'
 require 'cloudmersive-image-recognition-api-client/api/nsfw_api'
 require 'cloudmersive-image-recognition-api-client/api/recognize_api'
 require 'cloudmersive-image-recognition-api-client/api/resize_api'

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
 
@@ -207,6 +207,86 @@ module CloudmersiveImageRecognitionApiClient
       return data, status_code, headers
     end
 
+    # Crop an image to a rectangular area
+    # Crop an image to a target rectangular area
+    # @param left The left edge of the rectangular crop area in pixels (X).
+    # @param top The top edge of the rectangular crop area in pixels (Y).
+    # @param width The width of the rectangular crop area in pixels.
+    # @param height The height of the rectangular crop area in pixels.
+    # @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 [String]
+    def edit_crop_rectangle(left, top, width, height, image_file, opts = {})
+      data, _status_code, _headers = edit_crop_rectangle_with_http_info(left, top, width, height, image_file, opts)
+      return data
+    end
+
+    # Crop an image to a rectangular area
+    # Crop an image to a target rectangular area
+    # @param left The left edge of the rectangular crop area in pixels (X).
+    # @param top The top edge of the rectangular crop area in pixels (Y).
+    # @param width The width of the rectangular crop area in pixels.
+    # @param height The height of the rectangular crop area in pixels.
+    # @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<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def edit_crop_rectangle_with_http_info(left, top, width, height, image_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditApi.edit_crop_rectangle ..."
+      end
+      # verify the required parameter 'left' is set
+      if @api_client.config.client_side_validation && left.nil?
+        fail ArgumentError, "Missing the required parameter 'left' when calling EditApi.edit_crop_rectangle"
+      end
+      # verify the required parameter 'top' is set
+      if @api_client.config.client_side_validation && top.nil?
+        fail ArgumentError, "Missing the required parameter 'top' when calling EditApi.edit_crop_rectangle"
+      end
+      # verify the required parameter 'width' is set
+      if @api_client.config.client_side_validation && width.nil?
+        fail ArgumentError, "Missing the required parameter 'width' when calling EditApi.edit_crop_rectangle"
+      end
+      # verify the required parameter 'height' is set
+      if @api_client.config.client_side_validation && height.nil?
+        fail ArgumentError, "Missing the required parameter 'height' when calling EditApi.edit_crop_rectangle"
+      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 EditApi.edit_crop_rectangle"
+      end
+      # resource path
+      local_var_path = "/image/edit/crop/rectangle/{left}/{top}/{width}/{height}".sub('{' + 'left' + '}', left.to_s).sub('{' + 'top' + '}', top.to_s).sub('{' + 'width' + '}', width.to_s).sub('{' + 'height' + '}', height.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+      # 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 => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditApi#edit_crop_rectangle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Draw a polygon onto an image
     # Draw one or more polygons, with customized visuals, onto an image
     # @param request 
@@ -372,6 +452,86 @@ module CloudmersiveImageRecognitionApiClient
       return data, status_code, headers
     end
 
+    # Add a customizeable drop shadow to an image
+    # Add a customizeable drop shadow to the image
+    # @param x Horizontal (X) offset of the drop shadow
+    # @param y Vertical (Y) offset of the drop shadow
+    # @param sigma Sigma (blur distance) of the drop shadow
+    # @param opacity Opacity of the drop shadow; 0 is 0% and 100 is 100%
+    # @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 [String]
+    def edit_drop_shadow(x, y, sigma, opacity, image_file, opts = {})
+      data, _status_code, _headers = edit_drop_shadow_with_http_info(x, y, sigma, opacity, image_file, opts)
+      return data
+    end
+
+    # Add a customizeable drop shadow to an image
+    # Add a customizeable drop shadow to the image
+    # @param x Horizontal (X) offset of the drop shadow
+    # @param y Vertical (Y) offset of the drop shadow
+    # @param sigma Sigma (blur distance) of the drop shadow
+    # @param opacity Opacity of the drop shadow; 0 is 0% and 100 is 100%
+    # @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<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def edit_drop_shadow_with_http_info(x, y, sigma, opacity, image_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditApi.edit_drop_shadow ..."
+      end
+      # verify the required parameter 'x' is set
+      if @api_client.config.client_side_validation && x.nil?
+        fail ArgumentError, "Missing the required parameter 'x' when calling EditApi.edit_drop_shadow"
+      end
+      # verify the required parameter 'y' is set
+      if @api_client.config.client_side_validation && y.nil?
+        fail ArgumentError, "Missing the required parameter 'y' when calling EditApi.edit_drop_shadow"
+      end
+      # verify the required parameter 'sigma' is set
+      if @api_client.config.client_side_validation && sigma.nil?
+        fail ArgumentError, "Missing the required parameter 'sigma' when calling EditApi.edit_drop_shadow"
+      end
+      # verify the required parameter 'opacity' is set
+      if @api_client.config.client_side_validation && opacity.nil?
+        fail ArgumentError, "Missing the required parameter 'opacity' when calling EditApi.edit_drop_shadow"
+      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 EditApi.edit_drop_shadow"
+      end
+      # resource path
+      local_var_path = "/image/edit/drop-shadow/{x}/{y}/{sigma}/{opacity}".sub('{' + 'x' + '}', x.to_s).sub('{' + 'y' + '}', y.to_s).sub('{' + 'sigma' + '}', sigma.to_s).sub('{' + 'opacity' + '}', opacity.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+      # 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 => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditApi#edit_drop_shadow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Rotate an image any number of degrees
     # Rotates an image by an arbitrary number of degrees
     # @param degrees Degrees to rotate the image; values range from 0.0 to 360.0.