be_azure_cognitiveservices_face 0.19.5

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

@@ -0,0 +1,101 @@
+# 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
+    #
+    # Face list object.
+    #
+    class FaceList < MetaDataContract
+
+      include MsRestAzure
+
+      # @return [String] FaceListId of the target face list.
+      attr_accessor :face_list_id
+
+      # @return [Array<PersistedFace>] Persisted faces within the face list.
+      attr_accessor :persisted_faces
+
+
+      #
+      # Mapper for FaceList class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'FaceList',
+          type: {
+            name: 'Composite',
+            class_name: 'FaceList',
+            model_properties: {
+              name: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'name',
+                constraints: {
+                  MaxLength: 128
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              user_data: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'userData',
+                constraints: {
+                  MaxLength: 16384
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              recognition_model: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'recognitionModel',
+                default_value: 'recognition_01',
+                type: {
+                  name: 'String'
+                }
+              },
+              face_list_id: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'faceListId',
+                constraints: {
+                  MaxLength: 64,
+                  Pattern: '^[a-z0-9-_]+$'
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              persisted_faces: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'persistedFaces',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'PersistedFaceElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'PersistedFace'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# 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
+    #
+    # A rectangle within which a face can be found
+    #
+    class FaceRectangle
+
+      include MsRestAzure
+
+      # @return [Integer] The width of the rectangle, in pixels.
+      attr_accessor :width
+
+      # @return [Integer] The height of the rectangle, in pixels.
+      attr_accessor :height
+
+      # @return [Integer] The distance from the left edge if the image to the
+      # left edge of the rectangle, in pixels.
+      attr_accessor :left
+
+      # @return [Integer] The distance from the top edge if the image to the
+      # top edge of the rectangle, in pixels.
+      attr_accessor :top
+
+
+      #
+      # Mapper for FaceRectangle class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'FaceRectangle',
+          type: {
+            name: 'Composite',
+            class_name: 'FaceRectangle',
+            model_properties: {
+              width: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'width',
+                type: {
+                  name: 'Number'
+                }
+              },
+              height: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'height',
+                type: {
+                  name: 'Number'
+                }
+              },
+              left: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'left',
+                type: {
+                  name: 'Number'
+                }
+              },
+              top: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'top',
+                type: {
+                  name: 'Number'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/facial_hair.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 describing facial hair attributes.
+    #
+    class FacialHair
+
+      include MsRestAzure
+
+      # @return [Float]
+      attr_accessor :moustache
+
+      # @return [Float]
+      attr_accessor :beard
+
+      # @return [Float]
+      attr_accessor :sideburns
+
+
+      #
+      # Mapper for FacialHair class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'FacialHair',
+          type: {
+            name: 'Composite',
+            class_name: 'FacialHair',
+            model_properties: {
+              moustache: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'moustache',
+                type: {
+                  name: 'Double'
+                }
+              },
+              beard: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'beard',
+                type: {
+                  name: 'Double'
+                }
+              },
+              sideburns: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'sideburns',
+                type: {
+                  name: 'Double'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# 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 FindSimilarMatchMode
+    #
+    module FindSimilarMatchMode
+      MatchPerson = "matchPerson"
+      MatchFace = "matchFace"
+    end
+  end
+end

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

@@ -0,0 +1,143 @@
+# 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 find similar operation.
+    #
+    class FindSimilarRequest
+
+      include MsRestAzure
+
+      # @return FaceId of the query face. User needs to call Face - Detect
+      # first to get a valid faceId. Note that this faceId is not persisted and
+      # will expire 24 hours after the detection call
+      attr_accessor :face_id
+
+      # @return [String] An existing user-specified unique candidate face list,
+      # created in Face List - Create a Face List. Face list contains a set of
+      # persistedFaceIds which are persisted and will never expire. Parameter
+      # faceListId, largeFaceListId and faceIds should not be provided at the
+      # same time.
+      attr_accessor :face_list_id
+
+      # @return [String] An existing user-specified unique candidate large face
+      # list, created in LargeFaceList - Create. Large face list contains a set
+      # of persistedFaceIds which are persisted and will never expire.
+      # Parameter faceListId, largeFaceListId and faceIds should not be
+      # provided at the same time.
+      attr_accessor :large_face_list_id
+
+      # @return An array of candidate faceIds. All of them are created by Face
+      # - Detect and the faceIds will expire 24 hours after the detection call.
+      # The number of faceIds is limited to 1000. Parameter faceListId,
+      # largeFaceListId and faceIds should not be provided at the same time.
+      attr_accessor :face_ids
+
+      # @return [Integer] The number of top similar faces returned. The valid
+      # range is [1, 1000]. Default value: 20 .
+      attr_accessor :max_num_of_candidates_returned
+
+      # @return [FindSimilarMatchMode] Similar face searching mode. It can be
+      # "matchPerson" or "matchFace". Possible values include: 'matchPerson',
+      # 'matchFace'. Default value: 'matchPerson' .
+      attr_accessor :mode
+
+
+      #
+      # Mapper for FindSimilarRequest class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'FindSimilarRequest',
+          type: {
+            name: 'Composite',
+            class_name: 'FindSimilarRequest',
+            model_properties: {
+              face_id: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'faceId',
+                type: {
+                  name: 'String'
+                }
+              },
+              face_list_id: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'faceListId',
+                constraints: {
+                  MaxLength: 64,
+                  Pattern: '^[a-z0-9-_]+$'
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              large_face_list_id: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'largeFaceListId',
+                constraints: {
+                  MaxLength: 64,
+                  Pattern: '^[a-z0-9-_]+$'
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              face_ids: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'faceIds',
+                constraints: {
+                  MaxItems: 1000
+                },
+                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: 20,
+                constraints: {
+                  InclusiveMaximum: 1000,
+                  InclusiveMinimum: 1
+                },
+                type: {
+                  name: 'Number'
+                }
+              },
+              mode: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'mode',
+                default_value: 'matchPerson',
+                type: {
+                  name: 'Enum',
+                  module: 'FindSimilarMatchMode'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# 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 Gender
+    #
+    module Gender
+      Male = "male"
+      Female = "female"
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# 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 GlassesType
+    #
+    module GlassesType
+      NoGlasses = "noGlasses"
+      ReadingGlasses = "readingGlasses"
+      Sunglasses = "sunglasses"
+      SwimmingGoggles = "swimmingGoggles"
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# 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 group request.
+    #
+    class GroupRequest
+
+      include MsRestAzure
+
+      # @return Array of candidate faceId created by Face - Detect. The maximum
+      # is 1000 faces
+      attr_accessor :face_ids
+
+
+      #
+      # Mapper for GroupRequest class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'GroupRequest',
+          type: {
+            name: 'Composite',
+            class_name: 'GroupRequest',
+            model_properties: {
+              face_ids: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'faceIds',
+                constraints: {
+                  MaxItems: 1000
+                },
+                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/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