1N Identification

SDK.create_database_connection(self: tfsdk.SDK, database_connection_string: str) → Trueface::ErrorCode

Create a connection to a new or existing database. If the database does not exist, a new one will be created with the provided name. If the NONE DatabaseManagementSystem (memory only) configuration option is selected, this function does not need to be called (and is a harmless no-op)

SDK.create_load_collection(self: tfsdk.SDK, collection_name: str) → Trueface::ErrorCode

Create a new collection, or load data from an existing collection if one with the provided name already exists in the database.

SDK.enroll_template(self: tfsdk.SDK, faceprint: Trueface::Faceprint, identity: str) → Tuple[Trueface::ErrorCode, str]

Enroll a template for a new or existing identity in the collection. Returns the UUID for the template.

SDK.remove_by_UUID(self: tfsdk.SDK, UUID: str) → Trueface::ErrorCode

Remove a template from the collection using the UUID.

SDK.remove_by_identity(self: tfsdk.SDK, identity: str) → Trueface::ErrorCode

Remove all templates in the collection corresponding to the identity.

SDK.identify_top_candidate(self: tfsdk.SDK, faceprint: Trueface::Faceprint, threshold: float = 0.3) → Tuple[Trueface::ErrorCode, bool, Trueface::Candidate]

Get the top candidate identity in the collection and the corresponding similarity score and match probability. Returns true if a match is found.

SDK.batch_identify_top_candidate(self: tfsdk.SDK, faceprints: List[Trueface::Faceprint], threshold: float = 0.3) → Tuple[Trueface::ErrorCode, List[bool], List[Trueface::Candidate]]

Get the top candidate identity in the collection and the corresponding similarity score and match probability for each probe faceprint. Like identifyTopCandidate, but runs search queries in parallel and improves throughput.

SDK.identify_top_candidates(self: tfsdk.SDK, faceprint: Trueface::Faceprint, num_candidates: int, threshold: float = 0.3) → Tuple[Trueface::ErrorCode, bool, List[Trueface::Candidate]]

Get a list of the top n candidate identities in the collection and their corresponding similarity scores and match probabilities. Returns true if at least one match is found.

class tfsdk.Candidate
property UUID

The UUID of the match.

property identity

The identity of the match.

property match_probability

The probability the two face feature vectors are a match.

property similarity_measure

The computed similarity measure.