class Azure::CognitiveServices::Face::V1_0::Models::IdentifyRequest
Request body for identify face operation.
Attributes
@return [Float] Confidence threshold of identification, used to judge whether one face belong to one person. The range of confidenceThreshold is [0, 1] (default specified by algorithm).
@return Array of query faces faceIds, created by the Face
- Detect. Each of the faces are identified independently. The valid number of faceIds is between [1, 10].
@return [String] LargePersonGroupId of the target large person group, created by LargePersonGroup
- Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.
@return [Integer] The range of maxNumOfCandidatesReturned is between 1 and 5 (default is 1). Default value: 1 .
@return [String] PersonGroupId of the target person group, created by PersonGroup
- Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.
Private Class Methods
Mapper for IdentifyRequest
class as Ruby Hash. This will be used for serialization/deserialization.
# File lib/1.0/generated/azure_cognitiveservices_face/models/identify_request.rb, line 44 def self.mapper() { client_side_validation: true, required: false, serialized_name: 'IdentifyRequest', type: { name: 'Composite', class_name: 'IdentifyRequest', model_properties: { face_ids: { client_side_validation: true, required: true, serialized_name: 'faceIds', constraints: { MaxItems: 10 }, type: { name: 'Sequence', element: { client_side_validation: true, required: false, serialized_name: 'UuidElementType', 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' } }, max_num_of_candidates_returned: { client_side_validation: true, required: false, serialized_name: 'maxNumOfCandidatesReturned', default_value: 1, constraints: { InclusiveMaximum: 5, InclusiveMinimum: 1 }, type: { name: 'Number' } }, confidence_threshold: { client_side_validation: true, required: false, serialized_name: 'confidenceThreshold', type: { name: 'Double' } } } } } end