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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d063cb2476ced3741652e33e98920d288909c5b68b0c6563e2330ad5edd9c73f
-  data.tar.gz: a8d38165be51821e7cdc2bfbfbfab44c62ca9b1422a928f268dd463ab23707ad
+  metadata.gz: 28d47f3b97ad2eb1de71ef4973102482bd9ce25fcc57f5317bd63fe6f79b1b23
+  data.tar.gz: 1deafa860293ddf923f7ea597778a2424a13c8e3dd4dcd6ea725da744d8f6219
 SHA512:
-  metadata.gz: 37e4faabbb26e87154abecac5f81c24eb5a1d49c7ed284cd7eac57b894d05ce9b19d30cc47453178607135b217af8e4d254770520179219750c3ec56b9bf8f3e
-  data.tar.gz: 85116f1fc8d500ce31ed6435443d1e85f4dbc91644da60a932033861540614d1e2a47710fa325520540781af7324e08e162da0d68467e407d1f53ff3b01c6eb7
+  metadata.gz: 85885ad1774529b094f81a7e091df07ed60b22a9e1ee0796900741d5205c787cb79bbb46945d42c1fc0578bba7c42339ae3512c304324e7b9354202126a163da
+  data.tar.gz: 89bab982050f215252ac237a0fcba21fe0085caf865d280e433a54e19100b0084967b1e09d96663496cb42efb8329bc5a9ae6a27cc0bd460a082b8825488f8b9

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.2.9
+- Package version: 1.3.0
 - 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.2.9.gem
+gem install ./cloudmersive-image-recognition-api-client-1.3.0.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-image-recognition-api-client-1.2.9.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-image-recognition-api-client-1.3.0.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.2.9'
+    gem 'cloudmersive-image-recognition-api-client', '~> 1.3.0'
 
 ### Install from Git
 
@@ -89,10 +89,12 @@ Class | Method | HTTP request | Description
 *CloudmersiveImageRecognitionApiClient::EditApi* | [**edit_composite_basic**](docs/EditApi.md#edit_composite_basic) | **POST** /image/edit/composite/{location} | Composite two images together
 *CloudmersiveImageRecognitionApiClient::EditApi* | [**edit_draw_rectangle**](docs/EditApi.md#edit_draw_rectangle) | **POST** /image/edit/draw/rectangle | Draw rectangle onto an image
 *CloudmersiveImageRecognitionApiClient::EditApi* | [**edit_draw_text**](docs/EditApi.md#edit_draw_text) | **POST** /image/edit/draw/text | Draw text onto an image
+*CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_compare**](docs/FaceApi.md#face_compare) | **POST** /image/face/compare-and-match | Compare and match faces
 *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_crop_first**](docs/FaceApi.md#face_crop_first) | **POST** /image/face/crop/first | Crop image to face (square)
 *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_crop_first_round**](docs/FaceApi.md#face_crop_first_round) | **POST** /image/face/crop/first/round | Crop image to face (round)
 *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_detect_age**](docs/FaceApi.md#face_detect_age) | **POST** /image/face/detect-age | Detect the age of people in an image
 *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_locate**](docs/FaceApi.md#face_locate) | **POST** /image/face/locate | Find faces in an image
+*CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_locate_with_landmarks**](docs/FaceApi.md#face_locate_with_landmarks) | **POST** /image/face/locate-with-landmarks | Find faces and face landmarks (eyes, eye brows, nose, mouth) in an image
 *CloudmersiveImageRecognitionApiClient::NsfwApi* | [**nsfw_classify**](docs/NsfwApi.md#nsfw_classify) | **POST** /image/nsfw/classify | Not safe for work (NSFW) racy content classification
 *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_describe**](docs/RecognizeApi.md#recognize_describe) | **POST** /image/recognize/describe | Describe an image in natural language
 *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
@@ -112,7 +114,12 @@ Class | Method | HTTP request | Description
  - [CloudmersiveImageRecognitionApiClient::DrawTextInstance](docs/DrawTextInstance.md)
  - [CloudmersiveImageRecognitionApiClient::DrawTextRequest](docs/DrawTextRequest.md)
  - [CloudmersiveImageRecognitionApiClient::Face](docs/Face.md)
+ - [CloudmersiveImageRecognitionApiClient::FaceCompareResponse](docs/FaceCompareResponse.md)
  - [CloudmersiveImageRecognitionApiClient::FaceLocateResponse](docs/FaceLocateResponse.md)
+ - [CloudmersiveImageRecognitionApiClient::FaceLocateWithLandmarksResponse](docs/FaceLocateWithLandmarksResponse.md)
+ - [CloudmersiveImageRecognitionApiClient::FaceMatch](docs/FaceMatch.md)
+ - [CloudmersiveImageRecognitionApiClient::FacePoint](docs/FacePoint.md)
+ - [CloudmersiveImageRecognitionApiClient::FaceWithLandmarks](docs/FaceWithLandmarks.md)
  - [CloudmersiveImageRecognitionApiClient::ImageDescriptionResponse](docs/ImageDescriptionResponse.md)
  - [CloudmersiveImageRecognitionApiClient::NsfwResult](docs/NsfwResult.md)
  - [CloudmersiveImageRecognitionApiClient::ObjectDetectionResult](docs/ObjectDetectionResult.md)

data/docs/FaceApi.md

@@ -4,10 +4,69 @@ All URIs are relative to *https://api.cloudmersive.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**face_compare**](FaceApi.md#face_compare) | **POST** /image/face/compare-and-match | Compare and match faces
 [**face_crop_first**](FaceApi.md#face_crop_first) | **POST** /image/face/crop/first | Crop image to face (square)
 [**face_crop_first_round**](FaceApi.md#face_crop_first_round) | **POST** /image/face/crop/first/round | Crop image to face (round)
 [**face_detect_age**](FaceApi.md#face_detect_age) | **POST** /image/face/detect-age | Detect the age of people in an image
 [**face_locate**](FaceApi.md#face_locate) | **POST** /image/face/locate | Find faces in an image
+[**face_locate_with_landmarks**](FaceApi.md#face_locate_with_landmarks) | **POST** /image/face/locate-with-landmarks | Find faces and face landmarks (eyes, eye brows, nose, mouth) in an image
+
+
+# **face_compare**
+> FaceCompareResponse face_compare(input_image, match_face)
+
+Compare and match faces
+
+Find the faces in an input image, and compare against a reference image to determine if there is a match against the face in the reference image.  The reference image (second parameter) should contain exactly one face.
+
+### 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::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.
+
+match_face = File.new("/path/to/file.txt") # File | Image of a single face to compare and match against.
+
+
+begin
+  #Compare and match faces
+  result = api_instance.face_compare(input_image, match_face)
+  p result
+rescue CloudmersiveImageRecognitionApiClient::ApiError => e
+  puts "Exception when calling FaceApi->face_compare: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_image** | **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**| Image of a single face to compare and match against. | 
+
+### Return type
+
+[**FaceCompareResponse**](FaceCompareResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
 
 
 # **face_crop_first**
@@ -226,3 +285,57 @@ Name | Type | Description  | Notes
 
 
 
+# **face_locate_with_landmarks**
+> FaceLocateWithLandmarksResponse face_locate_with_landmarks(image_file)
+
+Find faces and face landmarks (eyes, eye brows, nose, mouth) in an image
+
+Locate the positions of all faces in an image, along with the eyes, eye brows, nose and mouth components of each
+
+### 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::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.
+
+
+begin
+  #Find faces and face landmarks (eyes, eye brows, nose, mouth) in an image
+  result = api_instance.face_locate_with_landmarks(image_file)
+  p result
+rescue CloudmersiveImageRecognitionApiClient::ApiError => e
+  puts "Exception when calling FaceApi->face_locate_with_landmarks: #{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
+
+[**FaceLocateWithLandmarksResponse**](FaceLocateWithLandmarksResponse.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/FaceCompareResponse.md

@@ -0,0 +1,11 @@
+# CloudmersiveImageRecognitionApiClient::FaceCompareResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_details** | **String** |  | [optional] 
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**faces** | [**Array<FaceMatch>**](FaceMatch.md) | Array of faces found in the input image | [optional] 
+**face_count** | **Integer** | Number of faces found in the image | [optional] 
+
+

data/docs/FaceLocateWithLandmarksResponse.md

@@ -0,0 +1,11 @@
+# CloudmersiveImageRecognitionApiClient::FaceLocateWithLandmarksResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_details** | **String** |  | [optional] 
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**faces** | [**Array<FaceWithLandmarks>**](FaceWithLandmarks.md) | Array of faces found in the image | [optional] 
+**face_count** | **Integer** | Number of faces found in the image | [optional] 
+
+

data/docs/FaceMatch.md

@@ -0,0 +1,13 @@
+# CloudmersiveImageRecognitionApiClient::FaceMatch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**left_x** | **Integer** | X coordinate of the left side of the face | [optional] 
+**top_y** | **Integer** | Y coordinate of the top side of the face | [optional] 
+**right_x** | **Integer** | X coordinate of the right side of the face | [optional] 
+**bottom_y** | **Integer** | Y coordinate of the bottom side of the face | [optional] 
+**high_confidence_match** | **BOOLEAN** | True if there is a high confidence match, false otherwise | [optional] 
+**match_score** | **Float** | Match score from 0.0 to 1.0 with higher scores indicating a greater match; scores above 0.7 indicate a match | [optional] 
+
+

data/docs/FacePoint.md

@@ -0,0 +1,9 @@
+# CloudmersiveImageRecognitionApiClient::FacePoint
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**x** | **Integer** | X location, where 0 is the left-most pixel | [optional] 
+**y** | **Integer** | Y location, where 0 is the top-most pixel | [optional] 
+
+

data/docs/FaceWithLandmarks.md

@@ -0,0 +1,20 @@
+# CloudmersiveImageRecognitionApiClient::FaceWithLandmarks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**left_eyebrow** | [**Array<FacePoint>**](FacePoint.md) |  | [optional] 
+**right_eyebrow** | [**Array<FacePoint>**](FacePoint.md) |  | [optional] 
+**left_eye** | [**Array<FacePoint>**](FacePoint.md) |  | [optional] 
+**right_eye** | [**Array<FacePoint>**](FacePoint.md) |  | [optional] 
+**bottom_and_sides_of_face** | [**Array<FacePoint>**](FacePoint.md) |  | [optional] 
+**nose_bridge** | [**Array<FacePoint>**](FacePoint.md) |  | [optional] 
+**nose_bottom** | [**Array<FacePoint>**](FacePoint.md) |  | [optional] 
+**lips_inner_outline** | [**Array<FacePoint>**](FacePoint.md) |  | [optional] 
+**lips_outer_outline** | [**Array<FacePoint>**](FacePoint.md) |  | [optional] 
+**left_x** | **Integer** | X coordinate of the left side of the face | [optional] 
+**top_y** | **Integer** | Y coordinate of the top side of the face | [optional] 
+**right_x** | **Integer** | X coordinate of the right side of the face | [optional] 
+**bottom_y** | **Integer** | Y coordinate of the bottom side of the face | [optional] 
+
+

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

@@ -25,7 +25,12 @@ require 'cloudmersive-image-recognition-api-client/models/draw_rectangle_request
 require 'cloudmersive-image-recognition-api-client/models/draw_text_instance'
 require 'cloudmersive-image-recognition-api-client/models/draw_text_request'
 require 'cloudmersive-image-recognition-api-client/models/face'
+require 'cloudmersive-image-recognition-api-client/models/face_compare_response'
 require 'cloudmersive-image-recognition-api-client/models/face_locate_response'
+require 'cloudmersive-image-recognition-api-client/models/face_locate_with_landmarks_response'
+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/image_description_response'
 require 'cloudmersive-image-recognition-api-client/models/nsfw_result'
 require 'cloudmersive-image-recognition-api-client/models/object_detection_result'

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

@@ -20,6 +20,69 @@ module CloudmersiveImageRecognitionApiClient
       @api_client = api_client
     end
 
+    # Compare and match faces
+    # Find the faces in an input image, and compare against a reference image to determine if there is a match against the face in the reference image.  The reference image (second parameter) should contain exactly one face.
+    # @param input_image 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.
+    # @param match_face Image of a single face to compare and match against.
+    # @param [Hash] opts the optional parameters
+    # @return [FaceCompareResponse]
+    def face_compare(input_image, match_face, opts = {})
+      data, _status_code, _headers = face_compare_with_http_info(input_image, match_face, opts)
+      return data
+    end
+
+    # Compare and match faces
+    # Find the faces in an input image, and compare against a reference image to determine if there is a match against the face in the reference image.  The reference image (second parameter) should contain exactly one face.
+    # @param input_image 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.
+    # @param match_face Image of a single face to compare and match against.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FaceCompareResponse, Fixnum, Hash)>] FaceCompareResponse data, response status code and response headers
+    def face_compare_with_http_info(input_image, match_face, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FaceApi.face_compare ..."
+      end
+      # verify the required parameter 'input_image' is set
+      if @api_client.config.client_side_validation && input_image.nil?
+        fail ArgumentError, "Missing the required parameter 'input_image' when calling FaceApi.face_compare"
+      end
+      # verify the required parameter 'match_face' is set
+      if @api_client.config.client_side_validation && match_face.nil?
+        fail ArgumentError, "Missing the required parameter 'match_face' when calling FaceApi.face_compare"
+      end
+      # resource path
+      local_var_path = "/image/face/compare-and-match"
+
+      # 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["inputImage"] = input_image
+      form_params["matchFace"] = match_face
+
+      # 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 => 'FaceCompareResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FaceApi#face_compare\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Crop image to face (square)
     # Crop an image to the face (rectangular crop).  If there is more than one face present, choose the first one.
     # @param image_file Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
@@ -243,5 +306,61 @@ module CloudmersiveImageRecognitionApiClient
       end
       return data, status_code, headers
     end
+
+    # Find faces and face landmarks (eyes, eye brows, nose, mouth) in an image
+    # Locate the positions of all faces in an image, along with the eyes, eye brows, nose and mouth components of each
+    # @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 [FaceLocateWithLandmarksResponse]
+    def face_locate_with_landmarks(image_file, opts = {})
+      data, _status_code, _headers = face_locate_with_landmarks_with_http_info(image_file, opts)
+      return data
+    end
+
+    # Find faces and face landmarks (eyes, eye brows, nose, mouth) in an image
+    # Locate the positions of all faces in an image, along with the eyes, eye brows, nose and mouth components of each
+    # @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<(FaceLocateWithLandmarksResponse, Fixnum, Hash)>] FaceLocateWithLandmarksResponse data, response status code and response headers
+    def face_locate_with_landmarks_with_http_info(image_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FaceApi.face_locate_with_landmarks ..."
+      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 FaceApi.face_locate_with_landmarks"
+      end
+      # resource path
+      local_var_path = "/image/face/locate-with-landmarks"
+
+      # 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 => 'FaceLocateWithLandmarksResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FaceApi#face_locate_with_landmarks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

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

@@ -0,0 +1,220 @@
+=begin
+#imageapi
+
+#Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: unset
+
+=end
+
+require 'date'
+
+module CloudmersiveImageRecognitionApiClient
+  # Results of comparing/matching faces in an image
+  class FaceCompareResponse
+    attr_accessor :error_details
+
+    # True if the operation was successful, false otherwise
+    attr_accessor :successful
+
+    # Array of faces found in the input image
+    attr_accessor :faces
+
+    # Number of faces found in the image
+    attr_accessor :face_count
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error_details' => :'ErrorDetails',
+        :'successful' => :'Successful',
+        :'faces' => :'Faces',
+        :'face_count' => :'FaceCount'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error_details' => :'String',
+        :'successful' => :'BOOLEAN',
+        :'faces' => :'Array<FaceMatch>',
+        :'face_count' => :'Integer'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'ErrorDetails')
+        self.error_details = attributes[:'ErrorDetails']
+      end
+
+      if attributes.has_key?(:'Successful')
+        self.successful = attributes[:'Successful']
+      end
+
+      if attributes.has_key?(:'Faces')
+        if (value = attributes[:'Faces']).is_a?(Array)
+          self.faces = value
+        end
+      end
+
+      if attributes.has_key?(:'FaceCount')
+        self.face_count = attributes[:'FaceCount']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          error_details == o.error_details &&
+          successful == o.successful &&
+          faces == o.faces &&
+          face_count == o.face_count
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [error_details, successful, faces, face_count].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CloudmersiveImageRecognitionApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end