raw_data_api module

RawDataApi

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

Parameters

• api_client=None

Methods

batch_add_metadata

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

Add metadata (multiple samples)

Add specific metadata for multiple samples.

Parameters

• self

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

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

• batch_add_metadata_request: edgeimpulse_api.models.batch_add_metadata_request.BatchAddMetadataRequest

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

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

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

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

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

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

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

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

• ids: Annotated[pydantic.types.StrictStr | None, 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: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None

• min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label >= this value', extra={})] = None

• max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label < this value', extra={})] = None

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

• **kwargs

Return

edgeimpulse_api.models.split_sample_in_frames200_response.SplitSampleInFrames200Response

batch_clear_metadata

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

Clear all metadata (multiple samples)

Clears all metadata for multiple samples.

Parameters

• self

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

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

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

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

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

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

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

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

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

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

• ids: Annotated[pydantic.types.StrictStr | None, 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: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None

• min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label >= this value', extra={})] = None

• max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label < this value', extra={})] = None

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

batch_clear_metadata_by_key

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

Clear metadata by key (multiple samples)

Clears a specific metadata field (by key) for multiple samples.

Parameters

• self

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

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

• batch_clear_metadata_by_key_request: edgeimpulse_api.models.batch_clear_metadata_by_key_request.BatchClearMetadataByKeyRequest

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

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

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

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

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

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

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

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

• ids: Annotated[pydantic.types.StrictStr | None, 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: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None

• min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label >= this value', extra={})] = None

• max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label < this value', extra={})] = None

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

• **kwargs

Return

edgeimpulse_api.models.split_sample_in_frames200_response.SplitSampleInFrames200Response

batch_delete

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

Remove multiple samples

Deletes samples. Note that this does not delete the data from cold storage. Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.

Parameters

• self

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

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

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

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

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

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

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

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

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

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

• ids: Annotated[pydantic.types.StrictStr | None, 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: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None

• min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label >= this value', extra={})] = None

• max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label < this value', extra={})] = None

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

• **kwargs

Return

edgeimpulse_api.models.split_sample_in_frames200_response.SplitSampleInFrames200Response

batch_disable

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

Disable multiple samples

Disables samples, ensuring that they are excluded from the dataset. Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.

Parameters

• self

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

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

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

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

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

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

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

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

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

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

• ids: Annotated[pydantic.types.StrictStr | None, 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: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None

• min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label >= this value', extra={})] = None

• max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label < this value', extra={})] = None

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

• **kwargs

Return

edgeimpulse_api.models.split_sample_in_frames200_response.SplitSampleInFrames200Response

batch_edit_labels

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

Edit labels for multiple samples

Sets the label (also known as class) of multiple samples. Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.

Parameters

• self

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

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

• edit_sample_label_request: edgeimpulse_api.models.edit_sample_label_request.EditSampleLabelRequest

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

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

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

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

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

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

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

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

• ids: Annotated[pydantic.types.StrictStr | None, 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: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None

• min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label >= this value', extra={})] = None

• max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label < this value', extra={})] = None

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

• **kwargs

Return

edgeimpulse_api.models.split_sample_in_frames200_response.SplitSampleInFrames200Response

batch_enable

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

Enable multiple samples

Enables samples, ensuring that they are not excluded from the dataset. Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.

Parameters

• self

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

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

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

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

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

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

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

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

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

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

• ids: Annotated[pydantic.types.StrictStr | None, 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: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None

• min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label >= this value', extra={})] = None

• max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label < this value', extra={})] = None

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

• **kwargs

Return

edgeimpulse_api.models.split_sample_in_frames200_response.SplitSampleInFrames200Response

batch_move

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

Move multiple samples

Move multiple samples to another category (e.g. from test to training). Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.

Parameters

• self

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

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

• move_raw_data_request: edgeimpulse_api.models.move_raw_data_request.MoveRawDataRequest

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

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

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

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

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

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

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

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

• ids: Annotated[pydantic.types.StrictStr | None, 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: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None

• min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label >= this value', extra={})] = None

• max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label < this value', extra={})] = None

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

• **kwargs

Return

edgeimpulse_api.models.split_sample_in_frames200_response.SplitSampleInFrames200Response

classify_using_autolabel

edgeimpulse_api.api.raw_data_api.classify_using_autolabel(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		object_detection_auto_label_request: edgeimpulse_api.models.object_detection_auto_label_request.ObjectDetectionAutoLabelRequest,
		**kwargs
) ‑> edgeimpulse_api.models.object_detection_auto_label_response.ObjectDetectionAutoLabelResponse

Auto-label an image

Classify an image using another neural network.

Parameters

• self

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

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

• object_detection_auto_label_request: edgeimpulse_api.models.object_detection_auto_label_request.ObjectDetectionAutoLabelRequest

• **kwargs

Return

edgeimpulse_api.models.object_detection_auto_label_response.ObjectDetectionAutoLabelResponse

clear_all_object_detection_labels

edgeimpulse_api.api.raw_data_api.clear_all_object_detection_labels(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Clear all object detection labels

Clears all object detection labels for this dataset, and places all images back in the labeling queue.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

clear_data_explorer

edgeimpulse_api.api.raw_data_api.clear_data_explorer(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Clear data explorer

Remove the current data explorer state

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

count_samples

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

Count samples

Count all raw data by category.

Parameters

• self

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

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

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

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

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

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

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

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

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

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

• min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label >= this value', extra={})] = None

• max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label < this value', extra={})] = None

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

• **kwargs

Return

edgeimpulse_api.models.count_samples_response.CountSamplesResponse

crop_sample

edgeimpulse_api.api.raw_data_api.crop_sample(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		crop_sample_request: edgeimpulse_api.models.crop_sample_request.CropSampleRequest,
		**kwargs
) ‑> edgeimpulse_api.models.crop_sample_response.CropSampleResponse

Crop sample

Crop a sample to within a new range.

Parameters

• self

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

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

• crop_sample_request: edgeimpulse_api.models.crop_sample_request.CropSampleRequest

• **kwargs

Return

edgeimpulse_api.models.crop_sample_response.CropSampleResponse

delete_all_samples

edgeimpulse_api.api.raw_data_api.delete_all_samples(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Remove all samples

Deletes all samples for this project over all categories. This also invalidates all DSP and learn blocks. Note that this does not delete the data from cold storage.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

delete_all_samples_by_category

edgeimpulse_api.api.raw_data_api.delete_all_samples_by_category(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		category: Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to download data from', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Remove all samples by category

Deletes all samples for this project over a single category. Note that this does not delete the data from cold storage.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

delete_sample

edgeimpulse_api.api.raw_data_api.delete_sample(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Remove sample

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

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

disable_sample

edgeimpulse_api.api.raw_data_api.disable_sample(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Disable sample

Disable a sample, ensuring that it is excluded from the dataset.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

edit_label

edgeimpulse_api.api.raw_data_api.edit_label(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		edit_sample_label_request: edgeimpulse_api.models.edit_sample_label_request.EditSampleLabelRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Edit label

Sets the label (also known as class) of the sample. Use the same label for similar types of data, as they are used during training.

Parameters

• self

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

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

• edit_sample_label_request: edgeimpulse_api.models.edit_sample_label_request.EditSampleLabelRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

enable_sample

edgeimpulse_api.api.raw_data_api.enable_sample(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Enable sample

Enable a sample, ensuring that it is not excluded from the dataset.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

find_segments_in_sample

edgeimpulse_api.api.raw_data_api.find_segments_in_sample(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		find_segment_sample_request: edgeimpulse_api.models.find_segment_sample_request.FindSegmentSampleRequest,
		**kwargs
) ‑> edgeimpulse_api.models.find_segment_sample_response.FindSegmentSampleResponse

Find segments

Find start and end times for all non-noise events in a sample

Parameters

• self

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

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

• find_segment_sample_request: edgeimpulse_api.models.find_segment_sample_request.FindSegmentSampleRequest

• **kwargs

Return

edgeimpulse_api.models.find_segment_sample_response.FindSegmentSampleResponse

get_ai_actions_proposed_changes

edgeimpulse_api.api.raw_data_api.get_ai_actions_proposed_changes(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		job_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_ai_actions_proposed_changes_response.GetAIActionsProposedChangesResponse

Get AI Actions proposed changes

Get proposed changes from an AI Actions job.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.get_ai_actions_proposed_changes_response.GetAIActionsProposedChangesResponse

get_all_imported_from

edgeimpulse_api.api.raw_data_api.get_all_imported_from(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.get_all_imported_from_response.GetAllImportedFromResponse

List data with "imported from" metadata key

Lists all data with an 'imported from' metadata key. Used to check in a data source which items are already in a project.

Parameters

• self

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

• limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

• offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.get_all_imported_from_response.GetAllImportedFromResponse

get_data_explorer_features

edgeimpulse_api.api.raw_data_api.get_data_explorer_features(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_data_explorer_features_response.GetDataExplorerFeaturesResponse

Get data explorer features

t-SNE2 output of the raw dataset

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.get_data_explorer_features_response.GetDataExplorerFeaturesResponse

get_data_explorer_predictions

edgeimpulse_api.api.raw_data_api.get_data_explorer_predictions(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.data_explorer_predictions_response.DataExplorerPredictionsResponse

Get data explorer predictions

Predictions for every data explorer point (only available when using current impulse to populate data explorer)

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.data_explorer_predictions_response.DataExplorerPredictionsResponse

get_data_explorer_settings

edgeimpulse_api.api.raw_data_api.get_data_explorer_settings(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_data_explorer_settings_response.GetDataExplorerSettingsResponse

Get data explorer settings

Get data explorer configuration, like the type of data, and the input / dsp block to use.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.get_data_explorer_settings_response.GetDataExplorerSettingsResponse

get_diversity_data

edgeimpulse_api.api.raw_data_api.get_diversity_data(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_diversity_data_response.GetDiversityDataResponse

Get diversity metrics data

Obtain metrics that describe the similarity and diversity of a dataset. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.get_diversity_data_response.GetDiversityDataResponse

get_label_noise_data

edgeimpulse_api.api.raw_data_api.get_label_noise_data(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_label_noise_data_response.GetLabelNoiseDataResponse

Get label noise data

Obtain metrics that describe potential label noise issues in the dataset. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.get_label_noise_data_response.GetLabelNoiseDataResponse

get_object_detection_label_queue

edgeimpulse_api.api.raw_data_api.get_object_detection_label_queue(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.object_detection_label_queue_response.ObjectDetectionLabelQueueResponse

Object detection label queue

Get all unlabeled items from the object detection queue.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.object_detection_label_queue_response.ObjectDetectionLabelQueueResponse

get_object_detection_label_queue_count

edgeimpulse_api.api.raw_data_api.get_object_detection_label_queue_count(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.object_detection_label_queue_count_response.ObjectDetectionLabelQueueCountResponse

Object detection label queue count

Get count for unlabeled items from the object detection queue.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.object_detection_label_queue_count_response.ObjectDetectionLabelQueueCountResponse

get_sample

edgeimpulse_api.api.raw_data_api.get_sample(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		limit_payload_values: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Limit the number of payload values in the response', extra={})] = None,
		cache_key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).', extra={})] = None,
		impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
		proposed_actions_job_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.get_sample_response.GetSampleResponse

Get sample

Get a sample.

Parameters

• self

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

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

• limit_payload_values: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Limit the number of payload values in the response', extra={})] = None

• cache_key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).', extra={})] = None

• impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None

• proposed_actions_job_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.get_sample_response.GetSampleResponse

get_sample_as_audio

edgeimpulse_api.api.raw_data_api.get_sample_as_audio(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		axis_ix: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Axis index', extra={})],
		slice_start: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Begin index of the slice. If not given, the whole sample is used.', extra={})] = None,
		slice_end: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the whole sample is used.', extra={})] = None,
		cache_key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).', extra={})] = None,
		**kwargs
) ‑> str

Get WAV file

Get a sample as a WAV file. This only applies to samples with an audio axis.

Parameters

• self

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

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

• axis_ix: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Axis index', extra={})]

• slice_start: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Begin index of the slice. If not given, the whole sample is used.', extra={})] = None

• slice_end: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the whole sample is used.', extra={})] = None

• cache_key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).', extra={})] = None

• **kwargs

Return

str

get_sample_as_image

edgeimpulse_api.api.raw_data_api.get_sample_as_image(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		after_input_block: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to process the image through the input block first', extra={})] = None,
		cache_key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).', extra={})] = None,
		impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
		**kwargs
) ‑> str

Get image file

Get a sample as an image file. This only applies to samples with RGBA data.

Parameters

• self

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

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

• after_input_block: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to process the image through the input block first', extra={})] = None

• cache_key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).', extra={})] = None

• impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None

• **kwargs

Return

str

get_sample_as_raw

edgeimpulse_api.api.raw_data_api.get_sample_as_raw(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		**kwargs
) ‑> str

Download file

Download a sample in it's original format as uploaded to the ingestion service.

Parameters

• self

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

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

• **kwargs

Return

str

get_sample_as_video

edgeimpulse_api.api.raw_data_api.get_sample_as_video(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		after_input_block: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to process the image through the input block first', extra={})] = None,
		cache_key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).', extra={})] = None,
		impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
		**kwargs
) ‑> str

Get video file

Get a sample as an video file. This only applies to samples with video data.

Parameters

• self

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

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

• after_input_block: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to process the image through the input block first', extra={})] = None

• cache_key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).', extra={})] = None

• impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None

• **kwargs

Return

str

get_sample_metadata

edgeimpulse_api.api.raw_data_api.get_sample_metadata(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		category: Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_sample_metadata_response.GetSampleMetadataResponse

Get project sample metadata

Get metadata for all samples in a project.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.get_sample_metadata_response.GetSampleMetadataResponse

get_sample_slice

edgeimpulse_api.api.raw_data_api.get_sample_slice(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		slice_start: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Begin index of the slice', extra={})],
		slice_end: Annotated[pydantic.types.StrictInt | None, 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,
		impulse_id: Annotated[pydantic.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_sample_response.GetSampleResponse

Get sample slice

Get a slice of a sample.

Parameters

• self

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

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

• slice_start: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Begin index of the slice', extra={})]

• slice_end: Annotated[pydantic.types.StrictInt | None, 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

• impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.get_sample_response.GetSampleResponse

get_uncropped_downsampled_sample

edgeimpulse_api.api.raw_data_api.get_uncropped_downsampled_sample(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		limit_payload_values: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Limit the number of payload values in the response', extra={})] = None,
		zoom_start: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Zoom into the sample, with the focus starting at this index', extra={})] = None,
		zoom_end: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Zoom into the sample, with the focus ending at this index', extra={})] = None,
		impulse_id: Annotated[pydantic.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_sample_response.GetSampleResponse

Get the original downsampled data

Get the original, uncropped, downsampled data.

Parameters

• self

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

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

• limit_payload_values: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Limit the number of payload values in the response', extra={})] = None

• zoom_start: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Zoom into the sample, with the focus starting at this index', extra={})] = None

• zoom_end: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Zoom into the sample, with the focus ending at this index', extra={})] = None

• impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.get_sample_response.GetSampleResponse

has_data_explorer_features

edgeimpulse_api.api.raw_data_api.has_data_explorer_features(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.has_data_explorer_features_response.HasDataExplorerFeaturesResponse

Check data explorer features

t-SNE2 output of the raw dataset

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.has_data_explorer_features_response.HasDataExplorerFeaturesResponse

has_diversity_data

edgeimpulse_api.api.raw_data_api.has_diversity_data(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.has_data_explorer_features_response.HasDataExplorerFeaturesResponse

Check if data diversity metrics exist

Determine if data diversity metrics have been calculated. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.has_data_explorer_features_response.HasDataExplorerFeaturesResponse

has_label_noise_data

edgeimpulse_api.api.raw_data_api.has_label_noise_data(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.has_data_explorer_features_response.HasDataExplorerFeaturesResponse

Check if label noise metrics exist

Determine if label noise metrics have been calculated. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.has_data_explorer_features_response.HasDataExplorerFeaturesResponse

list_samples

edgeimpulse_api.api.raw_data_api.list_samples(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		category: Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})],
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		exclude_sensors: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude sensors in the response (as these can slow down requests when you have large pages).', extra={})] = None,
		labels: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None,
		filename: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None,
		max_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None,
		min_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None,
		min_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None,
		max_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None,
		signature_validity: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None,
		include_disabled: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None,
		min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label >= this value', extra={})] = None,
		max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label < this value', extra={})] = None,
		search: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None,
		proposed_actions_job_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.list_samples_response.ListSamplesResponse

List samples

Retrieve all raw data by category.

Parameters

• self

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

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

• limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

• offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None

• exclude_sensors: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude sensors in the response (as these can slow down requests when you have large pages).', extra={})] = None

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

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

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

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

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

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

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

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

• min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label >= this value', extra={})] = None

• max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description='Only include samples with a label < this value', extra={})] = None

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

• proposed_actions_job_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.list_samples_response.ListSamplesResponse

move_sample

edgeimpulse_api.api.raw_data_api.move_sample(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		move_raw_data_request: edgeimpulse_api.models.move_raw_data_request.MoveRawDataRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Move sample

Move a sample to another category (e.g. from test to training).

Parameters

• self

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

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

• move_raw_data_request: edgeimpulse_api.models.move_raw_data_request.MoveRawDataRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

move_to_labeling_queue

edgeimpulse_api.api.raw_data_api.move_to_labeling_queue(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Move sample to labeling queue

Clears the bounding box labels and moves item back to labeling queue

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

rebalance_dataset

edgeimpulse_api.api.raw_data_api.rebalance_dataset(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.rebalance_dataset_response.RebalanceDatasetResponse

Rebalance dataset

Rebalances the dataset over training / testing categories. This resets the category for all data and splits it 80%/20% between training and testing. This is a deterministic process based on the hash of the name of the data.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.rebalance_dataset_response.RebalanceDatasetResponse

rename_sample

edgeimpulse_api.api.raw_data_api.rename_sample(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		rename_sample_request: edgeimpulse_api.models.rename_sample_request.RenameSampleRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Rename sample

Sets the file name of the sample. This name does not need to be unique, but it's highly recommended to do so.

Parameters

• self

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

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

• rename_sample_request: edgeimpulse_api.models.rename_sample_request.RenameSampleRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

retry_processing

edgeimpulse_api.api.raw_data_api.retry_processing(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Retry processing

If a sample failed processing, retry the processing operation.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse