class Azure::CognitiveServices::Face::V1_0::Models::FindSimilarRequest

Request body for find similar operation.

Attributes

face_id[RW]

@return FaceId of the query face. User needs to call Face - Detect first to get a valid faceId. Note that this faceId is not persisted and will expire 24 hours after the detection call

face_ids[RW]

@return An array of candidate faceIds. All of them are created by Face

  • Detect and the faceIds will expire 24 hours after the detection call.

The number of faceIds is limited to 1000. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.

face_list_id[RW]

@return [String] An existing user-specified unique candidate face list, created in Face List - Create a Face List. Face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.

large_face_list_id[RW]

@return [String] An existing user-specified unique candidate large face list, created in LargeFaceList - Create. Large face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.

max_num_of_candidates_returned[RW]

@return [Integer] The number of top similar faces returned. The valid range is [1, 1000]. Default value: 20 .

mode[RW]

@return [FindSimilarMatchMode] Similar face searching mode. It can be “matchPerson” or “matchFace”. Possible values include: 'matchPerson', 'matchFace'. Default value: 'matchPerson' .

Private Class Methods

mapper() click to toggle source

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

# File lib/1.0/generated/azure_cognitiveservices_face/models/find_similar_request.rb, line 54
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'FindSimilarRequest',
    type: {
      name: 'Composite',
      class_name: 'FindSimilarRequest',
      model_properties: {
        face_id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'faceId',
          type: {
            name: 'String'
          }
        },
        face_list_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'faceListId',
          constraints: {
            MaxLength: 64,
            Pattern: '^[a-z0-9-_]+$'
          },
          type: {
            name: 'String'
          }
        },
        large_face_list_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'largeFaceListId',
          constraints: {
            MaxLength: 64,
            Pattern: '^[a-z0-9-_]+$'
          },
          type: {
            name: 'String'
          }
        },
        face_ids: {
          client_side_validation: true,
          required: false,
          serialized_name: 'faceIds',
          constraints: {
            MaxItems: 1000
          },
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'UuidElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        max_num_of_candidates_returned: {
          client_side_validation: true,
          required: false,
          serialized_name: 'maxNumOfCandidatesReturned',
          default_value: 20,
          constraints: {
            InclusiveMaximum: 1000,
            InclusiveMinimum: 1
          },
          type: {
            name: 'Number'
          }
        },
        mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'mode',
          default_value: 'matchPerson',
          type: {
            name: 'Enum',
            module: 'FindSimilarMatchMode'
          }
        }
      }
    }
  }
end