performance_calibration_api module#

class edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi(api_client=None)[source]#

Bases: object

delete_performance_calibration_saved_parameters(
project_id: StrictInt[StrictInt],
**kwargs,
) → GenericApiResponse[source]#

Clear performance calibration parameters

Clears the current performance calibration parameters

Parameters:

  • project_id (int) – Project ID (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

get_performance_calibration_ground_truth(
project_id: StrictInt[StrictInt],
**kwargs,
) → GetPerformanceCalibrationGroundTruthResponse[source]#

Get ground truth

Get performance calibration ground truth data

Parameters:

  • project_id (int) – Project ID (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetPerformanceCalibrationGroundTruthResponse

get_performance_calibration_parameter_sets(
project_id: StrictInt[StrictInt],
**kwargs,
) → GetPerformanceCalibrationParameterSetsResponse[source]#

Get parameter sets

Get performance calibration parameter sets

Parameters:

  • project_id (int) – Project ID (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetPerformanceCalibrationParameterSetsResponse

get_performance_calibration_raw_result(
project_id: StrictInt[StrictInt],
**kwargs,
) → GetPerformanceCalibrationRawResultResponse[source]#

Get raw result

Get performance calibration raw result

Parameters:

  • project_id (int) – Project ID (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetPerformanceCalibrationRawResultResponse

get_performance_calibration_saved_parameters(
project_id: StrictInt[StrictInt],
**kwargs,
) → GetPerformanceCalibrationParametersResponse[source]#

Get parameters

Get performance calibration stored parameters

Parameters:

  • project_id (int) – Project ID (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetPerformanceCalibrationParametersResponse

get_performance_calibration_status(
project_id: StrictInt[StrictInt],
**kwargs,
) → GetPerformanceCalibrationStatusResponse[source]#

Get status

Get performance calibration status

Parameters:

  • project_id (int) – Project ID (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetPerformanceCalibrationStatusResponse

get_wav_file(
project_id: StrictInt[StrictInt],
**kwargs,
) → str[source]#

Get WAV file

Get the synthetic sample as a WAV file

Parameters:

  • project_id (int) – Project ID (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

str

set_performance_calibration_saved_parameters(
project_id: StrictInt[StrictInt],
performance_calibration_save_parameter_set_request: PerformanceCalibrationSaveParameterSetRequest,
**kwargs,
) → GenericApiResponse[source]#

Save performance calibration parameters

Set the current performance calibration parameters

Parameters:

  • project_id (int) – Project ID (required)

  • performance_calibration_save_parameter_set_request (PerformanceCalibrationSaveParameterSetRequest) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

upload_labeled_audio(
project_id: StrictInt[StrictInt],
zip: StrictStr,
**kwargs,
) → PerformanceCalibrationUploadLabeledAudioResponse[source]#

Upload Performance Calibration Audio files

Upload a zip files with a wav file and its Label metadata to run performance calibration on it.

Parameters:

  • project_id (int) – Project ID (required)

  • zip (str) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PerformanceCalibrationUploadLabeledAudioResponse