class Azure::CognitiveServices::Face::V1_0::Models::SimilarFace

Response body for find similar face operation.

Attributes

confidence[RW]

@return [Float] Similarity confidence of the candidate face. The higher confidence, the more similar. Range between [0,1].

face_id[RW]

@return FaceId of candidate face when find by faceIds. faceId is created by Face - Detect and will expire 24 hours after the detection call

persisted_face_id[RW]

@return PersistedFaceId of candidate face when find by faceListId. persistedFaceId in face list is persisted and will not expire. As showed in below response

Private Class Methods

mapper() click to toggle source

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

# File lib/1.0/generated/azure_cognitiveservices_face/models/similar_face.rb, line 34
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