Skip to main content

FeatureHubConfiguration

Configuration settings for the FeatureHub functionality. FeatureHub is a built-in global lightweight face feature vector management system. It supports basic face feature search, deletion, and modification functions, and offers two optional data storage modes: in-memory and persistence.

type FeatureHubConfiguration = {
searchMode: SearchMode;
enablePersistence: boolean;
persistenceDbPath: string;
searchThreshold: number;
primaryKeyMode: PrimaryKeyMode;
};

Properties

PropertyTypeDescription
searchModeSearchModeMode of face search affecting execution efficiency and results
enablePersistencebooleanFlag to enable or disable data persistence
persistenceDbPathstringPath to the database file for persistence storage
searchThresholdnumberThreshold value for face search comparisons. Default to 0.48
primaryKeyModePrimaryKeyModeMode for managing primary keys in the database