Python SDK

﻿
The Python SDK enables you to use IntelliProves features with ease.
Requirements
Python 3.9 or up
Tested on
Python 3.9
Python 3.10
Python 3.11
Installation
You can find our SDK on the PyPi package manager repository for easy installation:
﻿https://pypi.org/project/intelliprove/﻿
Shell
pip install intelliprove
pip install intelliprove
﻿
Updating the SDK
Shell
pip install intelliprove --upgrade
pip install intelliprove --upgrade
﻿
Authentication
More info on authentication and the API key can be found here: API docs﻿ .
﻿
Functionality
Check conditions
Check the quality of a given video or image before uploading.
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 video or image you want to check the quality of
Python
api = IntelliproveApi('apikey')
video_path = Path('/path/to/video.mp4')
quality = api.check_conditions(video_path)
api = IntelliproveApi('apikey')
video_path = Path('/path/to/video.mp4')
quality = api.check_conditions(video_path)
﻿
Upload a video
Easily upload a video to IntelliProve for analysis of the subject's biomarkers.
Returns the uuid of the uploaded video, which can be used to get the results.
NOTE: The quality check needs to be successful before you can upload a video.
Parameters:
video_path: Path - path to the video that needs to be uploaded
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
Python
from pathlib import Path

api = IntelliproveApi('apikey')
video_path = Path('/path/to/video.mp4')
uuid = api.upload(video_path)
from pathlib import Path

api = IntelliproveApi('apikey')
video_path = Path('/path/to/video.mp4')
uuid = api.upload(video_path)
﻿
Get the results of a video
Returns the results of a processed video for a given uuid as a Biomarkers object.
NOTE: This uses long polling, when demand is high this call can take a while.
Parameters:
uuid: str - uuid of the uploaded video
Raises:
VideoProcessingFailedException
Python
uuid = 'uploaded-video-uuid' # result of the api.upload method
api = IntelliproveApi('apikey')
biomarkers = api.get_results(uuid)
uuid = 'uploaded-video-uuid' # result of the api.upload method
api = IntelliproveApi('apikey')
biomarkers = api.get_results(uuid)
﻿
﻿
Models
Quality
Describes the quality of a video or image.
Python
@dataclass
class Quality:
    score: int
    error_type: QualityErrorType
    message: str
@dataclass
class Quality:
    score: int
    error_type: QualityErrorType
    message: str
﻿
Biomarkers
Holds the results of an analyzed video after upload.
Python
@dataclass
class Biomarkers:
    """Data class that contains the extracted biomarkers"""
    timestamp: datetime
    mental_health_risk: Optional[MentalHealthRiskScore]
    heart_rate: Optional[int] = None
    respiratory_rate: Optional[int] = None
    heart_rate_variability: Optional[int] = None
    ans_balance: Optional[int] = None
    morning_readiness: Optional[int] = None
    acute_mental_stress_score: Optional[int] = None
    resonant_breathing_score: Optional[int] = None

@dataclass
class Biomarkers:
    """Data class that contains the extracted biomarkers"""
    timestamp: datetime
    mental_health_risk: Optional[MentalHealthRiskScore]
    heart_rate: Optional[int] = None
    respiratory_rate: Optional[int] = None
    heart_rate_variability: Optional[int] = None
    ans_balance: Optional[int] = None
    morning_readiness: Optional[int] = None
    acute_mental_stress_score: Optional[int] = None
    resonant_breathing_score: Optional[int] = None
﻿
UnprocessableVideoResponse
Contains information on why a video was unprocessable.
Python
@dataclass
class UnprocessableVideoResponse:
    error_code: int
    error_type: str
    error_description: str
@dataclass
class UnprocessableVideoResponse:
    error_code: int
    error_type: str
    error_description: str
﻿
﻿
Exceptions
ImageQualityException
When trying to upload a video that does not fulfill the requirements.
MediaException
Invalid video or image file provided.
VideoProcessingFailedException
This exception gets raised whenever a video you uploaded was unprocessable. Contains a response property (UnprocessableVideoResponse) with more information.
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, or the IntelliProve API could not be reached.
ApiResultNotAvailable
The UUID you provided is valid, but the video has not been processed yet and has no result available yet.
﻿
Example usage
Provided with a valid API key and a valid image and video path, this code snippet runs from start to finish.
Python
import os
from pathlib import Path

from intelliprove.api import IntelliproveApi, IntelliproveApiSettings, Biomarkers, Quality

# define api key and settings
apikey = os.environ.get('apikey')
settings = IntelliproveApiSettings(
    base_url=''
)

# init api
api = IntelliproveApi(apikey, settings)

# define the path of the video you want to upload
video_path = Path('./mydir/example.mp4')
image_path = Path('./mydir/example.png')

# manually check quality of a video of image
quality: Quality = api.check_conditions(video_path)
quality: Quality = api.check_conditions(image_path)

# Optional: define the performer and patient
performer: str = 'performer-a'
patient: str = 'patient-1'

# upload video to IntelliProve
# performer and patient are optional
uuid: str = api.upload(video_path)
# or
uuid: str = api.upload(video_path, performer=performer, patient=patient)

# get the results of the uploaded video
results: Biomarkers = api.get_results(uuid)
import os
from pathlib import Path

from intelliprove.api import IntelliproveApi, IntelliproveApiSettings, Biomarkers, Quality

# define api key and settings
apikey = os.environ.get('apikey')
settings = IntelliproveApiSettings(
    base_url=''
)

# init api
api = IntelliproveApi(apikey, settings)

# define the path of the video you want to upload
video_path = Path('./mydir/example.mp4')
image_path = Path('./mydir/example.png')

# manually check quality of a video of image
quality: Quality = api.check_conditions(video_path)
quality: Quality = api.check_conditions(image_path)

# Optional: define the performer and patient
performer: str = 'performer-a'
patient: str = 'patient-1'

# upload video to IntelliProve
# performer and patient are optional
uuid: str = api.upload(video_path)
# or
uuid: str = api.upload(video_path, performer=performer, patient=patient)

# get the results of the uploaded video
results: Biomarkers = api.get_results(uuid)
﻿
﻿
TABLE OF CONTENTS
Requirements
Get the results of a video
Models
Quality
Biomarkers
UnprocessableVideoResponse
Exceptions
Example usage