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