class Azure::CognitiveServices::Face::V1_0::Models::VerifyFaceToPersonRequest

Request body for face to person verification.

Attributes

face_id[RW]

@return FaceId of the face, comes from Face - Detect

large_person_group_id[RW]

@return [String] Using existing largePersonGroupId and personId for fast loading a specified person. largePersonGroupId is created in LargePersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

person_group_id[RW]

@return [String] Using existing personGroupId and personId for fast loading a specified person. personGroupId is created in PersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

person_id[RW]

@return Specify a certain person in a person group or a large person group. personId is created in PersonGroup Person - Create or LargePersonGroup Person - Create.

Private Class Methods

mapper() click to toggle source

Mapper for VerifyFaceToPersonRequest class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/1.0/generated/azure_cognitiveservices_face/models/verify_face_to_person_request.rb, line 40
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'VerifyFaceToPersonRequest',
    type: {
      name: 'Composite',
      class_name: 'VerifyFaceToPersonRequest',
      model_properties: {
        face_id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'faceId',
          type: {
            name: 'String'
          }
        },
        person_group_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'personGroupId',
          constraints: {
            MaxLength: 64,
            Pattern: '^[a-z0-9-_]+$'
          },
          type: {
            name: 'String'
          }
        },
        large_person_group_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'largePersonGroupId',
          constraints: {
            MaxLength: 64,
            Pattern: '^[a-z0-9-_]+$'
          },
          type: {
            name: 'String'
          }
        },
        person_id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'personId',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end