cloudmersive-image-recognition-api-client 2.0.4 → 2.1.0

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

@@ -0,0 +1,196 @@
+=begin
+#imageapi
+
+#Image Recognition and Processing APIs let you use Artificial Intelligence and 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: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersiveImageRecognitionApiClient
+  # Request to compute the similarity between two image hashes
+  class ImageSimilarityHashDistanceRequest
+    # Image hash computed using Cloudmersive Image Hashing API
+    attr_accessor :image_hash1
+
+    # Image hash computed using Cloudmersive Image Hashing API
+    attr_accessor :image_hash2
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'image_hash1' => :'ImageHash1',
+        :'image_hash2' => :'ImageHash2'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'image_hash1' => :'String',
+        :'image_hash2' => :'String'
+      }
+    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?(:'ImageHash1')
+        self.image_hash1 = attributes[:'ImageHash1']
+      end
+
+      if attributes.has_key?(:'ImageHash2')
+        self.image_hash2 = attributes[:'ImageHash2']
+      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
+      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?
+      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 &&
+          image_hash1 == o.image_hash1 &&
+          image_hash2 == o.image_hash2
+    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
+      [image_hash1, image_hash2].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 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

data/lib/cloudmersive-image-recognition-api-client/models/{object_detection_result.rb → image_similarity_hash_distance_response.rb}

@@ -1,7 +1,7 @@
 =begin
 #imageapi
 
-#Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations.
+#Image Recognition and Processing APIs let you use Artificial Intelligence and Machine Learning to recognize and process images, and also perform useful image modification operations.
 
 OpenAPI spec version: v1
 
@@ -13,23 +13,19 @@ Swagger Codegen version: 2.4.14
 require 'date'
 
 module CloudmersiveImageRecognitionApiClient
-  # Result of detecting objects in an image
-  class ObjectDetectionResult
-    # Was the image processed successfully?
+  # Result of computing the similarity between two image hashes
+  class ImageSimilarityHashDistanceResponse
+    # True if successful, false otherwise
     attr_accessor :successful
 
-    # Array of objects detected in the scene
-    attr_accessor :objects
-
-    # Number of objects detected in the scene
-    attr_accessor :object_count
+    # Similarity score between 0.0 and 1.0, with 1.0 meaning highly similar and 0.0 meaning highly dissimilar
+    attr_accessor :image_similarity_score
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'successful' => :'Successful',
-        :'objects' => :'Objects',
-        :'object_count' => :'ObjectCount'
+        :'image_similarity_score' => :'ImageSimilarityScore'
       }
     end
 
@@ -37,8 +33,7 @@ module CloudmersiveImageRecognitionApiClient
     def self.swagger_types
       {
         :'successful' => :'BOOLEAN',
-        :'objects' => :'Array<DetectedObject>',
-        :'object_count' => :'Integer'
+        :'image_similarity_score' => :'Float'
       }
     end
 
@@ -54,14 +49,8 @@ module CloudmersiveImageRecognitionApiClient
         self.successful = attributes[:'Successful']
       end
 
-      if attributes.has_key?(:'Objects')
-        if (value = attributes[:'Objects']).is_a?(Array)
-          self.objects = value
-        end
-      end
-
-      if attributes.has_key?(:'ObjectCount')
-        self.object_count = attributes[:'ObjectCount']
+      if attributes.has_key?(:'ImageSimilarityScore')
+        self.image_similarity_score = attributes[:'ImageSimilarityScore']
       end
     end
 
@@ -84,8 +73,7 @@ module CloudmersiveImageRecognitionApiClient
       return true if self.equal?(o)
       self.class == o.class &&
           successful == o.successful &&
-          objects == o.objects &&
-          object_count == o.object_count
+          image_similarity_score == o.image_similarity_score
     end
 
     # @see the `==` method
@@ -97,7 +85,7 @@ module CloudmersiveImageRecognitionApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [successful, objects, object_count].hash
+      [successful, image_similarity_score].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-image-recognition-api-client/models/{gender_detection_result.rb → image_similarity_hash_response.rb}

@@ -1,7 +1,7 @@
 =begin
 #imageapi
 
-#Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations.
+#Image Recognition and Processing APIs let you use Artificial Intelligence and Machine Learning to recognize and process images, and also perform useful image modification operations.
 
 OpenAPI spec version: v1
 
@@ -13,23 +13,19 @@ Swagger Codegen version: 2.4.14
 require 'date'
 
 module CloudmersiveImageRecognitionApiClient
-  # Result from classifying the Gender of people in an image
-  class GenderDetectionResult
-    # True if the operation was successful, false otherwise
+  # Result of performing an image hash operation
+  class ImageSimilarityHashResponse
+    # True if successful, false otherwise
     attr_accessor :successful
 
-    # People in the image annotated with gender information
-    attr_accessor :person_with_gender
-
-    # Number of people identified in the image with a gender
-    attr_accessor :people_identified
+    # String representing image perceptual hash value; values with smaller Hamming Distances are more similar than ones with large Hamming Distances
+    attr_accessor :image_hash
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'successful' => :'Successful',
-        :'person_with_gender' => :'PersonWithGender',
-        :'people_identified' => :'PeopleIdentified'
+        :'image_hash' => :'ImageHash'
       }
     end
 
@@ -37,8 +33,7 @@ module CloudmersiveImageRecognitionApiClient
     def self.swagger_types
       {
         :'successful' => :'BOOLEAN',
-        :'person_with_gender' => :'Array<PersonWithGender>',
-        :'people_identified' => :'Integer'
+        :'image_hash' => :'String'
       }
     end
 
@@ -54,14 +49,8 @@ module CloudmersiveImageRecognitionApiClient
         self.successful = attributes[:'Successful']
       end
 
-      if attributes.has_key?(:'PersonWithGender')
-        if (value = attributes[:'PersonWithGender']).is_a?(Array)
-          self.person_with_gender = value
-        end
-      end
-
-      if attributes.has_key?(:'PeopleIdentified')
-        self.people_identified = attributes[:'PeopleIdentified']
+      if attributes.has_key?(:'ImageHash')
+        self.image_hash = attributes[:'ImageHash']
       end
     end
 
@@ -84,8 +73,7 @@ module CloudmersiveImageRecognitionApiClient
       return true if self.equal?(o)
       self.class == o.class &&
           successful == o.successful &&
-          person_with_gender == o.person_with_gender &&
-          people_identified == o.people_identified
+          image_hash == o.image_hash
     end
 
     # @see the `==` method
@@ -97,7 +85,7 @@ module CloudmersiveImageRecognitionApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [successful, person_with_gender, people_identified].hash
+      [successful, image_hash].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,296 @@
+=begin
+#imageapi
+
+#Image Recognition and Processing APIs let you use Artificial Intelligence and 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: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersiveImageRecognitionApiClient
+  # Result of an Advanced NSFW classification
+  class NsfwAdvancedResult
+    # True if the classification was successfully run, false otherwise
+    attr_accessor :successful
+
+    # True if the result was clean, false otherwise
+    attr_accessor :clean_result
+
+    # True if the image contains nudity or sex, false otherwise
+    attr_accessor :contains_nudity
+
+    # True if the image contains graphic violence and/or gore, false otherwise
+    attr_accessor :contains_graphic_violence
+
+    # True if the image contains non-graphic violence, e.g. weapons, false otherwise
+    attr_accessor :contains_non_graphic_violence
+
+    # True if the image contains self-harm or suicide imagery, false otherwise
+    attr_accessor :contains_self_harm
+
+    # True if the image contains hate, false otherwise
+    attr_accessor :contains_hate
+
+    # True if the image contains potentially illegal activity such as drugs, false otherwise
+    attr_accessor :contains_potential_illegal_activity
+
+    # True if the image contains medical imagery, false otherwise
+    attr_accessor :contains_medical_imagery
+
+    # True if the image contains profanity or obscenities, false otherwise
+    attr_accessor :contains_profanity
+
+    # Score between 0.0 and 1.0.  Scores of 0.0-0.2 represent high probability safe content, while scores 0.8-1.0 represent high probability unsafe content.  Content between 0.2 and 0.8 is of increasing raciness.
+    attr_accessor :score
+
+    # Classification result into four categories: SafeContent_HighProbability, UnsafeContent_HighProbability, RacyContent, SafeContent_ModerateProbability
+    attr_accessor :classification_outcome
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'successful' => :'Successful',
+        :'clean_result' => :'CleanResult',
+        :'contains_nudity' => :'ContainsNudity',
+        :'contains_graphic_violence' => :'ContainsGraphicViolence',
+        :'contains_non_graphic_violence' => :'ContainsNonGraphicViolence',
+        :'contains_self_harm' => :'ContainsSelfHarm',
+        :'contains_hate' => :'ContainsHate',
+        :'contains_potential_illegal_activity' => :'ContainsPotentialIllegalActivity',
+        :'contains_medical_imagery' => :'ContainsMedicalImagery',
+        :'contains_profanity' => :'ContainsProfanity',
+        :'score' => :'Score',
+        :'classification_outcome' => :'ClassificationOutcome'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'successful' => :'BOOLEAN',
+        :'clean_result' => :'BOOLEAN',
+        :'contains_nudity' => :'BOOLEAN',
+        :'contains_graphic_violence' => :'BOOLEAN',
+        :'contains_non_graphic_violence' => :'BOOLEAN',
+        :'contains_self_harm' => :'BOOLEAN',
+        :'contains_hate' => :'BOOLEAN',
+        :'contains_potential_illegal_activity' => :'BOOLEAN',
+        :'contains_medical_imagery' => :'BOOLEAN',
+        :'contains_profanity' => :'BOOLEAN',
+        :'score' => :'Float',
+        :'classification_outcome' => :'String'
+      }
+    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?(:'Successful')
+        self.successful = attributes[:'Successful']
+      end
+
+      if attributes.has_key?(:'CleanResult')
+        self.clean_result = attributes[:'CleanResult']
+      end
+
+      if attributes.has_key?(:'ContainsNudity')
+        self.contains_nudity = attributes[:'ContainsNudity']
+      end
+
+      if attributes.has_key?(:'ContainsGraphicViolence')
+        self.contains_graphic_violence = attributes[:'ContainsGraphicViolence']
+      end
+
+      if attributes.has_key?(:'ContainsNonGraphicViolence')
+        self.contains_non_graphic_violence = attributes[:'ContainsNonGraphicViolence']
+      end
+
+      if attributes.has_key?(:'ContainsSelfHarm')
+        self.contains_self_harm = attributes[:'ContainsSelfHarm']
+      end
+
+      if attributes.has_key?(:'ContainsHate')
+        self.contains_hate = attributes[:'ContainsHate']
+      end
+
+      if attributes.has_key?(:'ContainsPotentialIllegalActivity')
+        self.contains_potential_illegal_activity = attributes[:'ContainsPotentialIllegalActivity']
+      end
+
+      if attributes.has_key?(:'ContainsMedicalImagery')
+        self.contains_medical_imagery = attributes[:'ContainsMedicalImagery']
+      end
+
+      if attributes.has_key?(:'ContainsProfanity')
+        self.contains_profanity = attributes[:'ContainsProfanity']
+      end
+
+      if attributes.has_key?(:'Score')
+        self.score = attributes[:'Score']
+      end
+
+      if attributes.has_key?(:'ClassificationOutcome')
+        self.classification_outcome = attributes[:'ClassificationOutcome']
+      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
+      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?
+      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 &&
+          successful == o.successful &&
+          clean_result == o.clean_result &&
+          contains_nudity == o.contains_nudity &&
+          contains_graphic_violence == o.contains_graphic_violence &&
+          contains_non_graphic_violence == o.contains_non_graphic_violence &&
+          contains_self_harm == o.contains_self_harm &&
+          contains_hate == o.contains_hate &&
+          contains_potential_illegal_activity == o.contains_potential_illegal_activity &&
+          contains_medical_imagery == o.contains_medical_imagery &&
+          contains_profanity == o.contains_profanity &&
+          score == o.score &&
+          classification_outcome == o.classification_outcome
+    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
+      [successful, clean_result, contains_nudity, contains_graphic_violence, contains_non_graphic_violence, contains_self_harm, contains_hate, contains_potential_illegal_activity, contains_medical_imagery, contains_profanity, score, classification_outcome].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 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

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

@@ -1,7 +1,7 @@
 =begin
 #imageapi
 
-#Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations.
+#Image Recognition and Processing APIs let you use Artificial Intelligence and Machine Learning to recognize and process images, and also perform useful image modification operations.
 
 OpenAPI spec version: v1