edgeimpulse_api.api.performance_calibration_api

Classes

PerformanceCalibrationApi

edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi(
	api_client=None
)

Parameters
`api_client=None`

METHODS

clear_performance_calibration_state

edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi.clear_performance_calibration_state(
	self,
	project_id: Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
	impulse_id: Annotated[pydantic.v1.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
	**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Clear Performance Calibration state Deletes all state related to performance calibration (used in tests for example).

Parameters
`self`
`project_id`	`Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]`
`impulse_id`	`Annotated[pydantic.v1.types.StrictInt \| None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None`
`**kwargs`

Returns
`edgeimpulse_api.models.generic_api_response.GenericApiResponse`

delete_performance_calibration_saved_parameters

edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi.delete_performance_calibration_saved_parameters(
	self,
	project_id: Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
	impulse_id: Annotated[pydantic.v1.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
	**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Clear performance calibration parameters Clears the current performance calibration parameters

Parameters
`self`
`project_id`	`Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]`
`impulse_id`	`Annotated[pydantic.v1.types.StrictInt \| None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None`
`**kwargs`

Returns
`edgeimpulse_api.models.generic_api_response.GenericApiResponse`

get_performance_calibration_ground_truth

edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi.get_performance_calibration_ground_truth(
	self,
	project_id: Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
	impulse_id: Annotated[pydantic.v1.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
	**kwargs
) ‑> edgeimpulse_api.models.get_performance_calibration_ground_truth_response.GetPerformanceCalibrationGroundTruthResponse

Get ground truth Get performance calibration ground truth data

Parameters
`self`
`project_id`	`Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]`
`impulse_id`	`Annotated[pydantic.v1.types.StrictInt \| None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None`
`**kwargs`

Returns
`edgeimpulse_api.models.get_performance_calibration_ground_truth_response.GetPerformanceCalibrationGroundTruthResponse`

get_performance_calibration_parameter_sets

edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi.get_performance_calibration_parameter_sets(
	self,
	project_id: Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
	impulse_id: Annotated[pydantic.v1.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
	**kwargs
) ‑> edgeimpulse_api.models.get_performance_calibration_parameter_sets_response.GetPerformanceCalibrationParameterSetsResponse

Get parameter sets Get performance calibration parameter sets

Parameters
`self`
`project_id`	`Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]`
`impulse_id`	`Annotated[pydantic.v1.types.StrictInt \| None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None`
`**kwargs`

Returns
`edgeimpulse_api.models.get_performance_calibration_parameter_sets_response.GetPerformanceCalibrationParameterSetsResponse`

get_performance_calibration_raw_result

edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi.get_performance_calibration_raw_result(
	self,
	project_id: Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
	impulse_id: Annotated[pydantic.v1.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
	**kwargs
) ‑> edgeimpulse_api.models.get_performance_calibration_raw_result_response.GetPerformanceCalibrationRawResultResponse

Get raw result Get performance calibration raw result

Parameters
`self`
`project_id`	`Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]`
`impulse_id`	`Annotated[pydantic.v1.types.StrictInt \| None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None`
`**kwargs`

Returns
`edgeimpulse_api.models.get_performance_calibration_raw_result_response.GetPerformanceCalibrationRawResultResponse`

get_performance_calibration_saved_parameters

edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi.get_performance_calibration_saved_parameters(
	self,
	project_id: Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
	impulse_id: Annotated[pydantic.v1.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
	**kwargs
) ‑> edgeimpulse_api.models.get_performance_calibration_parameters_response.GetPerformanceCalibrationParametersResponse

Get parameters Get performance calibration stored parameters

Parameters
`self`
`project_id`	`Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]`
`impulse_id`	`Annotated[pydantic.v1.types.StrictInt \| None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None`
`**kwargs`

Returns
`edgeimpulse_api.models.get_performance_calibration_parameters_response.GetPerformanceCalibrationParametersResponse`

get_performance_calibration_status

edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi.get_performance_calibration_status(
	self,
	project_id: Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
	impulse_id: Annotated[pydantic.v1.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
	**kwargs
) ‑> edgeimpulse_api.models.get_performance_calibration_status_response.GetPerformanceCalibrationStatusResponse

Get status Get performance calibration status

Parameters
`self`
`project_id`	`Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]`
`impulse_id`	`Annotated[pydantic.v1.types.StrictInt \| None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None`
`**kwargs`

Returns
`edgeimpulse_api.models.get_performance_calibration_status_response.GetPerformanceCalibrationStatusResponse`

get_wav_file

edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi.get_wav_file(
	self,
	project_id: Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
	impulse_id: Annotated[pydantic.v1.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
	**kwargs
) ‑> str

Get WAV file Get the synthetic sample as a WAV file

Parameters
`self`
`project_id`	`Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]`
`impulse_id`	`Annotated[pydantic.v1.types.StrictInt \| None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None`
`**kwargs`

Returns
`str`

set_performance_calibration_saved_parameters

edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi.set_performance_calibration_saved_parameters(
	self,
	project_id: Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
	performance_calibration_save_parameter_set_request: edgeimpulse_api.models.performance_calibration_save_parameter_set_request.PerformanceCalibrationSaveParameterSetRequest,
	impulse_id: Annotated[pydantic.v1.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
	**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Save performance calibration parameters Set the current performance calibration parameters

Parameters
`self`
`project_id`	`Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]`
`performance_calibration_save_parameter_set_request`	`edgeimpulse_api.models.performance_calibration_save_parameter_set_request.PerformanceCalibrationSaveParameterSetRequest`
`impulse_id`	`Annotated[pydantic.v1.types.StrictInt \| None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None`
`**kwargs`

Returns
`edgeimpulse_api.models.generic_api_response.GenericApiResponse`

upload_labeled_audio

edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi.upload_labeled_audio(
	self,
	project_id: Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
	zip: pydantic.v1.types.StrictStr,
	impulse_id: Annotated[pydantic.v1.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
	**kwargs
) ‑> edgeimpulse_api.models.performance_calibration_upload_labeled_audio_response.PerformanceCalibrationUploadLabeledAudioResponse

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

Parameters
`self`
`project_id`	`Annotated[pydantic.v1.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]`
`zip`	`pydantic.v1.types.StrictStr`
`impulse_id`	`Annotated[pydantic.v1.types.StrictInt \| None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None`
`**kwargs`

Returns
`edgeimpulse_api.models.performance_calibration_upload_labeled_audio_response.PerformanceCalibrationUploadLabeledAudioResponse`

OVERVIEW

CLIs

LIBRARIES

SPECIFICATIONS

PROTOCOLS

edgeimpulse_api.api.performance_calibration_api

Classes

PerformanceCalibrationApi

clear_performance_calibration_state

delete_performance_calibration_saved_parameters

get_performance_calibration_ground_truth

get_performance_calibration_parameter_sets

get_performance_calibration_raw_result

get_performance_calibration_saved_parameters

get_performance_calibration_status

get_wav_file

set_performance_calibration_saved_parameters

upload_labeled_audio

​Classes

​PerformanceCalibrationApi

​clear_performance_calibration_state

​delete_performance_calibration_saved_parameters

​get_performance_calibration_ground_truth

​get_performance_calibration_parameter_sets

​get_performance_calibration_raw_result

​get_performance_calibration_saved_parameters

​get_performance_calibration_status

​get_wav_file

​set_performance_calibration_saved_parameters

​upload_labeled_audio

Classes

PerformanceCalibrationApi

clear_performance_calibration_state

delete_performance_calibration_saved_parameters

get_performance_calibration_ground_truth

get_performance_calibration_parameter_sets

get_performance_calibration_raw_result

get_performance_calibration_saved_parameters

get_performance_calibration_status

get_wav_file

set_performance_calibration_saved_parameters

upload_labeled_audio