dsp_api module

DSPApi

class edgeimpulse_api.api.dsp_api.DSPApi(
		api_client=None
)

Parameters

api_client=None

Methods

clear_dsp_block

edgeimpulse_api.api.dsp_api.clear_dsp_block(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Clear DSP block

Clear generated features for a DSP block (used in tests).

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

download_dsp_artifact

edgeimpulse_api.api.dsp_api.download_dsp_artifact(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		key: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='DSP artifact file key', extra={})],
		**kwargs
) ‑> str

Download a DSP artifact

Download an artifact from a DSP block for debugging. This is an internal API.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
key: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='DSP artifact file key', extra={})]
**kwargs

Return

str

download_dsp_data

edgeimpulse_api.api.dsp_api.download_dsp_data(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to download data from', extra={})],
		raw: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to download raw data or processed data. Processed data is the default.', extra={})] = None,
		**kwargs
) ‑> str

Download DSP data

Download output from a DSP block over all data in the training set, already sliced in windows. In Numpy binary format.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to download data from', extra={})]
raw: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to download raw data or processed data. Processed data is the default.', extra={})] = None
**kwargs

Return

str

download_dsp_labels

edgeimpulse_api.api.dsp_api.download_dsp_labels(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to download data from', extra={})],
		**kwargs
) ‑> str

Download DSP labels

Download labels for a DSP block over all data in the training set, already sliced in windows.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to download data from', extra={})]
**kwargs

Return

str

dsp_get_features_for_sample

edgeimpulse_api.api.dsp_api.dsp_get_features_for_sample(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.dsp_sample_features_response.DspSampleFeaturesResponse

Features for sample

Runs the DSP block against a sample. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and run the DSP function for every window that is extracted.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs

Return

edgeimpulse_api.models.dsp_sample_features_response.DspSampleFeaturesResponse

dsp_sample_trained_features

edgeimpulse_api.api.dsp_api.dsp_sample_trained_features(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		feature_ax1: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Feature axis 1', extra={})],
		feature_ax2: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Feature axis 2', extra={})],
		feature_ax3: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Feature axis 3', extra={})],
		category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to download data from', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.dsp_trained_features_response.DspTrainedFeaturesResponse

Sample of trained features

Get a sample of trained features, this extracts a number of samples and their labels. Used to visualize the current training set.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
feature_ax1: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Feature axis 1', extra={})]
feature_ax2: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Feature axis 2', extra={})]
feature_ax3: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Feature axis 3', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to download data from', extra={})]
**kwargs

Return

edgeimpulse_api.models.dsp_trained_features_response.DspTrainedFeaturesResponse

get_autotuner_results

edgeimpulse_api.api.dsp_api.get_autotuner_results(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.dsp_autotuner_results.DspAutotunerResults

Get results from DSP autotuner

Get a set of parameters, found as a result of running the DSP autotuner.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs

Return

edgeimpulse_api.models.dsp_autotuner_results.DspAutotunerResults

get_dsp_config

edgeimpulse_api.api.dsp_api.get_dsp_config(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.dsp_config_response.DSPConfigResponse

Get config

Retrieve the configuration parameters for the DSP block. Use the impulse functions to retrieve all DSP blocks.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs

Return

edgeimpulse_api.models.dsp_config_response.DSPConfigResponse

get_dsp_feature_importance

edgeimpulse_api.api.dsp_api.get_dsp_feature_importance(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.dsp_feature_importance_response.DspFeatureImportanceResponse

Feature importance

Retrieve the feature importance for a DSP block (only available for blocks where dimensionalityReduction is not enabled)

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs

Return

edgeimpulse_api.models.dsp_feature_importance_response.DspFeatureImportanceResponse

get_dsp_feature_labels

edgeimpulse_api.api.dsp_api.get_dsp_feature_labels(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.dsp_feature_labels_response.DspFeatureLabelsResponse

Feature labels

Retrieve the names of the features the DSP block generates

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs

Return

edgeimpulse_api.models.dsp_feature_labels_response.DspFeatureLabelsResponse

get_dsp_metadata

edgeimpulse_api.api.dsp_api.get_dsp_metadata(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		exclude_included_samples: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description="Whether to exclude 'includedSamples' in the response (as these can slow down requests significantly).", extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.dsp_metadata_response.DSPMetadataResponse

Get metadata

Retrieve the metadata from a generated DSP block.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
exclude_included_samples: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description="Whether to exclude 'includedSamples' in the response (as these can slow down requests significantly).", extra={})] = None
**kwargs

Return

edgeimpulse_api.models.dsp_metadata_response.DSPMetadataResponse

get_dsp_raw_sample

edgeimpulse_api.api.dsp_api.get_dsp_raw_sample(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		limit_payload_values: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Limit the number of payload values in the response', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.get_sample_response.GetSampleResponse

Get raw sample

Get raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out. If you pass dspId = 0 this will return a raw graph without any processing.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
limit_payload_values: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Limit the number of payload values in the response', extra={})] = None
**kwargs

Return

edgeimpulse_api.models.get_sample_response.GetSampleResponse

get_dsp_sample_slice

edgeimpulse_api.api.dsp_api.get_dsp_sample_slice(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		slice_start: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Begin index of the slice', extra={})],
		slice_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.get_sample_response.GetSampleResponse

Get raw sample (slice)

Get slice of raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
slice_start: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Begin index of the slice', extra={})]
slice_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.', extra={})] = None
**kwargs

Return

edgeimpulse_api.models.get_sample_response.GetSampleResponse

get_performance_all_variants

edgeimpulse_api.api.dsp_api.get_performance_all_variants(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.dsp_performance_all_variants_response.DspPerformanceAllVariantsResponse

Get DSP block performance for all latency devices

Get estimated performance (latency and RAM) for the DSP block, for all supported project latency devices.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
**kwargs

Return

edgeimpulse_api.models.dsp_performance_all_variants_response.DspPerformanceAllVariantsResponse

run_dsp_on_features_array

edgeimpulse_api.api.dsp_api.run_dsp_on_features_array(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		dsp_run_request_with_features: edgeimpulse_api.models.dsp_run_request_with_features.DspRunRequestWithFeatures,
		**kwargs
) ‑> edgeimpulse_api.models.dsp_run_response.DspRunResponse

Get processed sample (from features array)

Takes in a features array and runs it through the DSP block. This data should have the same frequency as set in the input block in your impulse.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
dsp_run_request_with_features: edgeimpulse_api.models.dsp_run_request_with_features.DspRunRequestWithFeatures
**kwargs

Return

edgeimpulse_api.models.dsp_run_response.DspRunResponse

run_dsp_sample_slice

edgeimpulse_api.api.dsp_api.run_dsp_sample_slice(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		slice_start: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Begin index of the slice', extra={})],
		dsp_run_request_without_features: edgeimpulse_api.models.dsp_run_request_without_features.DspRunRequestWithoutFeatures,
		slice_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.dsp_run_response_with_sample.DspRunResponseWithSample

Get processed sample (slice)

Get slice of sample data, and run it through the DSP block. This only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
slice_start: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Begin index of the slice', extra={})]
dsp_run_request_without_features: edgeimpulse_api.models.dsp_run_request_without_features.DspRunRequestWithoutFeatures
slice_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.', extra={})] = None
**kwargs

Return

edgeimpulse_api.models.dsp_run_response_with_sample.DspRunResponseWithSample

run_dsp_sample_slice_read_only

edgeimpulse_api.api.dsp_api.run_dsp_sample_slice_read_only(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		slice_start: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Begin index of the slice', extra={})],
		slice_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.dsp_run_response_with_sample.DspRunResponseWithSample

Get processed sample (slice)

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
slice_start: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Begin index of the slice', extra={})]
slice_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.', extra={})] = None
**kwargs

Return

edgeimpulse_api.models.dsp_run_response_with_sample.DspRunResponseWithSample

set_dsp_config

edgeimpulse_api.api.dsp_api.set_dsp_config(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		dsp_config_request: edgeimpulse_api.models.dsp_config_request.DSPConfigRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Set config

Set configuration parameters for the DSP block. Only values set in the body will be overwritten.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
dsp_config_request: edgeimpulse_api.models.dsp_config_request.DSPConfigRequest
**kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

start_profile_custom_dsp_block

edgeimpulse_api.api.dsp_api.start_profile_custom_dsp_block(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})],
		dsp_run_request_without_features_read_only: edgeimpulse_api.models.dsp_run_request_without_features_read_only.DspRunRequestWithoutFeaturesReadOnly,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

Profile custom DSP block

Returns performance characteristics for a custom DSP block (needs hasTfliteImplementation). Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
dsp_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='DSP Block ID, use the impulse functions to retrieve the ID', extra={})]
dsp_run_request_without_features_read_only: edgeimpulse_api.models.dsp_run_request_without_features_read_only.DspRunRequestWithoutFeaturesReadOnly
**kwargs

Return

edgeimpulse_api.models.start_job_response.StartJobResponse

Previousdevices_api module Nextemail_verification_api module

Last updated 2 months ago