Class SearchPersonRequest

constructor

• new SearchPersonRequest(image, params?): SearchPersonRequest

• Create SearchPersonRequest object.

  Parameters

  • image: ImageUpload

    Image Upload object to apply search with.
  • Optionalparams: {
        detectAll?: boolean;
        groupIdsForSearch?: string[];
        limit?: number;
        outputImageParams?: OutputImageParams;
        tag?: string;
        threshold?: number;
    }

    • OptionaldetectAll?: boolean

      Whether to process only the one face on the image or all the faces. Default: false.

    • OptionalgroupIdsForSearch?: string[]

      The Group IDs of the groups in which the search is performed.

    • Optionallimit?: number

      The number of returned Persons limit. Default: 100.

    • OptionaloutputImageParams?: OutputImageParams

      If set the uploaded image is processed according to the indicated settings.

    • Optionaltag?: string

    • Optionalthreshold?: number

      The similarity distance threshold, should be between 0.0 and 2.0, where 0.0 is for returning results for only the most similar persons and 2.0 is for all the persons, even the dissimilar ones. Default: 1.

  Returns SearchPersonRequest