RawDataApi
- api_client=None
Methods
batch_add_metadata
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- category: Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(default=Ellipsis, description=‘Which of the three acquisition categories to retrieve data from’, extra=)]
- batch_add_metadata_request: edgeimpulse_api.models.batch_add_metadata_request.BatchAddMetadataRequest
- labels: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label within the given list of labels, given as a JSON string’, extra=)] = None
- filename: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples whose filename includes the given filename’, extra=)] = None
- max_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples shorter than the given length, in milliseconds’, extra=)] = None
- min_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples longer than the given length, in milliseconds’, extra=)] = None
- min_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with higher frequency than given frequency, in hertz’, extra=)] = None
- max_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with lower frequency than given frequency, in hertz’, extra=)] = None
- signature_validity: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include samples with either valid or invalid signatures’, extra=)] = None
- include_disabled: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only enabled or disabled samples (or both)’, extra=)] = None
- ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- exclude_ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Exclude samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label >= this value’, extra=)] = None
- max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label < this value’, extra=)] = None
- search: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Search query’, extra=)] = None
- data_type: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with a particular data type’, extra=)] = None
- min_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID >= this value’, extra=)] = None
- max_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID < this value’, extra=)] = None
- metadata: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use:
{ "no_metadata": true }
. ’, extra=)] = None - min_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that where added after the date given’, extra=)] = None
- max_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that were added before the date given’, extra=)] = None
- **kwargs
batch_clear_metadata
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- category: Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(default=Ellipsis, description=‘Which of the three acquisition categories to retrieve data from’, extra=)]
- labels: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label within the given list of labels, given as a JSON string’, extra=)] = None
- filename: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples whose filename includes the given filename’, extra=)] = None
- max_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples shorter than the given length, in milliseconds’, extra=)] = None
- min_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples longer than the given length, in milliseconds’, extra=)] = None
- min_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with higher frequency than given frequency, in hertz’, extra=)] = None
- max_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with lower frequency than given frequency, in hertz’, extra=)] = None
- signature_validity: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include samples with either valid or invalid signatures’, extra=)] = None
- include_disabled: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only enabled or disabled samples (or both)’, extra=)] = None
- ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- exclude_ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Exclude samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label >= this value’, extra=)] = None
- max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label < this value’, extra=)] = None
- search: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Search query’, extra=)] = None
- data_type: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with a particular data type’, extra=)] = None
- min_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID >= this value’, extra=)] = None
- max_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID < this value’, extra=)] = None
- metadata: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use:
{ "no_metadata": true }
. ’, extra=)] = None - min_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that where added after the date given’, extra=)] = None
- max_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that were added before the date given’, extra=)] = None
- **kwargs
batch_clear_metadata_by_key
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- category: Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(default=Ellipsis, description=‘Which of the three acquisition categories to retrieve data from’, extra=)]
- batch_clear_metadata_by_key_request: edgeimpulse_api.models.batch_clear_metadata_by_key_request.BatchClearMetadataByKeyRequest
- labels: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label within the given list of labels, given as a JSON string’, extra=)] = None
- filename: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples whose filename includes the given filename’, extra=)] = None
- max_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples shorter than the given length, in milliseconds’, extra=)] = None
- min_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples longer than the given length, in milliseconds’, extra=)] = None
- min_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with higher frequency than given frequency, in hertz’, extra=)] = None
- max_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with lower frequency than given frequency, in hertz’, extra=)] = None
- signature_validity: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include samples with either valid or invalid signatures’, extra=)] = None
- include_disabled: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only enabled or disabled samples (or both)’, extra=)] = None
- ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- exclude_ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Exclude samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label >= this value’, extra=)] = None
- max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label < this value’, extra=)] = None
- search: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Search query’, extra=)] = None
- data_type: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with a particular data type’, extra=)] = None
- min_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID >= this value’, extra=)] = None
- max_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID < this value’, extra=)] = None
- metadata: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use:
{ "no_metadata": true }
. ’, extra=)] = None - min_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that where added after the date given’, extra=)] = None
- max_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that were added before the date given’, extra=)] = None
- **kwargs
batch_delete
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- category: Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(default=Ellipsis, description=‘Which of the three acquisition categories to retrieve data from’, extra=)]
- labels: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label within the given list of labels, given as a JSON string’, extra=)] = None
- filename: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples whose filename includes the given filename’, extra=)] = None
- max_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples shorter than the given length, in milliseconds’, extra=)] = None
- min_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples longer than the given length, in milliseconds’, extra=)] = None
- min_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with higher frequency than given frequency, in hertz’, extra=)] = None
- max_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with lower frequency than given frequency, in hertz’, extra=)] = None
- signature_validity: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include samples with either valid or invalid signatures’, extra=)] = None
- include_disabled: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only enabled or disabled samples (or both)’, extra=)] = None
- ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- exclude_ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Exclude samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label >= this value’, extra=)] = None
- max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label < this value’, extra=)] = None
- search: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Search query’, extra=)] = None
- data_type: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with a particular data type’, extra=)] = None
- min_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID >= this value’, extra=)] = None
- max_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID < this value’, extra=)] = None
- metadata: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use:
{ "no_metadata": true }
. ’, extra=)] = None - min_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that where added after the date given’, extra=)] = None
- max_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that were added before the date given’, extra=)] = None
- **kwargs
batch_disable
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- category: Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(default=Ellipsis, description=‘Which of the three acquisition categories to retrieve data from’, extra=)]
- labels: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label within the given list of labels, given as a JSON string’, extra=)] = None
- filename: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples whose filename includes the given filename’, extra=)] = None
- max_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples shorter than the given length, in milliseconds’, extra=)] = None
- min_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples longer than the given length, in milliseconds’, extra=)] = None
- min_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with higher frequency than given frequency, in hertz’, extra=)] = None
- max_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with lower frequency than given frequency, in hertz’, extra=)] = None
- signature_validity: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include samples with either valid or invalid signatures’, extra=)] = None
- include_disabled: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only enabled or disabled samples (or both)’, extra=)] = None
- ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- exclude_ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Exclude samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label >= this value’, extra=)] = None
- max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label < this value’, extra=)] = None
- search: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Search query’, extra=)] = None
- data_type: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with a particular data type’, extra=)] = None
- min_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID >= this value’, extra=)] = None
- max_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID < this value’, extra=)] = None
- metadata: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use:
{ "no_metadata": true }
. ’, extra=)] = None - min_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that where added after the date given’, extra=)] = None
- max_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that were added before the date given’, extra=)] = None
- **kwargs
batch_edit_labels
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- category: Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(default=Ellipsis, description=‘Which of the three acquisition categories to retrieve data from’, extra=)]
- edit_sample_label_request: edgeimpulse_api.models.edit_sample_label_request.EditSampleLabelRequest
- labels: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label within the given list of labels, given as a JSON string’, extra=)] = None
- filename: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples whose filename includes the given filename’, extra=)] = None
- max_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples shorter than the given length, in milliseconds’, extra=)] = None
- min_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples longer than the given length, in milliseconds’, extra=)] = None
- min_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with higher frequency than given frequency, in hertz’, extra=)] = None
- max_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with lower frequency than given frequency, in hertz’, extra=)] = None
- signature_validity: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include samples with either valid or invalid signatures’, extra=)] = None
- include_disabled: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only enabled or disabled samples (or both)’, extra=)] = None
- ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- exclude_ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Exclude samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label >= this value’, extra=)] = None
- max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label < this value’, extra=)] = None
- search: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Search query’, extra=)] = None
- data_type: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with a particular data type’, extra=)] = None
- min_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID >= this value’, extra=)] = None
- max_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID < this value’, extra=)] = None
- metadata: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use:
{ "no_metadata": true }
. ’, extra=)] = None - min_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that where added after the date given’, extra=)] = None
- max_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that were added before the date given’, extra=)] = None
- **kwargs
batch_enable
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- category: Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(default=Ellipsis, description=‘Which of the three acquisition categories to retrieve data from’, extra=)]
- labels: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label within the given list of labels, given as a JSON string’, extra=)] = None
- filename: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples whose filename includes the given filename’, extra=)] = None
- max_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples shorter than the given length, in milliseconds’, extra=)] = None
- min_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples longer than the given length, in milliseconds’, extra=)] = None
- min_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with higher frequency than given frequency, in hertz’, extra=)] = None
- max_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with lower frequency than given frequency, in hertz’, extra=)] = None
- signature_validity: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include samples with either valid or invalid signatures’, extra=)] = None
- include_disabled: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only enabled or disabled samples (or both)’, extra=)] = None
- ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- exclude_ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Exclude samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label >= this value’, extra=)] = None
- max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label < this value’, extra=)] = None
- search: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Search query’, extra=)] = None
- data_type: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with a particular data type’, extra=)] = None
- min_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID >= this value’, extra=)] = None
- max_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID < this value’, extra=)] = None
- metadata: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use:
{ "no_metadata": true }
. ’, extra=)] = None - min_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that where added after the date given’, extra=)] = None
- max_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that were added before the date given’, extra=)] = None
- **kwargs
batch_move
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- category: Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(default=Ellipsis, description=‘Which of the three acquisition categories to retrieve data from’, extra=)]
- move_raw_data_request: edgeimpulse_api.models.move_raw_data_request.MoveRawDataRequest
- labels: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label within the given list of labels, given as a JSON string’, extra=)] = None
- filename: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples whose filename includes the given filename’, extra=)] = None
- max_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples shorter than the given length, in milliseconds’, extra=)] = None
- min_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples longer than the given length, in milliseconds’, extra=)] = None
- min_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with higher frequency than given frequency, in hertz’, extra=)] = None
- max_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with lower frequency than given frequency, in hertz’, extra=)] = None
- signature_validity: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include samples with either valid or invalid signatures’, extra=)] = None
- include_disabled: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only enabled or disabled samples (or both)’, extra=)] = None
- ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- exclude_ids: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Exclude samples with an ID within the given list of IDs, given as a JSON string’, extra=)] = None
- min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label >= this value’, extra=)] = None
- max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label < this value’, extra=)] = None
- search: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Search query’, extra=)] = None
- data_type: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with a particular data type’, extra=)] = None
- min_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID >= this value’, extra=)] = None
- max_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID < this value’, extra=)] = None
- metadata: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use:
{ "no_metadata": true }
. ’, extra=)] = None - min_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that where added after the date given’, extra=)] = None
- max_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that were added before the date given’, extra=)] = None
- **kwargs
classify_using_autolabel
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- object_detection_auto_label_request: edgeimpulse_api.models.object_detection_auto_label_request.ObjectDetectionAutoLabelRequest
- **kwargs
clear_all_object_detection_labels
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
clear_data_explorer
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
count_samples
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- category: Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(default=Ellipsis, description=‘Which of the three acquisition categories to retrieve data from’, extra=)]
- labels: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label within the given list of labels, given as a JSON string’, extra=)] = None
- filename: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples whose filename includes the given filename’, extra=)] = None
- max_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples shorter than the given length, in milliseconds’, extra=)] = None
- min_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples longer than the given length, in milliseconds’, extra=)] = None
- min_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with higher frequency than given frequency, in hertz’, extra=)] = None
- max_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with lower frequency than given frequency, in hertz’, extra=)] = None
- signature_validity: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include samples with either valid or invalid signatures’, extra=)] = None
- include_disabled: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only enabled or disabled samples (or both)’, extra=)] = None
- min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label >= this value’, extra=)] = None
- max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label < this value’, extra=)] = None
- search: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Search query’, extra=)] = None
- data_type: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with a particular data type’, extra=)] = None
- min_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID >= this value’, extra=)] = None
- max_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID < this value’, extra=)] = None
- metadata: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use:
{ "no_metadata": true }
. ’, extra=)] = None - min_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that where added after the date given’, extra=)] = None
- max_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that were added before the date given’, extra=)] = None
- **kwargs
crop_sample
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- crop_sample_request: edgeimpulse_api.models.crop_sample_request.CropSampleRequest
- **kwargs
delete_all_samples
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
delete_all_samples_by_category
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- category: Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(default=Ellipsis, description=‘Which of the three acquisition categories to download data from’, extra=)]
- **kwargs
delete_sample
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- **kwargs
disable_sample
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- **kwargs
edit_label
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- edit_sample_label_request: edgeimpulse_api.models.edit_sample_label_request.EditSampleLabelRequest
- **kwargs
enable_sample
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- **kwargs
find_segments_in_sample
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- find_segment_sample_request: edgeimpulse_api.models.find_segment_sample_request.FindSegmentSampleRequest
- **kwargs
get_ai_actions_proposed_changes
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- job_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Job ID’, extra=)]
- **kwargs
get_all_imported_from
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Maximum number of results’, extra=)] = None
- offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.’, extra=)] = None
- **kwargs
get_data_explorer_features
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
get_data_explorer_predictions
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
get_data_explorer_settings
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
get_dataset_ratio
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
get_diversity_data
calculateDataQualityMetrics
endpoint.
Parameters
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
get_label_noise_data
calculateDataQualityMetrics
endpoint.
Parameters
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
get_object_detection_label_queue
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
get_object_detection_label_queue_count
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
get_sample
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- limit_payload_values: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Limit the number of payload values in the response’, extra=)] = None
- cache_key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).’, extra=)] = None
- impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Impulse ID. If this is unset then the default impulse is used.’, extra=)] = None
- proposed_actions_job_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.’, extra=)] = None
- truncate_structured_labels: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description=‘If true, only a slice of labels will be returned for samples with multiple labels.’, extra=)] = None
- **kwargs
get_sample_as_audio
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- axis_ix: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Axis index’, extra=)]
- slice_start: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Begin index of the slice. If not given, the whole sample is used.’, extra=)] = None
- slice_end: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘End index of the slice. If not given, the whole sample is used.’, extra=)] = None
- cache_key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).’, extra=)] = None
- **kwargs
get_sample_as_image
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- after_input_block: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description=‘Whether to process the image through the input block first’, extra=)] = None
- cache_key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).’, extra=)] = None
- impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Impulse ID. If this is unset then the default impulse is used.’, extra=)] = None
- **kwargs
get_sample_as_raw
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- **kwargs
get_sample_as_video
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- after_input_block: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description=‘Whether to process the image through the input block first’, extra=)] = None
- cache_key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).’, extra=)] = None
- impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Impulse ID. If this is unset then the default impulse is used.’, extra=)] = None
- **kwargs
get_sample_metadata
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- category: Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(default=Ellipsis, description=‘Which of the three acquisition categories to retrieve data from’, extra=)]
- **kwargs
get_sample_metadata_filter_options
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- category: Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(default=Ellipsis, description=‘Which of the three acquisition categories to retrieve data from’, extra=)]
- limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Maximum number of results’, extra=)] = None
- offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.’, extra=)] = None
- **kwargs
get_sample_slice
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- slice_start: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Begin index of the slice’, extra=)]
- slice_end: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.’, extra=)] = None
- impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Impulse ID. If this is unset then the default impulse is used.’, extra=)] = None
- truncate_structured_labels: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description=‘If true, only a slice of labels will be returned for samples with multiple labels.’, extra=)] = None
- **kwargs
get_uncropped_downsampled_sample
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- limit_payload_values: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Limit the number of payload values in the response’, extra=)] = None
- zoom_start: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Zoom into the sample, with the focus starting at this index’, extra=)] = None
- zoom_end: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Zoom into the sample, with the focus ending at this index’, extra=)] = None
- impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Impulse ID. If this is unset then the default impulse is used.’, extra=)] = None
- truncate_structured_labels: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description=‘If true, only a slice of labels will be returned for samples with multiple labels.’, extra=)] = None
- **kwargs
has_data_explorer_features
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
has_diversity_data
calculateDataQualityMetrics
endpoint.
Parameters
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
has_label_noise_data
calculateDataQualityMetrics
endpoint.
Parameters
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
list_samples
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- category: Annotated[edgeimpulse_api.models.raw_data_category.RawDataCategory, FieldInfo(default=Ellipsis, description=‘Which of the three acquisition categories to retrieve data from’, extra=)]
- limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Maximum number of results’, extra=)] = None
- offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.’, extra=)] = None
- exclude_sensors: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description=‘Whether to exclude sensors in the response (as these can slow down requests when you have large pages).’, extra=)] = None
- labels: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label within the given list of labels, given as a JSON string’, extra=)] = None
- filename: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples whose filename includes the given filename’, extra=)] = None
- max_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples shorter than the given length, in milliseconds’, extra=)] = None
- min_length: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples longer than the given length, in milliseconds’, extra=)] = None
- min_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with higher frequency than given frequency, in hertz’, extra=)] = None
- max_frequency: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with lower frequency than given frequency, in hertz’, extra=)] = None
- signature_validity: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include samples with either valid or invalid signatures’, extra=)] = None
- include_disabled: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only enabled or disabled samples (or both)’, extra=)] = None
- min_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label >= this value’, extra=)] = None
- max_label: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples with a label < this value’, extra=)] = None
- search: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Search query’, extra=)] = None
- proposed_actions_job_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description=‘Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.’, extra=)] = None
- truncate_structured_labels: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description=‘If true, only a slice of labels will be returned for samples with multiple labels.’, extra=)] = None
- sort_by: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘If not specified, “id-desc” is used.’, extra=)] = None
- data_type: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with a particular data type’, extra=)] = None
- min_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID >= this value’, extra=)] = None
- max_id: Annotated[float | None, FieldInfo(default=PydanticUndefined, description=‘Include only samples with an ID < this value’, extra=)] = None
- metadata: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description=‘Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use:
{ "no_metadata": true }
. ’, extra=)] = None - min_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that where added after the date given’, extra=)] = None
- max_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description=‘Only include samples that were added before the date given’, extra=)] = None
- **kwargs
move_sample
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- move_raw_data_request: edgeimpulse_api.models.move_raw_data_request.MoveRawDataRequest
- **kwargs
move_to_labeling_queue
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- **kwargs
rebalance_dataset
/v1/api/{projectId}/classify/v2/{sampleId}
). Rebalances the dataset over training / testing categories. This resets the category for all data and splits it 80%/20% between training and testing. This is a deterministic process based on the hash of the name of the data.
Parameters
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
rebalance_dataset_v2
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
rename_sample
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- rename_sample_request: edgeimpulse_api.models.rename_sample_request.RenameSampleRequest
- **kwargs
retry_processing
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- **kwargs
segment_sample
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- segment_sample_request: edgeimpulse_api.models.segment_sample_request.SegmentSampleRequest
- **kwargs
set_data_explorer_settings
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- data_explorer_settings: edgeimpulse_api.models.data_explorer_settings.DataExplorerSettings
- **kwargs
set_sample_bounding_boxes
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- sample_bounding_boxes_request: edgeimpulse_api.models.sample_bounding_boxes_request.SampleBoundingBoxesRequest
- **kwargs
set_sample_metadata
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- set_sample_metadata_request: edgeimpulse_api.models.set_sample_metadata_request.SetSampleMetadataRequest
- **kwargs
set_sample_proposed_changes
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- set_sample_proposed_changes_request: edgeimpulse_api.models.set_sample_proposed_changes_request.SetSampleProposedChangesRequest
- **kwargs
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[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- set_sample_structured_labels_request: edgeimpulse_api.models.set_sample_structured_labels_request.SetSampleStructuredLabelsRequest
- **kwargs
set_sample_video_dimensions
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- set_sample_video_dimensions_request: edgeimpulse_api.models.set_sample_video_dimensions_request.SetSampleVideoDimensionsRequest
- **kwargs
split_sample_in_frames
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- sample_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Sample ID’, extra=)]
- split_sample_in_frames_request: edgeimpulse_api.models.split_sample_in_frames_request.SplitSampleInFramesRequest
- **kwargs
store_segment_length
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- store_segment_length_request: edgeimpulse_api.models.store_segment_length_request.StoreSegmentLengthRequest
- **kwargs
track_objects
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- track_objects_request: edgeimpulse_api.models.track_objects_request.TrackObjectsRequest
- **kwargs