# API Reference ### get\_version ```python def get_version() -> str: ```


Name	get_version
Description	Retrieves the SDK version information from a library.
Input	None
Output	The version string is returned as a standard Python string.

### get\_device\_id ```python def get_device_id() -> str: ```


Name	get_device_id
Description	Retrieves the Hardware ID from a library.
Input	None
Output	The Hardware ID is returned as a standard Python string.

### init\_sdk {% code overflow="wrap" %} ```python def init_sdk(dict_path: str, online_key: str) -> int: ``` {% endcode %}


Name	init_sdk
Description	Initializes the SDK in online mode.
Input	dict_path (str): Path to the engine binary files directory online_key (str): Online key string
Output	Status code indicating the result of the initialization. 0: Success Non-zero: Initialization failed

### init\_sdk\_offline {% code overflow="wrap" %} ```python def init_sdk_offline(dict_path: str, offline_key_path: str) -> int: ``` {% endcode %}


Name	init_sdk_offline
Description	Initializes the SDK in offline mode.
Input	dict_path (str): Path to the engine binary files directory offline_key (str): Path to the offline license key file
Output	Status code indicating the result of the initialization. 0: Success Non-zero: Initialization failed

### extract\_template {% code overflow="wrap" %} ```python def extract_template(image: np.ndarray, width: int, height: int, face_bbox: np.ndarray, template: np.ndarray, template_len: np.ndarray) -> int: ``` {% endcode %}


Name	extract_template
Description	Extracts a template from an image
Input	image (numpy.ndarray): Input image matrix width (int): Width of the input image height (int): Height of the input image face_bbox (numpy.ndarray): Face bounding box coordinates. Extracted face bbox will be stored template (numpy.ndarray): Template buffer. Extracted template will be stored template_len (numpy.ndarray): Length of the extracted template
Output	Status code indicating the result of the template extraction. >0: Success 0: No Face -1: SDK Activation Error -2: SDK Initialization Error

### calculate\_similarity ```python def calculate_similarity(feature_1: np.ndarray, feature_2: np.ndarray) -> float: ```


Name	calculate_similarity
Description	Calculates the similarity between two features
Input	feature_1 (numpy.ndarray): 1st feature feature_2 (numpy.ndarray): 2nd feature
Output	Similarity score between the two features The score ranges from 0.0 to 1.0 Default Threshold is 0.67

--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.recognito.vision/face-recognition-sdk/integration-guide/linux/api-reference.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.