RFSSearchPersonRequest


@interface RFSSearchPersonRequest : NSObject

Request object that configures Search settings.

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

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSArray<NSString *> *groupIdsForSearch;

  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSNumber *threshold;

  • The number of returned Persons limit. Default: 100.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSNumber *limit;

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

    Declaration

    Objective-C

    @property (nonatomic) BOOL detectAll;

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

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) RFSOutputImageParams *outputImageParams;

  • Image Upload object to appply search with.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) RFSImageUpload *_Nonnull imageUpload;

  • Creates new Search request. The request will perform search only in specified groups.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithGroupIds:
                            (nullable NSArray<NSString *> *)groupIdsForSearch
                             imageUpload:(nonnull RFSImageUpload *)imageUpload;

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithImageUpload:(RFSImageUpload *)imageUpload;

  • Unavailable

    Not the designated initializer

    Undocumented

    Declaration

    Objective-C

    RFS_EMPTY_INIT_UNAVAILABLE

  • Unavailable

    Not the designated initializer

    Undocumented

    Declaration

    Objective-C

    RFS_EMPTY_INIT_UNAVAILABLE