be_azure_cognitiveservices_face 0.19.5

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

@@ -0,0 +1,72 @@
+# 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 combination of user defined name and user specified data and
+    # recognition model name for largePersonGroup/personGroup, and
+    # largeFaceList/faceList.
+    #
+    class MetaDataContract < NameAndUserDataContract
+
+      include MsRestAzure
+
+      # @return [RecognitionModel] Possible values include: 'recognition_01',
+      # 'recognition_02'. Default value: 'recognition_01' .
+      attr_accessor :recognition_model
+
+
+      #
+      # Mapper for MetaDataContract class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'MetaDataContract',
+          type: {
+            name: 'Composite',
+            class_name: 'MetaDataContract',
+            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'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# 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 combination of user defined name and user specified data for the
+    # person, largePersonGroup/personGroup, and largeFaceList/faceList.
+    #
+    class NameAndUserDataContract
+
+      include MsRestAzure
+
+      # @return [String] User defined name, maximum length is 128.
+      attr_accessor :name
+
+      # @return [String] User specified data. Length should not exceed 16KB.
+      attr_accessor :user_data
+
+
+      #
+      # Mapper for NameAndUserDataContract class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'NameAndUserDataContract',
+          type: {
+            name: 'Composite',
+            class_name: 'NameAndUserDataContract',
+            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'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# 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 noise level of the image.
+    #
+    class Noise
+
+      include MsRestAzure
+
+      # @return [NoiseLevel] An enum value indicating level of noise. Possible
+      # values include: 'Low', 'Medium', 'High'
+      attr_accessor :noise_level
+
+      # @return [Float] A number indicating level of noise level ranging from 0
+      # to 1. [0, 0.25) is under exposure. [0.25, 0.75) is good exposure.
+      # [0.75, 1] is over exposure. [0, 0.3) is low noise level. [0.3, 0.7) is
+      # medium noise level. [0.7, 1] is high noise level.
+      attr_accessor :value
+
+
+      #
+      # Mapper for Noise class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Noise',
+          type: {
+            name: 'Composite',
+            class_name: 'Noise',
+            model_properties: {
+              noise_level: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'noiseLevel',
+                type: {
+                  name: 'Enum',
+                  module: 'NoiseLevel'
+                }
+              },
+              value: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'value',
+                type: {
+                  name: 'Double'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# 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 NoiseLevel
+    #
+    module NoiseLevel
+      Low = "Low"
+      Medium = "Medium"
+      High = "High"
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# 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 occlusions on a given face.
+    #
+    class Occlusion
+
+      include MsRestAzure
+
+      # @return [Boolean] A boolean value indicating whether forehead is
+      # occluded.
+      attr_accessor :forehead_occluded
+
+      # @return [Boolean] A boolean value indicating whether eyes are occluded.
+      attr_accessor :eye_occluded
+
+      # @return [Boolean] A boolean value indicating whether the mouth is
+      # occluded.
+      attr_accessor :mouth_occluded
+
+
+      #
+      # Mapper for Occlusion class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Occlusion',
+          type: {
+            name: 'Composite',
+            class_name: 'Occlusion',
+            model_properties: {
+              forehead_occluded: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'foreheadOccluded',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              eye_occluded: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'eyeOccluded',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              mouth_occluded: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'mouthOccluded',
+                type: {
+                  name: 'Boolean'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+# 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
+    #
+    # Operation status object. Operation refers to the asynchronous backend
+    # task including taking a snapshot and applying a snapshot.
+    #
+    class OperationStatus
+
+      include MsRestAzure
+
+      # @return [OperationStatusType] Operation status: notstarted, running,
+      # succeeded, failed. If the operation is requested and waiting to
+      # perform, the status is notstarted. If the operation is ongoing in
+      # backend, the status is running. Status succeeded means the operation is
+      # completed successfully, specifically for snapshot taking operation, it
+      # illustrates the snapshot is well taken and ready to apply, and for
+      # snapshot applying operation, it presents the target object has finished
+      # creating by the snapshot and ready to be used. Status failed is often
+      # caused by editing the source object while taking the snapshot or
+      # editing the target object while applying the snapshot before
+      # completion, see the field "message" to check the failure reason.
+      # Possible values include: 'notstarted', 'running', 'succeeded', 'failed'
+      attr_accessor :status
+
+      # @return [DateTime] A combined UTC date and time string that describes
+      # the time when the operation (take or apply a snapshot) is requested.
+      # E.g. 2018-12-25T11:41:02.2331413Z.
+      attr_accessor :created_time
+
+      # @return [DateTime] A combined UTC date and time string that describes
+      # the last time the operation (take or apply a snapshot) is actively
+      # migrating data. The lastActionTime will keep increasing until the
+      # operation finishes. E.g. 2018-12-25T11:51:27.8705696Z.
+      attr_accessor :last_action_time
+
+      # @return [String] When the operation succeeds successfully, for snapshot
+      # taking operation the snapshot id will be included in this field, and
+      # for snapshot applying operation, the path to get the target object will
+      # be returned in this field.
+      attr_accessor :resource_location
+
+      # @return [String] Show failure message when operation fails (omitted
+      # when operation succeeds).
+      attr_accessor :message
+
+
+      #
+      # Mapper for OperationStatus class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'OperationStatus',
+          type: {
+            name: 'Composite',
+            class_name: 'OperationStatus',
+            model_properties: {
+              status: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'status',
+                type: {
+                  name: 'Enum',
+                  module: 'OperationStatusType'
+                }
+              },
+              created_time: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'createdTime',
+                type: {
+                  name: 'DateTime'
+                }
+              },
+              last_action_time: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'lastActionTime',
+                type: {
+                  name: 'DateTime'
+                }
+              },
+              resource_location: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'resourceLocation',
+                type: {
+                  name: 'String'
+                }
+              },
+              message: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'message',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/operation_status_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 OperationStatusType
+    #
+    module OperationStatusType
+      Notstarted = "notstarted"
+      Running = "running"
+      Succeeded = "succeeded"
+      Failed = "failed"
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# 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
+    #
+    # PersonFace object.
+    #
+    class PersistedFace
+
+      include MsRestAzure
+
+      # @return The persistedFaceId of the target face, which is persisted and
+      # will not expire. Different from faceId created by Face - Detect and
+      # will expire in 24 hours after the detection call.
+      attr_accessor :persisted_face_id
+
+      # @return [String] User-provided data attached to the face. The size
+      # limit is 1KB.
+      attr_accessor :user_data
+
+
+      #
+      # Mapper for PersistedFace class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'PersistedFace',
+          type: {
+            name: 'Composite',
+            class_name: 'PersistedFace',
+            model_properties: {
+              persisted_face_id: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'persistedFaceId',
+                type: {
+                  name: 'String'
+                }
+              },
+              user_data: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'userData',
+                constraints: {
+                  MaxLength: 1024
+                },
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# 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
+    #
+    # Person object.
+    #
+    class Person < NameAndUserDataContract
+
+      include MsRestAzure
+
+      # @return PersonId of the target face list.
+      attr_accessor :person_id
+
+      # @return PersistedFaceIds of registered faces in the person. These
+      # persistedFaceIds are returned from Person - Add a Person Face, and will
+      # not expire.
+      attr_accessor :persisted_face_ids
+
+
+      #
+      # Mapper for Person class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Person',
+          type: {
+            name: 'Composite',
+            class_name: 'Person',
+            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'
+                }
+              },
+              person_id: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'personId',
+                type: {
+                  name: 'String'
+                }
+              },
+              persisted_face_ids: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'persistedFaceIds',
+                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/person_group.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
+    #
+    # Person group object.
+    #
+    class PersonGroup < MetaDataContract
+
+      include MsRestAzure
+
+      # @return [String] PersonGroupId of the target person group.
+      attr_accessor :person_group_id
+
+
+      #
+      # Mapper for PersonGroup class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'PersonGroup',
+          type: {
+            name: 'Composite',
+            class_name: 'PersonGroup',
+            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'
+                }
+              },
+              person_group_id: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'personGroupId',
+                constraints: {
+                  MaxLength: 64,
+                  Pattern: '^[a-z0-9-_]+$'
+                },
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/recognition_model.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 RecognitionModel
+    #
+    module RecognitionModel
+      Recognition01 = "recognition_01"
+      Recognition02 = "recognition_02"
+    end
+  end
+end