azure_cognitiveservices_face 0.16.0

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,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
+    #
+    # Person group object.
+    #
+    class PersonGroup < NameAndUserDataContract
+
+      include MsRestAzure
+
+      # @return [String] PersonGroupId of the existing person groups.
+      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'
+                }
+              },
+              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/similar_face.rb

@@ -0,0 +1,73 @@
+# 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
+    #
+    # Response body for find similar face operation.
+    #
+    class SimilarFace
+
+      include MsRestAzure
+
+      # @return FaceId of candidate face when find by faceIds. faceId is
+      # created by Face - Detect and will expire 24 hours after the detection
+      # call
+      attr_accessor :face_id
+
+      # @return PersistedFaceId of candidate face when find by faceListId.
+      # persistedFaceId in face list is persisted and will not expire. As
+      # showed in below response
+      attr_accessor :persisted_face_id
+
+      # @return [Float] Similarity confidence of the candidate face. The higher
+      # confidence, the more similar. Range between [0,1].
+      attr_accessor :confidence
+
+
+      #
+      # Mapper for SimilarFace class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'SimilarFace',
+          type: {
+            name: 'Composite',
+            class_name: 'SimilarFace',
+            model_properties: {
+              face_id: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'faceId',
+                type: {
+                  name: 'String'
+                }
+              },
+              persisted_face_id: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'persistedFaceId',
+                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/training_status.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
+    #
+    # Training status object.
+    #
+    class TrainingStatus
+
+      include MsRestAzure
+
+      # @return [TrainingStatusType] Training status: notstarted, running,
+      # succeeded, failed. If the training process is waiting to perform, the
+      # status is notstarted. If the training is ongoing, the status is
+      # running. Status succeed means this person group is ready for Face -
+      # Identify. Status failed is often caused by no person or no persisted
+      # face exist in the person group. Possible values include: 'nonstarted',
+      # 'running', 'succeeded', 'failed'
+      attr_accessor :status
+
+      # @return [DateTime] A combined UTC date and time string that describes
+      # person group created time.
+      attr_accessor :created
+
+      # @return [DateTime] Person group last modify time in the UTC, could be
+      # null value when the person group is not successfully trained.
+      attr_accessor :last_action
+
+      # @return [String] Show failure message when training failed (omitted
+      # when training succeed).
+      attr_accessor :message
+
+
+      #
+      # Mapper for TrainingStatus class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'TrainingStatus',
+          type: {
+            name: 'Composite',
+            class_name: 'TrainingStatus',
+            model_properties: {
+              status: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'status',
+                type: {
+                  name: 'Enum',
+                  module: 'TrainingStatusType'
+                }
+              },
+              created: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'createdDateTime',
+                type: {
+                  name: 'DateTime'
+                }
+              },
+              last_action: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'lastActionDateTime',
+                type: {
+                  name: 'DateTime'
+                }
+              },
+              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/training_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 TrainingStatusType
+    #
+    module TrainingStatusType
+      Nonstarted = "nonstarted"
+      Running = "running"
+      Succeeded = "succeeded"
+      Failed = "failed"
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# 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 to update person face data.
+    #
+    class UpdatePersonFaceRequest
+
+      include MsRestAzure
+
+      # @return [String] User-provided data attached to the face. The size
+      # limit is 1KB.
+      attr_accessor :user_data
+
+
+      #
+      # Mapper for UpdatePersonFaceRequest class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'UpdatePersonFaceRequest',
+          type: {
+            name: 'Composite',
+            class_name: 'UpdatePersonFaceRequest',
+            model_properties: {
+              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/verify_face_to_face_request.rb

@@ -0,0 +1,57 @@
+# 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 verify operation.
+    #
+    class VerifyFaceToFaceRequest
+
+      include MsRestAzure
+
+      # @return FaceId of the first face, comes from Face - Detect
+      attr_accessor :face_id1
+
+      # @return FaceId of the second face, comes from Face - Detect
+      attr_accessor :face_id2
+
+
+      #
+      # Mapper for VerifyFaceToFaceRequest class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'VerifyFaceToFaceRequest',
+          type: {
+            name: 'Composite',
+            class_name: 'VerifyFaceToFaceRequest',
+            model_properties: {
+              face_id1: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'faceId1',
+                type: {
+                  name: 'String'
+                }
+              },
+              face_id2: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'faceId2',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end