raw_data_api
edgeimpulse_api v1.0.0
edgeimpulse_api.api.raw_data_api module
class edgeimpulse_api.api.raw_data_api.RawDataApi(api_client=None)Bases:
object
batch_delete(project_id: StrictInt, category: StrictStr, labels: Optional[StrictStr] = None, filename: Optional[StrictStr] = None, max_length: Optional[StrictInt] = None, min_length: Optional[StrictInt] = None, min_frequency: Optional[float] = None, max_frequency: Optional[float] = None, signature_validity: Optional[StrictStr] = None, include_disabled: Optional[StrictStr] = None, ids: Optional[StrictStr] = None, **kwargs)Remove multiple samples
Deletes samples. Note that this does not delete the data from cold storage.
Parameters
project_id (int) – Project ID (required)
category (str) – Which of the three acquisition categories to retrieve data from (required)
labels (str) – Only include samples with a label within the given list of labels, given as a JSON string
filename (str) – Only include samples whose filename includes the given filename
max_length (int) – Only include samples shorter than the given length, in milliseconds
min_length (int) – Only include samples longer than the given length, in milliseconds
min_frequency (float) – Only include samples with higher frequency than given frequency, in hertz
max_frequency (float) – Only include samples with lower frequency than given frequency, in hertz
signature_validity (str) – Include samples with either valid or invalid signatures
include_disabled (str) – Include only enabled or disabled samples (or both)
ids (str) – Only include samples with an ID within the given list of IDs, given as a JSON string
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
batch_disable(project_id: StrictInt, category: StrictStr, labels: Optional[StrictStr] = None, filename: Optional[StrictStr] = None, max_length: Optional[StrictInt] = None, min_length: Optional[StrictInt] = None, min_frequency: Optional[float] = None, max_frequency: Optional[float] = None, signature_validity: Optional[StrictStr] = None, include_disabled: Optional[StrictStr] = None, ids: Optional[StrictStr] = None, **kwargs)Disable multiple samples
Disables samples, ensuring that they are excluded from the dataset.
Parameters
project_id (int) – Project ID (required)
category (str) – Which of the three acquisition categories to retrieve data from (required)
labels (str) – Only include samples with a label within the given list of labels, given as a JSON string
filename (str) – Only include samples whose filename includes the given filename
max_length (int) – Only include samples shorter than the given length, in milliseconds
min_length (int) – Only include samples longer than the given length, in milliseconds
min_frequency (float) – Only include samples with higher frequency than given frequency, in hertz
max_frequency (float) – Only include samples with lower frequency than given frequency, in hertz
signature_validity (str) – Include samples with either valid or invalid signatures
include_disabled (str) – Include only enabled or disabled samples (or both)
ids (str) – Only include samples with an ID within the given list of IDs, given as a JSON string
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
batch_edit_labels(project_id: StrictInt, category: StrictStr, edit_sample_label_request: EditSampleLabelRequest, labels: Optional[StrictStr] = None, filename: Optional[StrictStr] = None, max_length: Optional[StrictInt] = None, min_length: Optional[StrictInt] = None, min_frequency: Optional[float] = None, max_frequency: Optional[float] = None, signature_validity: Optional[StrictStr] = None, include_disabled: Optional[StrictStr] = None, ids: Optional[StrictStr] = None, **kwargs)Edit labels for multiple samples
Sets the label (also known as class) of multiple samples.
Parameters
project_id (int) – Project ID (required)
category (str) – Which of the three acquisition categories to retrieve data from (required)
edit_sample_label_request (EditSampleLabelRequest) – (required)
labels (str) – Only include samples with a label within the given list of labels, given as a JSON string
filename (str) – Only include samples whose filename includes the given filename
max_length (int) – Only include samples shorter than the given length, in milliseconds
min_length (int) – Only include samples longer than the given length, in milliseconds
min_frequency (float) – Only include samples with higher frequency than given frequency, in hertz
max_frequency (float) – Only include samples with lower frequency than given frequency, in hertz
signature_validity (str) – Include samples with either valid or invalid signatures
include_disabled (str) – Include only enabled or disabled samples (or both)
ids (str) – Only include samples with an ID within the given list of IDs, given as a JSON string
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
batch_enable(project_id: StrictInt, category: StrictStr, labels: Optional[StrictStr] = None, filename: Optional[StrictStr] = None, max_length: Optional[StrictInt] = None, min_length: Optional[StrictInt] = None, min_frequency: Optional[float] = None, max_frequency: Optional[float] = None, signature_validity: Optional[StrictStr] = None, include_disabled: Optional[StrictStr] = None, ids: Optional[StrictStr] = None, **kwargs)Enable multiple samples
Enables samples, ensuring that they are not excluded from the dataset.
Parameters
project_id (int) – Project ID (required)
category (str) – Which of the three acquisition categories to retrieve data from (required)
labels (str) – Only include samples with a label within the given list of labels, given as a JSON string
filename (str) – Only include samples whose filename includes the given filename
max_length (int) – Only include samples shorter than the given length, in milliseconds
min_length (int) – Only include samples longer than the given length, in milliseconds
min_frequency (float) – Only include samples with higher frequency than given frequency, in hertz
max_frequency (float) – Only include samples with lower frequency than given frequency, in hertz
signature_validity (str) – Include samples with either valid or invalid signatures
include_disabled (str) – Include only enabled or disabled samples (or both)
ids (str) – Only include samples with an ID within the given list of IDs, given as a JSON string
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
batch_move(project_id: StrictInt, category: StrictStr, move_raw_data_request: MoveRawDataRequest, labels: Optional[StrictStr] = None, filename: Optional[StrictStr] = None, max_length: Optional[StrictInt] = None, min_length: Optional[StrictInt] = None, min_frequency: Optional[float] = None, max_frequency: Optional[float] = None, signature_validity: Optional[StrictStr] = None, include_disabled: Optional[StrictStr] = None, ids: Optional[StrictStr] = None, **kwargs)Move multiple samples
Move multiple samples to another category (e.g. from test to training).
Parameters
project_id (int) – Project ID (required)
category (str) – Which of the three acquisition categories to retrieve data from (required)
move_raw_data_request (MoveRawDataRequest) – (required)
labels (str) – Only include samples with a label within the given list of labels, given as a JSON string
filename (str) – Only include samples whose filename includes the given filename
max_length (int) – Only include samples shorter than the given length, in milliseconds
min_length (int) – Only include samples longer than the given length, in milliseconds
min_frequency (float) – Only include samples with higher frequency than given frequency, in hertz
max_frequency (float) – Only include samples with lower frequency than given frequency, in hertz
signature_validity (str) – Include samples with either valid or invalid signatures
include_disabled (str) – Include only enabled or disabled samples (or both)
ids (str) – Only include samples with an ID within the given list of IDs, given as a JSON string
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
classify_using_autolabel(project_id: StrictInt, sample_id: StrictInt, object_detection_auto_label_request: ObjectDetectionAutoLabelRequest, **kwargs)Auto-label an image
Classify an image using another neural network.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
object_detection_auto_label_request (ObjectDetectionAutoLabelRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
clear_data_explorer(project_id: StrictInt, **kwargs)Clear data explorer
Remove the current data explorer state
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
count_samples(project_id: StrictInt, category: StrictStr, labels: Optional[StrictStr] = None, filename: Optional[StrictStr] = None, max_length: Optional[StrictInt] = None, min_length: Optional[StrictInt] = None, min_frequency: Optional[float] = None, max_frequency: Optional[float] = None, signature_validity: Optional[StrictStr] = None, include_disabled: Optional[StrictStr] = None, **kwargs)Count samples
Count all raw data by category.
Parameters
project_id (int) – Project ID (required)
category (str) – Which of the three acquisition categories to retrieve data from (required)
labels (str) – Only include samples with a label within the given list of labels, given as a JSON string
filename (str) – Only include samples whose filename includes the given filename
max_length (int) – Only include samples shorter than the given length, in milliseconds
min_length (int) – Only include samples longer than the given length, in milliseconds
min_frequency (float) – Only include samples with higher frequency than given frequency, in hertz
max_frequency (float) – Only include samples with lower frequency than given frequency, in hertz
signature_validity (str) – Include samples with either valid or invalid signatures
include_disabled (str) – Include only enabled or disabled samples (or both)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
crop_sample(project_id: StrictInt, sample_id: StrictInt, crop_sample_request: CropSampleRequest, **kwargs)Crop sample
Crop a sample to within a new range.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
crop_sample_request (CropSampleRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
delete_all_samples(project_id: StrictInt, **kwargs)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
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
delete_all_samples_by_category(project_id: StrictInt, category: StrictStr, **kwargs)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
project_id (int) – Project ID (required)
category (str) – Which of the three acquisition categories to download data from (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
delete_sample(project_id: StrictInt, sample_id: StrictInt, **kwargs)Remove sample
Deletes the sample. Note that this does not delete the data from cold storage.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
disable_sample(project_id: StrictInt, sample_id: StrictInt, **kwargs)Disable sample
Disable a sample, ensuring that it is excluded from the dataset.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
edit_label(project_id: StrictInt, sample_id: StrictInt, edit_sample_label_request: EditSampleLabelRequest, **kwargs)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
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
edit_sample_label_request (EditSampleLabelRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
enable_sample(project_id: StrictInt, sample_id: StrictInt, **kwargs)Enable sample
Enable a sample, ensuring that it is not excluded from the dataset.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
find_segments_in_sample(project_id: StrictInt, sample_id: StrictInt, find_segment_sample_request: FindSegmentSampleRequest, **kwargs)Find segments
Find start and end times for all non-noise events in a sample
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
find_segment_sample_request (FindSegmentSampleRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_data_explorer_features(project_id: StrictInt, **kwargs)Get data explorer features
t-SNE2 output of the raw dataset
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_data_explorer_predictions(project_id: StrictInt, **kwargs)Get data explorer predictions
Predictions for every data explorer point (only available when using current impulse to populate data explorer)
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_data_explorer_settings(project_id: StrictInt, **kwargs)Get data explorer settings
Get data explorer configuration, like the type of data, and the input / dsp block to use.
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_object_detection_label_queue(project_id: StrictInt, **kwargs)Object detection label queue
Get all unlabeled items from the object detection queue.
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_object_detection_label_queue_count(project_id: StrictInt, **kwargs)Object detection label queue count
Get count for unlabeled items from the object detection queue.
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_sample(project_id: StrictInt, sample_id: StrictInt, limit_payload_values: Optional[StrictInt] = None, **kwargs)Get sample
Get a sample.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
limit_payload_values (int) – Limit the number of payload values in the response
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_sample_as_audio(project_id: StrictInt, sample_id: StrictInt, axis_ix: StrictInt, slice_start: Optional[StrictInt] = None, slice_end: Optional[StrictInt] = None, **kwargs)Get WAV file
Get a sample as a WAV file. This only applies to samples with an audio axis.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
axis_ix (int) – Axis index (required)
slice_start (int) – Begin index of the slice
slice_end (int) – End index of the slice
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
str
get_sample_as_image(project_id: StrictInt, sample_id: StrictInt, after_input_block: Optional[StrictBool] = None, **kwargs)Get image file
Get a sample as an image file. This only applies to samples with RGBA data.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
after_input_block (bool) – Whether to process the image through the input block first
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
str
get_sample_as_raw(project_id: StrictInt, sample_id: StrictInt, **kwargs)Download file
Download a sample in it’s original format as uploaded to the ingestion service.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
str
get_sample_as_video(project_id: StrictInt, sample_id: StrictInt, after_input_block: Optional[StrictBool] = None, **kwargs)Get video file
Get a sample as an video file. This only applies to samples with video data.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
after_input_block (bool) – Whether to process the image through the input block first
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
str
get_sample_metadata(project_id: StrictInt, category: StrictStr, **kwargs)Get project sample metadata
Get metadata for all samples in a project.
Parameters
project_id (int) – Project ID (required)
category (str) – Which of the three acquisition categories to retrieve data from (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_sample_slice(project_id: StrictInt, sample_id: StrictInt, slice_start: StrictInt, slice_end: StrictInt, **kwargs)Get sample slice
Get a slice of a sample.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
slice_start (int) – Begin index of the slice (required)
slice_end (int) – End index of the slice (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_uncropped_downsampled_sample(project_id: StrictInt, sample_id: StrictInt, limit_payload_values: Optional[StrictInt] = None, zoom_start: Optional[StrictInt] = None, zoom_end: Optional[StrictInt] = None, **kwargs)Get the original downsampled data
Get the original, uncropped, downsampled data.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
limit_payload_values (int) – Limit the number of payload values in the response
zoom_start (int) – Zoom into the sample, with the focus starting at this index
zoom_end (int) – Zoom into the sample, with the focus ending at this index
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
has_data_explorer_features(project_id: StrictInt, **kwargs)Check data explorer features
t-SNE2 output of the raw dataset
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
list_samples(project_id: StrictInt, category: StrictStr, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, exclude_sensors: Optional[StrictBool] = None, labels: Optional[StrictStr] = None, filename: Optional[StrictStr] = None, max_length: Optional[StrictInt] = None, min_length: Optional[StrictInt] = None, min_frequency: Optional[float] = None, max_frequency: Optional[float] = None, signature_validity: Optional[StrictStr] = None, include_disabled: Optional[StrictStr] = None, **kwargs)List samples
Retrieve all raw data by category.
Parameters
project_id (int) – Project ID (required)
category (str) – Which of the three acquisition categories to retrieve data from (required)
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
exclude_sensors (bool) – Whether to exclude sensors in the response (as these can slow down requests when you have large pages).
labels (str) – Only include samples with a label within the given list of labels, given as a JSON string
filename (str) – Only include samples whose filename includes the given filename
max_length (int) – Only include samples shorter than the given length, in milliseconds
min_length (int) – Only include samples longer than the given length, in milliseconds
min_frequency (float) – Only include samples with higher frequency than given frequency, in hertz
max_frequency (float) – Only include samples with lower frequency than given frequency, in hertz
signature_validity (str) – Include samples with either valid or invalid signatures
include_disabled (str) – Include only enabled or disabled samples (or both)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
move_sample(project_id: StrictInt, sample_id: StrictInt, move_raw_data_request: MoveRawDataRequest, **kwargs)Move sample
Move a sample to another category (e.g. from test to training).
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
move_raw_data_request (MoveRawDataRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
rebalance_dataset(project_id: StrictInt, **kwargs)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
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
rename_sample(project_id: StrictInt, sample_id: StrictInt, rename_sample_request: RenameSampleRequest, **kwargs)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
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
rename_sample_request (RenameSampleRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
retry_processing(project_id: StrictInt, sample_id: StrictInt, **kwargs)Retry processing
If a sample failed processing, retry the processing operation.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
segment_sample(project_id: StrictInt, sample_id: StrictInt, segment_sample_request: SegmentSampleRequest, **kwargs)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
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
segment_sample_request (SegmentSampleRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
set_data_explorer_settings(project_id: StrictInt, data_explorer_settings: DataExplorerSettings, **kwargs)Set data explorer settings
Set data explorer configuration, like the type of data, and the input / dsp block to use.
Parameters
project_id (int) – Project ID (required)
data_explorer_settings (DataExplorerSettings) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
set_sample_bounding_boxes(project_id: StrictInt, sample_id: StrictInt, sample_bounding_boxes_request: SampleBoundingBoxesRequest, **kwargs)Set bounding boxes
Set the bounding boxes for a sample
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
sample_bounding_boxes_request (SampleBoundingBoxesRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
set_sample_metadata(project_id: StrictInt, sample_id: StrictInt, set_sample_metadata_request: SetSampleMetadataRequest, **kwargs)Set sample metadata
Adds or updates the metadata associated to a sample.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
set_sample_metadata_request (SetSampleMetadataRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
split_sample_in_frames(project_id: StrictInt, sample_id: StrictInt, split_sample_in_frames_request: SplitSampleInFramesRequest, **kwargs)Split sample into frames
Split a video sample into individual frames.
Parameters
project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
split_sample_in_frames_request (SplitSampleInFramesRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
store_segment_length(project_id: StrictInt, store_segment_length_request: StoreSegmentLengthRequest, **kwargs)Store the last segment length
When segmenting a sample into smaller segments, store the segment length to ensure uniform segment lengths.
Parameters
project_id (int) – Project ID (required)
store_segment_length_request (StoreSegmentLengthRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
track_objects(project_id: StrictInt, track_objects_request: TrackObjectsRequest, **kwargs)Track objects
Track objects between two samples. Source sample should have bounding boxes set.
Parameters
project_id (int) – Project ID (required)
track_objects_request (TrackObjectsRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
upload_data_explorer_screenshot(project_id: StrictInt, image: StrictStr, **kwargs)Upload a data explorer screenshot
Used internally (from a data pipeline) to upload a picture of the data explorer
Parameters
project_id (int) – Project ID (required)
image (str) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
Last updated
Was this helpful?