class Azure::CognitiveServices::Face::V1_0::Models::IdentifyResult

Response body for identify face operation.

Attributes

candidates[RW]

@return [Array<IdentifyCandidate>] Identified person candidates for that face (ranked by confidence). Array size should be no larger than input maxNumOfCandidatesReturned. If no person is identified, will return an empty array.

face_id[RW]

@return FaceId of the query face

Private Class Methods

mapper() click to toggle source

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

# File lib/1.0/generated/azure_cognitiveservices_face/models/identify_result.rb, line 29
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'IdentifyResult',
    type: {
      name: 'Composite',
      class_name: 'IdentifyResult',
      model_properties: {
        face_id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'faceId',
          type: {
            name: 'String'
          }
        },
        candidates: {
          client_side_validation: true,
          required: true,
          serialized_name: 'candidates',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'IdentifyCandidateElementType',
                type: {
                  name: 'Composite',
                  class_name: 'IdentifyCandidate'
                }
            }
          }
        }
      }
    }
  }
end