Interface SearchUsersRequest

interface SearchUsersRequest {
    CollectionId: undefined | string;
    FaceId?: string;
    MaxUsers?: number;
    UserId?: string;
    UserMatchThreshold?: number;
}

Hierarchy (view full)

Properties

CollectionId FaceId? MaxUsers? UserId? UserMatchThreshold?

Properties

CollectionId

CollectionId: undefined | string

The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.

Optional FaceId

FaceId?: string

ID for the existing face.

Optional MaxUsers

MaxUsers?: number

Maximum number of identities to return.

Optional UserId

UserId?: string

ID for the existing User.

Optional UserMatchThreshold

UserMatchThreshold?: number

Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.

Settings

Member Visibility

Theme

On This Page