# 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 identify face operation.
    #
    class IdentifyResult

      include MsRestAzure

      # @return FaceId of the query face
      attr_accessor :face_id

      # @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.
      attr_accessor :candidates


      #
      # Mapper for IdentifyResult class as Ruby Hash.
      # This will be used for serialization/deserialization.
      #
      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
    end
  end
end
