raw_data_api module

RawDataApi

class edgeimpulse_api.api.raw_data_api.RawDataApi(
		api_client=None
)

Parameters

  • api_client=None

Methods

batch_delete

edgeimpulse_api.api.raw_data_api.batch_delete(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})],
		labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None,
		filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None,
		max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None,
		min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None,
		min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None,
		max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None,
		signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None,
		include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None,
		ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None,
		exclude_ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None,
		search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None,
		**kwargs
)> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Remove multiple samples

Deletes samples. Note that this does not delete the data from cold storage.

Parameters

  • self

  • project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

  • category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]

  • labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None

  • filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None

  • max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None

  • min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None

  • min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None

  • max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None

  • signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None

  • include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None

  • ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None

  • exclude_ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None

  • search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

batch_disable

edgeimpulse_api.api.raw_data_api.batch_disable(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})],
		labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None,
		filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None,
		max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None,
		min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None,
		min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None,
		max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None,
		signature_validity: typing_extensions.Annotated[Optional[pydantic.types.Stri