raw_data_api module
RawDataApi
Parameters
api_client=None
Methods
batch_delete
Remove multiple samples
Deletes samples. Note that this does not delete the data from cold storage.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None
filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None
max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None
min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None
min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None
max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None
signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None
ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
exclude_ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
batch_disable
Disable multiple samples
Disables samples, ensuring that they are excluded from the dataset.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None
filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None
max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None
min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None
min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None
max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None
signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None
ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
exclude_ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
batch_edit_labels
Edit labels for multiple samples
Sets the label (also known as class) of multiple samples.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
edit_sample_label_request: edgeimpulse_api.models.edit_sample_label_request.EditSampleLabelRequest
labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None
filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None
max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None
min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None
min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None
max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None
signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None
ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
exclude_ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
batch_enable
Enable multiple samples
Enables samples, ensuring that they are not excluded from the dataset.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None
filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None
max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None
min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None
min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None
max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None
signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None
ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
exclude_ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
batch_move
Move multiple samples
Move multiple samples to another category (e.g. from test to training).
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
move_raw_data_request: edgeimpulse_api.models.move_raw_data_request.MoveRawDataRequest
labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None
filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None
max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None
min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None
min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None
max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None
signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None
ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
exclude_ids: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Exclude samples with an ID within the given list of IDs, given as a JSON string', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
classify_using_autolabel
Auto-label an image
Classify an image using another neural network.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.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
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
clear_data_explorer
Clear data explorer
Remove the current data explorer state
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
count_samples
Count samples
Count all raw data by category.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
labels: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None
filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None
max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None
min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None
min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None
max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None
signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.count_samples_response.CountSamplesResponse
crop_sample
Crop sample
Crop a sample to within a new range.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.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
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: typing_extensions.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
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to download data from', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
delete_sample
Remove sample
Deletes the sample. Note that this does not delete the data from cold storage.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
disable_sample
Disable sample
Disable a sample, ensuring that it is excluded from the dataset.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
edit_label
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.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
Enable sample
Enable a sample, ensuring that it is not excluded from the dataset.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
find_segments_in_sample
Find segments
Find start and end times for all non-noise events in a sample
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.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_all_imported_from
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], 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_auto_labeler
Get auto-labeler results
Retrieve the results of the auto-labeler (after running StartJobResponse)
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_auto_labeler_response.GetAutoLabelerResponse
get_auto_labeler_image
Get auto-labeler image
Grab a segment image from the auto-labeler
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
image: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which image to receive from the auto-labeler', extra={})]
**kwargs
Return
str
get_auto_labeler_segment_info
View auto-labeler segment info
Get info from a specific segment in an image. Pass in both sampleId and segmentId in the URL.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_auto_labeler_segment_info_response.GetAutoLabelerSegmentInfoResponse
get_data_explorer_features
Get data explorer features
t-SNE2 output of the raw dataset
Parameters
self
project_id: typing_extensions.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
Get data explorer predictions
Predictions for every data explorer point (only available when using current impulse to populate data explorer)
Parameters
self
project_id: typing_extensions.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
Get data explorer settings
Get data explorer configuration, like the type of data, and the input / dsp block to use.
Parameters
self
project_id: typing_extensions.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
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: typing_extensions.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
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: typing_extensions.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
Object detection label queue
Get all unlabeled items from the object detection queue.
Parameters
self
project_id: typing_extensions.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
Object detection label queue count
Get count for unlabeled items from the object detection queue.
Parameters
self
project_id: typing_extensions.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
Get sample
Get a sample.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
limit_payload_values: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Limit the number of payload values in the response', extra={})] = None
cache_key: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], 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
edgeimpulse_api.models.get_sample_response.GetSampleResponse
get_sample_as_audio
Get WAV file
Get a sample as a WAV file. This only applies to samples with an audio axis.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
axis_ix: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Axis index', extra={})]
slice_start: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Begin index of the slice. If not given, the whole sample is used.', extra={})] = None
slice_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the whole sample is used.', extra={})] = None
cache_key: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], 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
Get image file
Get a sample as an image file. This only applies to samples with RGBA data.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
after_input_block: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to process the image through the input block first', extra={})] = None
cache_key: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], 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_raw
Download file
Download a sample in it's original format as uploaded to the ingestion service.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
str
get_sample_as_video
Get video file
Get a sample as an video file. This only applies to samples with video data.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
after_input_block: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to process the image through the input block first', extra={})] = None
cache_key: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], 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_metadata
Get project sample metadata
Get metadata for all samples in a project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_sample_metadata_response.GetSampleMetadataResponse
get_sample_slice
Get sample slice
Get a slice of a sample.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
slice_start: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Begin index of the slice', extra={})]
slice_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.get_sample_response.GetSampleResponse
get_uncropped_downsampled_sample
Get the original downsampled data
Get the original, uncropped, downsampled data.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
limit_payload_values: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Limit the number of payload values in the response', extra={})] = None
zoom_start: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Zoom into the sample, with the focus starting at this index', extra={})] = None
zoom_end: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Zoom into the sample, with the focus ending at this index', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.get_sample_response.GetSampleResponse
has_data_explorer_features
Check data explorer features
t-SNE2 output of the raw dataset
Parameters
self
project_id: typing_extensions.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
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: typing_extensions.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
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.has_data_explorer_features_response.HasDataExplorerFeaturesResponse
list_samples
List samples
Retrieve all raw data by category.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
category: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Which of the three acquisition categories to retrieve data from', extra={})]
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
exclude_sensors: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], 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: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples with a label within the given list of labels, given as a JSON string', extra={})] = None
filename: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include samples whose filename includes the given filename', extra={})] = None
max_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples shorter than the given length, in milliseconds', extra={})] = None
min_length: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Only include samples longer than the given length, in milliseconds', extra={})] = None
min_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with higher frequency than given frequency, in hertz', extra={})] = None
max_frequency: typing_extensions.Annotated[Optional[float], FieldInfo(default=PydanticUndefined, description='Only include samples with lower frequency than given frequency, in hertz', extra={})] = None
signature_validity: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include samples with either valid or invalid signatures', extra={})] = None
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Include only enabled or disabled samples (or both)', extra={})] = None
search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_samples_response.ListSamplesResponse
move_sample
Move sample
Move a sample to another category (e.g. from test to training).
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.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
Move sample to labeling queue
Clears the bounding box labels and moves item back to labeling queue
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
rebalance_dataset
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.rebalance_dataset_response.RebalanceDatasetResponse
rename_sample
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.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
Retry processing
If a sample failed processing, retry the processing operation.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
run_auto_labeler
Run auto-labeler job
Run the auto-labeler over all unlabeled data.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
run_auto_labeler_request: edgeimpulse_api.models.run_auto_labeler_request.RunAutoLabelerRequest
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
save_auto_labeler_clusters
Save auto-labeler clusters
Set labels for all auto-segment clusters.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
save_auto_labeler_clusters_request: edgeimpulse_api.models.save_auto_labeler_clusters_request.SaveAutoLabelerClustersRequest
**kwargs
Return
edgeimpulse_api.models.save_auto_labeler_clusters_response.SaveAutoLabelerClustersResponse
segment_sample
Segment sample
Slice a sample into multiple segments. The original file will be marked as deleted, but you can crop any created segment to retrieve the original file.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
segment_sample_request: edgeimpulse_api.models.segment_sample_request.SegmentSampleRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
set_data_explorer_settings
Set data explorer settings
Set data explorer configuration, like the type of data, and the input / dsp block to use.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
data_explorer_settings: edgeimpulse_api.models.data_explorer_settings.DataExplorerSettings
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
set_sample_bounding_boxes
Set bounding boxes
Set the bounding boxes for a sample
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
sample_bounding_boxes_request: edgeimpulse_api.models.sample_bounding_boxes_request.SampleBoundingBoxesRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
set_sample_metadata
Set sample metadata
Adds or updates the metadata associated to a sample.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
set_sample_metadata_request: edgeimpulse_api.models.set_sample_metadata_request.SetSampleMetadataRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
set_sample_structured_labels
Update structured labels
Set structured labels for a sample. If a sample has structured labels the label column is ignored, and the sample is allowed to have multiple labels. An array of { startIndex, endIndex, label } needs to be passed in with labels for the complete sample (see valuesCount to get the upper bound). endIndex is inclusive. If you pass in an incorrect array (e.g. missing values) you'll get an error back.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
set_sample_structured_labels_request: edgeimpulse_api.models.set_sample_structured_labels_request.SetSampleStructuredLabelsRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
split_sample_in_frames
Split sample into frames
Split a video sample into individual frames.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
sample_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Sample ID', extra={})]
split_sample_in_frames_request: edgeimpulse_api.models.split_sample_in_frames_request.SplitSampleInFramesRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
store_segment_length
Store the last segment length
When segmenting a sample into smaller segments, store the segment length to ensure uniform segment lengths.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
store_segment_length_request: edgeimpulse_api.models.store_segment_length_request.StoreSegmentLengthRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
track_objects
Track objects
Track objects between two samples. Source sample should have bounding boxes set.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
track_objects_request: edgeimpulse_api.models.track_objects_request.TrackObjectsRequest
**kwargs
Return
edgeimpulse_api.models.track_objects_response.TrackObjectsResponse
upload_data_explorer_screenshot
Upload a data explorer screenshot
Used internally (from a data pipeline) to upload a picture of the data explorer
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
image: pydantic.types.StrictStr
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Last updated