Python SDK
The Python SDK enables you to use IntelliProves features with ease.
Requirements
- Python 3.9 or up
Installation
Installation of our Python SDK can be done with pip through PyPi.
Updating the SDK
API Key
More info on authentication and the api key can be found here: Authentication docs .
Functionality
Check conditions
Check the quality of a given video or image before upload. Returns a Quality object with feedback on whether your video/image is usable and why it might not be usable.
Parameters:
- path: Path - path to the a video or image you want to check the quality of
Upload a video
Easily upload a video to IntelliProve for analysis of the subjects biomarkers. Returns the uuid of the uploaded video, which can be used to get the results.
Parameters:
- video_path: Path - path to the video that needs to be upload
- performer: str - Optional, the name of the person who performed the capture of the video
- patient: str - Optional, the name of the person who performed the capture of the video
Get results
Returns the results of a proccessed video for a given uuid as a Biomarkers object.
Parameters:
- uuid: str - uuid of the uploaded video
Return types
Quality
Describes the quality of a video or image.
Biomarkers
Holds the results of an analysed video after upload.
Exceptions
ImageQualityException When trying to upload a video that does not fulfil the requirements.
MediaException Invalid video or image file provided.
ApiNotFoundException The asked for resource could not be found. Eg. wrong uuid.
ApiForbiddenException You don't have access to this functionality, most likely due to an invalid api key.
ApiErrorException There was an error in executing your request. This could be due to various reasons, eg. no internet connection, a server error, the IntelliProve API could not be reached.
ApiResultNotAvailable The uuid you provide is valid, but the video is not processed yet and has no result available yet.
Example usage