Classes
RawDataApi
Parameters | |
---|---|
api_client=None | |
METHODS
batch_add_metadata
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
category | Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(annotation=NoneType, required=True, description='Which of the three acquisition categories to retrieve data from')] |
batch_add_metadata_request | edgeimpulse_api.models.batch_add_metadata_request.BatchAddMetadataRequest |
labels | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label within the given list of labels, given as a JSON string')] = None |
filename | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples whose filename includes the given filename')] = None |
max_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples shorter than the given length, in milliseconds')] = None |
min_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples longer than the given length, in milliseconds')] = None |
min_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with higher frequency than given frequency, in hertz')] = None |
max_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with lower frequency than given frequency, in hertz')] = None |
signature_validity | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include samples with either valid or invalid signatures')] = None |
include_disabled | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only enabled or disabled samples (or both)')] = None |
ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with an ID within the given list of IDs, given as a JSON string')] = None |
exclude_ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Exclude samples with an ID within the given list of IDs, given as a JSON string')] = None |
min_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label >= this value')] = None |
max_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label < this value')] = None |
search | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Search query')] = None |
data_type | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with a particular data type')] = None |
min_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID >= this value')] = None |
max_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID < this value')] = None |
metadata | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties |
min_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that where added after the date given')] = None |
max_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that were added before the date given')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.rebalance_dataset_v2200_response.RebalanceDatasetV2200Response |
batch_clear_metadata
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
category | Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(annotation=NoneType, required=True, description='Which of the three acquisition categories to retrieve data from')] |
labels | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label within the given list of labels, given as a JSON string')] = None |
filename | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples whose filename includes the given filename')] = None |
max_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples shorter than the given length, in milliseconds')] = None |
min_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples longer than the given length, in milliseconds')] = None |
min_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with higher frequency than given frequency, in hertz')] = None |
max_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with lower frequency than given frequency, in hertz')] = None |
signature_validity | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include samples with either valid or invalid signatures')] = None |
include_disabled | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only enabled or disabled samples (or both)')] = None |
ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with an ID within the given list of IDs, given as a JSON string')] = None |
exclude_ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Exclude samples with an ID within the given list of IDs, given as a JSON string')] = None |
min_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label >= this value')] = None |
max_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label < this value')] = None |
search | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Search query')] = None |
data_type | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with a particular data type')] = None |
min_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID >= this value')] = None |
max_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID < this value')] = None |
metadata | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties |
min_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that where added after the date given')] = None |
max_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that were added before the date given')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
batch_clear_metadata_by_key
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
category | Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(annotation=NoneType, required=True, description='Which of the three acquisition categories to retrieve data from')] |
batch_clear_metadata_by_key_request | edgeimpulse_api.models.batch_clear_metadata_by_key_request.BatchClearMetadataByKeyRequest |
labels | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label within the given list of labels, given as a JSON string')] = None |
filename | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples whose filename includes the given filename')] = None |
max_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples shorter than the given length, in milliseconds')] = None |
min_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples longer than the given length, in milliseconds')] = None |
min_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with higher frequency than given frequency, in hertz')] = None |
max_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with lower frequency than given frequency, in hertz')] = None |
signature_validity | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include samples with either valid or invalid signatures')] = None |
include_disabled | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only enabled or disabled samples (or both)')] = None |
ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with an ID within the given list of IDs, given as a JSON string')] = None |
exclude_ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Exclude samples with an ID within the given list of IDs, given as a JSON string')] = None |
min_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label >= this value')] = None |
max_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label < this value')] = None |
search | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Search query')] = None |
data_type | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with a particular data type')] = None |
min_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID >= this value')] = None |
max_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID < this value')] = None |
metadata | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties |
min_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that where added after the date given')] = None |
max_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that were added before the date given')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.rebalance_dataset_v2200_response.RebalanceDatasetV2200Response |
batch_delete
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
category | Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(annotation=NoneType, required=True, description='Which of the three acquisition categories to retrieve data from')] |
labels | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label within the given list of labels, given as a JSON string')] = None |
filename | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples whose filename includes the given filename')] = None |
max_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples shorter than the given length, in milliseconds')] = None |
min_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples longer than the given length, in milliseconds')] = None |
min_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with higher frequency than given frequency, in hertz')] = None |
max_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with lower frequency than given frequency, in hertz')] = None |
signature_validity | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include samples with either valid or invalid signatures')] = None |
include_disabled | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only enabled or disabled samples (or both)')] = None |
ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with an ID within the given list of IDs, given as a JSON string')] = None |
exclude_ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Exclude samples with an ID within the given list of IDs, given as a JSON string')] = None |
min_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label >= this value')] = None |
max_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label < this value')] = None |
search | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Search query')] = None |
data_type | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with a particular data type')] = None |
min_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID >= this value')] = None |
max_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID < this value')] = None |
metadata | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties |
min_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that where added after the date given')] = None |
max_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that were added before the date given')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.rebalance_dataset_v2200_response.RebalanceDatasetV2200Response |
batch_disable
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
category | Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(annotation=NoneType, required=True, description='Which of the three acquisition categories to retrieve data from')] |
labels | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label within the given list of labels, given as a JSON string')] = None |
filename | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples whose filename includes the given filename')] = None |
max_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples shorter than the given length, in milliseconds')] = None |
min_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples longer than the given length, in milliseconds')] = None |
min_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with higher frequency than given frequency, in hertz')] = None |
max_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with lower frequency than given frequency, in hertz')] = None |
signature_validity | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include samples with either valid or invalid signatures')] = None |
include_disabled | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only enabled or disabled samples (or both)')] = None |
ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with an ID within the given list of IDs, given as a JSON string')] = None |
exclude_ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Exclude samples with an ID within the given list of IDs, given as a JSON string')] = None |
min_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label >= this value')] = None |
max_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label < this value')] = None |
search | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Search query')] = None |
data_type | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with a particular data type')] = None |
min_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID >= this value')] = None |
max_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID < this value')] = None |
metadata | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties |
min_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that where added after the date given')] = None |
max_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that were added before the date given')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.rebalance_dataset_v2200_response.RebalanceDatasetV2200Response |
batch_edit_bounding_boxes
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
category | Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(annotation=NoneType, required=True, description='Which of the three acquisition categories to retrieve data from')] |
batch_edit_bounding_boxes_request | edgeimpulse_api.models.batch_edit_bounding_boxes_request.BatchEditBoundingBoxesRequest |
labels | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label within the given list of labels, given as a JSON string')] = None |
filename | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples whose filename includes the given filename')] = None |
max_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples shorter than the given length, in milliseconds')] = None |
min_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples longer than the given length, in milliseconds')] = None |
min_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with higher frequency than given frequency, in hertz')] = None |
max_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with lower frequency than given frequency, in hertz')] = None |
signature_validity | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include samples with either valid or invalid signatures')] = None |
include_disabled | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only enabled or disabled samples (or both)')] = None |
ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with an ID within the given list of IDs, given as a JSON string')] = None |
exclude_ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Exclude samples with an ID within the given list of IDs, given as a JSON string')] = None |
min_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label >= this value')] = None |
max_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label < this value')] = None |
search | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Search query')] = None |
data_type | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with a particular data type')] = None |
min_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID >= this value')] = None |
max_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID < this value')] = None |
metadata | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties |
min_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that where added after the date given')] = None |
max_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that were added before the date given')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.rebalance_dataset_v2200_response.RebalanceDatasetV2200Response |
batch_edit_labels
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
category | Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(annotation=NoneType, required=True, description='Which of the three acquisition categories to retrieve data from')] |
edit_sample_label_request | edgeimpulse_api.models.edit_sample_label_request.EditSampleLabelRequest |
labels | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label within the given list of labels, given as a JSON string')] = None |
filename | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples whose filename includes the given filename')] = None |
max_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples shorter than the given length, in milliseconds')] = None |
min_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples longer than the given length, in milliseconds')] = None |
min_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with higher frequency than given frequency, in hertz')] = None |
max_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with lower frequency than given frequency, in hertz')] = None |
signature_validity | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include samples with either valid or invalid signatures')] = None |
include_disabled | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only enabled or disabled samples (or both)')] = None |
ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with an ID within the given list of IDs, given as a JSON string')] = None |
exclude_ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Exclude samples with an ID within the given list of IDs, given as a JSON string')] = None |
min_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label >= this value')] = None |
max_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label < this value')] = None |
search | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Search query')] = None |
data_type | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with a particular data type')] = None |
min_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID >= this value')] = None |
max_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID < this value')] = None |
metadata | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties |
min_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that where added after the date given')] = None |
max_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that were added before the date given')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.rebalance_dataset_v2200_response.RebalanceDatasetV2200Response |
batch_enable
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
category | Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(annotation=NoneType, required=True, description='Which of the three acquisition categories to retrieve data from')] |
labels | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label within the given list of labels, given as a JSON string')] = None |
filename | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples whose filename includes the given filename')] = None |
max_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples shorter than the given length, in milliseconds')] = None |
min_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples longer than the given length, in milliseconds')] = None |
min_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with higher frequency than given frequency, in hertz')] = None |
max_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with lower frequency than given frequency, in hertz')] = None |
signature_validity | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include samples with either valid or invalid signatures')] = None |
include_disabled | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only enabled or disabled samples (or both)')] = None |
ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with an ID within the given list of IDs, given as a JSON string')] = None |
exclude_ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Exclude samples with an ID within the given list of IDs, given as a JSON string')] = None |
min_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label >= this value')] = None |
max_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label < this value')] = None |
search | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Search query')] = None |
data_type | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with a particular data type')] = None |
min_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID >= this value')] = None |
max_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID < this value')] = None |
metadata | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties |
min_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that where added after the date given')] = None |
max_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that were added before the date given')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.rebalance_dataset_v2200_response.RebalanceDatasetV2200Response |
batch_move
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
category | Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(annotation=NoneType, required=True, description='Which of the three acquisition categories to retrieve data from')] |
move_raw_data_request | edgeimpulse_api.models.move_raw_data_request.MoveRawDataRequest |
labels | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label within the given list of labels, given as a JSON string')] = None |
filename | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples whose filename includes the given filename')] = None |
max_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples shorter than the given length, in milliseconds')] = None |
min_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples longer than the given length, in milliseconds')] = None |
min_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with higher frequency than given frequency, in hertz')] = None |
max_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with lower frequency than given frequency, in hertz')] = None |
signature_validity | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include samples with either valid or invalid signatures')] = None |
include_disabled | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only enabled or disabled samples (or both)')] = None |
ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with an ID within the given list of IDs, given as a JSON string')] = None |
exclude_ids | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Exclude samples with an ID within the given list of IDs, given as a JSON string')] = None |
min_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label >= this value')] = None |
max_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label < this value')] = None |
search | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Search query')] = None |
data_type | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with a particular data type')] = None |
min_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID >= this value')] = None |
max_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID < this value')] = None |
metadata | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties |
min_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that where added after the date given')] = None |
max_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that were added before the date given')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.rebalance_dataset_v2200_response.RebalanceDatasetV2200Response |
classify_using_autolabel
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
object_detection_auto_label_request | edgeimpulse_api.models.object_detection_auto_label_request.ObjectDetectionAutoLabelRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.object_detection_auto_label_response.ObjectDetectionAutoLabelResponse |
clear_all_object_detection_labels
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
clear_data_explorer
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
count_samples
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
category | Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(annotation=NoneType, required=True, description='Which of the three acquisition categories to retrieve data from')] |
labels | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label within the given list of labels, given as a JSON string')] = None |
filename | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples whose filename includes the given filename')] = None |
max_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples shorter than the given length, in milliseconds')] = None |
min_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples longer than the given length, in milliseconds')] = None |
min_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with higher frequency than given frequency, in hertz')] = None |
max_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with lower frequency than given frequency, in hertz')] = None |
signature_validity | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include samples with either valid or invalid signatures')] = None |
include_disabled | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only enabled or disabled samples (or both)')] = None |
min_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label >= this value')] = None |
max_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label < this value')] = None |
search | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Search query')] = None |
data_type | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with a particular data type')] = None |
min_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID >= this value')] = None |
max_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID < this value')] = None |
metadata | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties |
min_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that where added after the date given')] = None |
max_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that were added before the date given')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.count_samples_response.CountSamplesResponse |
crop_sample
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
crop_sample_request | edgeimpulse_api.models.crop_sample_request.CropSampleRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.crop_sample_response.CropSampleResponse |
delete_all_samples
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
delete_all_samples_by_category
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
category | Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(annotation=NoneType, required=True, description='Which of the three acquisition categories to download data from')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
delete_sample
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
disable_sample
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
edit_label
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
edit_sample_label_request | edgeimpulse_api.models.edit_sample_label_request.EditSampleLabelRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
enable_sample
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
find_segments_in_sample
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
find_segment_sample_request | edgeimpulse_api.models.find_segment_sample_request.FindSegmentSampleRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.find_segment_sample_response.FindSegmentSampleResponse |
get_ai_actions_proposed_changes
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
job_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Job ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_ai_actions_proposed_changes_response.GetAIActionsProposedChangesResponse |
get_all_imported_from
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
limit | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Maximum number of results')] = None |
offset | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_all_imported_from_response.GetAllImportedFromResponse |
get_data_explorer_features
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_data_explorer_features_response.GetDataExplorerFeaturesResponse |
get_data_explorer_predictions
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.data_explorer_predictions_response.DataExplorerPredictionsResponse |
get_data_explorer_settings
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_data_explorer_settings_response.GetDataExplorerSettingsResponse |
get_dataset_ratio
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_dataset_ratio_response.GetDatasetRatioResponse |
get_diversity_data
calculateDataQualityMetrics
endpoint.
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_diversity_data_response.GetDiversityDataResponse |
get_label_noise_data
calculateDataQualityMetrics
endpoint.
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_label_noise_data_response.GetLabelNoiseDataResponse |
get_object_detection_label_queue
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.object_detection_label_queue_response.ObjectDetectionLabelQueueResponse |
get_object_detection_label_queue_count
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.object_detection_label_queue_count_response.ObjectDetectionLabelQueueCountResponse |
get_sample
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
limit_payload_values | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Limit the number of payload values in the response')] = None |
cache_key | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).')] = None |
impulse_id | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Impulse ID. If this is unset then the default impulse is used.')] = None |
proposed_actions_job_id | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.')] = None |
truncate_structured_labels | Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If true, only a slice of labels will be returned for samples with multiple labels.')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_sample_response.GetSampleResponse |
get_sample_as_audio
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
axis_ix | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Axis index')] |
slice_start | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Begin index of the slice. If not given, the whole sample is used.')] = None |
slice_end | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='End index of the slice. If not given, the whole sample is used.')] = None |
cache_key | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).')] = None |
**kwargs | |
Returns |
---|
str |
get_sample_as_image
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
after_input_block | Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Whether to process the image through the input block first')] = None |
cache_key | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).')] = None |
impulse_id | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Impulse ID. If this is unset then the default impulse is used.')] = None |
**kwargs | |
Returns |
---|
str |
get_sample_as_raw
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
**kwargs | |
Returns |
---|
str |
get_sample_as_video
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
after_input_block | Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Whether to process the image through the input block first')] = None |
cache_key | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).')] = None |
impulse_id | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Impulse ID. If this is unset then the default impulse is used.')] = None |
**kwargs | |
Returns |
---|
str |
get_sample_metadata
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
category | Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(annotation=NoneType, required=True, description='Which of the three acquisition categories to retrieve data from')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_sample_metadata_response.GetSampleMetadataResponse |
get_sample_metadata_filter_options
{projectId}
/raw-data endpoint
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
category | Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(annotation=NoneType, required=True, description='Which of the three acquisition categories to retrieve data from')] |
limit | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Maximum number of results')] = None |
offset | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_sample_metadata_filter_options_response.GetSampleMetadataFilterOptionsResponse |
get_sample_slice
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
slice_start | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Begin index of the slice')] |
slice_end | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.')] = None |
impulse_id | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Impulse ID. If this is unset then the default impulse is used.')] = None |
truncate_structured_labels | Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If true, only a slice of labels will be returned for samples with multiple labels.')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_sample_response.GetSampleResponse |
get_uncropped_downsampled_sample
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
limit_payload_values | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Limit the number of payload values in the response')] = None |
zoom_start | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Zoom into the sample, with the focus starting at this index')] = None |
zoom_end | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Zoom into the sample, with the focus ending at this index')] = None |
impulse_id | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Impulse ID. If this is unset then the default impulse is used.')] = None |
truncate_structured_labels | Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If true, only a slice of labels will be returned for samples with multiple labels.')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_sample_response.GetSampleResponse |
has_data_explorer_features
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.has_data_explorer_features_response.HasDataExplorerFeaturesResponse |
has_diversity_data
calculateDataQualityMetrics
endpoint.
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.has_data_explorer_features_response.HasDataExplorerFeaturesResponse |
has_label_noise_data
calculateDataQualityMetrics
endpoint.
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.has_data_explorer_features_response.HasDataExplorerFeaturesResponse |
list_samples
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
category | Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(annotation=NoneType, required=True, description='Which of the three acquisition categories to retrieve data from')] |
limit | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Maximum number of results')] = None |
offset | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.')] = None |
exclude_sensors | Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Whether to exclude sensors in the response (as these can slow down requests when you have large pages).')] = None |
labels | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label within the given list of labels, given as a JSON string')] = None |
filename | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples whose filename includes the given filename')] = None |
max_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples shorter than the given length, in milliseconds')] = None |
min_length | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples longer than the given length, in milliseconds')] = None |
min_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with higher frequency than given frequency, in hertz')] = None |
max_frequency | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with lower frequency than given frequency, in hertz')] = None |
signature_validity | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include samples with either valid or invalid signatures')] = None |
include_disabled | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only enabled or disabled samples (or both)')] = None |
min_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label >= this value')] = None |
max_label | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples with a label < this value')] = None |
search | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Search query')] = None |
proposed_actions_job_id | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.')] = None |
truncate_structured_labels | Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If true, only a slice of labels will be returned for samples with multiple labels.')] = None |
sort_by | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If not specified, "id-desc" is used.')] = None |
data_type | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with a particular data type')] = None |
min_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID >= this value')] = None |
max_id | Annotated[float | None, FieldInfo(annotation=NoneType, required=True, description='Include only samples with an ID < this value')] = None |
metadata | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties |
min_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that where added after the date given')] = None |
max_date | Annotated[datetime.datetime | None, FieldInfo(annotation=NoneType, required=True, description='Only include samples that were added before the date given')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.list_samples_response.ListSamplesResponse |
move_sample
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
move_raw_data_request | edgeimpulse_api.models.move_raw_data_request.MoveRawDataRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
move_to_labeling_queue
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
rebalance_dataset
/v1/api/{projectId}/v2/rebalance
). Rebalances the dataset over training / testing categories. This resets the category for all data and splits it 80%/20% between training and testing. This is a deterministic process based on the hash of the name of the data.
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.rebalance_dataset_response.RebalanceDatasetResponse |
rebalance_dataset_v2
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.rebalance_dataset_v2200_response.RebalanceDatasetV2200Response |
rename_sample
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
rename_sample_request | edgeimpulse_api.models.rename_sample_request.RenameSampleRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
retry_processing
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
segment_sample
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
segment_sample_request | edgeimpulse_api.models.segment_sample_request.SegmentSampleRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
set_data_explorer_settings
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
data_explorer_settings | edgeimpulse_api.models.data_explorer_settings.DataExplorerSettings |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
set_sample_bounding_boxes
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
sample_bounding_boxes_request | edgeimpulse_api.models.sample_bounding_boxes_request.SampleBoundingBoxesRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
set_sample_metadata
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
set_sample_metadata_request | edgeimpulse_api.models.set_sample_metadata_request.SetSampleMetadataRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
set_sample_proposed_changes
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
set_sample_proposed_changes_request | edgeimpulse_api.models.set_sample_proposed_changes_request.SetSampleProposedChangesRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
set_sample_structured_labels
label
column is ignored, and the sample is allowed to have multiple labels. An array of { startIndex, endIndex, label }
needs to be passed in with labels for the complete sample (see valuesCount
to get the upper bound). endIndex is inclusive. If you pass in an incorrect array (e.g. missing values) you’ll get an error back.
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
set_sample_structured_labels_request | edgeimpulse_api.models.set_sample_structured_labels_request.SetSampleStructuredLabelsRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
set_sample_video_dimensions
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
set_sample_video_dimensions_request | edgeimpulse_api.models.set_sample_video_dimensions_request.SetSampleVideoDimensionsRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
split_sample_in_frames
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
sample_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Sample ID')] |
split_sample_in_frames_request | edgeimpulse_api.models.split_sample_in_frames_request.SplitSampleInFramesRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.rebalance_dataset_v2200_response.RebalanceDatasetV2200Response |
store_segment_length
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
store_segment_length_request | edgeimpulse_api.models.store_segment_length_request.StoreSegmentLengthRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
track_objects
Parameters | |
---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
track_objects_request | edgeimpulse_api.models.track_objects_request.TrackObjectsRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.track_objects_response.TrackObjectsResponse |