raw_data_api module#

class edgeimpulse_api.api.raw_data_api.RawDataApi(api_client=None)[source]#

Bases: object

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
exclude_ids (str) – Exclude samples with an ID within the given list of IDs, given as a JSON string
search (str) – Search query
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:

GenericApiResponse

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
exclude_ids (str) – Exclude samples with an ID within the given list of IDs, given as a JSON string
search (str) – Search query
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:

GenericApiResponse

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
exclude_ids (str) – Exclude samples with an ID within the given list of IDs, given as a JSON string
search (str) – Search query
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:

GenericApiResponse

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
exclude_ids (str) – Exclude samples with an ID within the given list of IDs, given as a JSON string
search (str) – Search query
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:

GenericApiResponse

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
exclude_ids (str) – Exclude samples with an ID within the given list of IDs, given as a JSON string
search (str) – Search query
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:

GenericApiResponse

classify_using_autolabel(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

object_detection_auto_label_request: ObjectDetectionAutoLabelRequest,

**kwargs,

) → ObjectDetectionAutoLabelResponse[source]#

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:

ObjectDetectionAutoLabelResponse

clear_all_object_detection_labels(

project_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Clear all object detection labels

Clears all object detection labels for this dataset, and places all images back in the labeling 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:

GenericApiResponse

clear_data_explorer(

project_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

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)
search (str) – Search query
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:

CountSamplesResponse

crop_sample(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

crop_sample_request: CropSampleRequest,

**kwargs,

) → CropSampleResponse[source]#

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:

CropSampleResponse

delete_all_samples(

project_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

delete_all_samples_by_category(

project_id: StrictInt[StrictInt],

category: StrictStr[StrictStr],

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

delete_sample(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

disable_sample(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

edit_label(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

edit_sample_label_request: EditSampleLabelRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

enable_sample(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

find_segments_in_sample(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

find_segment_sample_request: FindSegmentSampleRequest,

**kwargs,

) → FindSegmentSampleResponse[source]#

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:

FindSegmentSampleResponse

get_all_imported_from(

project_id: StrictInt[StrictInt],

limit: StrictInt | None[StrictInt | None] = None,

offset: StrictInt | None[StrictInt | None] = None,

**kwargs,

) → GetAllImportedFromResponse[source]#

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:

project_id (int) – Project ID (required)
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
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:

GetAllImportedFromResponse

get_auto_labeler(

project_id: StrictInt[StrictInt],

**kwargs,

) → GetAutoLabelerResponse[source]#

Get auto-labeler results

Retrieve the results of the auto-labeler (after running StartJobResponse)

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:

GetAutoLabelerResponse

get_auto_labeler_image(

project_id: StrictInt[StrictInt],

image: StrictStr[StrictStr],

**kwargs,

) → str[source]#

Get auto-labeler image

Grab a segment image from the auto-labeler

Parameters:

project_id (int) – Project ID (required)
image (str) – Which image to receive from the auto-labeler (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_data_explorer_features(

project_id: StrictInt[StrictInt],

**kwargs,

) → GetDataExplorerFeaturesResponse[source]#

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:

GetDataExplorerFeaturesResponse

get_data_explorer_predictions(

project_id: StrictInt[StrictInt],

**kwargs,

) → DataExplorerPredictionsResponse[source]#

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:

DataExplorerPredictionsResponse

get_data_explorer_settings(

project_id: StrictInt[StrictInt],

**kwargs,

) → GetDataExplorerSettingsResponse[source]#

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:

GetDataExplorerSettingsResponse

get_diversity_data(

project_id: StrictInt[StrictInt],

**kwargs,

) → GetDiversityDataResponse[source]#

Get diversity metrics data

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

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:

GetDiversityDataResponse

get_label_noise_data(

project_id: StrictInt[StrictInt],

**kwargs,

) → GetLabelNoiseDataResponse[source]#

Get label noise data

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

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:

GetLabelNoiseDataResponse

get_object_detection_label_queue(

project_id: StrictInt[StrictInt],

**kwargs,

) → ObjectDetectionLabelQueueResponse[source]#

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:

ObjectDetectionLabelQueueResponse

get_object_detection_label_queue_count(

project_id: StrictInt[StrictInt],

**kwargs,

) → ObjectDetectionLabelQueueCountResponse[source]#

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:

ObjectDetectionLabelQueueCountResponse

get_sample(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

limit_payload_values: StrictInt | None[StrictInt | None] = None,

cache_key: StrictStr | None[StrictStr | None] = None,

**kwargs,

) → GetSampleResponse[source]#

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
cache_key (str) – 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).
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:

GetSampleResponse

get_sample_as_audio(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

axis_ix: StrictInt[StrictInt],

slice_start: StrictInt | None[StrictInt | None] = None,

slice_end: StrictInt | None[StrictInt | None] = None,

cache_key: StrictStr | None[StrictStr | None] = None,

**kwargs,

) → str[source]#

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. If not given, the whole sample is used.
slice_end (int) – End index of the slice. If not given, the whole sample is used.
cache_key (str) – 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).
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[StrictInt],

sample_id: StrictInt[StrictInt],

after_input_block: StrictBool | None[StrictBool | None] = None,

cache_key: StrictStr | None[StrictStr | None] = None,

**kwargs,

) → str[source]#

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
cache_key (str) – 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).
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[StrictInt],

sample_id: StrictInt[StrictInt],

**kwargs,

) → str[source]#

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[StrictInt],

sample_id: StrictInt[StrictInt],

after_input_block: StrictBool | None[StrictBool | None] = None,

cache_key: StrictStr | None[StrictStr | None] = None,

**kwargs,

) → str[source]#

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
cache_key (str) – 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).
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[StrictInt],

category: StrictStr[StrictStr],

**kwargs,

) → GetSampleMetadataResponse[source]#

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:

GetSampleMetadataResponse

get_sample_slice(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

slice_start: StrictInt[StrictInt],

slice_end: StrictInt | None[StrictInt | None] = None,

**kwargs,

) → GetSampleResponse[source]#

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. If not given, the sample will be sliced to the same length as the impulse input block window length.
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:

GetSampleResponse

get_uncropped_downsampled_sample(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

limit_payload_values: StrictInt | None[StrictInt | None] = None,

zoom_start: StrictInt | None[StrictInt | None] = None,

zoom_end: StrictInt | None[StrictInt | None] = None,

**kwargs,

) → GetSampleResponse[source]#

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:

GetSampleResponse

has_data_explorer_features(

project_id: StrictInt[StrictInt],

**kwargs,

) → HasDataExplorerFeaturesResponse[source]#

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:

HasDataExplorerFeaturesResponse

has_diversity_data(

project_id: StrictInt[StrictInt],

**kwargs,

) → HasDataExplorerFeaturesResponse[source]#

Check if data diversity metrics exist

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

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:

HasDataExplorerFeaturesResponse

has_label_noise_data(

project_id: StrictInt[StrictInt],

**kwargs,

) → HasDataExplorerFeaturesResponse[source]#

Check if label noise metrics exist

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

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:

HasDataExplorerFeaturesResponse

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)
search (str) – Search query
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:

ListSamplesResponse

move_sample(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

move_raw_data_request: MoveRawDataRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

move_to_labeling_queue(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Move sample to labeling queue

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

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:

GenericApiResponse

rebalance_dataset(

project_id: StrictInt[StrictInt],

**kwargs,

) → RebalanceDatasetResponse[source]#

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:

RebalanceDatasetResponse

rename_sample(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

rename_sample_request: RenameSampleRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

retry_processing(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

run_auto_labeler(

project_id: StrictInt[StrictInt],

run_auto_labeler_request: RunAutoLabelerRequest,

**kwargs,

) → StartJobResponse[source]#

Run auto-labeler job

Run the auto-labeler over all unlabeled data.

Parameters:

project_id (int) – Project ID (required)
run_auto_labeler_request (RunAutoLabelerRequest) – (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:

StartJobResponse

save_auto_labeler_clusters(

project_id: StrictInt[StrictInt],

save_auto_labeler_clusters_request: SaveAutoLabelerClustersRequest,

**kwargs,

) → SaveAutoLabelerClustersResponse[source]#

Save auto-labeler clusters

Set labels for all auto-segment clusters.

Parameters:

project_id (int) – Project ID (required)
save_auto_labeler_clusters_request (SaveAutoLabelerClustersRequest) – (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:

SaveAutoLabelerClustersResponse

segment_sample(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

segment_sample_request: SegmentSampleRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

set_data_explorer_settings(

project_id: StrictInt[StrictInt],

data_explorer_settings: DataExplorerSettings,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

set_sample_bounding_boxes(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

sample_bounding_boxes_request: SampleBoundingBoxesRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

set_sample_metadata(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

set_sample_metadata_request: SetSampleMetadataRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

set_sample_structured_labels(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

set_sample_structured_labels_request: SetSampleStructuredLabelsRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

project_id (int) – Project ID (required)
sample_id (int) – Sample ID (required)
set_sample_structured_labels_request (SetSampleStructuredLabelsRequest) – (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:

GenericApiResponse

split_sample_in_frames(

project_id: StrictInt[StrictInt],

sample_id: StrictInt[StrictInt],

split_sample_in_frames_request: SplitSampleInFramesRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

store_segment_length(

project_id: StrictInt[StrictInt],

store_segment_length_request: StoreSegmentLengthRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

track_objects(

project_id: StrictInt[StrictInt],

track_objects_request: TrackObjectsRequest,

**kwargs,

) → TrackObjectsResponse[source]#

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:

TrackObjectsResponse

upload_data_explorer_screenshot(

project_id: StrictInt[StrictInt],

image: StrictStr,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse