be_azure_cognitiveservices_face 0.19.5

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/snapshot.rb

@@ -0,0 +1,136 @@
+# 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
+    #
+    # Snapshot object.
+    #
+    class Snapshot
+
+      include MsRestAzure
+
+      # @return Snapshot id.
+      attr_accessor :id
+
+      # @return [String] Azure Cognitive Service Face account id of the
+      # subscriber who created the snapshot by Snapshot - Take.
+      attr_accessor :account
+
+      # @return [SnapshotObjectType] Type of the source object in the snapshot,
+      # specified by the subscriber who created the snapshot when calling
+      # Snapshot - Take. Currently FaceList, PersonGroup, LargeFaceList and
+      # LargePersonGroup are supported. Possible values include: 'FaceList',
+      # 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
+      attr_accessor :type
+
+      # @return Array of the target Face subscription ids for the snapshot,
+      # specified by the user who created the snapshot when calling Snapshot -
+      # Take. For each snapshot, only subscriptions included in the applyScope
+      # of Snapshot - Take can apply it.
+      attr_accessor :apply_scope
+
+      # @return [String] User specified data about the snapshot for any
+      # purpose. Length should not exceed 16KB.
+      attr_accessor :user_data
+
+      # @return [DateTime] A combined UTC date and time string that describes
+      # the created time of the snapshot. 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 when the snapshot was created or updated by Snapshot -
+      # Update. E.g. 2018-12-25T11:51:27.8705696Z.
+      attr_accessor :last_update_time
+
+
+      #
+      # Mapper for Snapshot class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Snapshot',
+          type: {
+            name: 'Composite',
+            class_name: 'Snapshot',
+            model_properties: {
+              id: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'id',
+                type: {
+                  name: 'String'
+                }
+              },
+              account: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'account',
+                type: {
+                  name: 'String'
+                }
+              },
+              type: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'type',
+                type: {
+                  name: 'Enum',
+                  module: 'SnapshotObjectType'
+                }
+              },
+              apply_scope: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'applyScope',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'UuidElementType',
+                      type: {
+                        name: 'String'
+                      }
+                  }
+                }
+              },
+              user_data: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'userData',
+                constraints: {
+                  MaxLength: 16384
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              created_time: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'createdTime',
+                type: {
+                  name: 'DateTime'
+                }
+              },
+              last_update_time: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'lastUpdateTime',
+                type: {
+                  name: 'DateTime'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# 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 SnapshotApplyMode
+    #
+    module SnapshotApplyMode
+      CreateNew = "CreateNew"
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/snapshot_object_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 SnapshotObjectType
+    #
+    module SnapshotObjectType
+      FaceList = "FaceList"
+      LargeFaceList = "LargeFaceList"
+      LargePersonGroup = "LargePersonGroup"
+      PersonGroup = "PersonGroup"
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_face/models/take_snapshot_request.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
+    #
+    # Request body for taking snapshot operation.
+    #
+    class TakeSnapshotRequest
+
+      include MsRestAzure
+
+      # @return [SnapshotObjectType] User specified type for the source object
+      # to take snapshot from. Currently FaceList, PersonGroup, LargeFaceList
+      # and LargePersonGroup are supported. Possible values include:
+      # 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
+      attr_accessor :type
+
+      # @return [String] User specified source object id to take snapshot from.
+      attr_accessor :object_id
+
+      # @return User specified array of target Face subscription ids for the
+      # snapshot. For each snapshot, only subscriptions included in the
+      # applyScope of Snapshot - Take can apply it.
+      attr_accessor :apply_scope
+
+      # @return [String] User specified data about the snapshot for any
+      # purpose. Length should not exceed 16KB.
+      attr_accessor :user_data
+
+
+      #
+      # Mapper for TakeSnapshotRequest class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'TakeSnapshotRequest',
+          type: {
+            name: 'Composite',
+            class_name: 'TakeSnapshotRequest',
+            model_properties: {
+              type: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'type',
+                type: {
+                  name: 'Enum',
+                  module: 'SnapshotObjectType'
+                }
+              },
+              object_id: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'objectId',
+                constraints: {
+                  MaxLength: 64,
+                  Pattern: '^[a-z0-9-_]+$'
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              apply_scope: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'applyScope',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'UuidElementType',
+                      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/training_status.rb

@@ -0,0 +1,107 @@
+# 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 or large person group
+      # is ready for Face - Identify, or this large face list is ready for Face
+      # - Find Similar. Status failed is often caused by no person or no
+      # persisted face exist in the person group or large person group, or no
+      # persisted face exist in the large face list. Possible values include:
+      # 'nonstarted', 'running', 'succeeded', 'failed'
+      attr_accessor :status
+
+      # @return [DateTime] A combined UTC date and time string that describes
+      # the created time of the person group, large person group or large face
+      # list.
+      attr_accessor :created
+
+      # @return [DateTime] A combined UTC date and time string that describes
+      # the last modify time of the person group, large person group or large
+      # face list, could be null value when the group is not successfully
+      # trained.
+      attr_accessor :last_action
+
+      # @return [DateTime] A combined UTC date and time string that describes
+      # the last successful training time of the person group, large person
+      # group or large face list.
+      attr_accessor :last_successful_training
+
+      # @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'
+                }
+              },
+              last_successful_training: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'lastSuccessfulTrainingDateTime',
+                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_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 face data.
+    #
+    class UpdateFaceRequest
+
+      include MsRestAzure
+
+      # @return [String] User-provided data attached to the face. The size
+      # limit is 1KB.
+      attr_accessor :user_data
+
+
+      #
+      # Mapper for UpdateFaceRequest class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'UpdateFaceRequest',
+          type: {
+            name: 'Composite',
+            class_name: 'UpdateFaceRequest',
+            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/update_snapshot_request.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
+    #
+    # Request body for updating a snapshot, with a combination of user defined
+    # apply scope and user specified data.
+    #
+    class UpdateSnapshotRequest
+
+      include MsRestAzure
+
+      # @return Array of the target Face subscription ids for the snapshot,
+      # specified by the user who created the snapshot when calling Snapshot -
+      # Take. For each snapshot, only subscriptions included in the applyScope
+      # of Snapshot - Take can apply it.
+      attr_accessor :apply_scope
+
+      # @return [String] User specified data about the snapshot for any
+      # purpose. Length should not exceed 16KB.
+      attr_accessor :user_data
+
+
+      #
+      # Mapper for UpdateSnapshotRequest class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'UpdateSnapshotRequest',
+          type: {
+            name: 'Composite',
+            class_name: 'UpdateSnapshotRequest',
+            model_properties: {
+              apply_scope: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'applyScope',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'UuidElementType',
+                      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/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 face to face verification.
+    #
+    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