azure_cognitiveservices_face 0.16.0

data/lib/1.0/generated/azure_cognitiveservices_face/models/group_result.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Face::V1_0
+  module Models
+    #
+    # An array of face groups based on face similarity.
+    #
+    class GroupResult
+
+      include MsRestAzure
+
+      # @return A partition of the original faces based on face similarity.
+      # Groups are ranked by number of faces
+      attr_accessor :groups
+
+      # @return Face ids array of faces that cannot find any similar faces from
+      # original faces.
+      attr_accessor :messy_group
+
+
+      #
+      # Mapper for GroupResult class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'GroupResult',
+          type: {
+            name: 'Composite',
+            class_name: 'GroupResult',
+            model_properties: {
+              groups: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'groups',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ArrayElementType',
+                      type: {
+                        name: 'Sequence',
+                        element: {
+                            client_side_validation: true,
+                            required: false,
+                            serialized_name: 'UuidElementType',
+                            type: {
+                              name: 'String'
+                            }
+                        }
+                      }
+                  }
+                }
+              },
+              messy_group: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'messyGroup',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'UuidElementType',
+                      type: {
+                        name: 'String'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/hair.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Face::V1_0
+  module Models
+    #
+    # Properties describing hair attributes.
+    #
+    class Hair
+
+      include MsRestAzure
+
+      # @return [Float] A number describing confidence level of whether the
+      # person is bald.
+      attr_accessor :bald
+
+      # @return [Boolean] A boolean value describing whether the hair is
+      # visible in the image.
+      attr_accessor :invisible
+
+      # @return [Array<HairColor>] An array of candidate colors and confidence
+      # level in the presence of each.
+      attr_accessor :hair_color
+
+
+      #
+      # Mapper for Hair class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Hair',
+          type: {
+            name: 'Composite',
+            class_name: 'Hair',
+            model_properties: {
+              bald: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'bald',
+                type: {
+                  name: 'Double'
+                }
+              },
+              invisible: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'invisible',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              hair_color: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'hairColor',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'HairColorElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'HairColor'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/hair_color.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Face::V1_0
+  module Models
+    #
+    # Hair color and associated confidence
+    #
+    class HairColor
+
+      include MsRestAzure
+
+      # @return [HairColorType] Name of the hair color. Possible values
+      # include: 'unknown', 'white', 'gray', 'blond', 'brown', 'red', 'black',
+      # 'other'
+      attr_accessor :color
+
+      # @return [Float] Confidence level of the color
+      attr_accessor :confidence
+
+
+      #
+      # Mapper for HairColor class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'HairColor',
+          type: {
+            name: 'Composite',
+            class_name: 'HairColor',
+            model_properties: {
+              color: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'color',
+                type: {
+                  name: 'Enum',
+                  module: 'HairColorType'
+                }
+              },
+              confidence: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'confidence',
+                type: {
+                  name: 'Double'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/hair_color_type.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Face::V1_0
+  module Models
+    #
+    # Defines values for HairColorType
+    #
+    module HairColorType
+      Unknown = "unknown"
+      White = "white"
+      Gray = "gray"
+      Blond = "blond"
+      Brown = "brown"
+      Red = "red"
+      Black = "black"
+      Other = "other"
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/head_pose.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Face::V1_0
+  module Models
+    #
+    # Properties indicating head pose of the face.
+    #
+    class HeadPose
+
+      include MsRestAzure
+
+      # @return [Float]
+      attr_accessor :roll
+
+      # @return [Float]
+      attr_accessor :yaw
+
+      # @return [Float]
+      attr_accessor :pitch
+
+
+      #
+      # Mapper for HeadPose class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'HeadPose',
+          type: {
+            name: 'Composite',
+            class_name: 'HeadPose',
+            model_properties: {
+              roll: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'roll',
+                type: {
+                  name: 'Double'
+                }
+              },
+              yaw: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'yaw',
+                type: {
+                  name: 'Double'
+                }
+              },
+              pitch: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'pitch',
+                type: {
+                  name: 'Double'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/identify_candidate.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Face::V1_0
+  module Models
+    #
+    # All possible faces that may qualify.
+    #
+    class IdentifyCandidate
+
+      include MsRestAzure
+
+      # @return Id of candidate
+      attr_accessor :person_id
+
+      # @return [Float] Confidence threshold of identification, used to judge
+      # whether one face belong to one person. The range of confidenceThreshold
+      # is [0, 1] (default specified by algorithm).
+      attr_accessor :confidence
+
+
+      #
+      # Mapper for IdentifyCandidate class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'IdentifyCandidate',
+          type: {
+            name: 'Composite',
+            class_name: 'IdentifyCandidate',
+            model_properties: {
+              person_id: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'personId',
+                type: {
+                  name: 'String'
+                }
+              },
+              confidence: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'confidence',
+                type: {
+                  name: 'Double'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/identify_request.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Face::V1_0
+  module Models
+    #
+    # Request body for identify face operation.
+    #
+    class IdentifyRequest
+
+      include MsRestAzure
+
+      # @return [String] PersonGroupId of the target person group, created by
+      # PersonGroups.Create
+      attr_accessor :person_group_id
+
+      # @return Array of query faces faceIds, created by the Face - Detect.
+      # Each of the faces are identified independently. The valid number of
+      # faceIds is between [1, 10].
+      attr_accessor :face_ids
+
+      # @return [Integer] The range of maxNumOfCandidatesReturned is between 1
+      # and 5 (default is 1). Default value: 1 .
+      attr_accessor :max_num_of_candidates_returned
+
+      # @return [Float] Confidence threshold of identification, used to judge
+      # whether one face belong to one person. The range of confidenceThreshold
+      # is [0, 1] (default specified by algorithm).
+      attr_accessor :confidence_threshold
+
+
+      #
+      # Mapper for IdentifyRequest class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'IdentifyRequest',
+          type: {
+            name: 'Composite',
+            class_name: 'IdentifyRequest',
+            model_properties: {
+              person_group_id: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'personGroupId',
+                constraints: {
+                  MaxLength: 64,
+                  Pattern: '^[a-z0-9-_]+$'
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              face_ids: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'faceIds',
+                constraints: {
+                  MaxItems: 10
+                },
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'UuidElementType',
+                      type: {
+                        name: 'String'
+                      }
+                  }
+                }
+              },
+              max_num_of_candidates_returned: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'maxNumOfCandidatesReturned',
+                default_value: 1,
+                constraints: {
+                  InclusiveMaximum: 5,
+                  InclusiveMinimum: 1
+                },
+                type: {
+                  name: 'Number'
+                }
+              },
+              confidence_threshold: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'confidenceThreshold',
+                type: {
+                  name: 'Double'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end