sample module

Sample

class edgeimpulse_api.models.sample.Sample(
		**data: Any
)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Parameters

• **data: Any

Bases

• pydantic.main.BaseModel

• pydantic.utils.Representation

Class variables

• Config

• added: datetime.datetime

• bounding_boxes: List[edgeimpulse_api.models.bounding_box.BoundingBox]

• bounding_boxes_type: pydantic.types.StrictStr

• category: pydantic.types.StrictStr

• chart_type: pydantic.types.StrictStr

• coldstorage_filename: pydantic.types.StrictStr

• created: datetime.datetime

• created_by_synthetic_data_job_id: pydantic.types.StrictInt | None

• device_name: pydantic.types.StrictStr | None

• device_type: pydantic.types.StrictStr

• filename: pydantic.types.StrictStr

• frequency: float

• id: pydantic.types.StrictInt

• image_dimensions: edgeimpulse_api.models.sample_image_dimensions.SampleImageDimensions | None

• interval_ms: float

• is_cropped: pydantic.types.StrictBool

• is_disabled: pydantic.types.StrictBool

• is_processing: pydantic.types.StrictBool

• label: pydantic.types.StrictStr

• last_modified: datetime.datetime

• metadata: Dict[str, pydantic.types.StrictStr] | None

• original_frequency: float

• original_interval_ms: float

• processing_error: pydantic.types.StrictBool

• processing_error_string: pydantic.types.StrictStr | None

• processing_job_id: pydantic.types.StrictInt | None

• project_id: pydantic.types.StrictInt

• project_labeling_method: pydantic.types.StrictStr | None

• project_name: pydantic.types.StrictStr | None

• project_owner_name: pydantic.types.StrictStr | None

• sensors: List[edgeimpulse_api.models.sensor.Sensor]

• sha256_hash: pydantic.types.StrictStr

• signature_key: pydantic.types.StrictStr | None

• signature_method: pydantic.types.StrictStr | None

• signature_validate: pydantic.types.StrictBool

• structured_labels: List[edgeimpulse_api.models.structured_label.StructuredLabel] | None

• structured_labels_list: List[pydantic.types.StrictStr] | None

• thumbnail_video: pydantic.types.StrictStr | None

• thumbnail_video_full: pydantic.types.StrictStr | None

• total_length_ms: float | None

• values_count: pydantic.types.StrictInt

Static methods

bounding_boxes_type_validate_enum

edgeimpulse_api.models.sample.bounding_boxes_type_validate_enum(
		v
)

Parameters

• v

chart_type_validate_enum

edgeimpulse_api.models.sample.chart_type_validate_enum(
		v
)

Parameters

• v

from_dict

edgeimpulse_api.models.sample.from_dict(
		obj: dict
) ‑> edgeimpulse_api.models.sample.Sample

Create an instance of Sample from a dict

Parameters

• obj: dict

Return

edgeimpulse_api.models.sample.Sample

from_json

edgeimpulse_api.models.sample.from_json(
		json_str: str
) ‑> edgeimpulse_api.models.sample.Sample

Create an instance of Sample from a JSON string

Parameters

• json_str: str

Return

edgeimpulse_api.models.sample.Sample

project_labeling_method_validate_enum

edgeimpulse_api.models.sample.project_labeling_method_validate_enum(
		v
)

Parameters

• v

Methods

to_dict

edgeimpulse_api.models.sample.to_dict(
		self
)

Returns the dictionary representation of the model using alias

Parameters

• self

to_json

edgeimpulse_api.models.sample.to_json(
		self,
		indent=None
) ‑> str

Returns the JSON representation of the model using alias

Parameters

• self

• indent=None

Return

str

to_str

edgeimpulse_api.models.sample.to_str(
		self
) ‑> str

Returns the string representation of the model using alias

Parameters

• self

Return

str